id
stringlengths 14
16
| conversations
listlengths 3
3
| schema
stringlengths 68
3.98M
| task
stringlengths 134
732
| category
stringlengths 2
130
| source
stringclasses 1
value |
|---|---|---|---|---|---|
schema_store_201
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://nullstone.io/.nullstone/config.yml\",\"title\":\"Nullstone configuration specification\",\"description\":\"The Nullstone configuration file is a YAML file defining a platform-agnostic architecture\",\"type\":\"object\",\"properties\":{\"version\":{\"const\":\"0.1\"},\"apps\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/app\"}},\"additionalProperties\":false},\"blocks\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/block\"}},\"additionalProperties\":false},\"cluster_namespaces\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/cluster_namespace\"}},\"additionalProperties\":false},\"clusters\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/cluster\"}},\"additionalProperties\":false},\"datastores\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/datastore\"}},\"additionalProperties\":false},\"domains\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/domain\"}},\"additionalProperties\":false},\"ingresses\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/ingress\"}},\"additionalProperties\":false},\"networks\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/network\"}},\"additionalProperties\":false},\"subdomains\":{\"type\":\"object\",\"patternProperties\":{\"^[a-z0-9\\\\-]+$\":{\"$ref\":\"#/definitions/subdomain\"}},\"additionalProperties\":false}},\"required\":[\"version\"],\"additionalProperties\":false,\"definitions\":{\"block\":{\"id\":\"#/definitions/block\",\"type\":\"object\",\"properties\":{\"module\":{\"type\":\"string\",\"description\":\"\"},\"module_version\":{\"type\":\"string\",\"description\":\"\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"},\"is_shared\":{\"type\":\"boolean\",\"description\":\"\"}},\"patternProperties\":{\"^x-\":{}},\"additionalProperties\":false},\"app\":{\"id\":\"#/definitions/app\",\"type\":\"object\",\"properties\":{\"module\":{\"type\":\"string\",\"description\":\"\"},\"module_version\":{\"type\":\"string\",\"description\":\"\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"},\"is_shared\":{\"type\":\"boolean\",\"description\":\"\"},\"framework\":{\"type\":\"string\",\"description\":\"\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_]+$\":{\"type\":\"string\"}}},\"capabilities\":{\"oneOf\":[{\"$ref\":\"#/definitions/capabilities\"},{\"$ref\":\"#/definitions/capabilitiesArray\"}]}},\"patternProperties\":{\"^x-\":{}},\"additionalProperties\":false},\"cluster_namespace\":{\"allOf\":[{\"$ref\":\"#/definitions/block\"}]},\"cluster\":{\"allOf\":[{\"$ref\":\"#/definitions/block\"}]},\"datastore\":{\"allOf\":[{\"$ref\":\"#/definitions/block\"}]},\"domain\":{\"id\":\"#/definitions/subdomain\",\"type\":\"object\",\"properties\":{\"module\":{\"type\":\"string\",\"description\":\"\"},\"module_version\":{\"type\":\"string\",\"description\":\"\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"},\"dns_name\":{\"type\":\"string\",\"description\":\"\"}},\"patternProperties\":{\"^x-\":{}},\"additionalProperties\":false},\"ingress\":{\"allOf\":[{\"$ref\":\"#/definitions/block\"}]},\"network\":{\"allOf\":[{\"$ref\":\"#/definitions/block\"}]},\"subdomain\":{\"id\":\"#/definitions/subdomain\",\"type\":\"object\",\"properties\":{\"module\":{\"type\":\"string\",\"description\":\"\"},\"module_version\":{\"type\":\"string\",\"description\":\"\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"},\"is_shared\":{\"type\":\"boolean\",\"description\":\"\"},\"dns_name\":{\"type\":\"string\",\"description\":\"\"}},\"patternProperties\":{\"^x-\":{}},\"additionalProperties\":false},\"capabilities\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/capability\"}},\"capabilitiesArray\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/namedCapability\"}},\"capability\":{\"type\":\"object\",\"properties\":{\"namespace\":{\"types\":\"string\"},\"module\":{\"type\":\"string\"},\"module_version\":{\"type\":\"string\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"}}},\"namedCapability\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"},\"module\":{\"type\":\"string\"},\"module_version\":{\"type\":\"string\"},\"vars\":{\"$ref\":\"#/definitions/variables\"},\"connections\":{\"$ref\":\"#/definitions/connection_targets\"}}},\"variables\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z_][A-Za-z0-9_\\\\-]*$\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"number\"},{\"type\":\"object\"},{\"type\":\"array\"}]}}},\"connection_targets\":{\"type\":\"object\",\"patternProperties\":{\"^[_a-z0-9\\\\-]+$\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^(?:([a-zA-Z0-9\\\\-]+)\\\\.)?(?:([a-zA-Z0-9\\\\-]+)\\\\.)?([a-zA-Z0-9\\\\-]+)$\"},{\"$ref\":\"#/definitions/connection_target\"}]}}},\"connection_target\":{\"type\":\"object\",\"properties\":{\"stack_name\":{\"type\":\"string\"},\"env_name\":{\"type\":\"string\"},\"block_name\":{\"type\":\"string\"}},\"required\":[\"block_name\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Nullstone configuration specification\". Here are the required top‑level fields: version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://nullstone.io/.nullstone/config.yml","title":"Nullstone configuration specification","description":"The Nullstone configuration file is a YAML file defining a platform-agnostic architecture","type":"object","properties":{"version":{"const":"0.1"},"apps":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/app"}},"additionalProperties":false},"blocks":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/block"}},"additionalProperties":false},"cluster_namespaces":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/cluster_namespace"}},"additionalProperties":false},"clusters":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/cluster"}},"additionalProperties":false},"datastores":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/datastore"}},"additionalProperties":false},"domains":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/domain"}},"additionalProperties":false},"ingresses":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/ingress"}},"additionalProperties":false},"networks":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/network"}},"additionalProperties":false},"subdomains":{"type":"object","patternProperties":{"^[a-z0-9\\-]+$":{"$ref":"#/definitions/subdomain"}},"additionalProperties":false}},"required":["version"],"additionalProperties":false,"definitions":{"block":{"id":"#/definitions/block","type":"object","properties":{"module":{"type":"string","description":""},"module_version":{"type":"string","description":""},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"},"is_shared":{"type":"boolean","description":""}},"patternProperties":{"^x-":{}},"additionalProperties":false},"app":{"id":"#/definitions/app","type":"object","properties":{"module":{"type":"string","description":""},"module_version":{"type":"string","description":""},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"},"is_shared":{"type":"boolean","description":""},"framework":{"type":"string","description":""},"environment":{"type":"object","patternProperties":{"^[A-Za-z0-9_]+$":{"type":"string"}}},"capabilities":{"oneOf":[{"$ref":"#/definitions/capabilities"},{"$ref":"#/definitions/capabilitiesArray"}]}},"patternProperties":{"^x-":{}},"additionalProperties":false},"cluster_namespace":{"allOf":[{"$ref":"#/definitions/block"}]},"cluster":{"allOf":[{"$ref":"#/definitions/block"}]},"datastore":{"allOf":[{"$ref":"#/definitions/block"}]},"domain":{"id":"#/definitions/subdomain","type":"object","properties":{"module":{"type":"string","description":""},"module_version":{"type":"string","description":""},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"},"dns_name":{"type":"string","description":""}},"patternProperties":{"^x-":{}},"additionalProperties":false},"ingress":{"allOf":[{"$ref":"#/definitions/block"}]},"network":{"allOf":[{"$ref":"#/definitions/block"}]},"subdomain":{"id":"#/definitions/subdomain","type":"object","properties":{"module":{"type":"string","description":""},"module_version":{"type":"string","description":""},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"},"is_shared":{"type":"boolean","description":""},"dns_name":{"type":"string","description":""}},"patternProperties":{"^x-":{}},"additionalProperties":false},"capabilities":{"type":"object","additionalProperties":{"$ref":"#/definitions/capability"}},"capabilitiesArray":{"type":"array","items":{"$ref":"#/definitions/namedCapability"}},"capability":{"type":"object","properties":{"namespace":{"types":"string"},"module":{"type":"string"},"module_version":{"type":"string"},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"}}},"namedCapability":{"type":"object","properties":{"name":{"type":"string"},"namespace":{"type":"string"},"module":{"type":"string"},"module_version":{"type":"string"},"vars":{"$ref":"#/definitions/variables"},"connections":{"$ref":"#/definitions/connection_targets"}}},"variables":{"type":"object","patternProperties":{"^[A-Za-z_][A-Za-z0-9_\\-]*$":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"object"},{"type":"array"}]}}},"connection_targets":{"type":"object","patternProperties":{"^[_a-z0-9\\-]+$":{"oneOf":[{"type":"string","pattern":"^(?:([a-zA-Z0-9\\-]+)\\.)?(?:([a-zA-Z0-9\\-]+)\\.)?([a-zA-Z0-9\\-]+)$"},{"$ref":"#/definitions/connection_target"}]}}},"connection_target":{"type":"object","properties":{"stack_name":{"type":"string"},"env_name":{"type":"string"},"block_name":{"type":"string"}},"required":["block_name"]}}}
|
Provide a JSON object that satisfies the schema "Nullstone configuration specification". Here are the required top‑level fields: version. Return only the valid JSON object.
|
Nullstone configuration specification
|
schema-store
|
schema_store_202
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-06/schema#\",\"$id\":\"https://html-validate.org/schemas/config.json\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"$schema\":{\"type\":\"string\"},\"root\":{\"type\":\"boolean\",\"title\":\"Mark as root configuration\",\"description\":\"If this is set to true no further configurations will be searched.\",\"default\":false},\"extends\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"title\":\"Configurations to extend\",\"description\":\"Array of shareable or builtin configurations to extend.\"},\"elements\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\"}]},\"title\":\"Element metadata to load\",\"description\":\"Array of modules, plugins or files to load element metadata from. Use <rootDir> to refer to the folder with the package.json file.\",\"examples\":[[\"html-validate:recommended\",\"plugin:recommended\",\"module\",\"./local-file.json\"]]},\"plugins\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\"}]},\"title\":\"Plugins to load\",\"description\":\"Array of plugins load. Use <rootDir> to refer to the folder with the package.json file.\",\"examples\":[[\"my-plugin\",\"./local-plugin\"]]},\"transform\":{\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"string\"},{\"function\":true}]},\"title\":\"File transformations to use.\",\"description\":\"Object where key is regular expression to match filename and value is name of transformer or a function.\",\"examples\":[{\"^.*\\\\.foo$\":\"my-transformer\",\"^.*\\\\.bar$\":\"my-plugin\",\"^.*\\\\.baz$\":\"my-plugin:named\"}]},\"rules\":{\"type\":\"object\",\"patternProperties\":{\".*\":{\"anyOf\":[{\"enum\":[0,1,2,\"off\",\"warn\",\"error\"]},{\"type\":\"array\",\"minItems\":1,\"maxItems\":1,\"items\":[{\"enum\":[0,1,2,\"off\",\"warn\",\"error\"]}]},{\"type\":\"array\",\"minItems\":2,\"maxItems\":2,\"items\":[{\"enum\":[0,1,2,\"off\",\"warn\",\"error\"]},{}]}]}},\"title\":\"Rule configuration.\",\"description\":\"Enable/disable rules, set severity. Some rules have additional configuration like style or patterns to use.\",\"examples\":[{\"foo\":\"error\",\"bar\":\"off\",\"baz\":[\"error\",{\"style\":\"camelcase\"}]}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"config\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://html-validate.org/schemas/config.json","type":"object","additionalProperties":false,"properties":{"$schema":{"type":"string"},"root":{"type":"boolean","title":"Mark as root configuration","description":"If this is set to true no further configurations will be searched.","default":false},"extends":{"type":"array","items":{"type":"string"},"title":"Configurations to extend","description":"Array of shareable or builtin configurations to extend."},"elements":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object"}]},"title":"Element metadata to load","description":"Array of modules, plugins or files to load element metadata from. Use <rootDir> to refer to the folder with the package.json file.","examples":[["html-validate:recommended","plugin:recommended","module","./local-file.json"]]},"plugins":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object"}]},"title":"Plugins to load","description":"Array of plugins load. Use <rootDir> to refer to the folder with the package.json file.","examples":[["my-plugin","./local-plugin"]]},"transform":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"function":true}]},"title":"File transformations to use.","description":"Object where key is regular expression to match filename and value is name of transformer or a function.","examples":[{"^.*\\.foo$":"my-transformer","^.*\\.bar$":"my-plugin","^.*\\.baz$":"my-plugin:named"}]},"rules":{"type":"object","patternProperties":{".*":{"anyOf":[{"enum":[0,1,2,"off","warn","error"]},{"type":"array","minItems":1,"maxItems":1,"items":[{"enum":[0,1,2,"off","warn","error"]}]},{"type":"array","minItems":2,"maxItems":2,"items":[{"enum":[0,1,2,"off","warn","error"]},{}]}]}},"title":"Rule configuration.","description":"Enable/disable rules, set severity. Some rules have additional configuration like style or patterns to use.","examples":[{"foo":"error","bar":"off","baz":["error",{"style":"camelcase"}]}]}}}
|
Provide a JSON object that satisfies the schema "config". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
config
|
schema-store
|
schema_store_203
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/Config\",\"definitions\":{\"BazelStep\":{\"properties\":{\"build_targets\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of bazel targets to build\"},\"test_targets\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of bazel targets to test\"},\"build_flags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"Build flags to use in addition to defined in /etc/bazel.bazelrc\"},\"test_flags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"Test flags to use in addition to defined in /etc/bazel.bazelrc\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BranchesAndPaths\":{\"required\":[\"branches\"],\"properties\":{\"branches\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of branch name masks (doubleglob) to match\"},\"paths\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of path masks (doubleglob) to match. If not specified, all paths are matched\"},\"branches-ignore\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of branch name masks (doubleglob) to ignore\"},\"paths-ignore\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of path masks (doubleglob) to match. If not specified, all paths are ignored\"},\"from-branches\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of source branches masks (doubleglob) to match. If not specified will match any source branch name\"},\"from-branches-ignore\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of source branches masks (doubleglob) to ignore. If not specified, no source branch names are ignored\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BranchesOrTags\":{\"anyOf\":[{\"required\":[\"branches\"]},{\"required\":[\"tags\"]}],\"properties\":{\"branches\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of branch name masks (doubleglob) to match\"},\"tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of tag masks (doubleglob) to match\"},\"branches-ignore\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of branch name masks (doubleglob) to ignore\"},\"tags-ignore\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of tag masks (doubleglob) to ignore\"}},\"additionalProperties\":false,\"type\":\"object\"},\"Config\":{\"required\":[\"workflows\"],\"properties\":{\"workflows\":{\"items\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/Workflow\"},\"type\":\"array\",\"description\":\"The list of FasterCI workflows\"}},\"additionalProperties\":false,\"type\":\"object\"},\"On\":{\"anyOf\":[{\"required\":[\"push\"]},{\"required\":[\"pull_request\"]}],\"properties\":{\"push\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/BranchesOrTags\",\"description\":\"Run the workflow on code push\"},\"pull_request\":{\"$ref\":\"#/definitions/BranchesAndPaths\",\"description\":\"Run the workflow on pull request\"}},\"additionalProperties\":false,\"type\":\"object\"},\"Step\":{\"anyOf\":[{\"required\":[\"github_check_md_file\"]},{\"required\":[\"run\"]},{\"required\":[\"bazel\"]}],\"dependencies\":{\"github_check\":[\"name\"],\"github_check_md_file\":[\"name\"]},\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Step name, optional\"},\"working-directory\":{\"type\":\"string\",\"description\":\"Directory to run the step instead of default repo directory\"},\"github_check\":{\"type\":\"boolean\",\"description\":\"Report the result of the step as a separate github check\"},\"github_check_md_file\":{\"type\":\"string\",\"description\":\"After completing the step, report as a separate Github Check, using the content of the file as a report body, optional\"},\"run\":{\"type\":\"string\",\"description\":\"Arbitrary command execution; Could be multiline\"},\"bazel\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/BazelStep\",\"description\":\"Bazel step\"},\"side_effects\":{\"type\":\"boolean\",\"description\":\"Side effects step is anything that may change the state not related to building from the source tree or tests execution. Think of publishing artifacts, sending notifications etc.\"}},\"additionalProperties\":false,\"type\":\"object\"},\"Workflow\":{\"required\":[\"name\",\"on\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Workflow name\"},\"on\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/On\",\"description\":\"Event to activate the workflow on\"},\"image\":{\"type\":\"string\",\"description\":\"Docker image to run the workflow\"},\"cleanup\":{\"type\":\"string\",\"description\":\"optional cleanup command, executed after the workflow\"},\"max_parallel\":{\"type\":\"integer\",\"description\":\"optional maximum number of parallel runs of this workflow\"},\"ephemeral\":{\"type\":\"boolean\",\"description\":\"optionally mark this workflow as ephemeral. Will not keep the workflow state between runs\"},\"env\":{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\",\"description\":\"Environment variables\"},\"secrets\":{\"items\":{\"type\":\"string\"},\"type\":\"array\",\"description\":\"List of secrets to mount as environment variables\"},\"hide_from_github\":{\"type\":\"boolean\",\"description\":\"Do not notify github\"},\"init\":{\"type\":\"string\",\"description\":\"Optional command to run before the workflow. Use multiline for multiple commands\"},\"steps\":{\"items\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/Step\"},\"type\":\"array\",\"description\":\"List of workflow steps to execute\"}},\"additionalProperties\":false,\"type\":\"object\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"config.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/Config","definitions":{"BazelStep":{"properties":{"build_targets":{"items":{"type":"string"},"type":"array","description":"List of bazel targets to build"},"test_targets":{"items":{"type":"string"},"type":"array","description":"List of bazel targets to test"},"build_flags":{"items":{"type":"string"},"type":"array","description":"Build flags to use in addition to defined in /etc/bazel.bazelrc"},"test_flags":{"items":{"type":"string"},"type":"array","description":"Test flags to use in addition to defined in /etc/bazel.bazelrc"}},"additionalProperties":false,"type":"object"},"BranchesAndPaths":{"required":["branches"],"properties":{"branches":{"items":{"type":"string"},"type":"array","description":"List of branch name masks (doubleglob) to match"},"paths":{"items":{"type":"string"},"type":"array","description":"List of path masks (doubleglob) to match. If not specified, all paths are matched"},"branches-ignore":{"items":{"type":"string"},"type":"array","description":"List of branch name masks (doubleglob) to ignore"},"paths-ignore":{"items":{"type":"string"},"type":"array","description":"List of path masks (doubleglob) to match. If not specified, all paths are ignored"},"from-branches":{"items":{"type":"string"},"type":"array","description":"List of source branches masks (doubleglob) to match. If not specified will match any source branch name"},"from-branches-ignore":{"items":{"type":"string"},"type":"array","description":"List of source branches masks (doubleglob) to ignore. If not specified, no source branch names are ignored"}},"additionalProperties":false,"type":"object"},"BranchesOrTags":{"anyOf":[{"required":["branches"]},{"required":["tags"]}],"properties":{"branches":{"items":{"type":"string"},"type":"array","description":"List of branch name masks (doubleglob) to match"},"tags":{"items":{"type":"string"},"type":"array","description":"List of tag masks (doubleglob) to match"},"branches-ignore":{"items":{"type":"string"},"type":"array","description":"List of branch name masks (doubleglob) to ignore"},"tags-ignore":{"items":{"type":"string"},"type":"array","description":"List of tag masks (doubleglob) to ignore"}},"additionalProperties":false,"type":"object"},"Config":{"required":["workflows"],"properties":{"workflows":{"items":{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/Workflow"},"type":"array","description":"The list of FasterCI workflows"}},"additionalProperties":false,"type":"object"},"On":{"anyOf":[{"required":["push"]},{"required":["pull_request"]}],"properties":{"push":{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/BranchesOrTags","description":"Run the workflow on code push"},"pull_request":{"$ref":"#/definitions/BranchesAndPaths","description":"Run the workflow on pull request"}},"additionalProperties":false,"type":"object"},"Step":{"anyOf":[{"required":["github_check_md_file"]},{"required":["run"]},{"required":["bazel"]}],"dependencies":{"github_check":["name"],"github_check_md_file":["name"]},"properties":{"name":{"type":"string","description":"Step name, optional"},"working-directory":{"type":"string","description":"Directory to run the step instead of default repo directory"},"github_check":{"type":"boolean","description":"Report the result of the step as a separate github check"},"github_check_md_file":{"type":"string","description":"After completing the step, report as a separate Github Check, using the content of the file as a report body, optional"},"run":{"type":"string","description":"Arbitrary command execution; Could be multiline"},"bazel":{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/BazelStep","description":"Bazel step"},"side_effects":{"type":"boolean","description":"Side effects step is anything that may change the state not related to building from the source tree or tests execution. Think of publishing artifacts, sending notifications etc."}},"additionalProperties":false,"type":"object"},"Workflow":{"required":["name","on"],"properties":{"name":{"type":"string","description":"Workflow name"},"on":{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/On","description":"Event to activate the workflow on"},"image":{"type":"string","description":"Docker image to run the workflow"},"cleanup":{"type":"string","description":"optional cleanup command, executed after the workflow"},"max_parallel":{"type":"integer","description":"optional maximum number of parallel runs of this workflow"},"ephemeral":{"type":"boolean","description":"optionally mark this workflow as ephemeral. Will not keep the workflow state between runs"},"env":{"patternProperties":{".*":{"type":"string"}},"type":"object","description":"Environment variables"},"secrets":{"items":{"type":"string"},"type":"array","description":"List of secrets to mount as environment variables"},"hide_from_github":{"type":"boolean","description":"Do not notify github"},"init":{"type":"string","description":"Optional command to run before the workflow. Use multiline for multiple commands"},"steps":{"items":{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/Step"},"type":"array","description":"List of workflow steps to execute"}},"additionalProperties":false,"type":"object"}}}
|
Provide a JSON object that satisfies the schema "config.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
config.schema
|
schema-store
|
schema_store_204
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://github.com/k3d-io/k3d/tree/main/pkg/config/config.versions.schema.json\",\"$schema\":\"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/config.versions.meta.schema.json#\",\"title\":\"All k3d config versions\",\"type\":\"object\",\"oneOf\":[{\"allOf\":[{\"properties\":{\"version\":{\"const\":\"v1alpha5\"}}},{\"$ref\":\"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha5/schema.json\"}]},{\"allOf\":[{\"properties\":{\"version\":{\"const\":\"v1alpha4\"}}},{\"$ref\":\"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha4/schema.json\"}]},{\"allOf\":[{\"properties\":{\"version\":{\"const\":\"v1alpha3\"}}},{\"$ref\":\"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha3/schema.json\"}]},{\"allOf\":[{\"properties\":{\"version\":{\"const\":\"v1alpha2\"}}},{\"$ref\":\"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha2/schema.json\"}]}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"All k3d config versions\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://github.com/k3d-io/k3d/tree/main/pkg/config/config.versions.schema.json","$schema":"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/config.versions.meta.schema.json#","title":"All k3d config versions","type":"object","oneOf":[{"allOf":[{"properties":{"version":{"const":"v1alpha5"}}},{"$ref":"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha5/schema.json"}]},{"allOf":[{"properties":{"version":{"const":"v1alpha4"}}},{"$ref":"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha4/schema.json"}]},{"allOf":[{"properties":{"version":{"const":"v1alpha3"}}},{"$ref":"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha3/schema.json"}]},{"allOf":[{"properties":{"version":{"const":"v1alpha2"}}},{"$ref":"https://raw.githubusercontent.com/k3d-io/k3d/main/pkg/config/v1alpha2/schema.json"}]}]}
|
Provide a JSON object that satisfies the schema "All k3d config versions". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
All k3d config versions
|
schema-store
|
schema_store_205
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"DeployStack Configuration Schema\",\"description\":\"Configuration schema for DeployStack applications\",\"type\":\"object\",\"properties\":{\"application\":{\"type\":\"object\",\"description\":\"Application metadata and settings\",\"properties\":{\"logo\":{\"type\":\"string\",\"description\":\"Path to the application logo. Can be a local file relative to .deploystack directory or an external URL. Supports PNG, WEBP, or JPG formats.\",\"pattern\":\"^(https?://.*|.*)\\\\.(?:png|svg|jpg|jpeg|webp)$\"},\"name\":{\"type\":\"string\",\"description\":\"Application name for display in catalogs and deployment interfaces (maximum 40 characters)\",\"maxLength\":40},\"description\":{\"type\":\"string\",\"description\":\"Brief description of your application (maximum 500 characters)\",\"maxLength\":500}}},\"deployment\":{\"type\":\"object\",\"description\":\"Deployment configuration including branch settings\",\"properties\":{\"branches\":{\"type\":\"object\",\"description\":\"Configuration for multiple branch deployment support\",\"patternProperties\":{\"^[a-zA-Z0-9._-]+$\":{\"type\":\"object\",\"description\":\"Branch-specific configuration\",\"properties\":{\"label\":{\"type\":\"string\",\"description\":\"Display label for the branch in UI elements\",\"maxLength\":20},\"description\":{\"type\":\"string\",\"description\":\"Detailed description of the branch version\",\"maxLength\":100},\"active\":{\"type\":\"boolean\",\"description\":\"Whether this branch is active for deployment\",\"default\":true},\"priority\":{\"type\":\"integer\",\"description\":\"Optional priority for ordering in UI (lower numbers appear first)\",\"minimum\":1},\"exclude_providers\":{\"type\":\"array\",\"description\":\"List of cloud providers to exclude from template generation for this branch\",\"items\":{\"type\":\"string\",\"enum\":[\"aws\",\"rnd\",\"dop\"],\"description\":\"Provider code to exclude (aws: AWS CloudFormation, rnd: Render.com, dop: DigitalOcean)\"},\"uniqueItems\":true},\"serviceConnections\":{\"type\":\"object\",\"description\":\"Configuration for service-to-service communication\",\"properties\":{\"mappings\":{\"type\":\"array\",\"description\":\"Defines relationships between services for connection configuration\",\"items\":{\"type\":\"object\",\"properties\":{\"fromService\":{\"type\":\"string\",\"description\":\"Service that needs to connect to another service\"},\"toService\":{\"type\":\"string\",\"description\":\"Service being connected to\"},\"environmentVariables\":{\"type\":\"array\",\"description\":\"Environment variable names that reference the target service\",\"items\":{\"type\":\"string\"}},\"property\":{\"type\":\"string\",\"description\":\"Type of connection property to reference (e.g., 'connectionString', 'hostport')\",\"default\":\"hostport\",\"enum\":[\"connectionString\",\"hostport\",\"host\",\"port\"]}},\"required\":[\"fromService\",\"toService\",\"environmentVariables\"]}}},\"required\":[\"mappings\"]}},\"required\":[\"label\"]}},\"minProperties\":1}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DeployStack Configuration Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"DeployStack Configuration Schema","description":"Configuration schema for DeployStack applications","type":"object","properties":{"application":{"type":"object","description":"Application metadata and settings","properties":{"logo":{"type":"string","description":"Path to the application logo. Can be a local file relative to .deploystack directory or an external URL. Supports PNG, WEBP, or JPG formats.","pattern":"^(https?://.*|.*)\\.(?:png|svg|jpg|jpeg|webp)$"},"name":{"type":"string","description":"Application name for display in catalogs and deployment interfaces (maximum 40 characters)","maxLength":40},"description":{"type":"string","description":"Brief description of your application (maximum 500 characters)","maxLength":500}}},"deployment":{"type":"object","description":"Deployment configuration including branch settings","properties":{"branches":{"type":"object","description":"Configuration for multiple branch deployment support","patternProperties":{"^[a-zA-Z0-9._-]+$":{"type":"object","description":"Branch-specific configuration","properties":{"label":{"type":"string","description":"Display label for the branch in UI elements","maxLength":20},"description":{"type":"string","description":"Detailed description of the branch version","maxLength":100},"active":{"type":"boolean","description":"Whether this branch is active for deployment","default":true},"priority":{"type":"integer","description":"Optional priority for ordering in UI (lower numbers appear first)","minimum":1},"exclude_providers":{"type":"array","description":"List of cloud providers to exclude from template generation for this branch","items":{"type":"string","enum":["aws","rnd","dop"],"description":"Provider code to exclude (aws: AWS CloudFormation, rnd: Render.com, dop: DigitalOcean)"},"uniqueItems":true},"serviceConnections":{"type":"object","description":"Configuration for service-to-service communication","properties":{"mappings":{"type":"array","description":"Defines relationships between services for connection configuration","items":{"type":"object","properties":{"fromService":{"type":"string","description":"Service that needs to connect to another service"},"toService":{"type":"string","description":"Service being connected to"},"environmentVariables":{"type":"array","description":"Environment variable names that reference the target service","items":{"type":"string"}},"property":{"type":"string","description":"Type of connection property to reference (e.g., 'connectionString', 'hostport')","default":"hostport","enum":["connectionString","hostport","host","port"]}},"required":["fromService","toService","environmentVariables"]}}},"required":["mappings"]}},"required":["label"]}},"minProperties":1}}}}}
|
Provide a JSON object that satisfies the schema "DeployStack Configuration Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
DeployStack Configuration Schema
|
schema-store
|
schema_store_206
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON schema for Batect configuration files\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://ide-integration.batect.dev/v1/configSchema.json\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"containers\":{\"$ref\":\"#/definitions/containers\"},\"tasks\":{\"$ref\":\"#/definitions/tasks\"},\"config_variables\":{\"$ref\":\"#/definitions/configVariablesList\"},\"project_name\":{\"type\":\"string\",\"description\":\"The name of your project. Used to label any images built.\",\"minLength\":1},\"forbid_telemetry\":{\"type\":\"boolean\",\"description\":\"Forbid reporting telemetry information for this project, even if the user has previously consented to telemetry.\"},\"include\":{\"$ref\":\"#/definitions/includesList\"}},\"patternProperties\":{\"^\\\\.\":{}},\"definitions\":{\"containers\":{\"type\":\"object\",\"description\":\"Definitions for each of the containers that make up your various environments\",\"additionalProperties\":{\"$ref\":\"#/definitions/container\"}},\"container\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"image\":{\"type\":\"string\",\"description\":\"Image name (in standard Docker image reference format) to use for this container\",\"minLength\":1},\"build_directory\":{\"type\":\"string\",\"description\":\"Path (relative to the configuration file's directory) to a directory containing a Dockerfile to build and use as an image for this container\",\"minLength\":1},\"build_args\":{\"description\":\"List of build args to use when building the image in build_directory\",\"$ref\":\"#/definitions/buildArgList\"},\"build_target\":{\"type\":\"string\",\"description\":\"Dockerfile stage name to build and use for this container\",\"minLength\":1},\"build_ssh\":{\"description\":\"List of SSH agents to forward to the image build process when building the image in build_directory\",\"$ref\":\"#/definitions/buildSSHAgentList\"},\"build_secrets\":{\"description\":\"Secrets to expose to the image build process when building the image in build_directory\",\"$ref\":\"#/definitions/buildSecretsList\"},\"dockerfile\":{\"type\":\"string\",\"description\":\"Dockerfile (relative to build_directory) to use when building the image. Defaults to Dockerfile if not set.\",\"minLength\":1},\"command\":{\"type\":\"string\",\"description\":\"Command to run when the container starts\",\"minLength\":1},\"entrypoint\":{\"type\":\"string\",\"description\":\"Entrypoint to use to run the command\",\"minLength\":1},\"environment\":{\"description\":\"List of environment variables for the container\",\"$ref\":\"#/definitions/environmentVariableList\"},\"working_directory\":{\"type\":\"string\",\"description\":\"Working directory to start the container in\",\"minLength\":1},\"volumes\":{\"description\":\"List of volume mounts to create for the container\",\"$ref\":\"#/definitions/volumeMountList\"},\"ports\":{\"description\":\"List of ports to make available to the host machine\",\"$ref\":\"#/definitions/portMappingList\"},\"dependencies\":{\"description\":\"List of other containers that should be started and healthy before starting this container\",\"$ref\":\"#/definitions/containerDependencyList\"},\"health_check\":{\"description\":\"Overrides health check configuration specified in the image or Dockerfile\",\"$ref\":\"#/definitions/healthCheckOptions\"},\"run_as_current_user\":{\"$ref\":\"#/definitions/runAsCurrentUserOptions\"},\"privileged\":{\"type\":\"boolean\",\"description\":\"Enable privileged mode for the container\"},\"enable_init_process\":{\"type\":\"boolean\",\"description\":\"Set to `true` to run an init process inside the container that forwards signals and reaps processes\"},\"capabilities_to_add\":{\"description\":\"List of additional capabilities to add to the container\",\"$ref\":\"#/definitions/capabilityList\"},\"capabilities_to_drop\":{\"description\":\"List of additional capabilities to remove from the container\",\"$ref\":\"#/definitions/capabilityList\"},\"additional_hostnames\":{\"description\":\"Hostnames to associate with this container in addition to the default hostname\",\"$ref\":\"#/definitions/additionalHostnamesList\"},\"additional_hosts\":{\"description\":\"Additional hostnames to add to /etc/hosts in the container\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"setup_commands\":{\"description\":\"Commands to run after the container reports as healthy but before dependency containers start\",\"$ref\":\"#/definitions/setupCommandsList\"},\"log_driver\":{\"type\":\"string\",\"description\":\"Docker log driver to use\"},\"log_options\":{\"description\":\"Additional options to pass to Docker log driver\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"image_pull_policy\":{\"description\":\"Whether or not to pull image (including base image for containers that use a built image), even if it has already been pulled\",\"type\":\"string\",\"enum\":[\"Always\",\"IfNotPresent\"]},\"shm_size\":{\"description\":\"Size of /dev/shm (shared memory for IPC) for the container\",\"type\":\"string\",\"pattern\":\"^\\\\d+\\\\s*[mkg]?b?$\"},\"labels\":{\"description\":\"Labels to apply to the container\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"oneOf\":[{\"required\":[\"image\"],\"not\":{\"required\":[\"build_args\",\"dockerfile\",\"build_target\",\"build_ssh\"]}},{\"required\":[\"build_directory\"]}]},\"tasks\":{\"type\":\"object\",\"description\":\"Definitions for each of your tasks, the actions you launch through Batect\",\"additionalProperties\":{\"$ref\":\"#/definitions/task\"}},\"task\":{\"type\":\"object\",\"description\":\"Definition of a single task\",\"additionalProperties\":false,\"properties\":{\"run\":{\"$ref\":\"#/definitions/taskRunOptions\"},\"description\":{\"type\":\"string\",\"description\":\"Description shown when running `batect --list-tasks`\",\"minLength\":1},\"group\":{\"type\":\"string\",\"description\":\"Name used to group tasks when running `batect --list-tasks`\",\"minLength\":1},\"dependencies\":{\"description\":\"List of other containers that should be started and healthy before starting the task container given in `run`\",\"$ref\":\"#/definitions/containerDependencyList\"},\"prerequisites\":{\"type\":\"array\",\"description\":\"List of other tasks that should be run before running this task\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"customise\":{\"type\":\"object\",\"description\":\"Customisations for dependency containers run as part of this task\",\"additionalProperties\":{\"$ref\":\"#/definitions/taskContainerCustomisation\"}}},\"anyOf\":[{\"required\":[\"run\"]},{\"required\":[\"prerequisites\"],\"not\":{\"required\":[\"dependencies\",\"run\"]}}]},\"taskRunOptions\":{\"type\":\"object\",\"description\":\"Specifies what to do when this task starts\",\"additionalProperties\":false,\"properties\":{\"container\":{\"type\":\"string\",\"description\":\"Container to run for this task\",\"minLength\":1},\"command\":{\"type\":\"string\",\"description\":\"Command to run for this task\",\"minLength\":1},\"entrypoint\":{\"type\":\"string\",\"description\":\"Entrypoint to use to run the command for this task\",\"minLength\":1},\"environment\":{\"description\":\"List of environment variables to pass to the container, in addition to those defined on the container itself\",\"$ref\":\"#/definitions/environmentVariableList\"},\"ports\":{\"description\":\"List of port mappings to create for the container, in addition to those defined on the container itself\",\"$ref\":\"#/definitions/portMappingList\"},\"working_directory\":{\"type\":\"string\",\"description\":\"Working directory to start the container in\",\"minLength\":1}},\"required\":[\"container\"]},\"taskContainerCustomisation\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"environment\":{\"description\":\"List of environment variables to pass to the container, in addition to those defined on the container itself\",\"$ref\":\"#/definitions/environmentVariableList\"},\"ports\":{\"description\":\"List of port mappings to create for the container, in addition to those defined on the container itself\",\"$ref\":\"#/definitions/portMappingList\"},\"working_directory\":{\"type\":\"string\",\"description\":\"Working directory to start the container in\",\"minLength\":1}}},\"containerDependencyList\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}},\"additionalHostnamesList\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}},\"environmentVariableList\":{\"type\":\"object\",\"additionalProperties\":{\"type\":[\"string\",\"number\"]}},\"buildArgList\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"buildSSHAgentList\":{\"type\":\"array\",\"items\":{\"minLength\":1,\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID used to refer to agent from Dockerfile\",\"minimum\":1},\"paths\":{\"type\":\"array\",\"description\":\"Paths to keys or SSH agent sockets to expose to image build process\",\"items\":{\"type\":\"string\"}}},\"required\":[\"id\"]}},\"buildSecretsList\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/buildSecret\"}},\"buildSecret\":{\"oneOf\":[{\"$ref\":\"#/definitions/environmentSecret\"},{\"$ref\":\"#/definitions/fileSecret\"}]},\"environmentSecret\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"environment\":{\"type\":\"string\",\"description\":\"Name of the environment variable to expose as a secret\",\"minLength\":1}},\"required\":[\"environment\"]},\"fileSecret\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path to the file to expose as a secret\",\"minLength\":1}},\"required\":[\"path\"]},\"portMappingList\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\d+(-\\\\d+)?:\\\\d+(-\\\\d+)?(/.*)?$\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"local\":{\"type\":\"integer\",\"description\":\"Port on the host machine to map\",\"minimum\":1},\"container\":{\"type\":\"integer\",\"description\":\"Port inside the container to map\",\"minimum\":1},\"protocol\":{\"type\":\"string\",\"description\":\"Protocol to use (eg. TCP or UDP)\",\"minLength\":1}},\"required\":[\"local\",\"container\"]},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"local\":{\"type\":\"string\",\"description\":\"Ports on the host machine to map\",\"pattern\":\"^\\\\d+-\\\\d+$\"},\"container\":{\"type\":\"string\",\"description\":\"Ports inside the container to map\",\"pattern\":\"^\\\\d+-\\\\d+$\"},\"protocol\":{\"type\":\"string\",\"description\":\"Protocol to use (eg. TCP or UDP)\",\"minLength\":1}},\"required\":[\"local\",\"container\"]}]}},\"volumeMountList\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^.+:.+(:.+)?$\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Type of volume mount\",\"enum\":[\"local\"]},\"local\":{\"type\":\"string\",\"description\":\"Path on the host machine to mount\",\"minLength\":1},\"container\":{\"type\":\"string\",\"description\":\"Path inside the container to mount the host path at\",\"minLength\":1},\"options\":{\"type\":\"string\",\"description\":\"Docker volume mount options to use when creating mount\",\"enum\":[\"cached\",\"delegated\",\"consistent\",\"default\",\"ro\"]}},\"required\":[\"local\",\"container\"]},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Type of volume mount\",\"enum\":[\"cache\"]},\"name\":{\"type\":\"string\",\"description\":\"Name of the cache\",\"minLength\":1},\"container\":{\"type\":\"string\",\"description\":\"Path inside the container to mount the cache at\",\"minLength\":1},\"options\":{\"type\":\"string\",\"description\":\"Docker volume mount options to use when creating mount\",\"enum\":[\"cached\",\"delegated\",\"consistent\",\"default\",\"ro\"]}},\"required\":[\"type\",\"name\",\"container\"]},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Type of volume mount\",\"enum\":[\"tmpfs\"]},\"container\":{\"type\":\"string\",\"description\":\"Path inside the container to mount the tmpfs filesystem at\",\"minLength\":1},\"options\":{\"type\":\"string\",\"description\":\"Docker tmpfs mount options to use when creating mount\"}},\"required\":[\"type\",\"container\"]}]}},\"healthCheckOptions\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"retries\":{\"type\":\"integer\",\"description\":\"The number of times to perform the health check before considering the container unhealthy\",\"minimum\":0},\"interval\":{\"type\":\"string\",\"description\":\"The interval between runs of the health check. Accepts values such as `2s` (two seconds) or `1m` (one minute).\",\"minLength\":1},\"start_period\":{\"type\":\"string\",\"description\":\"The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as `2s` (two seconds) or `1m` (one minute).\",\"minLength\":1},\"timeout\":{\"type\":\"string\",\"description\":\"The time to wait before timing out a single health check command invocation. Accepts values such as `2s` (two seconds) or `1m` (one minute).\",\"minLength\":1},\"command\":{\"type\":\"string\",\"description\":\"The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.\",\"minLength\":1}}},\"runAsCurrentUserOptions\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Set to `true` to enable 'run as current user' mode\",\"enum\":[false]}},\"required\":[\"enabled\"]},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Set to `true` to enable 'run as current user' mode\",\"enum\":[true]},\"home_directory\":{\"type\":\"string\",\"description\":\"Directory to use as home directory for user inside container\",\"minLength\":1}},\"required\":[\"enabled\",\"home_directory\"]}]},\"capabilityList\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"AUDIT_CONTROL\",\"AUDIT_READ\",\"AUDIT_WRITE\",\"BLOCK_SUSPEND\",\"CHOWN\",\"DAC_OVERRIDE\",\"DAC_READ_SEARCH\",\"FOWNER\",\"FSETID\",\"IPC_LOCK\",\"IPC_OWNER\",\"KILL\",\"LEASE\",\"LINUX_IMMUTABLE\",\"MAC_ADMIN\",\"MAC_OVERRIDE\",\"MKNOD\",\"NET_ADMIN\",\"NET_BIND_SERVICE\",\"NET_BROADCAST\",\"NET_RAW\",\"SETGID\",\"SETFCAP\",\"SETPCAP\",\"SETUID\",\"SYS_ADMIN\",\"SYS_BOOT\",\"SYS_CHROOT\",\"SYS_MODULE\",\"SYS_NICE\",\"SYS_PACCT\",\"SYS_PTRACE\",\"SYS_RAWIO\",\"SYS_RESOURCE\",\"SYS_TIME\",\"SYS_TTY_CONFIG\",\"SYSLOG\",\"WAKE_ALARM\",\"ALL\"]}]}},\"setupCommandsList\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"command\":{\"type\":\"string\",\"description\":\"Command to execute\",\"minLength\":1},\"working_directory\":{\"type\":\"string\",\"description\":\"Working directory to start the command in (defaults to container working directory if not set)\",\"minLength\":1}},\"required\":[\"command\"]}},\"configVariablesList\":{\"type\":\"object\",\"description\":\"Definitions for each of the config variables used to configure your tasks and containers\",\"additionalProperties\":{\"$ref\":\"#/definitions/configVariable\"}},\"configVariable\":{\"type\":\"object\",\"description\":\"Definition of a single config variable\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Human-readable description of the purpose of the variable\",\"minLength\":1},\"default\":{\"type\":\"string\",\"description\":\"Default value of the variable if one is not provided elsewhere\",\"minLength\":1}}},\"includesList\":{\"type\":\"array\",\"description\":\"List of configuration files to include in this project\",\"items\":{\"$ref\":\"#/definitions/include\"}},\"include\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Path (relative to this file) to the file to include\"},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of include\",\"enum\":[\"file\"]},\"path\":{\"type\":\"string\",\"description\":\"Path (relative to this file) of the file to include\",\"minLength\":1}},\"additionalProperties\":false,\"required\":[\"type\",\"path\"]},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of include\",\"enum\":[\"git\"]},\"repo\":{\"type\":\"string\",\"description\":\"Git repository containing the file to include\",\"minLength\":1},\"ref\":{\"type\":\"string\",\"description\":\"Git reference (commit, tag or branch) containing the file to include\"},\"path\":{\"type\":\"string\",\"description\":\"Path (relative to the root of the repository) of the file to include (defaults to batect-bundle.yml if not set)\",\"minLength\":1}},\"additionalProperties\":false,\"required\":[\"type\",\"repo\",\"ref\"]}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Batect configuration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON schema for Batect configuration files","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://ide-integration.batect.dev/v1/configSchema.json","type":"object","additionalProperties":false,"properties":{"containers":{"$ref":"#/definitions/containers"},"tasks":{"$ref":"#/definitions/tasks"},"config_variables":{"$ref":"#/definitions/configVariablesList"},"project_name":{"type":"string","description":"The name of your project. Used to label any images built.","minLength":1},"forbid_telemetry":{"type":"boolean","description":"Forbid reporting telemetry information for this project, even if the user has previously consented to telemetry."},"include":{"$ref":"#/definitions/includesList"}},"patternProperties":{"^\\.":{}},"definitions":{"containers":{"type":"object","description":"Definitions for each of the containers that make up your various environments","additionalProperties":{"$ref":"#/definitions/container"}},"container":{"type":"object","additionalProperties":false,"properties":{"image":{"type":"string","description":"Image name (in standard Docker image reference format) to use for this container","minLength":1},"build_directory":{"type":"string","description":"Path (relative to the configuration file's directory) to a directory containing a Dockerfile to build and use as an image for this container","minLength":1},"build_args":{"description":"List of build args to use when building the image in build_directory","$ref":"#/definitions/buildArgList"},"build_target":{"type":"string","description":"Dockerfile stage name to build and use for this container","minLength":1},"build_ssh":{"description":"List of SSH agents to forward to the image build process when building the image in build_directory","$ref":"#/definitions/buildSSHAgentList"},"build_secrets":{"description":"Secrets to expose to the image build process when building the image in build_directory","$ref":"#/definitions/buildSecretsList"},"dockerfile":{"type":"string","description":"Dockerfile (relative to build_directory) to use when building the image. Defaults to Dockerfile if not set.","minLength":1},"command":{"type":"string","description":"Command to run when the container starts","minLength":1},"entrypoint":{"type":"string","description":"Entrypoint to use to run the command","minLength":1},"environment":{"description":"List of environment variables for the container","$ref":"#/definitions/environmentVariableList"},"working_directory":{"type":"string","description":"Working directory to start the container in","minLength":1},"volumes":{"description":"List of volume mounts to create for the container","$ref":"#/definitions/volumeMountList"},"ports":{"description":"List of ports to make available to the host machine","$ref":"#/definitions/portMappingList"},"dependencies":{"description":"List of other containers that should be started and healthy before starting this container","$ref":"#/definitions/containerDependencyList"},"health_check":{"description":"Overrides health check configuration specified in the image or Dockerfile","$ref":"#/definitions/healthCheckOptions"},"run_as_current_user":{"$ref":"#/definitions/runAsCurrentUserOptions"},"privileged":{"type":"boolean","description":"Enable privileged mode for the container"},"enable_init_process":{"type":"boolean","description":"Set to `true` to run an init process inside the container that forwards signals and reaps processes"},"capabilities_to_add":{"description":"List of additional capabilities to add to the container","$ref":"#/definitions/capabilityList"},"capabilities_to_drop":{"description":"List of additional capabilities to remove from the container","$ref":"#/definitions/capabilityList"},"additional_hostnames":{"description":"Hostnames to associate with this container in addition to the default hostname","$ref":"#/definitions/additionalHostnamesList"},"additional_hosts":{"description":"Additional hostnames to add to /etc/hosts in the container","type":"object","additionalProperties":{"type":"string"}},"setup_commands":{"description":"Commands to run after the container reports as healthy but before dependency containers start","$ref":"#/definitions/setupCommandsList"},"log_driver":{"type":"string","description":"Docker log driver to use"},"log_options":{"description":"Additional options to pass to Docker log driver","type":"object","additionalProperties":{"type":"string"}},"image_pull_policy":{"description":"Whether or not to pull image (including base image for containers that use a built image), even if it has already been pulled","type":"string","enum":["Always","IfNotPresent"]},"shm_size":{"description":"Size of /dev/shm (shared memory for IPC) for the container","type":"string","pattern":"^\\d+\\s*[mkg]?b?$"},"labels":{"description":"Labels to apply to the container","type":"object","additionalProperties":{"type":"string"}}},"oneOf":[{"required":["image"],"not":{"required":["build_args","dockerfile","build_target","build_ssh"]}},{"required":["build_directory"]}]},"tasks":{"type":"object","description":"Definitions for each of your tasks, the actions you launch through Batect","additionalProperties":{"$ref":"#/definitions/task"}},"task":{"type":"object","description":"Definition of a single task","additionalProperties":false,"properties":{"run":{"$ref":"#/definitions/taskRunOptions"},"description":{"type":"string","description":"Description shown when running `batect --list-tasks`","minLength":1},"group":{"type":"string","description":"Name used to group tasks when running `batect --list-tasks`","minLength":1},"dependencies":{"description":"List of other containers that should be started and healthy before starting the task container given in `run`","$ref":"#/definitions/containerDependencyList"},"prerequisites":{"type":"array","description":"List of other tasks that should be run before running this task","uniqueItems":true,"items":{"type":"string"}},"customise":{"type":"object","description":"Customisations for dependency containers run as part of this task","additionalProperties":{"$ref":"#/definitions/taskContainerCustomisation"}}},"anyOf":[{"required":["run"]},{"required":["prerequisites"],"not":{"required":["dependencies","run"]}}]},"taskRunOptions":{"type":"object","description":"Specifies what to do when this task starts","additionalProperties":false,"properties":{"container":{"type":"string","description":"Container to run for this task","minLength":1},"command":{"type":"string","description":"Command to run for this task","minLength":1},"entrypoint":{"type":"string","description":"Entrypoint to use to run the command for this task","minLength":1},"environment":{"description":"List of environment variables to pass to the container, in addition to those defined on the container itself","$ref":"#/definitions/environmentVariableList"},"ports":{"description":"List of port mappings to create for the container, in addition to those defined on the container itself","$ref":"#/definitions/portMappingList"},"working_directory":{"type":"string","description":"Working directory to start the container in","minLength":1}},"required":["container"]},"taskContainerCustomisation":{"type":"object","additionalProperties":false,"properties":{"environment":{"description":"List of environment variables to pass to the container, in addition to those defined on the container itself","$ref":"#/definitions/environmentVariableList"},"ports":{"description":"List of port mappings to create for the container, in addition to those defined on the container itself","$ref":"#/definitions/portMappingList"},"working_directory":{"type":"string","description":"Working directory to start the container in","minLength":1}}},"containerDependencyList":{"type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"additionalHostnamesList":{"type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"environmentVariableList":{"type":"object","additionalProperties":{"type":["string","number"]}},"buildArgList":{"type":"object","additionalProperties":{"type":"string"}},"buildSSHAgentList":{"type":"array","items":{"minLength":1,"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"ID used to refer to agent from Dockerfile","minimum":1},"paths":{"type":"array","description":"Paths to keys or SSH agent sockets to expose to image build process","items":{"type":"string"}}},"required":["id"]}},"buildSecretsList":{"type":"object","additionalProperties":{"$ref":"#/definitions/buildSecret"}},"buildSecret":{"oneOf":[{"$ref":"#/definitions/environmentSecret"},{"$ref":"#/definitions/fileSecret"}]},"environmentSecret":{"type":"object","additionalProperties":false,"properties":{"environment":{"type":"string","description":"Name of the environment variable to expose as a secret","minLength":1}},"required":["environment"]},"fileSecret":{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string","description":"Path to the file to expose as a secret","minLength":1}},"required":["path"]},"portMappingList":{"type":"array","items":{"oneOf":[{"type":"string","pattern":"^\\d+(-\\d+)?:\\d+(-\\d+)?(/.*)?$"},{"type":"object","additionalProperties":false,"properties":{"local":{"type":"integer","description":"Port on the host machine to map","minimum":1},"container":{"type":"integer","description":"Port inside the container to map","minimum":1},"protocol":{"type":"string","description":"Protocol to use (eg. TCP or UDP)","minLength":1}},"required":["local","container"]},{"type":"object","additionalProperties":false,"properties":{"local":{"type":"string","description":"Ports on the host machine to map","pattern":"^\\d+-\\d+$"},"container":{"type":"string","description":"Ports inside the container to map","pattern":"^\\d+-\\d+$"},"protocol":{"type":"string","description":"Protocol to use (eg. TCP or UDP)","minLength":1}},"required":["local","container"]}]}},"volumeMountList":{"type":"array","items":{"oneOf":[{"type":"string","pattern":"^.+:.+(:.+)?$"},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Type of volume mount","enum":["local"]},"local":{"type":"string","description":"Path on the host machine to mount","minLength":1},"container":{"type":"string","description":"Path inside the container to mount the host path at","minLength":1},"options":{"type":"string","description":"Docker volume mount options to use when creating mount","enum":["cached","delegated","consistent","default","ro"]}},"required":["local","container"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Type of volume mount","enum":["cache"]},"name":{"type":"string","description":"Name of the cache","minLength":1},"container":{"type":"string","description":"Path inside the container to mount the cache at","minLength":1},"options":{"type":"string","description":"Docker volume mount options to use when creating mount","enum":["cached","delegated","consistent","default","ro"]}},"required":["type","name","container"]},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Type of volume mount","enum":["tmpfs"]},"container":{"type":"string","description":"Path inside the container to mount the tmpfs filesystem at","minLength":1},"options":{"type":"string","description":"Docker tmpfs mount options to use when creating mount"}},"required":["type","container"]}]}},"healthCheckOptions":{"type":"object","additionalProperties":false,"properties":{"retries":{"type":"integer","description":"The number of times to perform the health check before considering the container unhealthy","minimum":0},"interval":{"type":"string","description":"The interval between runs of the health check. Accepts values such as `2s` (two seconds) or `1m` (one minute).","minLength":1},"start_period":{"type":"string","description":"The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as `2s` (two seconds) or `1m` (one minute).","minLength":1},"timeout":{"type":"string","description":"The time to wait before timing out a single health check command invocation. Accepts values such as `2s` (two seconds) or `1m` (one minute).","minLength":1},"command":{"type":"string","description":"The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.","minLength":1}}},"runAsCurrentUserOptions":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable 'run as current user' mode","enum":[false]}},"required":["enabled"]},{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable 'run as current user' mode","enum":[true]},"home_directory":{"type":"string","description":"Directory to use as home directory for user inside container","minLength":1}},"required":["enabled","home_directory"]}]},"capabilityList":{"type":"array","items":{"oneOf":[{"type":"string","enum":["AUDIT_CONTROL","AUDIT_READ","AUDIT_WRITE","BLOCK_SUSPEND","CHOWN","DAC_OVERRIDE","DAC_READ_SEARCH","FOWNER","FSETID","IPC_LOCK","IPC_OWNER","KILL","LEASE","LINUX_IMMUTABLE","MAC_ADMIN","MAC_OVERRIDE","MKNOD","NET_ADMIN","NET_BIND_SERVICE","NET_BROADCAST","NET_RAW","SETGID","SETFCAP","SETPCAP","SETUID","SYS_ADMIN","SYS_BOOT","SYS_CHROOT","SYS_MODULE","SYS_NICE","SYS_PACCT","SYS_PTRACE","SYS_RAWIO","SYS_RESOURCE","SYS_TIME","SYS_TTY_CONFIG","SYSLOG","WAKE_ALARM","ALL"]}]}},"setupCommandsList":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"command":{"type":"string","description":"Command to execute","minLength":1},"working_directory":{"type":"string","description":"Working directory to start the command in (defaults to container working directory if not set)","minLength":1}},"required":["command"]}},"configVariablesList":{"type":"object","description":"Definitions for each of the config variables used to configure your tasks and containers","additionalProperties":{"$ref":"#/definitions/configVariable"}},"configVariable":{"type":"object","description":"Definition of a single config variable","additionalProperties":false,"properties":{"description":{"type":"string","description":"Human-readable description of the purpose of the variable","minLength":1},"default":{"type":"string","description":"Default value of the variable if one is not provided elsewhere","minLength":1}}},"includesList":{"type":"array","description":"List of configuration files to include in this project","items":{"$ref":"#/definitions/include"}},"include":{"oneOf":[{"type":"string","description":"Path (relative to this file) to the file to include"},{"type":"object","properties":{"type":{"type":"string","description":"The type of include","enum":["file"]},"path":{"type":"string","description":"Path (relative to this file) of the file to include","minLength":1}},"additionalProperties":false,"required":["type","path"]},{"type":"object","properties":{"type":{"type":"string","description":"The type of include","enum":["git"]},"repo":{"type":"string","description":"Git repository containing the file to include","minLength":1},"ref":{"type":"string","description":"Git reference (commit, tag or branch) containing the file to include"},"path":{"type":"string","description":"Path (relative to the root of the repository) of the file to include (defaults to batect-bundle.yml if not set)","minLength":1}},"additionalProperties":false,"required":["type","repo","ref"]}]}}}
|
Provide a JSON object that satisfies the schema "JSON schema for Batect configuration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Batect configuration files
|
schema-store
|
schema_store_207
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"MS\\u00b2Rescore configuration\",\"type\":\"object\",\"required\":[\"ms2rescore\"],\"properties\":{\"ms2rescore\":{\"description\":\"General MS\\u00b2Rescore settings.\",\"type\":\"object\",\"required\":[\"psm_file\"],\"additionalProperties\":false,\"properties\":{\"feature_generators\":{\"description\":\"Feature generators and their configurations.\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/feature_generator\"},\"basic\":{\"$ref\":\"#/definitions/basic\"},\"ms2pip\":{\"$ref\":\"#/definitions/ms2pip\"},\"deeplc\":{\"$ref\":\"#/definitions/deeplc\"},\"maxquant\":{\"$ref\":\"#/definitions/maxquant\"},\"ionmob\":{\"$ref\":\"#/definitions/ionmob\"},\"im2deep\":{\"$ref\":\"#/definitions/im2deep\"}},\"default\":{\"basic\":{},\"ms2pip\":{\"model\":\"HCD\",\"ms2_tolerance\":0.02},\"deeplc\":{},\"maxquant\":{}}},\"rescoring_engine\":{\"description\":\"Rescoring engine to use and its configuration. Leave empty to skip rescoring and write features to file.\",\"type\":\"object\",\"minProperties\":0,\"maxProperties\":1,\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/rescoring_engine\"},\"percolator\":{\"$ref\":\"#/definitions/percolator\"},\"mokapot\":{\"$ref\":\"#/definitions/mokapot\"}},\"default\":{\"mokapot\":{}}},\"config_file\":{\"description\":\"Path to configuration file\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"psm_file\":{\"description\":\"Path to file with peptide-spectrum matches.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"psm_file_type\":{\"description\":\"PSM file type. By default inferred from file extension.\",\"type\":\"string\",\"default\":\"infer\"},\"psm_reader_kwargs\":{\"description\":\"Keyword arguments passed to the PSM reader.\",\"type\":\"object\",\"default\":{}},\"spectrum_path\":{\"description\":\"Path to spectrum file or directory with spectrum files\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"output_path\":{\"description\":\"Path and root name for output files\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"log_level\":{\"description\":\"Logging level\",\"type\":\"string\",\"enum\":[\"debug\",\"info\",\"warning\",\"error\",\"critical\"]},\"id_decoy_pattern\":{\"description\":\"Regex pattern used to identify the decoy PSMs in identification file.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null},\"spectrum_id_pattern\":{\"description\":\"Regex pattern to extract index or scan number from spectrum file. Requires at least one capturing group.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"(.*)\",\"format\":\"regex\"},\"psm_id_pattern\":{\"description\":\"Regex pattern to extract index or scan number from PSM file. Requires at least one capturing group.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"(.*)\",\"format\":\"regex\"},\"psm_id_rt_pattern\":{\"description\":\"Regex pattern to extract retention time from PSM identifier. Requires at least one capturing group.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"format\":\"regex\"},\"psm_id_im_pattern\":{\"description\":\"Regex pattern to extract ion mobility from PSM identifier. Requires at least one capturing group.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"format\":\"regex\"},\"lower_score_is_better\":{\"description\":\"Bool indicating if lower score is better\",\"type\":\"boolean\",\"default\":false},\"max_psm_rank_input\":{\"description\":\"Maximum rank of PSMs to use as input for rescoring\",\"type\":\"number\",\"default\":10,\"minimum\":1},\"max_psm_rank_output\":{\"description\":\"Maximum rank of PSMs to return after rescoring, before final FDR calculation\",\"type\":\"number\",\"default\":1,\"minimum\":1},\"modification_mapping\":{\"description\":\"Mapping of modification labels to each replacement label.\",\"type\":\"object\",\"default\":{}},\"fixed_modifications\":{\"description\":\"Mapping of amino acids with fixed modifications to the modification name.\",\"type\":\"object\",\"default\":{},\"additionalProperties\":true},\"processes\":{\"description\":\"Number of parallel processes to use; -1 for all available\",\"type\":\"number\",\"multipleOf\":1,\"minimum\":-1,\"default\":-1},\"rename_to_usi\":{\"description\":\"Convert spectrum IDs to their universal spectrum identifier\",\"type\":\"boolean\"},\"fasta_file\":{\"description\":\"Path to FASTA file with protein sequences to use for protein inference\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"write_flashlfq\":{\"description\":\"Write results to a FlashLFQ-compatible file\",\"type\":\"boolean\",\"default\":false},\"write_report\":{\"description\":\"Write an HTML report with various QC metrics and charts\",\"type\":\"boolean\",\"default\":false},\"profile\":{\"description\":\"Write a txt report using cProfile for profiling\",\"type\":\"boolean\",\"default\":false}}}},\"definitions\":{\"feature_generator\":{\"description\":\"Feature generator configuration\",\"type\":\"object\",\"additionalProperties\":true},\"rescoring_engine\":{\"description\":\"Rescoring engine configuration\",\"type\":\"object\",\"additionalProperties\":true},\"basic\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"Basic feature generator configuration\",\"type\":\"object\",\"additionalProperties\":true},\"ms2pip\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"MS\\u00b2PIP feature generator configuration\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"model\":{\"description\":\"MS\\u00b2PIP model to use (see MS\\u00b2PIP documentation)\",\"type\":\"string\",\"default\":\"HCD\"},\"ms2_tolerance\":{\"description\":\"MS2 error tolerance in Da\",\"type\":\"number\",\"minimum\":0,\"default\":0.02}}},\"deeplc\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"DeepLC feature generator configuration\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"calibration_set_size\":{\"description\":\"Calibration set size\",\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"number\"}],\"default\":0.15}}},\"maxquant\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"MaxQuant feature generator configuration\",\"type\":\"object\",\"additionalProperties\":true},\"ionmob\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"Ion mobility feature generator configuration using Ionmob\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"ionmob_model\":{\"description\":\"Path to Ionmob model directory\",\"type\":\"string\",\"default\":\"GRUPredictor\"},\"reference_dataset\":{\"description\":\"Path to Ionmob reference dataset file\",\"type\":\"string\",\"default\":\"Meier_unimod.parquet\"},\"tokenizer\":{\"description\":\"Path to tokenizer json file\",\"type\":\"string\",\"default\":\"tokenizer.json\"}}},\"im2deep\":{\"$ref\":\"#/definitions/feature_generator\",\"description\":\"Ion mobility feature generator configuration using IM2Deep\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"reference_dataset\":{\"description\":\"Path to IM2Deep reference dataset file\",\"type\":\"string\",\"default\":\"Meier_unimod.parquet\"}}},\"mokapot\":{\"$ref\":\"#/definitions/rescoring_engine\",\"description\":\"Mokapot rescoring engine configuration. Additional properties are passed to the Mokapot brew function.\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"train_fdr\":{\"description\":\"FDR threshold for training Mokapot\",\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"default\":0.01},\"write_weights\":{\"description\":\"Write Mokapot weights to a text file\",\"type\":\"boolean\",\"default\":false},\"write_txt\":{\"description\":\"Write Mokapot results to a text file\",\"type\":\"boolean\",\"default\":false}}},\"percolator\":{\"$ref\":\"#/definitions/rescoring_engine\",\"description\":\"Percolator rescoring engine configuration\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"init-weights\":{\"description\":\"Weights file for scoring function\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":false}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"MS²Rescore configuration\". Here are the required top‑level fields: ms2rescore. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"MS\u00b2Rescore configuration","type":"object","required":["ms2rescore"],"properties":{"ms2rescore":{"description":"General MS\u00b2Rescore settings.","type":"object","required":["psm_file"],"additionalProperties":false,"properties":{"feature_generators":{"description":"Feature generators and their configurations.","type":"object","patternProperties":{".*":{"$ref":"#/definitions/feature_generator"},"basic":{"$ref":"#/definitions/basic"},"ms2pip":{"$ref":"#/definitions/ms2pip"},"deeplc":{"$ref":"#/definitions/deeplc"},"maxquant":{"$ref":"#/definitions/maxquant"},"ionmob":{"$ref":"#/definitions/ionmob"},"im2deep":{"$ref":"#/definitions/im2deep"}},"default":{"basic":{},"ms2pip":{"model":"HCD","ms2_tolerance":0.02},"deeplc":{},"maxquant":{}}},"rescoring_engine":{"description":"Rescoring engine to use and its configuration. Leave empty to skip rescoring and write features to file.","type":"object","minProperties":0,"maxProperties":1,"patternProperties":{".*":{"$ref":"#/definitions/rescoring_engine"},"percolator":{"$ref":"#/definitions/percolator"},"mokapot":{"$ref":"#/definitions/mokapot"}},"default":{"mokapot":{}}},"config_file":{"description":"Path to configuration file","oneOf":[{"type":"string"},{"type":"null"}]},"psm_file":{"description":"Path to file with peptide-spectrum matches.","oneOf":[{"type":"string"},{"type":"null"},{"type":"array","items":{"type":"string"}}]},"psm_file_type":{"description":"PSM file type. By default inferred from file extension.","type":"string","default":"infer"},"psm_reader_kwargs":{"description":"Keyword arguments passed to the PSM reader.","type":"object","default":{}},"spectrum_path":{"description":"Path to spectrum file or directory with spectrum files","oneOf":[{"type":"string"},{"type":"null"}]},"output_path":{"description":"Path and root name for output files","oneOf":[{"type":"string"},{"type":"null"}]},"log_level":{"description":"Logging level","type":"string","enum":["debug","info","warning","error","critical"]},"id_decoy_pattern":{"description":"Regex pattern used to identify the decoy PSMs in identification file.","oneOf":[{"type":"string"},{"type":"null"}],"default":null},"spectrum_id_pattern":{"description":"Regex pattern to extract index or scan number from spectrum file. Requires at least one capturing group.","oneOf":[{"type":"string"},{"type":"null"}],"default":"(.*)","format":"regex"},"psm_id_pattern":{"description":"Regex pattern to extract index or scan number from PSM file. Requires at least one capturing group.","oneOf":[{"type":"string"},{"type":"null"}],"default":"(.*)","format":"regex"},"psm_id_rt_pattern":{"description":"Regex pattern to extract retention time from PSM identifier. Requires at least one capturing group.","oneOf":[{"type":"string"},{"type":"null"}],"default":null,"format":"regex"},"psm_id_im_pattern":{"description":"Regex pattern to extract ion mobility from PSM identifier. Requires at least one capturing group.","oneOf":[{"type":"string"},{"type":"null"}],"default":null,"format":"regex"},"lower_score_is_better":{"description":"Bool indicating if lower score is better","type":"boolean","default":false},"max_psm_rank_input":{"description":"Maximum rank of PSMs to use as input for rescoring","type":"number","default":10,"minimum":1},"max_psm_rank_output":{"description":"Maximum rank of PSMs to return after rescoring, before final FDR calculation","type":"number","default":1,"minimum":1},"modification_mapping":{"description":"Mapping of modification labels to each replacement label.","type":"object","default":{}},"fixed_modifications":{"description":"Mapping of amino acids with fixed modifications to the modification name.","type":"object","default":{},"additionalProperties":true},"processes":{"description":"Number of parallel processes to use; -1 for all available","type":"number","multipleOf":1,"minimum":-1,"default":-1},"rename_to_usi":{"description":"Convert spectrum IDs to their universal spectrum identifier","type":"boolean"},"fasta_file":{"description":"Path to FASTA file with protein sequences to use for protein inference","oneOf":[{"type":"string"},{"type":"null"}]},"write_flashlfq":{"description":"Write results to a FlashLFQ-compatible file","type":"boolean","default":false},"write_report":{"description":"Write an HTML report with various QC metrics and charts","type":"boolean","default":false},"profile":{"description":"Write a txt report using cProfile for profiling","type":"boolean","default":false}}}},"definitions":{"feature_generator":{"description":"Feature generator configuration","type":"object","additionalProperties":true},"rescoring_engine":{"description":"Rescoring engine configuration","type":"object","additionalProperties":true},"basic":{"$ref":"#/definitions/feature_generator","description":"Basic feature generator configuration","type":"object","additionalProperties":true},"ms2pip":{"$ref":"#/definitions/feature_generator","description":"MS\u00b2PIP feature generator configuration","type":"object","additionalProperties":true,"properties":{"model":{"description":"MS\u00b2PIP model to use (see MS\u00b2PIP documentation)","type":"string","default":"HCD"},"ms2_tolerance":{"description":"MS2 error tolerance in Da","type":"number","minimum":0,"default":0.02}}},"deeplc":{"$ref":"#/definitions/feature_generator","description":"DeepLC feature generator configuration","type":"object","additionalProperties":true,"properties":{"calibration_set_size":{"description":"Calibration set size","oneOf":[{"type":"integer"},{"type":"number"}],"default":0.15}}},"maxquant":{"$ref":"#/definitions/feature_generator","description":"MaxQuant feature generator configuration","type":"object","additionalProperties":true},"ionmob":{"$ref":"#/definitions/feature_generator","description":"Ion mobility feature generator configuration using Ionmob","type":"object","additionalProperties":true,"properties":{"ionmob_model":{"description":"Path to Ionmob model directory","type":"string","default":"GRUPredictor"},"reference_dataset":{"description":"Path to Ionmob reference dataset file","type":"string","default":"Meier_unimod.parquet"},"tokenizer":{"description":"Path to tokenizer json file","type":"string","default":"tokenizer.json"}}},"im2deep":{"$ref":"#/definitions/feature_generator","description":"Ion mobility feature generator configuration using IM2Deep","type":"object","additionalProperties":true,"properties":{"reference_dataset":{"description":"Path to IM2Deep reference dataset file","type":"string","default":"Meier_unimod.parquet"}}},"mokapot":{"$ref":"#/definitions/rescoring_engine","description":"Mokapot rescoring engine configuration. Additional properties are passed to the Mokapot brew function.","type":"object","additionalProperties":true,"properties":{"train_fdr":{"description":"FDR threshold for training Mokapot","type":"number","minimum":0,"maximum":1,"default":0.01},"write_weights":{"description":"Write Mokapot weights to a text file","type":"boolean","default":false},"write_txt":{"description":"Write Mokapot results to a text file","type":"boolean","default":false}}},"percolator":{"$ref":"#/definitions/rescoring_engine","description":"Percolator rescoring engine configuration","type":"object","additionalProperties":true,"properties":{"init-weights":{"description":"Weights file for scoring function","oneOf":[{"type":"string"},{"type":"null"}],"default":false}}}}}
|
Provide a JSON object that satisfies the schema "MS²Rescore configuration". Here are the required top‑level fields: ms2rescore. Return only the valid JSON object.
|
MS²Rescore configuration
|
schema-store
|
schema_store_208
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"type\":\"object\",\"title\":\"Schema for cog.yaml\",\"description\":\"Defines how to build a Docker image and how to run predictions on your model inside that image.\",\"properties\":{\"build\":{\"$id\":\"#/properties/build\",\"type\":\"object\",\"description\":\"This stanza describes how to build the Docker image your model runs in.\",\"properties\":{\"cuda\":{\"$id\":\"#/properties/build/properties/cuda\",\"type\":\"string\",\"description\":\"Cog automatically picks the correct version of CUDA to install, but this lets you override it for whatever reason.\"},\"cudnn\":{\"$id\":\"#/properties/build/properties/cudnn\",\"type\":\"string\",\"description\":\"Cog automatically picks the correct version of cuDNN to install, but this lets you override it for whatever reason.\"},\"gpu\":{\"$id\":\"#/properties/build/properties/gpu\",\"type\":\"boolean\",\"description\":\"Enable GPUs for this model. When enabled, the [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) base image will be used, and Cog will automatically figure out what versions of CUDA and cuDNN to use based on the version of Python, PyTorch, and Tensorflow that you are using.\"},\"python_version\":{\"$id\":\"#/properties/build/properties/python_version\",\"type\":[\"string\",\"number\"],\"description\":\"The minor (`3.8`) or patch (`3.8.1`) version of Python to use.\"},\"python_packages\":{\"$id\":\"#/properties/build/properties/python_packages\",\"type\":[\"array\",\"null\"],\"description\":\"A list of Python packages to install, in the format `package==version`.\",\"additionalItems\":true,\"items\":{\"$id\":\"#/properties/build/properties/python_packages/items\",\"anyOf\":[{\"$id\":\"#/properties/build/properties/python_packages/items/anyOf/0\",\"type\":\"string\"}]}},\"pre_install\":{\"$id\":\"#/properties/build/properties/pre_install\",\"type\":[\"array\",\"null\"],\"description\":\"A list of setup commands to run in the environment before your Python packages are installed.\",\"additionalItems\":true,\"items\":{\"$id\":\"#/properties/build/properties/pre_install/items\",\"anyOf\":[{\"$id\":\"#/properties/build/properties/pre_install/items/anyOf/0\",\"type\":\"string\"}]}},\"python_requirements\":{\"$id\":\"#/properties/build/properties/python_requirements\",\"type\":\"string\",\"description\":\"A pip requirements file specifying the Python packages to install.\"},\"system_packages\":{\"$id\":\"#/properties/build/properties/system_packages\",\"type\":[\"array\",\"null\"],\"description\":\"A list of Ubuntu APT packages to install.\",\"additionalItems\":true,\"items\":{\"$id\":\"#/properties/build/properties/system_packages/items\",\"anyOf\":[{\"$id\":\"#/properties/build/properties/system_packages/items/anyOf/0\",\"type\":\"string\"}]}},\"run\":{\"$id\":\"#/properties/build/properties/run\",\"type\":[\"array\",\"null\"],\"description\":\"A list of setup commands to run in the environment after your system packages and Python packages have been installed. If you're familiar with Docker, it's like a `RUN` instruction in your `Dockerfile`.\",\"additionalItems\":true,\"items\":{\"$id\":\"#/properties/build/properties/run/items\",\"anyOf\":[{\"$id\":\"#/properties/build/properties/run/items/anyOf/0\",\"type\":\"string\"},{\"$id\":\"#/properties/build/properties/run/items/anyOf/1\",\"type\":\"object\",\"properties\":{\"command\":{\"type\":\"string\"},\"mounts\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"secret\"]},\"id\":{\"type\":\"string\"},\"target\":{\"type\":\"string\"}},\"required\":[\"type\",\"id\",\"target\"]}}},\"required\":[\"command\"]}]}},\"fast\":{\"$id\":\"#/properties/build/properties/fast\",\"type\":\"boolean\",\"description\":\"A flag to enable the experimental fast-push feature from a config level.\"},\"python_overrides\":{\"$id\":\"#/properties/build/properties/python_overrides\",\"type\":\"string\",\"description\":\"A file in the format of pip requirements that specifies python overrides.\"}},\"additionalProperties\":false},\"image\":{\"$id\":\"#/properties/image\",\"type\":\"string\",\"description\":\"The name given to built Docker images. If you want to push to a registry, this should also include the registry name.\"},\"predict\":{\"$id\":\"#/properties/predict\",\"type\":\"string\",\"description\":\"The pointer to the `Predictor` object in your code, which defines how predictions are run on your model.\"},\"train\":{\"$id\":\"#/properties/train\",\"type\":\"string\",\"description\":\"The pointer to the `Predictor` object in your code, which defines how predictions are run on your model.\"},\"concurrency\":{\"$id\":\"#/properties/concurrency\",\"type\":\"object\",\"description\":\"The concurrency settings for the model.\",\"required\":[\"max\"],\"additionalProperties\":false,\"properties\":{\"max\":{\"$id\":\"#/properties/concurrency/properties/max\",\"type\":\"integer\",\"description\":\"The maximum number of concurrent predictions.\"},\"default_target\":{\"$id\":\"#/properties/concurrency/properties/default_target\",\"type\":\"integer\",\"description\":\"The default target for number of concurrent predictions. This setting can be used by an autoscaler to determine when to scale a deployment of a model up or down.\"}}},\"tests\":{\"$id\":\"#/properties/tests\",\"type\":[\"array\",\"null\"],\"description\":\"A list of test cog commands to run.\",\"additionalItems\":false,\"items\":{\"type\":\"object\",\"additionalItems\":true}},\"environment\":{\"$id\":\"#/properties/properties/environment\",\"type\":[\"array\",\"null\"],\"description\":\"A list of environment variables to make available during builds and at runtime, in the format `NAME=value`\",\"additionalItems\":true,\"items\":{\"$id\":\"#/properties/properties/environment/items\",\"type\":\"string\",\"pattern\":\"^[A-Za-z_][A-Za-z0-9_]*=[^\\\\s]+$\"}}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Schema for cog.yaml\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"Schema for cog.yaml","description":"Defines how to build a Docker image and how to run predictions on your model inside that image.","properties":{"build":{"$id":"#/properties/build","type":"object","description":"This stanza describes how to build the Docker image your model runs in.","properties":{"cuda":{"$id":"#/properties/build/properties/cuda","type":"string","description":"Cog automatically picks the correct version of CUDA to install, but this lets you override it for whatever reason."},"cudnn":{"$id":"#/properties/build/properties/cudnn","type":"string","description":"Cog automatically picks the correct version of cuDNN to install, but this lets you override it for whatever reason."},"gpu":{"$id":"#/properties/build/properties/gpu","type":"boolean","description":"Enable GPUs for this model. When enabled, the [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) base image will be used, and Cog will automatically figure out what versions of CUDA and cuDNN to use based on the version of Python, PyTorch, and Tensorflow that you are using."},"python_version":{"$id":"#/properties/build/properties/python_version","type":["string","number"],"description":"The minor (`3.8`) or patch (`3.8.1`) version of Python to use."},"python_packages":{"$id":"#/properties/build/properties/python_packages","type":["array","null"],"description":"A list of Python packages to install, in the format `package==version`.","additionalItems":true,"items":{"$id":"#/properties/build/properties/python_packages/items","anyOf":[{"$id":"#/properties/build/properties/python_packages/items/anyOf/0","type":"string"}]}},"pre_install":{"$id":"#/properties/build/properties/pre_install","type":["array","null"],"description":"A list of setup commands to run in the environment before your Python packages are installed.","additionalItems":true,"items":{"$id":"#/properties/build/properties/pre_install/items","anyOf":[{"$id":"#/properties/build/properties/pre_install/items/anyOf/0","type":"string"}]}},"python_requirements":{"$id":"#/properties/build/properties/python_requirements","type":"string","description":"A pip requirements file specifying the Python packages to install."},"system_packages":{"$id":"#/properties/build/properties/system_packages","type":["array","null"],"description":"A list of Ubuntu APT packages to install.","additionalItems":true,"items":{"$id":"#/properties/build/properties/system_packages/items","anyOf":[{"$id":"#/properties/build/properties/system_packages/items/anyOf/0","type":"string"}]}},"run":{"$id":"#/properties/build/properties/run","type":["array","null"],"description":"A list of setup commands to run in the environment after your system packages and Python packages have been installed. If you're familiar with Docker, it's like a `RUN` instruction in your `Dockerfile`.","additionalItems":true,"items":{"$id":"#/properties/build/properties/run/items","anyOf":[{"$id":"#/properties/build/properties/run/items/anyOf/0","type":"string"},{"$id":"#/properties/build/properties/run/items/anyOf/1","type":"object","properties":{"command":{"type":"string"},"mounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["secret"]},"id":{"type":"string"},"target":{"type":"string"}},"required":["type","id","target"]}}},"required":["command"]}]}},"fast":{"$id":"#/properties/build/properties/fast","type":"boolean","description":"A flag to enable the experimental fast-push feature from a config level."},"python_overrides":{"$id":"#/properties/build/properties/python_overrides","type":"string","description":"A file in the format of pip requirements that specifies python overrides."}},"additionalProperties":false},"image":{"$id":"#/properties/image","type":"string","description":"The name given to built Docker images. If you want to push to a registry, this should also include the registry name."},"predict":{"$id":"#/properties/predict","type":"string","description":"The pointer to the `Predictor` object in your code, which defines how predictions are run on your model."},"train":{"$id":"#/properties/train","type":"string","description":"The pointer to the `Predictor` object in your code, which defines how predictions are run on your model."},"concurrency":{"$id":"#/properties/concurrency","type":"object","description":"The concurrency settings for the model.","required":["max"],"additionalProperties":false,"properties":{"max":{"$id":"#/properties/concurrency/properties/max","type":"integer","description":"The maximum number of concurrent predictions."},"default_target":{"$id":"#/properties/concurrency/properties/default_target","type":"integer","description":"The default target for number of concurrent predictions. This setting can be used by an autoscaler to determine when to scale a deployment of a model up or down."}}},"tests":{"$id":"#/properties/tests","type":["array","null"],"description":"A list of test cog commands to run.","additionalItems":false,"items":{"type":"object","additionalItems":true}},"environment":{"$id":"#/properties/properties/environment","type":["array","null"],"description":"A list of environment variables to make available during builds and at runtime, in the format `NAME=value`","additionalItems":true,"items":{"$id":"#/properties/properties/environment/items","type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*=[^\\s]+$"}}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "Schema for cog.yaml". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Schema for cog.yaml
|
schema-store
|
schema_store_209
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://github.com/nwithan8/tauticord/.schema/config_v2.schema.json\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$comment\":\"https://github.com/nwithan8/tauticord\",\"title\":\"Tauticord Config v2 Schema\",\"type\":\"object\",\"additionalProperties\":true,\"definitions\":{\"emptyString\":{\"id\":\"#/definitions/emptyString\",\"type\":\"string\",\"pattern\":\"^$\"},\"emptyableString\":{\"id\":\"#/definitions/emptyableString\",\"oneOf\":[{\"$ref\":\"#/definitions/emptyString\"},{\"type\":\"string\"}]},\"numberZero\":{\"id\":\"#/definitions/numberZero\",\"type\":\"number\",\"minimum\":0,\"maximum\":0},\"positiveInteger\":{\"id\":\"#/definitions/positiveInteger\",\"type\":\"integer\",\"minimum\":1},\"hostWithIpAndOptionalPort\":{\"id\":\"#/definitions/hostWithIpAndOptionalPort\",\"type\":\"string\",\"pattern\":\"^(https?://)?[a-zA-Z0-9.-]+(:[0-9]{1,5})?$\"},\"discordBotToken\":{\"id\":\"#/definitions/discordBotToken\",\"type\":\"string\",\"pattern\":\"^[MNO][a-zA-Z\\\\d_-]{23,25}\\\\.[a-zA-Z\\\\d_-]{6}\\\\.[a-zA-Z\\\\d_-]{27,}$\",\"description\":\"A Discord Bot Token\",\"$comment\":\"https://github.com/Yelp/detect-secrets/blob/master/detect_secrets/plugins/discord.py#L17C22-L17C81\"},\"discordChannelId\":{\"id\":\"#/definitions/discordChannelId\",\"description\":\"A Discord channel ID\",\"type\":\"string\",\"pattern\":\"^[0-9]{17,20}$\"},\"discordUserId\":{\"id\":\"#/definitions/discordUserId\",\"description\":\"A Discord user ID\",\"type\":\"string\",\"pattern\":\"^[0-9]{17,20}$\"},\"discordServerId\":{\"id\":\"#/definitions/discordServerId\",\"description\":\"A Discord server ID\",\"type\":\"string\",\"pattern\":\"^[0-9]{17,20}$\"},\"discordTextChannelName\":{\"id\":\"#/definitions/discordTextChannelName\",\"description\":\"A Discord text channel name. No emojis allowed.\",\"type\":\"string\",\"pattern\":\"^[a-z0-9-]{2,100}$\",\"$comment\":\"Cannot contain spaces or uppercase letters\"},\"discordVoiceChannelName\":{\"id\":\"#/definitions/discordVoiceChannelName\",\"description\":\"A Discord voice channel name. No emojis allowed.\",\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9-_ ]{2,100}$\"},\"discordCategoryName\":{\"id\":\"#/definitions/discordCategoryName\",\"description\":\"A Discord category name. No emojis allowed.\",\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9-_ ]{2,100}$\"},\"tautulliApiKey\":{\"id\":\"#/definitions/tautulliApiKey\",\"description\":\"A Tautulli API key\",\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9]{32}$\"},\"tautulliUrl\":{\"id\":\"#/definitions/tautulliUrl\",\"description\":\"A Tautulli URL\",\"$ref\":\"#/definitions/hostWithIpAndOptionalPort\"},\"voiceChannel\":{\"id\":\"#/definitions/voiceChannel\",\"type\":\"object\",\"properties\":{\"CustomName\":{\"description\":\"The custom name to use for the voice channel (overrides the default name)\",\"oneOf\":[{\"$ref\":\"#/definitions/discordVoiceChannelName\"},{\"$ref\":\"#/definitions/emptyString\"}]},\"CustomEmoji\":{\"description\":\"The custom emoji to use for the voice channel (overrides the default emoji)\",\"type\":\"string\"},\"Enable\":{\"description\":\"Whether to enable the voice channel\",\"type\":\"boolean\"},\"VoiceChannelID\":{\"description\":\"The ID of the voice channel\",\"oneOf\":[{\"$ref\":\"#/definitions/discordChannelId\"},{\"$ref\":\"#/definitions/numberZero\"}]}},\"required\":[\"CustomName\",\"CustomEmoji\",\"Enable\",\"VoiceChannelID\"]},\"recentlyAddedVoiceChannel\":{\"id\":\"#/definitions/voiceChannel\",\"type\":\"object\",\"properties\":{\"CustomName\":{\"description\":\"The custom name to use for the voice channel (overrides the default name)\",\"oneOf\":[{\"$ref\":\"#/definitions/discordVoiceChannelName\"},{\"$ref\":\"#/definitions/emptyString\"}]},\"CustomEmoji\":{\"description\":\"The custom emoji to use for the voice channel (overrides the default emoji)\",\"type\":\"string\"},\"Enable\":{\"description\":\"Whether to enable the voice channel\",\"type\":\"boolean\"},\"VoiceChannelID\":{\"description\":\"The ID of the voice channel\",\"oneOf\":[{\"$ref\":\"#/definitions/discordChannelId\"},{\"$ref\":\"#/definitions/numberZero\"}]},\"Hours\":{\"description\":\"The number of hours to look back for recently added items\",\"type\":\"integer\",\"minimum\":1}},\"required\":[\"CustomName\",\"CustomEmoji\",\"Enable\",\"VoiceChannelID\",\"Hours\"]},\"library\":{\"id\":\"#/definitions/library\",\"type\":\"object\",\"properties\":{\"Name\":{\"description\":\"The name of the library as it appears in Plex\",\"type\":\"string\"},\"ID\":{\"description\":\"The ID of the library as it appears in Tautulli. Use if the library name is not unique\",\"oneOf\":[{\"$ref\":\"#/definitions/positiveInteger\"},{\"$ref\":\"#/definitions/numberZero\"}]},\"AlternateName\":{\"description\":\"An alternate name for the library (used as the voice channel name)\",\"oneOf\":[{\"$ref\":\"#/definitions/discordVoiceChannelName\"},{\"$ref\":\"#/definitions/emptyString\"}]},\"Albums\":{\"description\":\"Settings for the voice channel about album information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Artists\":{\"description\":\"Settings for the voice channel about artist information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Episodes\":{\"description\":\"Settings for the voice channel about episode information (used if the library is a TV show library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Movies\":{\"description\":\"Settings for the voice channel about movie information (used if the library is a movie library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Series\":{\"description\":\"Settings for the voice channel about series/show information (used if the library is a TV show library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Tracks\":{\"description\":\"Settings for the voice channel about track information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"RecentlyAdded\":{\"description\":\"Settings for the voice channel about recently added items\",\"$ref\":\"#/definitions/recentlyAddedVoiceChannel\"}},\"required\":[\"Name\",\"AlternateName\"]},\"combinedLibrarySubLibrary\":{\"id\":\"#/definitions/combinedLibrarySubLibrary\",\"type\":\"object\",\"properties\":{\"Name\":{\"description\":\"The name of the library as it appears in Tautulli\",\"type\":\"string\"},\"ID\":{\"description\":\"The ID of the library as it appears in Tautulli. Use if the library name is not unique\",\"oneOf\":[{\"$ref\":\"#/definitions/positiveInteger\"},{\"$ref\":\"#/definitions/numberZero\"}]}},\"required\":[\"Name\"]},\"combinedLibrary\":{\"id\":\"#/definitions/combinedLibrary\",\"type\":\"object\",\"properties\":{\"Name\":{\"description\":\"The name for the combined library (used as the voice channel name)\",\"oneOf\":[{\"$ref\":\"#/definitions/discordVoiceChannelName\"},{\"$ref\":\"#/definitions/emptyString\"}]},\"Libraries\":{\"description\":\"The libraries to combine\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/combinedLibrarySubLibrary\"}},\"Albums\":{\"description\":\"Settings for the voice channel about album information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Artists\":{\"description\":\"Settings for the voice channel about artist information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Episodes\":{\"description\":\"Settings for the voice channel about episode information (used if the library is a TV show library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Movies\":{\"description\":\"Settings for the voice channel about movie information (used if the library is a movie library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Series\":{\"description\":\"Settings for the voice channel about series/show information (used if the library is a TV show library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"Tracks\":{\"description\":\"Settings for the voice channel about track information (used if the library is a music library)\",\"$ref\":\"#/definitions/voiceChannel\"},\"RecentlyAdded\":{\"description\":\"Settings for the voice channel about recently added items\",\"$ref\":\"#/definitions/recentlyAddedVoiceChannel\"}},\"required\":[\"Name\",\"Libraries\"]}},\"properties\":{\"Tautulli\":{\"title\":\"Tautulli configuration\",\"description\":\"Settings for the Tautulli instance\",\"type\":\"object\",\"properties\":{\"URL\":{\"title\":\"Tautulli URL\",\"description\":\"The URL of the Tautulli instance\",\"$ref\":\"#/definitions/tautulliUrl\"},\"APIKey\":{\"title\":\"Tautulli API key\",\"description\":\"The API key for the Tautulli instance\",\"$ref\":\"#/definitions/tautulliApiKey\"},\"UseSelfSignedCert\":{\"title\":\"Use self-signed certificate\",\"description\":\"Whether to use a self-signed certificate for the Tautulli instance (ignore SSL warnings)\",\"type\":\"boolean\"},\"RefreshSeconds\":{\"title\":\"Activity data refresh interval\",\"description\":\"How often, in seconds, the bot pulls new live activity data. A 5-second minimum is built-in; it's for your own good\",\"type\":\"integer\",\"minimum\":5,\"multipleOf\":5},\"TerminateMessage\":{\"title\":\"Stream termination message\",\"description\":\"The message to send when a stream is terminated\",\"type\":\"string\"}},\"required\":[\"URL\",\"APIKey\",\"UseSelfSignedCert\",\"RefreshSeconds\",\"TerminateMessage\"]},\"Discord\":{\"title\":\"Discord configuration\",\"description\":\"Settings for the Discord bot and server\",\"type\":\"object\",\"properties\":{\"BotToken\":{\"title\":\"Discord bot token\",\"description\":\"The token for the Discord bot\",\"$ref\":\"#/definitions/discordBotToken\"},\"ServerID\":{\"title\":\"Discord server ID\",\"description\":\"The ID of the Discord server where the bot will be used\",\"$ref\":\"#/definitions/discordServerId\"},\"AdminIDs\":{\"title\":\"Admin IDs\",\"description\":\"The IDs of the Discord users who will have admin permissions\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/discordUserId\"}},\"PostSummaryMessage\":{\"title\":\"Post summary message\",\"description\":\"Whether to post a summary message in the activity summary channel\",\"type\":\"boolean\"},\"ChannelName\":{\"title\":\"Activity summary channel name\",\"description\":\"The name of the channel where the bot will post messages\",\"$ref\":\"#/definitions/discordTextChannelName\"},\"EnableTermination\":{\"title\":\"Enable stream termination\",\"description\":\"Whether to enable stream termination\",\"type\":\"boolean\"},\"EnableSlashCommands\":{\"title\":\"Enable slash commands\",\"description\":\"Whether to enable slash commands for the bot\",\"type\":\"boolean\"},\"StatusMessage\":{\"title\":\"Bot Discord activity status\",\"description\":\"Settings regarding the bot's Discord status/activity\",\"type\":\"object\",\"properties\":{\"Enable\":{\"title\":\"Enable bot activity status\",\"description\":\"Whether to enable the bot's activity status\",\"type\":\"boolean\"},\"CustomMessage\":{\"title\":\"Custom activity status message\",\"description\":\"Display a custom activity status message. Overrides default if not-empty\",\"type\":\"string\"},\"ShowStreamCount\":{\"title\":\"Show active stream count\",\"description\":\"Whether to display current active stream count in activity status message\",\"type\":\"boolean\"}}}},\"required\":[\"BotToken\",\"ServerID\",\"AdminIDs\",\"PostSummaryMessage\",\"ChannelName\",\"EnableSlashCommands\"]},\"Display\":{\"title\":\"Display configuration\",\"description\":\"Settings for how the bot displays information\",\"type\":\"object\",\"properties\":{\"Anonymize\":{\"title\":\"Anonymization settings\",\"description\":\"Settings for anonymizing user information\",\"type\":\"object\",\"properties\":{\"HideBandwidth\":{\"title\":\"Hide bandwidth\",\"description\":\"Whether to hide bandwidth information\",\"type\":\"boolean\"},\"HideETA\":{\"title\":\"Hide ETA\",\"description\":\"Whether to hide ETAs for streams\",\"type\":\"boolean\"},\"HidePlatforms\":{\"title\":\"Hide platforms\",\"description\":\"Whether to hide stream platform information\",\"type\":\"boolean\"},\"HidePlayerNames\":{\"title\":\"Hide player names\",\"description\":\"Whether to hide stream player names\",\"type\":\"boolean\"},\"HideProgress\":{\"title\":\"Hide progress\",\"description\":\"Whether to hide stream progress\",\"type\":\"boolean\"},\"HideQuality\":{\"title\":\"Hide quality\",\"description\":\"Whether to hide stream quality information\",\"type\":\"boolean\"},\"HideTranscode\":{\"title\":\"Hide transcode\",\"description\":\"Whether to hide stream transcoding information\",\"type\":\"boolean\"},\"HideUsernames\":{\"title\":\"Hide usernames\",\"description\":\"Whether to hide Plex usernames\",\"type\":\"boolean\"}},\"required\":[\"HideBandwidth\",\"HideETA\",\"HidePlatforms\",\"HidePlayerNames\",\"HideProgress\",\"HideQuality\",\"HideTranscode\",\"HideUsernames\"]},\"ServerName\":{\"title\":\"Server name\",\"description\":\"The name of the Plex server\",\"type\":\"string\"},\"ThousandsSeparator\":{\"title\":\"Thousands separator\",\"description\":\"The character to use as a numerical thousands separator\",\"type\":\"string\"},\"Time\":{\"title\":\"Time settings\",\"description\":\"Settings for how the bot handles time\",\"type\":\"object\",\"properties\":{},\"required\":[]},\"UseFriendlyNames\":{\"title\":\"Use friendly names\",\"description\":\"Whether to use Plex user names instead of Plex usernames\",\"type\":\"boolean\"}},\"required\":[\"Anonymize\",\"ServerName\",\"ThousandsSeparator\",\"Time\",\"UseFriendlyNames\"]},\"Extras\":{\"title\":\"Extras configuration\",\"description\":\"Extra settings for the bot\",\"type\":\"object\",\"properties\":{\"AllowAnalytics\":{\"title\":\"Allow analytics\",\"description\":\"Whether to allow the bot to collect and send analytics data\",\"type\":\"boolean\"},\"EnableUpdateReminders\":{\"title\":\"Enable update reminders\",\"description\":\"Whether to enable update reminders\",\"type\":\"boolean\"}},\"required\":[\"AllowAnalytics\",\"EnableUpdateReminders\"]},\"Stats\":{\"title\":\"Stats configuration\",\"description\":\"Settings for the bot's stat tracking features (via voice channels)\",\"type\":\"object\",\"properties\":{\"Activity\":{\"title\":\"Activity stats settings\",\"type\":\"object\",\"properties\":{\"CategoryName\":{\"title\":\"Category name\",\"description\":\"The name of the category for activity stats\",\"$ref\":\"#/definitions/discordCategoryName\"},\"Enable\":{\"title\":\"Enable activity stats\",\"description\":\"Whether to enable activity stats\",\"type\":\"boolean\"},\"StatTypes\":{\"title\":\"Stat types\",\"description\":\"The types of activity stats to track\",\"type\":\"object\",\"properties\":{\"Bandwidth\":{\"title\":\"Bandwidth\",\"description\":\"Settings for bandwidth stats\",\"$ref\":\"#/definitions/voiceChannel\"},\"LocalBandwidth\":{\"title\":\"Local bandwidth\",\"description\":\"Settings for local bandwidth stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"PlexServerAvailability\":{\"title\":\"Plex server availability\",\"description\":\"Settings for Plex server availability stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"RemoteBandwidth\":{\"title\":\"Remote bandwidth\",\"description\":\"Settings for remote bandwidth stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"StreamCount\":{\"title\":\"Stream count\",\"description\":\"Settings for stream count stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"TranscodeCount\":{\"title\":\"Transcode count\",\"description\":\"Settings for transcode count stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"}},\"required\":[\"Bandwidth\",\"LocalBandwidth\",\"PlexServerAvailability\",\"RemoteBandwidth\",\"StreamCount\",\"TranscodeCount\"]}},\"required\":[\"CategoryName\",\"Enable\",\"StatTypes\"]},\"Libraries\":{\"title\":\"Library stats settings\",\"description\":\"Settings for Plex library stats\",\"type\":\"object\",\"properties\":{\"Enable\":{\"title\":\"Enable library stats\",\"description\":\"Whether to enable library stats\",\"type\":\"boolean\"},\"CategoryName\":{\"title\":\"Category name\",\"description\":\"The name of the category for library stats\",\"$ref\":\"#/definitions/discordCategoryName\"},\"RefreshSeconds\":{\"title\":\"Library data refresh interval\",\"description\":\"How often, in seconds, the bot pulls new library data. A 5-minute minimum is built-in; it's for your own good\",\"type\":\"integer\",\"minimum\":300,\"multipleOf\":5},\"Libraries\":{\"title\":\"Libraries\",\"description\":\"Libraries to track\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/library\"}},\"CombinedLibraries\":{\"title\":\"Combined libraries\",\"description\":\"Combined libraries to track\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/combinedLibrary\"}}},\"required\":[\"Enable\",\"CategoryName\",\"RefreshSeconds\",\"Libraries\",\"CombinedLibraries\"]},\"Performance\":{\"title\":\"Performance stats settings\",\"description\":\"Settings for performance stats\",\"type\":\"object\",\"properties\":{\"CategoryName\":{\"title\":\"Category name\",\"description\":\"The name of the category for performance stats\",\"$ref\":\"#/definitions/discordCategoryName\"},\"Enable\":{\"title\":\"Enable performance stats\",\"description\":\"Whether to enable performance stats\",\"type\":\"boolean\"},\"Metrics\":{\"title\":\"Metrics\",\"description\":\"The performance metrics to track\",\"type\":\"object\",\"properties\":{\"CPU\":{\"title\":\"CPU\",\"description\":\"Settings for CPU stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"DiskSpace\":{\"title\":\"Disk space\",\"description\":\"Settings for disk space stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"Memory\":{\"title\":\"Memory\",\"description\":\"Settings for memory stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"},\"UserCount\":{\"title\":\"User count\",\"description\":\"Settings for user count stats\",\"type\":\"object\",\"$ref\":\"#/definitions/voiceChannel\"}},\"required\":[\"CPU\",\"DiskSpace\",\"Memory\",\"UserCount\"]}},\"required\":[\"CategoryName\",\"Enable\",\"Metrics\"]}},\"required\":[\"Activity\",\"Libraries\",\"Performance\"]}},\"required\":[\"Tautulli\",\"Discord\",\"Display\",\"Stats\",\"Extras\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Tauticord Config v2 Schema\". Here are the required top‑level fields: Tautulli, Discord, Display, Stats, Extras. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://github.com/nwithan8/tauticord/.schema/config_v2.schema.json","$schema":"http://json-schema.org/draft-07/schema#","$comment":"https://github.com/nwithan8/tauticord","title":"Tauticord Config v2 Schema","type":"object","additionalProperties":true,"definitions":{"emptyString":{"id":"#/definitions/emptyString","type":"string","pattern":"^$"},"emptyableString":{"id":"#/definitions/emptyableString","oneOf":[{"$ref":"#/definitions/emptyString"},{"type":"string"}]},"numberZero":{"id":"#/definitions/numberZero","type":"number","minimum":0,"maximum":0},"positiveInteger":{"id":"#/definitions/positiveInteger","type":"integer","minimum":1},"hostWithIpAndOptionalPort":{"id":"#/definitions/hostWithIpAndOptionalPort","type":"string","pattern":"^(https?://)?[a-zA-Z0-9.-]+(:[0-9]{1,5})?$"},"discordBotToken":{"id":"#/definitions/discordBotToken","type":"string","pattern":"^[MNO][a-zA-Z\\d_-]{23,25}\\.[a-zA-Z\\d_-]{6}\\.[a-zA-Z\\d_-]{27,}$","description":"A Discord Bot Token","$comment":"https://github.com/Yelp/detect-secrets/blob/master/detect_secrets/plugins/discord.py#L17C22-L17C81"},"discordChannelId":{"id":"#/definitions/discordChannelId","description":"A Discord channel ID","type":"string","pattern":"^[0-9]{17,20}$"},"discordUserId":{"id":"#/definitions/discordUserId","description":"A Discord user ID","type":"string","pattern":"^[0-9]{17,20}$"},"discordServerId":{"id":"#/definitions/discordServerId","description":"A Discord server ID","type":"string","pattern":"^[0-9]{17,20}$"},"discordTextChannelName":{"id":"#/definitions/discordTextChannelName","description":"A Discord text channel name. No emojis allowed.","type":"string","pattern":"^[a-z0-9-]{2,100}$","$comment":"Cannot contain spaces or uppercase letters"},"discordVoiceChannelName":{"id":"#/definitions/discordVoiceChannelName","description":"A Discord voice channel name. No emojis allowed.","type":"string","pattern":"^[a-zA-Z0-9-_ ]{2,100}$"},"discordCategoryName":{"id":"#/definitions/discordCategoryName","description":"A Discord category name. No emojis allowed.","type":"string","pattern":"^[a-zA-Z0-9-_ ]{2,100}$"},"tautulliApiKey":{"id":"#/definitions/tautulliApiKey","description":"A Tautulli API key","type":"string","pattern":"^[a-zA-Z0-9]{32}$"},"tautulliUrl":{"id":"#/definitions/tautulliUrl","description":"A Tautulli URL","$ref":"#/definitions/hostWithIpAndOptionalPort"},"voiceChannel":{"id":"#/definitions/voiceChannel","type":"object","properties":{"CustomName":{"description":"The custom name to use for the voice channel (overrides the default name)","oneOf":[{"$ref":"#/definitions/discordVoiceChannelName"},{"$ref":"#/definitions/emptyString"}]},"CustomEmoji":{"description":"The custom emoji to use for the voice channel (overrides the default emoji)","type":"string"},"Enable":{"description":"Whether to enable the voice channel","type":"boolean"},"VoiceChannelID":{"description":"The ID of the voice channel","oneOf":[{"$ref":"#/definitions/discordChannelId"},{"$ref":"#/definitions/numberZero"}]}},"required":["CustomName","CustomEmoji","Enable","VoiceChannelID"]},"recentlyAddedVoiceChannel":{"id":"#/definitions/voiceChannel","type":"object","properties":{"CustomName":{"description":"The custom name to use for the voice channel (overrides the default name)","oneOf":[{"$ref":"#/definitions/discordVoiceChannelName"},{"$ref":"#/definitions/emptyString"}]},"CustomEmoji":{"description":"The custom emoji to use for the voice channel (overrides the default emoji)","type":"string"},"Enable":{"description":"Whether to enable the voice channel","type":"boolean"},"VoiceChannelID":{"description":"The ID of the voice channel","oneOf":[{"$ref":"#/definitions/discordChannelId"},{"$ref":"#/definitions/numberZero"}]},"Hours":{"description":"The number of hours to look back for recently added items","type":"integer","minimum":1}},"required":["CustomName","CustomEmoji","Enable","VoiceChannelID","Hours"]},"library":{"id":"#/definitions/library","type":"object","properties":{"Name":{"description":"The name of the library as it appears in Plex","type":"string"},"ID":{"description":"The ID of the library as it appears in Tautulli. Use if the library name is not unique","oneOf":[{"$ref":"#/definitions/positiveInteger"},{"$ref":"#/definitions/numberZero"}]},"AlternateName":{"description":"An alternate name for the library (used as the voice channel name)","oneOf":[{"$ref":"#/definitions/discordVoiceChannelName"},{"$ref":"#/definitions/emptyString"}]},"Albums":{"description":"Settings for the voice channel about album information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"Artists":{"description":"Settings for the voice channel about artist information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"Episodes":{"description":"Settings for the voice channel about episode information (used if the library is a TV show library)","$ref":"#/definitions/voiceChannel"},"Movies":{"description":"Settings for the voice channel about movie information (used if the library is a movie library)","$ref":"#/definitions/voiceChannel"},"Series":{"description":"Settings for the voice channel about series/show information (used if the library is a TV show library)","$ref":"#/definitions/voiceChannel"},"Tracks":{"description":"Settings for the voice channel about track information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"RecentlyAdded":{"description":"Settings for the voice channel about recently added items","$ref":"#/definitions/recentlyAddedVoiceChannel"}},"required":["Name","AlternateName"]},"combinedLibrarySubLibrary":{"id":"#/definitions/combinedLibrarySubLibrary","type":"object","properties":{"Name":{"description":"The name of the library as it appears in Tautulli","type":"string"},"ID":{"description":"The ID of the library as it appears in Tautulli. Use if the library name is not unique","oneOf":[{"$ref":"#/definitions/positiveInteger"},{"$ref":"#/definitions/numberZero"}]}},"required":["Name"]},"combinedLibrary":{"id":"#/definitions/combinedLibrary","type":"object","properties":{"Name":{"description":"The name for the combined library (used as the voice channel name)","oneOf":[{"$ref":"#/definitions/discordVoiceChannelName"},{"$ref":"#/definitions/emptyString"}]},"Libraries":{"description":"The libraries to combine","type":"array","items":{"$ref":"#/definitions/combinedLibrarySubLibrary"}},"Albums":{"description":"Settings for the voice channel about album information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"Artists":{"description":"Settings for the voice channel about artist information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"Episodes":{"description":"Settings for the voice channel about episode information (used if the library is a TV show library)","$ref":"#/definitions/voiceChannel"},"Movies":{"description":"Settings for the voice channel about movie information (used if the library is a movie library)","$ref":"#/definitions/voiceChannel"},"Series":{"description":"Settings for the voice channel about series/show information (used if the library is a TV show library)","$ref":"#/definitions/voiceChannel"},"Tracks":{"description":"Settings for the voice channel about track information (used if the library is a music library)","$ref":"#/definitions/voiceChannel"},"RecentlyAdded":{"description":"Settings for the voice channel about recently added items","$ref":"#/definitions/recentlyAddedVoiceChannel"}},"required":["Name","Libraries"]}},"properties":{"Tautulli":{"title":"Tautulli configuration","description":"Settings for the Tautulli instance","type":"object","properties":{"URL":{"title":"Tautulli URL","description":"The URL of the Tautulli instance","$ref":"#/definitions/tautulliUrl"},"APIKey":{"title":"Tautulli API key","description":"The API key for the Tautulli instance","$ref":"#/definitions/tautulliApiKey"},"UseSelfSignedCert":{"title":"Use self-signed certificate","description":"Whether to use a self-signed certificate for the Tautulli instance (ignore SSL warnings)","type":"boolean"},"RefreshSeconds":{"title":"Activity data refresh interval","description":"How often, in seconds, the bot pulls new live activity data. A 5-second minimum is built-in; it's for your own good","type":"integer","minimum":5,"multipleOf":5},"TerminateMessage":{"title":"Stream termination message","description":"The message to send when a stream is terminated","type":"string"}},"required":["URL","APIKey","UseSelfSignedCert","RefreshSeconds","TerminateMessage"]},"Discord":{"title":"Discord configuration","description":"Settings for the Discord bot and server","type":"object","properties":{"BotToken":{"title":"Discord bot token","description":"The token for the Discord bot","$ref":"#/definitions/discordBotToken"},"ServerID":{"title":"Discord server ID","description":"The ID of the Discord server where the bot will be used","$ref":"#/definitions/discordServerId"},"AdminIDs":{"title":"Admin IDs","description":"The IDs of the Discord users who will have admin permissions","type":"array","items":{"$ref":"#/definitions/discordUserId"}},"PostSummaryMessage":{"title":"Post summary message","description":"Whether to post a summary message in the activity summary channel","type":"boolean"},"ChannelName":{"title":"Activity summary channel name","description":"The name of the channel where the bot will post messages","$ref":"#/definitions/discordTextChannelName"},"EnableTermination":{"title":"Enable stream termination","description":"Whether to enable stream termination","type":"boolean"},"EnableSlashCommands":{"title":"Enable slash commands","description":"Whether to enable slash commands for the bot","type":"boolean"},"StatusMessage":{"title":"Bot Discord activity status","description":"Settings regarding the bot's Discord status/activity","type":"object","properties":{"Enable":{"title":"Enable bot activity status","description":"Whether to enable the bot's activity status","type":"boolean"},"CustomMessage":{"title":"Custom activity status message","description":"Display a custom activity status message. Overrides default if not-empty","type":"string"},"ShowStreamCount":{"title":"Show active stream count","description":"Whether to display current active stream count in activity status message","type":"boolean"}}}},"required":["BotToken","ServerID","AdminIDs","PostSummaryMessage","ChannelName","EnableSlashCommands"]},"Display":{"title":"Display configuration","description":"Settings for how the bot displays information","type":"object","properties":{"Anonymize":{"title":"Anonymization settings","description":"Settings for anonymizing user information","type":"object","properties":{"HideBandwidth":{"title":"Hide bandwidth","description":"Whether to hide bandwidth information","type":"boolean"},"HideETA":{"title":"Hide ETA","description":"Whether to hide ETAs for streams","type":"boolean"},"HidePlatforms":{"title":"Hide platforms","description":"Whether to hide stream platform information","type":"boolean"},"HidePlayerNames":{"title":"Hide player names","description":"Whether to hide stream player names","type":"boolean"},"HideProgress":{"title":"Hide progress","description":"Whether to hide stream progress","type":"boolean"},"HideQuality":{"title":"Hide quality","description":"Whether to hide stream quality information","type":"boolean"},"HideTranscode":{"title":"Hide transcode","description":"Whether to hide stream transcoding information","type":"boolean"},"HideUsernames":{"title":"Hide usernames","description":"Whether to hide Plex usernames","type":"boolean"}},"required":["HideBandwidth","HideETA","HidePlatforms","HidePlayerNames","HideProgress","HideQuality","HideTranscode","HideUsernames"]},"ServerName":{"title":"Server name","description":"The name of the Plex server","type":"string"},"ThousandsSeparator":{"title":"Thousands separator","description":"The character to use as a numerical thousands separator","type":"string"},"Time":{"title":"Time settings","description":"Settings for how the bot handles time","type":"object","properties":{},"required":[]},"UseFriendlyNames":{"title":"Use friendly names","description":"Whether to use Plex user names instead of Plex usernames","type":"boolean"}},"required":["Anonymize","ServerName","ThousandsSeparator","Time","UseFriendlyNames"]},"Extras":{"title":"Extras configuration","description":"Extra settings for the bot","type":"object","properties":{"AllowAnalytics":{"title":"Allow analytics","description":"Whether to allow the bot to collect and send analytics data","type":"boolean"},"EnableUpdateReminders":{"title":"Enable update reminders","description":"Whether to enable update reminders","type":"boolean"}},"required":["AllowAnalytics","EnableUpdateReminders"]},"Stats":{"title":"Stats configuration","description":"Settings for the bot's stat tracking features (via voice channels)","type":"object","properties":{"Activity":{"title":"Activity stats settings","type":"object","properties":{"CategoryName":{"title":"Category name","description":"The name of the category for activity stats","$ref":"#/definitions/discordCategoryName"},"Enable":{"title":"Enable activity stats","description":"Whether to enable activity stats","type":"boolean"},"StatTypes":{"title":"Stat types","description":"The types of activity stats to track","type":"object","properties":{"Bandwidth":{"title":"Bandwidth","description":"Settings for bandwidth stats","$ref":"#/definitions/voiceChannel"},"LocalBandwidth":{"title":"Local bandwidth","description":"Settings for local bandwidth stats","type":"object","$ref":"#/definitions/voiceChannel"},"PlexServerAvailability":{"title":"Plex server availability","description":"Settings for Plex server availability stats","type":"object","$ref":"#/definitions/voiceChannel"},"RemoteBandwidth":{"title":"Remote bandwidth","description":"Settings for remote bandwidth stats","type":"object","$ref":"#/definitions/voiceChannel"},"StreamCount":{"title":"Stream count","description":"Settings for stream count stats","type":"object","$ref":"#/definitions/voiceChannel"},"TranscodeCount":{"title":"Transcode count","description":"Settings for transcode count stats","type":"object","$ref":"#/definitions/voiceChannel"}},"required":["Bandwidth","LocalBandwidth","PlexServerAvailability","RemoteBandwidth","StreamCount","TranscodeCount"]}},"required":["CategoryName","Enable","StatTypes"]},"Libraries":{"title":"Library stats settings","description":"Settings for Plex library stats","type":"object","properties":{"Enable":{"title":"Enable library stats","description":"Whether to enable library stats","type":"boolean"},"CategoryName":{"title":"Category name","description":"The name of the category for library stats","$ref":"#/definitions/discordCategoryName"},"RefreshSeconds":{"title":"Library data refresh interval","description":"How often, in seconds, the bot pulls new library data. A 5-minute minimum is built-in; it's for your own good","type":"integer","minimum":300,"multipleOf":5},"Libraries":{"title":"Libraries","description":"Libraries to track","type":"array","items":{"$ref":"#/definitions/library"}},"CombinedLibraries":{"title":"Combined libraries","description":"Combined libraries to track","type":"array","items":{"$ref":"#/definitions/combinedLibrary"}}},"required":["Enable","CategoryName","RefreshSeconds","Libraries","CombinedLibraries"]},"Performance":{"title":"Performance stats settings","description":"Settings for performance stats","type":"object","properties":{"CategoryName":{"title":"Category name","description":"The name of the category for performance stats","$ref":"#/definitions/discordCategoryName"},"Enable":{"title":"Enable performance stats","description":"Whether to enable performance stats","type":"boolean"},"Metrics":{"title":"Metrics","description":"The performance metrics to track","type":"object","properties":{"CPU":{"title":"CPU","description":"Settings for CPU stats","type":"object","$ref":"#/definitions/voiceChannel"},"DiskSpace":{"title":"Disk space","description":"Settings for disk space stats","type":"object","$ref":"#/definitions/voiceChannel"},"Memory":{"title":"Memory","description":"Settings for memory stats","type":"object","$ref":"#/definitions/voiceChannel"},"UserCount":{"title":"User count","description":"Settings for user count stats","type":"object","$ref":"#/definitions/voiceChannel"}},"required":["CPU","DiskSpace","Memory","UserCount"]}},"required":["CategoryName","Enable","Metrics"]}},"required":["Activity","Libraries","Performance"]}},"required":["Tautulli","Discord","Display","Stats","Extras"]}
|
Provide a JSON object that satisfies the schema "Tauticord Config v2 Schema". Here are the required top‑level fields: Tautulli, Discord, Display, Stats, Extras. Return only the valid JSON object.
|
Tauticord Config v2 Schema
|
schema-store
|
schema_store_210
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"DstackConfigurationRequest\",\"discriminator\":{\"propertyName\":\"type\",\"mapping\":{\"dev-environment\":\"#/definitions/DevEnvironmentConfigurationRequest\",\"task\":\"#/definitions/TaskConfigurationRequest\",\"service\":\"#/definitions/ServiceConfigurationRequest\",\"fleet\":\"#/definitions/FleetConfigurationRequest\",\"gateway\":\"#/definitions/GatewayConfigurationRequest\",\"volume\":\"#/definitions/VolumeConfigurationRequest\"}},\"oneOf\":[{\"$ref\":\"#/definitions/DevEnvironmentConfigurationRequest\"},{\"$ref\":\"#/definitions/TaskConfigurationRequest\"},{\"$ref\":\"#/definitions/ServiceConfigurationRequest\"},{\"$ref\":\"#/definitions/FleetConfigurationRequest\"},{\"$ref\":\"#/definitions/GatewayConfigurationRequest\"},{\"$ref\":\"#/definitions/VolumeConfigurationRequest\"}],\"additionalProperties\":true,\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"RegistryAuthRequest\":{\"title\":\"RegistryAuthRequest\",\"description\":\"Credentials for pulling a private Docker image.\\n\\nAttributes:\\n username (str): The username\\n password (str): The password or access token\",\"type\":\"object\",\"properties\":{\"username\":{\"title\":\"Username\",\"description\":\"The username\",\"type\":\"string\"},\"password\":{\"title\":\"Password\",\"description\":\"The password or access token\",\"type\":\"string\"}},\"required\":[\"username\",\"password\"],\"additionalProperties\":false},\"PythonVersion\":{\"title\":\"PythonVersion\",\"description\":\"An enumeration.\",\"enum\":[\"3.9\",\"3.10\",\"3.11\",\"3.12\",\"3.13\"],\"type\":\"string\"},\"EnvSentinelRequest\":{\"title\":\"EnvSentinelRequest\",\"type\":\"object\",\"properties\":{\"key\":{\"title\":\"Key\",\"type\":\"string\"}},\"required\":[\"key\"],\"additionalProperties\":false},\"Env\":{\"title\":\"Env\",\"description\":\"Env represents a mapping of process environment variables, as in environ(7).\\nEnvironment values may be omitted, in that case the :class:`EnvSentinel`\\nobject is used as a placeholder.\\n\\nTo create an instance from a `dict[str, str]` or a `list[str]` use pydantic's\\n:meth:`BaseModel.parse_obj(dict | list)` method.\\n\\nNB: this is *NOT* a CoreModel, pydantic-duality, which is used as a base\\nfor the CoreModel, doesn't play well with custom root models.\",\"default\":{},\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/EnvSentinelRequest\"}]}}]},\"CPUArchitecture\":{\"title\":\"CPUArchitecture\",\"description\":\"An enumeration.\",\"enum\":[\"x86\",\"arm\"],\"type\":\"string\"},\"Range_int_\":{\"title\":\"Range[int]\",\"type\":\"object\",\"properties\":{\"min\":{\"title\":\"Min\",\"type\":\"integer\"},\"max\":{\"title\":\"Max\",\"type\":\"integer\"}},\"additionalProperties\":false},\"CPUSpecRequest\":{\"title\":\"CPUSpecRequest\",\"type\":\"object\",\"properties\":{\"arch\":{\"description\":\"The CPU architecture, one of: `x86`, `arm`\",\"allOf\":[{\"$ref\":\"#/definitions/CPUArchitecture\"}]},\"count\":{\"title\":\"Count\",\"description\":\"The number of CPU cores\",\"default\":{\"min\":2,\"max\":null},\"anyOf\":[{\"$ref\":\"#/definitions/Range_int_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"additionalProperties\":false},\"Range_Memory_\":{\"title\":\"Range[Memory]\",\"type\":\"object\",\"properties\":{\"min\":{\"title\":\"Min\",\"type\":\"number\"},\"max\":{\"title\":\"Max\",\"type\":\"number\"}},\"additionalProperties\":false},\"AcceleratorVendor\":{\"title\":\"AcceleratorVendor\",\"description\":\"An enumeration.\",\"enum\":[\"nvidia\",\"amd\",\"google\",\"intel\",\"tenstorrent\"],\"type\":\"string\"},\"GPUSpecRequest\":{\"title\":\"GPUSpecRequest\",\"type\":\"object\",\"properties\":{\"vendor\":{\"description\":\"The vendor of the GPU/accelerator, one of: `nvidia`, `amd`, `google` (alias: `tpu`), `intel`\",\"allOf\":[{\"$ref\":\"#/definitions/AcceleratorVendor\"}]},\"name\":{\"title\":\"Name\",\"description\":\"The name of the GPU (e.g., `A100` or `H100`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"count\":{\"title\":\"Count\",\"description\":\"The number of GPUs\",\"default\":{\"min\":1,\"max\":null},\"anyOf\":[{\"$ref\":\"#/definitions/Range_int_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"memory\":{\"title\":\"Memory\",\"description\":\"The RAM size (e.g., `16GB`). Can be set to a range (e.g. `16GB..`, or `16GB..80GB`)\",\"anyOf\":[{\"$ref\":\"#/definitions/Range_Memory_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"total_memory\":{\"title\":\"Total Memory\",\"description\":\"The total RAM size (e.g., `32GB`). Can be set to a range (e.g. `16GB..`, or `16GB..80GB`)\",\"anyOf\":[{\"$ref\":\"#/definitions/Range_Memory_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"compute_capability\":{\"title\":\"Compute Capability\",\"description\":\"The minimum compute capability of the GPU (e.g., `7.5`)\",\"type\":\"array\",\"items\":{}}},\"additionalProperties\":false},\"DiskSpecRequest\":{\"title\":\"DiskSpecRequest\",\"type\":\"object\",\"properties\":{\"size\":{\"title\":\"Size\",\"description\":\"Disk size\",\"anyOf\":[{\"$ref\":\"#/definitions/Range_Memory_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"required\":[\"size\"],\"additionalProperties\":false},\"ResourcesSpecRequest\":{\"title\":\"ResourcesSpecRequest\",\"type\":\"object\",\"properties\":{\"cpu\":{\"title\":\"Cpu\",\"description\":\"The CPU requirements\",\"default\":{\"arch\":null,\"count\":{\"min\":2,\"max\":null}},\"anyOf\":[{\"$ref\":\"#/definitions/CPUSpecRequest\"},{\"$ref\":\"#/definitions/Range_int_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"memory\":{\"title\":\"Memory\",\"description\":\"The RAM size (e.g., `8GB`)\",\"default\":{\"min\":8.0,\"max\":null},\"anyOf\":[{\"$ref\":\"#/definitions/Range_Memory_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"shm_size\":{\"title\":\"Shm Size\",\"description\":\"The size of shared memory (e.g., `8GB`). If you are using parallel communicating processes (e.g., dataloaders in PyTorch), you may need to configure this\",\"anyOf\":[{\"type\":\"number\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"gpu\":{\"title\":\"Gpu\",\"description\":\"The GPU requirements\",\"anyOf\":[{\"$ref\":\"#/definitions/GPUSpecRequest\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"disk\":{\"title\":\"Disk\",\"description\":\"The disk resources\",\"default\":{\"size\":{\"min\":100.0,\"max\":null}},\"anyOf\":[{\"$ref\":\"#/definitions/DiskSpecRequest\"},{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"additionalProperties\":false},\"VolumeMountPointRequest\":{\"title\":\"VolumeMountPointRequest\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The network volume name or the list of network volume names to mount. If a list is specified, one of the volumes in the list will be mounted. Specify volumes from different backends/regions to increase availability\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"path\":{\"title\":\"Path\",\"description\":\"The absolute container path to mount the volume at\",\"type\":\"string\"}},\"required\":[\"name\",\"path\"],\"additionalProperties\":false},\"InstanceMountPointRequest\":{\"title\":\"InstanceMountPointRequest\",\"type\":\"object\",\"properties\":{\"instance_path\":{\"title\":\"Instance Path\",\"description\":\"The absolute path on the instance (host)\",\"type\":\"string\"},\"path\":{\"title\":\"Path\",\"description\":\"The absolute path in the container\",\"type\":\"string\"},\"optional\":{\"title\":\"Optional\",\"description\":\"Allow running without this volume in backends that do not support instance volumes\",\"default\":false,\"type\":\"boolean\"}},\"required\":[\"instance_path\",\"path\"],\"additionalProperties\":false},\"FilePathMappingRequest\":{\"title\":\"FilePathMappingRequest\",\"type\":\"object\",\"properties\":{\"local_path\":{\"title\":\"Local Path\",\"description\":\"The path on the user's machine. Relative paths are resolved relative to the parent directory of the the configuration file\",\"type\":\"string\"},\"path\":{\"title\":\"Path\",\"description\":\"The path in the container. Relative paths are resolved relative to the repo directory (`/workflow`)\",\"type\":\"string\"}},\"required\":[\"local_path\",\"path\"],\"additionalProperties\":false},\"PortMappingRequest\":{\"title\":\"PortMappingRequest\",\"type\":\"object\",\"properties\":{\"local_port\":{\"title\":\"Local Port\",\"exclusiveMinimum\":0,\"maximum\":65536,\"type\":\"integer\"},\"container_port\":{\"title\":\"Container Port\",\"exclusiveMinimum\":0,\"maximum\":65536,\"type\":\"integer\"}},\"required\":[\"container_port\"],\"additionalProperties\":false},\"BackendType\":{\"title\":\"BackendType\",\"description\":\"Attributes:\\n AWS (BackendType): Amazon Web Services\\n AZURE (BackendType): Microsoft Azure\\n CLOUDRIFT (BackendType): CloudRift\\n CUDO (BackendType): Cudo\\n DSTACK (BackendType): dstack Sky\\n GCP (BackendType): Google Cloud Platform\\n DATACRUNCH (BackendType): DataCrunch\\n KUBERNETES (BackendType): Kubernetes\\n LAMBDA (BackendType): Lambda Cloud\\n NEBIUS (BackendType): Nebius AI Cloud\\n OCI (BackendType): Oracle Cloud Infrastructure\\n RUNPOD (BackendType): Runpod Cloud\\n TENSORDOCK (BackendType): TensorDock Marketplace\\n VASTAI (BackendType): Vast.ai Marketplace\\n VULTR (BackendType): Vultr\",\"enum\":[\"aws\",\"azure\",\"cloudrift\",\"cudo\",\"datacrunch\",\"dstack\",\"gcp\",\"kubernetes\",\"lambda\",\"local\",\"remote\",\"nebius\",\"oci\",\"runpod\",\"tensordock\",\"vastai\",\"vultr\"],\"type\":\"string\"},\"SpotPolicy\":{\"title\":\"SpotPolicy\",\"description\":\"An enumeration.\",\"enum\":[\"spot\",\"on-demand\",\"auto\"],\"type\":\"string\"},\"RetryEvent\":{\"title\":\"RetryEvent\",\"description\":\"An enumeration.\",\"enum\":[\"no-capacity\",\"interruption\",\"error\"],\"type\":\"string\"},\"ProfileRetryRequest\":{\"title\":\"ProfileRetryRequest\",\"type\":\"object\",\"properties\":{\"on_events\":{\"description\":\"The list of events that should be handled with retry. Supported events are `no-capacity`, `interruption`, `error`. Omit to retry on all events\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/RetryEvent\"}},\"duration\":{\"title\":\"Duration\",\"description\":\"The maximum period of retrying the run, e.g., `4h` or `1d`\",\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"additionalProperties\":false},\"CreationPolicy\":{\"title\":\"CreationPolicy\",\"description\":\"An enumeration.\",\"enum\":[\"reuse\",\"reuse-or-create\"],\"type\":\"string\"},\"UtilizationPolicyRequest\":{\"title\":\"UtilizationPolicyRequest\",\"type\":\"object\",\"properties\":{\"min_gpu_utilization\":{\"title\":\"Min Gpu Utilization\",\"description\":\"Minimum required GPU utilization, percent. If any GPU has utilization below specified value during the whole time window, the run is terminated\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"time_window\":{\"title\":\"Time Window\",\"description\":\"The time window of metric samples taking into account to measure utilization (e.g., `30m`, `1h`). Minimum is `5m`\",\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"required\":[\"min_gpu_utilization\",\"time_window\"],\"additionalProperties\":false},\"StartupOrder\":{\"title\":\"StartupOrder\",\"description\":\"An enumeration.\",\"enum\":[\"any\",\"master-first\",\"workers-first\"],\"type\":\"string\"},\"StopCriteria\":{\"title\":\"StopCriteria\",\"description\":\"An enumeration.\",\"enum\":[\"all-done\",\"master-done\"],\"type\":\"string\"},\"ProfileRetryPolicyRequest\":{\"title\":\"ProfileRetryPolicyRequest\",\"type\":\"object\",\"properties\":{\"retry\":{\"title\":\"Retry\",\"description\":\"Whether to retry the run on failure or not\",\"default\":false,\"type\":\"boolean\"},\"duration\":{\"title\":\"Duration\",\"description\":\"The maximum period of retrying the run, e.g., `4h` or `1d`\",\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]}},\"additionalProperties\":false},\"TerminationPolicy\":{\"title\":\"TerminationPolicy\",\"description\":\"An enumeration.\",\"enum\":[\"dont-destroy\",\"destroy-after-idle\"],\"type\":\"string\"},\"DevEnvironmentConfigurationRequest\":{\"title\":\"DevEnvironmentConfigurationRequest\",\"type\":\"object\",\"properties\":{\"ide\":{\"title\":\"Ide\",\"description\":\"The IDE to run. Supported values include `vscode` and `cursor`\",\"anyOf\":[{\"enum\":[\"vscode\"],\"type\":\"string\"},{\"enum\":[\"cursor\"],\"type\":\"string\"}]},\"version\":{\"title\":\"Version\",\"description\":\"The version of the IDE\",\"type\":\"string\"},\"init\":{\"title\":\"Init\",\"description\":\"The shell commands to run on startup\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"inactivity_duration\":{\"title\":\"Inactivity Duration\",\"description\":\"The maximum amount of time the dev environment can be inactive (e.g., `2h`, `1d`, etc). After it elapses, the dev environment is automatically stopped. Inactivity is defined as the absence of SSH connections to the dev environment, including VS Code connections, `ssh <run name>` shells, and attached `dstack apply` or `dstack attach` commands. Use `off` for unlimited duration. Can be updated in-place. Defaults to `off`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"},{\"type\":\"string\"}]},\"type\":{\"title\":\"Type\",\"default\":\"dev-environment\",\"enum\":[\"dev-environment\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The run name. If not specified, a random name is generated\",\"type\":\"string\"},\"image\":{\"title\":\"Image\",\"description\":\"The name of the Docker image to run\",\"type\":\"string\"},\"user\":{\"title\":\"User\",\"description\":\"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user\",\"type\":\"string\"},\"privileged\":{\"title\":\"Privileged\",\"description\":\"Run the container in privileged mode\",\"default\":false,\"type\":\"boolean\"},\"entrypoint\":{\"title\":\"Entrypoint\",\"description\":\"The Docker entrypoint\",\"type\":\"string\"},\"working_dir\":{\"title\":\"Working Dir\",\"description\":\"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\\\".\\\"` \",\"type\":\"string\"},\"home_dir\":{\"title\":\"Home Dir\",\"default\":\"/root\",\"type\":\"string\"},\"registry_auth\":{\"title\":\"Registry Auth\",\"description\":\"Credentials for pulling a private Docker image\",\"allOf\":[{\"$ref\":\"#/definitions/RegistryAuthRequest\"}]},\"python\":{\"description\":\"The major version of Python. Mutually exclusive with `image` and `docker`\",\"allOf\":[{\"$ref\":\"#/definitions/PythonVersion\"}]},\"nvcc\":{\"title\":\"Nvcc\",\"description\":\"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`\",\"type\":\"boolean\"},\"single_branch\":{\"title\":\"Single Branch\",\"description\":\"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services\",\"type\":\"boolean\"},\"env\":{\"title\":\"Env\",\"description\":\"The mapping or the list of environment variables\",\"default\":{\"__root__\":{}},\"allOf\":[{\"$ref\":\"#/definitions/Env\"}]},\"shell\":{\"title\":\"Shell\",\"description\":\"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise\",\"type\":\"string\"},\"resources\":{\"title\":\"Resources\",\"description\":\"The resources requirements to run the configuration\",\"default\":{\"cpu\":{\"min\":2,\"max\":null},\"memory\":{\"min\":8.0,\"max\":null},\"shm_size\":null,\"gpu\":null,\"disk\":{\"size\":{\"min\":100.0,\"max\":null}}},\"allOf\":[{\"$ref\":\"#/definitions/ResourcesSpecRequest\"}]},\"priority\":{\"title\":\"Priority\",\"description\":\"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"volumes\":{\"title\":\"Volumes\",\"description\":\"The volumes mount points\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeMountPointRequest\"},{\"$ref\":\"#/definitions/InstanceMountPointRequest\"},{\"type\":\"string\"}]}},\"docker\":{\"title\":\"Docker\",\"description\":\"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`\",\"type\":\"boolean\"},\"files\":{\"title\":\"Files\",\"description\":\"The local to container file path mappings\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FilePathMappingRequest\"},{\"type\":\"string\"}]}},\"setup\":{\"title\":\"Setup\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ports\":{\"title\":\"Ports\",\"description\":\"Port numbers/mapping to expose\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"integer\",\"exclusiveMinimum\":0,\"maximum\":65536},{\"type\":\"string\",\"pattern\":\"^(?:[0-9]+|\\\\*):[0-9]+$\"},{\"$ref\":\"#/definitions/PortMappingRequest\"}]}},\"backends\":{\"description\":\"The backends to consider for provisioning (e.g., `[aws, gcp]`)\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/BackendType\"}},\"regions\":{\"title\":\"Regions\",\"description\":\"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"availability_zones\":{\"title\":\"Availability Zones\",\"description\":\"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"instance_types\":{\"title\":\"Instance Types\",\"description\":\"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reservation\":{\"title\":\"Reservation\",\"description\":\"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks\",\"type\":\"string\"},\"spot_policy\":{\"description\":\"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`\",\"allOf\":[{\"$ref\":\"#/definitions/SpotPolicy\"}]},\"retry\":{\"title\":\"Retry\",\"description\":\"The policy for resubmitting the run. Defaults to `false`\",\"anyOf\":[{\"$ref\":\"#/definitions/ProfileRetryRequest\"},{\"type\":\"boolean\"}]},\"max_duration\":{\"title\":\"Max Duration\",\"description\":\"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"stop_duration\":{\"title\":\"Stop Duration\",\"description\":\"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"max_price\":{\"title\":\"Max Price\",\"description\":\"The maximum instance price per hour, in dollars\",\"exclusiveMinimum\":0.0,\"type\":\"number\"},\"creation_policy\":{\"description\":\"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`\",\"allOf\":[{\"$ref\":\"#/definitions/CreationPolicy\"}]},\"idle_duration\":{\"title\":\"Idle Duration\",\"description\":\"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"utilization_policy\":{\"title\":\"Utilization Policy\",\"description\":\"Run termination policy based on utilization\",\"allOf\":[{\"$ref\":\"#/definitions/UtilizationPolicyRequest\"}]},\"startup_order\":{\"description\":\"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`\",\"allOf\":[{\"$ref\":\"#/definitions/StartupOrder\"}]},\"stop_criteria\":{\"description\":\"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`\",\"allOf\":[{\"$ref\":\"#/definitions/StopCriteria\"}]},\"fleets\":{\"title\":\"Fleets\",\"description\":\"The fleets considered for reuse\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"required\":[\"ide\"],\"additionalProperties\":false},\"TaskConfigurationRequest\":{\"title\":\"TaskConfigurationRequest\",\"type\":\"object\",\"properties\":{\"nodes\":{\"title\":\"Nodes\",\"description\":\"Number of nodes\",\"default\":1,\"minimum\":1,\"type\":\"integer\"},\"type\":{\"title\":\"Type\",\"default\":\"task\",\"enum\":[\"task\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The run name. If not specified, a random name is generated\",\"type\":\"string\"},\"image\":{\"title\":\"Image\",\"description\":\"The name of the Docker image to run\",\"type\":\"string\"},\"user\":{\"title\":\"User\",\"description\":\"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user\",\"type\":\"string\"},\"privileged\":{\"title\":\"Privileged\",\"description\":\"Run the container in privileged mode\",\"default\":false,\"type\":\"boolean\"},\"entrypoint\":{\"title\":\"Entrypoint\",\"description\":\"The Docker entrypoint\",\"type\":\"string\"},\"working_dir\":{\"title\":\"Working Dir\",\"description\":\"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\\\".\\\"` \",\"type\":\"string\"},\"home_dir\":{\"title\":\"Home Dir\",\"default\":\"/root\",\"type\":\"string\"},\"registry_auth\":{\"title\":\"Registry Auth\",\"description\":\"Credentials for pulling a private Docker image\",\"allOf\":[{\"$ref\":\"#/definitions/RegistryAuthRequest\"}]},\"python\":{\"description\":\"The major version of Python. Mutually exclusive with `image` and `docker`\",\"allOf\":[{\"$ref\":\"#/definitions/PythonVersion\"}]},\"nvcc\":{\"title\":\"Nvcc\",\"description\":\"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`\",\"type\":\"boolean\"},\"single_branch\":{\"title\":\"Single Branch\",\"description\":\"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services\",\"type\":\"boolean\"},\"env\":{\"title\":\"Env\",\"description\":\"The mapping or the list of environment variables\",\"default\":{\"__root__\":{}},\"allOf\":[{\"$ref\":\"#/definitions/Env\"}]},\"shell\":{\"title\":\"Shell\",\"description\":\"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise\",\"type\":\"string\"},\"resources\":{\"title\":\"Resources\",\"description\":\"The resources requirements to run the configuration\",\"default\":{\"cpu\":{\"min\":2,\"max\":null},\"memory\":{\"min\":8.0,\"max\":null},\"shm_size\":null,\"gpu\":null,\"disk\":{\"size\":{\"min\":100.0,\"max\":null}}},\"allOf\":[{\"$ref\":\"#/definitions/ResourcesSpecRequest\"}]},\"priority\":{\"title\":\"Priority\",\"description\":\"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"volumes\":{\"title\":\"Volumes\",\"description\":\"The volumes mount points\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeMountPointRequest\"},{\"$ref\":\"#/definitions/InstanceMountPointRequest\"},{\"type\":\"string\"}]}},\"docker\":{\"title\":\"Docker\",\"description\":\"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`\",\"type\":\"boolean\"},\"files\":{\"title\":\"Files\",\"description\":\"The local to container file path mappings\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FilePathMappingRequest\"},{\"type\":\"string\"}]}},\"setup\":{\"title\":\"Setup\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ports\":{\"title\":\"Ports\",\"description\":\"Port numbers/mapping to expose\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"integer\",\"exclusiveMinimum\":0,\"maximum\":65536},{\"type\":\"string\",\"pattern\":\"^(?:[0-9]+|\\\\*):[0-9]+$\"},{\"$ref\":\"#/definitions/PortMappingRequest\"}]}},\"commands\":{\"title\":\"Commands\",\"description\":\"The shell commands to run\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"backends\":{\"description\":\"The backends to consider for provisioning (e.g., `[aws, gcp]`)\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/BackendType\"}},\"regions\":{\"title\":\"Regions\",\"description\":\"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"availability_zones\":{\"title\":\"Availability Zones\",\"description\":\"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"instance_types\":{\"title\":\"Instance Types\",\"description\":\"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reservation\":{\"title\":\"Reservation\",\"description\":\"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks\",\"type\":\"string\"},\"spot_policy\":{\"description\":\"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`\",\"allOf\":[{\"$ref\":\"#/definitions/SpotPolicy\"}]},\"retry\":{\"title\":\"Retry\",\"description\":\"The policy for resubmitting the run. Defaults to `false`\",\"anyOf\":[{\"$ref\":\"#/definitions/ProfileRetryRequest\"},{\"type\":\"boolean\"}]},\"max_duration\":{\"title\":\"Max Duration\",\"description\":\"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"stop_duration\":{\"title\":\"Stop Duration\",\"description\":\"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"max_price\":{\"title\":\"Max Price\",\"description\":\"The maximum instance price per hour, in dollars\",\"exclusiveMinimum\":0.0,\"type\":\"number\"},\"creation_policy\":{\"description\":\"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`\",\"allOf\":[{\"$ref\":\"#/definitions/CreationPolicy\"}]},\"idle_duration\":{\"title\":\"Idle Duration\",\"description\":\"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"utilization_policy\":{\"title\":\"Utilization Policy\",\"description\":\"Run termination policy based on utilization\",\"allOf\":[{\"$ref\":\"#/definitions/UtilizationPolicyRequest\"}]},\"startup_order\":{\"description\":\"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`\",\"allOf\":[{\"$ref\":\"#/definitions/StartupOrder\"}]},\"stop_criteria\":{\"description\":\"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`\",\"allOf\":[{\"$ref\":\"#/definitions/StopCriteria\"}]},\"fleets\":{\"title\":\"Fleets\",\"description\":\"The fleets considered for reuse\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"TGIChatModelRequest\":{\"title\":\"TGIChatModelRequest\",\"description\":\"Mapping of the model for the OpenAI-compatible endpoint.\\n\\nAttributes:\\n type (str): The type of the model, e.g. \\\"chat\\\"\\n name (str): The name of the model. This name will be used both to load model configuration from the HuggingFace Hub and in the OpenAI-compatible endpoint.\\n format (str): The format of the model, e.g. \\\"tgi\\\" if the model is served with HuggingFace's Text Generation Inference.\\n chat_template (Optional[str]): The custom prompt template for the model. If not specified, the default prompt template from the HuggingFace Hub configuration will be used.\\n eos_token (Optional[str]): The custom end of sentence token. If not specified, the default end of sentence token from the HuggingFace Hub configuration will be used.\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"The type of the model\",\"default\":\"chat\",\"enum\":[\"chat\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the model\",\"type\":\"string\"},\"format\":{\"title\":\"Format\",\"description\":\"The serving format. Must be set to `tgi`\",\"enum\":[\"tgi\"],\"type\":\"string\"},\"chat_template\":{\"title\":\"Chat Template\",\"description\":\"The custom prompt template for the model. If not specified, the default prompt template from the HuggingFace Hub configuration will be used\",\"type\":\"string\"},\"eos_token\":{\"title\":\"Eos Token\",\"description\":\"The custom end of sentence token. If not specified, the default end of sentence token from the HuggingFace Hub configuration will be used\",\"type\":\"string\"}},\"required\":[\"name\",\"format\"],\"additionalProperties\":false},\"OpenAIChatModelRequest\":{\"title\":\"OpenAIChatModelRequest\",\"description\":\"Mapping of the model for the OpenAI-compatible endpoint.\\n\\nAttributes:\\n type (str): The type of the model, e.g. \\\"chat\\\"\\n name (str): The name of the model. This name will be used both to load model configuration from the HuggingFace Hub and in the OpenAI-compatible endpoint.\\n format (str): The format of the model, i.e. \\\"openai\\\".\\n prefix (str): The `base_url` prefix: `http://hostname/{prefix}/chat/completions`. Defaults to `/v1`.\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"The type of the model\",\"default\":\"chat\",\"enum\":[\"chat\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the model\",\"type\":\"string\"},\"format\":{\"title\":\"Format\",\"description\":\"The serving format. Must be set to `openai`\",\"enum\":[\"openai\"],\"type\":\"string\"},\"prefix\":{\"title\":\"Prefix\",\"description\":\"The `base_url` prefix (after hostname)\",\"default\":\"/v1\",\"type\":\"string\"}},\"required\":[\"name\",\"format\"],\"additionalProperties\":false},\"ScalingSpecRequest\":{\"title\":\"ScalingSpecRequest\",\"type\":\"object\",\"properties\":{\"metric\":{\"title\":\"Metric\",\"description\":\"The target metric to track. Currently, the only supported value is `rps` (meaning requests per second)\",\"enum\":[\"rps\"],\"type\":\"string\"},\"target\":{\"title\":\"Target\",\"description\":\"The target value of the metric. The number of replicas is calculated based on this number and automatically adjusts (scales up or down) as this metric changes\",\"exclusiveMinimum\":0,\"type\":\"number\"},\"scale_up_delay\":{\"title\":\"Scale Up Delay\",\"description\":\"The delay in seconds before scaling up\",\"default\":300,\"type\":\"integer\"},\"scale_down_delay\":{\"title\":\"Scale Down Delay\",\"description\":\"The delay in seconds before scaling down\",\"default\":600,\"type\":\"integer\"}},\"required\":[\"metric\",\"target\"],\"additionalProperties\":false},\"IPAddressPartitioningKeyRequest\":{\"title\":\"IPAddressPartitioningKeyRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"Partitioning type\",\"default\":\"ip_address\",\"enum\":[\"ip_address\"],\"type\":\"string\"}},\"additionalProperties\":false},\"HeaderPartitioningKeyRequest\":{\"title\":\"HeaderPartitioningKeyRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"Partitioning type\",\"default\":\"header\",\"enum\":[\"header\"],\"type\":\"string\"},\"header\":{\"title\":\"Header\",\"description\":\"Name of the header to use for partitioning\",\"maxLength\":500,\"pattern\":\"^[a-zA-Z0-9-_]+$\",\"type\":\"string\"}},\"required\":[\"header\"],\"additionalProperties\":false},\"RateLimitRequest\":{\"title\":\"RateLimitRequest\",\"type\":\"object\",\"properties\":{\"prefix\":{\"title\":\"Prefix\",\"description\":\"URL path prefix to which this limit is applied. If an incoming request matches several prefixes, the longest prefix is applied\",\"default\":\"/\",\"maxLength\":4094,\"pattern\":\"^/[^\\\\s\\\\\\\\{}]*$\",\"type\":\"string\"},\"key\":{\"title\":\"Key\",\"description\":\"The partitioning key. Each incoming request belongs to a partition and rate limits are applied per partition. Defaults to partitioning by client IP address\",\"default\":{\"type\":\"ip_address\"},\"discriminator\":{\"propertyName\":\"type\",\"mapping\":{\"ip_address\":\"#/definitions/IPAddressPartitioningKeyRequest\",\"header\":\"#/definitions/HeaderPartitioningKeyRequest\"}},\"oneOf\":[{\"$ref\":\"#/definitions/IPAddressPartitioningKeyRequest\"},{\"$ref\":\"#/definitions/HeaderPartitioningKeyRequest\"}]},\"rps\":{\"title\":\"Rps\",\"description\":\"Max allowed number of requests per second. Requests are tracked at millisecond granularity. For example, `rps: 10` means at most 1 request per 100ms\",\"minimum\":0.016666666666666666,\"maximum\":153722867280912930,\"type\":\"number\"},\"burst\":{\"title\":\"Burst\",\"description\":\"Max number of requests that can be passed to the service ahead of the rate limit\",\"default\":0,\"minimum\":0,\"maximum\":9223372036854775807,\"type\":\"integer\"}},\"required\":[\"rps\"],\"additionalProperties\":false},\"ServiceConfigurationRequest\":{\"title\":\"ServiceConfigurationRequest\",\"type\":\"object\",\"properties\":{\"port\":{\"title\":\"Port\",\"description\":\"The port, that application listens on or the mapping\",\"anyOf\":[{\"type\":\"integer\",\"exclusiveMinimum\":0,\"maximum\":65536},{\"type\":\"string\",\"pattern\":\"^[0-9]+:[0-9]+$\"},{\"$ref\":\"#/definitions/PortMappingRequest\"}]},\"gateway\":{\"title\":\"Gateway\",\"description\":\"The name of the gateway. Specify boolean `false` to run without a gateway. Omit to run with the default gateway\",\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\"}]},\"strip_prefix\":{\"title\":\"Strip Prefix\",\"description\":\"Strip the `/proxy/services/<project name>/<run name>/` path prefix when forwarding requests to the service. Only takes effect when running the service without a gateway\",\"default\":true,\"type\":\"boolean\"},\"model\":{\"title\":\"Model\",\"description\":\"Mapping of the model for the OpenAI-compatible endpoint provided by `dstack`. Can be a full model format definition or just a model name. If it's a name, the service is expected to expose an OpenAI-compatible API at the `/v1` path\",\"anyOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/TGIChatModelRequest\"},{\"$ref\":\"#/definitions/OpenAIChatModelRequest\"}]},{\"type\":\"string\"}]},\"https\":{\"title\":\"Https\",\"description\":\"Enable HTTPS if running with a gateway\",\"default\":true,\"type\":\"boolean\"},\"auth\":{\"title\":\"Auth\",\"description\":\"Enable the authorization\",\"default\":true,\"type\":\"boolean\"},\"replicas\":{\"title\":\"Replicas\",\"description\":\"The number of replicas. Can be a number (e.g. `2`) or a range (`0..4` or `1..8`). If it's a range, the `scaling` property is required\",\"default\":{\"min\":1,\"max\":1},\"anyOf\":[{\"type\":\"integer\",\"minimum\":1},{\"type\":\"string\",\"pattern\":\"^[0-9]+..[1-9][0-9]*$\"},{\"$ref\":\"#/definitions/Range_int_\"}]},\"scaling\":{\"title\":\"Scaling\",\"description\":\"The auto-scaling rules. Required if `replicas` is set to a range\",\"allOf\":[{\"$ref\":\"#/definitions/ScalingSpecRequest\"}]},\"rate_limits\":{\"title\":\"Rate Limits\",\"description\":\"Rate limiting rules\",\"default\":[],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/RateLimitRequest\"}},\"type\":{\"title\":\"Type\",\"default\":\"service\",\"enum\":[\"service\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The run name. If not specified, a random name is generated\",\"type\":\"string\"},\"image\":{\"title\":\"Image\",\"description\":\"The name of the Docker image to run\",\"type\":\"string\"},\"user\":{\"title\":\"User\",\"description\":\"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user\",\"type\":\"string\"},\"privileged\":{\"title\":\"Privileged\",\"description\":\"Run the container in privileged mode\",\"default\":false,\"type\":\"boolean\"},\"entrypoint\":{\"title\":\"Entrypoint\",\"description\":\"The Docker entrypoint\",\"type\":\"string\"},\"working_dir\":{\"title\":\"Working Dir\",\"description\":\"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\\\".\\\"` \",\"type\":\"string\"},\"home_dir\":{\"title\":\"Home Dir\",\"default\":\"/root\",\"type\":\"string\"},\"registry_auth\":{\"title\":\"Registry Auth\",\"description\":\"Credentials for pulling a private Docker image\",\"allOf\":[{\"$ref\":\"#/definitions/RegistryAuthRequest\"}]},\"python\":{\"description\":\"The major version of Python. Mutually exclusive with `image` and `docker`\",\"allOf\":[{\"$ref\":\"#/definitions/PythonVersion\"}]},\"nvcc\":{\"title\":\"Nvcc\",\"description\":\"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`\",\"type\":\"boolean\"},\"single_branch\":{\"title\":\"Single Branch\",\"description\":\"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services\",\"type\":\"boolean\"},\"env\":{\"title\":\"Env\",\"description\":\"The mapping or the list of environment variables\",\"default\":{\"__root__\":{}},\"allOf\":[{\"$ref\":\"#/definitions/Env\"}]},\"shell\":{\"title\":\"Shell\",\"description\":\"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise\",\"type\":\"string\"},\"resources\":{\"title\":\"Resources\",\"description\":\"The resources requirements to run the configuration\",\"default\":{\"cpu\":{\"min\":2,\"max\":null},\"memory\":{\"min\":8.0,\"max\":null},\"shm_size\":null,\"gpu\":null,\"disk\":{\"size\":{\"min\":100.0,\"max\":null}}},\"allOf\":[{\"$ref\":\"#/definitions/ResourcesSpecRequest\"}]},\"priority\":{\"title\":\"Priority\",\"description\":\"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"volumes\":{\"title\":\"Volumes\",\"description\":\"The volumes mount points\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeMountPointRequest\"},{\"$ref\":\"#/definitions/InstanceMountPointRequest\"},{\"type\":\"string\"}]}},\"docker\":{\"title\":\"Docker\",\"description\":\"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`\",\"type\":\"boolean\"},\"files\":{\"title\":\"Files\",\"description\":\"The local to container file path mappings\",\"default\":[],\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FilePathMappingRequest\"},{\"type\":\"string\"}]}},\"setup\":{\"title\":\"Setup\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"commands\":{\"title\":\"Commands\",\"description\":\"The shell commands to run\",\"default\":[],\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"backends\":{\"description\":\"The backends to consider for provisioning (e.g., `[aws, gcp]`)\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/BackendType\"}},\"regions\":{\"title\":\"Regions\",\"description\":\"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"availability_zones\":{\"title\":\"Availability Zones\",\"description\":\"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"instance_types\":{\"title\":\"Instance Types\",\"description\":\"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reservation\":{\"title\":\"Reservation\",\"description\":\"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks\",\"type\":\"string\"},\"spot_policy\":{\"description\":\"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`\",\"allOf\":[{\"$ref\":\"#/definitions/SpotPolicy\"}]},\"retry\":{\"title\":\"Retry\",\"description\":\"The policy for resubmitting the run. Defaults to `false`\",\"anyOf\":[{\"$ref\":\"#/definitions/ProfileRetryRequest\"},{\"type\":\"boolean\"}]},\"max_duration\":{\"title\":\"Max Duration\",\"description\":\"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"stop_duration\":{\"title\":\"Stop Duration\",\"description\":\"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"max_price\":{\"title\":\"Max Price\",\"description\":\"The maximum instance price per hour, in dollars\",\"exclusiveMinimum\":0.0,\"type\":\"number\"},\"creation_policy\":{\"description\":\"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`\",\"allOf\":[{\"$ref\":\"#/definitions/CreationPolicy\"}]},\"idle_duration\":{\"title\":\"Idle Duration\",\"description\":\"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}]},\"utilization_policy\":{\"title\":\"Utilization Policy\",\"description\":\"Run termination policy based on utilization\",\"allOf\":[{\"$ref\":\"#/definitions/UtilizationPolicyRequest\"}]},\"startup_order\":{\"description\":\"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`\",\"allOf\":[{\"$ref\":\"#/definitions/StartupOrder\"}]},\"stop_criteria\":{\"description\":\"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`\",\"allOf\":[{\"$ref\":\"#/definitions/StopCriteria\"}]},\"fleets\":{\"title\":\"Fleets\",\"description\":\"The fleets considered for reuse\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"required\":[\"port\"],\"additionalProperties\":false},\"SSHKeyRequest\":{\"title\":\"SSHKeyRequest\",\"type\":\"object\",\"properties\":{\"public\":{\"title\":\"Public\",\"type\":\"string\"},\"private\":{\"title\":\"Private\",\"type\":\"string\"}},\"required\":[\"public\"],\"additionalProperties\":false},\"SSHProxyParamsRequest\":{\"title\":\"SSHProxyParamsRequest\",\"type\":\"object\",\"properties\":{\"hostname\":{\"title\":\"Hostname\",\"description\":\"The IP address or domain of proxy host\",\"type\":\"string\"},\"port\":{\"title\":\"Port\",\"description\":\"The SSH port of proxy host\",\"type\":\"integer\"},\"user\":{\"title\":\"User\",\"description\":\"The user to log in with for proxy host\",\"type\":\"string\"},\"identity_file\":{\"title\":\"Identity File\",\"description\":\"The private key to use for proxy host\",\"type\":\"string\"},\"ssh_key\":{\"$ref\":\"#/definitions/SSHKeyRequest\"}},\"required\":[\"hostname\",\"user\",\"identity_file\"],\"additionalProperties\":false},\"SSHHostParamsRequest\":{\"title\":\"SSHHostParamsRequest\",\"type\":\"object\",\"properties\":{\"hostname\":{\"title\":\"Hostname\",\"description\":\"The IP address or domain to connect to\",\"type\":\"string\"},\"port\":{\"title\":\"Port\",\"description\":\"The SSH port to connect to for this host\",\"type\":\"integer\"},\"user\":{\"title\":\"User\",\"description\":\"The user to log in with for this host\",\"type\":\"string\"},\"identity_file\":{\"title\":\"Identity File\",\"description\":\"The private key to use for this host\",\"type\":\"string\"},\"proxy_jump\":{\"title\":\"Proxy Jump\",\"description\":\"The SSH proxy configuration for this host\",\"allOf\":[{\"$ref\":\"#/definitions/SSHProxyParamsRequest\"}]},\"internal_ip\":{\"title\":\"Internal Ip\",\"description\":\"The internal IP of the host used for communication inside the cluster. If not specified, `dstack` will use the IP address from `network` or from the first found internal network.\",\"type\":\"string\"},\"ssh_key\":{\"$ref\":\"#/definitions/SSHKeyRequest\"},\"blocks\":{\"title\":\"Blocks\",\"description\":\"The amount of blocks to split the instance into, a number or `auto`. `auto` means as many as possible. The number of GPUs and CPUs must be divisible by the number of blocks. Defaults to `1`, i.e. do not split\",\"default\":1,\"anyOf\":[{\"enum\":[\"auto\"],\"type\":\"string\"},{\"type\":\"integer\",\"minimum\":1}]}},\"required\":[\"hostname\"],\"additionalProperties\":false},\"SSHParamsRequest\":{\"title\":\"SSHParamsRequest\",\"type\":\"object\",\"properties\":{\"user\":{\"title\":\"User\",\"description\":\"The user to log in with on all hosts\",\"type\":\"string\"},\"port\":{\"title\":\"Port\",\"description\":\"The SSH port to connect to\",\"type\":\"integer\"},\"identity_file\":{\"title\":\"Identity File\",\"description\":\"The private key to use for all hosts\",\"type\":\"string\"},\"ssh_key\":{\"$ref\":\"#/definitions/SSHKeyRequest\"},\"proxy_jump\":{\"title\":\"Proxy Jump\",\"description\":\"The SSH proxy configuration for all hosts\",\"allOf\":[{\"$ref\":\"#/definitions/SSHProxyParamsRequest\"}]},\"hosts\":{\"title\":\"Hosts\",\"description\":\"The per host connection parameters: a hostname or an object that overrides default ssh parameters\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/SSHHostParamsRequest\"},{\"type\":\"string\"}]}},\"network\":{\"title\":\"Network\",\"description\":\"The network address for cluster setup in the format `<ip>/<netmask>`. `dstack` will use IP addresses from this network for communication between hosts. If not specified, `dstack` will use IPs from the first found internal network.\",\"type\":\"string\"}},\"required\":[\"hosts\"],\"additionalProperties\":false},\"InstanceGroupPlacement\":{\"title\":\"InstanceGroupPlacement\",\"description\":\"An enumeration.\",\"enum\":[\"any\",\"cluster\"],\"type\":\"string\"},\"FleetConfigurationRequest\":{\"title\":\"FleetConfigurationRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"default\":\"fleet\",\"enum\":[\"fleet\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The fleet name\",\"type\":\"string\"},\"env\":{\"title\":\"Env\",\"description\":\"The mapping or the list of environment variables\",\"default\":{\"__root__\":{}},\"allOf\":[{\"$ref\":\"#/definitions/Env\"}]},\"ssh_config\":{\"title\":\"Ssh Config\",\"description\":\"The parameters for adding instances via SSH\",\"allOf\":[{\"$ref\":\"#/definitions/SSHParamsRequest\"}]},\"nodes\":{\"title\":\"Nodes\",\"description\":\"The number of instances\",\"anyOf\":[{\"$ref\":\"#/definitions/Range_int_\"},{\"type\":\"integer\"},{\"type\":\"string\"}]},\"placement\":{\"description\":\"The placement of instances: `any` or `cluster`\",\"allOf\":[{\"$ref\":\"#/definitions/InstanceGroupPlacement\"}]},\"reservation\":{\"title\":\"Reservation\",\"description\":\"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks\",\"type\":\"string\"},\"resources\":{\"title\":\"Resources\",\"description\":\"The resources requirements\",\"default\":{\"cpu\":{\"min\":2,\"max\":null},\"memory\":{\"min\":8.0,\"max\":null},\"shm_size\":null,\"gpu\":null,\"disk\":{\"size\":{\"min\":100.0,\"max\":null}}},\"allOf\":[{\"$ref\":\"#/definitions/ResourcesSpecRequest\"}]},\"blocks\":{\"title\":\"Blocks\",\"description\":\"The amount of blocks to split the instance into, a number or `auto`. `auto` means as many as possible. The number of GPUs and CPUs must be divisible by the number of blocks. Defaults to `1`, i.e. do not split\",\"default\":1,\"anyOf\":[{\"enum\":[\"auto\"],\"type\":\"string\"},{\"type\":\"integer\",\"minimum\":1}]},\"backends\":{\"description\":\"The backends to consider for provisioning (e.g., `[aws, gcp]`)\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/BackendType\"}},\"regions\":{\"title\":\"Regions\",\"description\":\"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"availability_zones\":{\"title\":\"Availability Zones\",\"description\":\"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"instance_types\":{\"title\":\"Instance Types\",\"description\":\"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"spot_policy\":{\"description\":\"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`\",\"allOf\":[{\"$ref\":\"#/definitions/SpotPolicy\"}]},\"retry\":{\"title\":\"Retry\",\"description\":\"The policy for provisioning retry. Defaults to `false`\",\"anyOf\":[{\"$ref\":\"#/definitions/ProfileRetryRequest\"},{\"type\":\"boolean\"}]},\"max_price\":{\"title\":\"Max Price\",\"description\":\"The maximum instance price per hour, in dollars\",\"exclusiveMinimum\":0.0,\"type\":\"number\"},\"idle_duration\":{\"title\":\"Idle Duration\",\"description\":\"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration\",\"anyOf\":[{\"enum\":[\"off\"],\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"integer\"}]},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"LetsEncryptGatewayCertificateRequest\":{\"title\":\"LetsEncryptGatewayCertificateRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"Automatic certificates by Let's Encrypt\",\"default\":\"lets-encrypt\",\"enum\":[\"lets-encrypt\"],\"type\":\"string\"}},\"additionalProperties\":false},\"ACMGatewayCertificateRequest\":{\"title\":\"ACMGatewayCertificateRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"Certificates by AWS Certificate Manager (ACM)\",\"default\":\"acm\",\"enum\":[\"acm\"],\"type\":\"string\"},\"arn\":{\"title\":\"Arn\",\"description\":\"The ARN of the wildcard ACM certificate for the domain\",\"type\":\"string\"}},\"required\":[\"arn\"],\"additionalProperties\":false},\"GatewayConfigurationRequest\":{\"title\":\"GatewayConfigurationRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"default\":\"gateway\",\"enum\":[\"gateway\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The gateway name\",\"type\":\"string\"},\"default\":{\"title\":\"Default\",\"description\":\"Make the gateway default\",\"default\":false,\"type\":\"boolean\"},\"backend\":{\"description\":\"The gateway backend\",\"allOf\":[{\"$ref\":\"#/definitions/BackendType\"}]},\"region\":{\"title\":\"Region\",\"description\":\"The gateway region\",\"type\":\"string\"},\"domain\":{\"title\":\"Domain\",\"description\":\"The gateway domain, e.g. `example.com`\",\"type\":\"string\"},\"public_ip\":{\"title\":\"Public Ip\",\"description\":\"Allocate public IP for the gateway\",\"default\":true,\"type\":\"boolean\"},\"certificate\":{\"title\":\"Certificate\",\"description\":\"The SSL certificate configuration. Defaults to `type: lets-encrypt`\",\"default\":{\"type\":\"lets-encrypt\"},\"anyOf\":[{\"$ref\":\"#/definitions/LetsEncryptGatewayCertificateRequest\"},{\"$ref\":\"#/definitions/ACMGatewayCertificateRequest\"}]},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the gateway. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"required\":[\"backend\",\"region\"],\"additionalProperties\":false},\"VolumeConfigurationRequest\":{\"title\":\"VolumeConfigurationRequest\",\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"Type\",\"default\":\"volume\",\"enum\":[\"volume\"],\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The volume name\",\"type\":\"string\"},\"backend\":{\"description\":\"The volume backend\",\"allOf\":[{\"$ref\":\"#/definitions/BackendType\"}]},\"region\":{\"title\":\"Region\",\"description\":\"The volume region\",\"type\":\"string\"},\"availability_zone\":{\"title\":\"Availability Zone\",\"description\":\"The volume availability zone\",\"type\":\"string\"},\"size\":{\"title\":\"Size\",\"description\":\"The volume size. Must be specified when creating new volumes\",\"type\":\"number\"},\"volume_id\":{\"title\":\"Volume Id\",\"description\":\"The volume ID. Must be specified when registering external volumes\",\"type\":\"string\"},\"tags\":{\"title\":\"Tags\",\"description\":\"The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"required\":[\"backend\",\"region\"],\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DstackConfigurationRequest\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"DstackConfigurationRequest","discriminator":{"propertyName":"type","mapping":{"dev-environment":"#/definitions/DevEnvironmentConfigurationRequest","task":"#/definitions/TaskConfigurationRequest","service":"#/definitions/ServiceConfigurationRequest","fleet":"#/definitions/FleetConfigurationRequest","gateway":"#/definitions/GatewayConfigurationRequest","volume":"#/definitions/VolumeConfigurationRequest"}},"oneOf":[{"$ref":"#/definitions/DevEnvironmentConfigurationRequest"},{"$ref":"#/definitions/TaskConfigurationRequest"},{"$ref":"#/definitions/ServiceConfigurationRequest"},{"$ref":"#/definitions/FleetConfigurationRequest"},{"$ref":"#/definitions/GatewayConfigurationRequest"},{"$ref":"#/definitions/VolumeConfigurationRequest"}],"additionalProperties":true,"$schema":"http://json-schema.org/draft-07/schema#","definitions":{"RegistryAuthRequest":{"title":"RegistryAuthRequest","description":"Credentials for pulling a private Docker image.\n\nAttributes:\n username (str): The username\n password (str): The password or access token","type":"object","properties":{"username":{"title":"Username","description":"The username","type":"string"},"password":{"title":"Password","description":"The password or access token","type":"string"}},"required":["username","password"],"additionalProperties":false},"PythonVersion":{"title":"PythonVersion","description":"An enumeration.","enum":["3.9","3.10","3.11","3.12","3.13"],"type":"string"},"EnvSentinelRequest":{"title":"EnvSentinelRequest","type":"object","properties":{"key":{"title":"Key","type":"string"}},"required":["key"],"additionalProperties":false},"Env":{"title":"Env","description":"Env represents a mapping of process environment variables, as in environ(7).\nEnvironment values may be omitted, in that case the :class:`EnvSentinel`\nobject is used as a placeholder.\n\nTo create an instance from a `dict[str, str]` or a `list[str]` use pydantic's\n:meth:`BaseModel.parse_obj(dict | list)` method.\n\nNB: this is *NOT* a CoreModel, pydantic-duality, which is used as a base\nfor the CoreModel, doesn't play well with custom root models.","default":{},"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/EnvSentinelRequest"}]}}]},"CPUArchitecture":{"title":"CPUArchitecture","description":"An enumeration.","enum":["x86","arm"],"type":"string"},"Range_int_":{"title":"Range[int]","type":"object","properties":{"min":{"title":"Min","type":"integer"},"max":{"title":"Max","type":"integer"}},"additionalProperties":false},"CPUSpecRequest":{"title":"CPUSpecRequest","type":"object","properties":{"arch":{"description":"The CPU architecture, one of: `x86`, `arm`","allOf":[{"$ref":"#/definitions/CPUArchitecture"}]},"count":{"title":"Count","description":"The number of CPU cores","default":{"min":2,"max":null},"anyOf":[{"$ref":"#/definitions/Range_int_"},{"type":"integer"},{"type":"string"}]}},"additionalProperties":false},"Range_Memory_":{"title":"Range[Memory]","type":"object","properties":{"min":{"title":"Min","type":"number"},"max":{"title":"Max","type":"number"}},"additionalProperties":false},"AcceleratorVendor":{"title":"AcceleratorVendor","description":"An enumeration.","enum":["nvidia","amd","google","intel","tenstorrent"],"type":"string"},"GPUSpecRequest":{"title":"GPUSpecRequest","type":"object","properties":{"vendor":{"description":"The vendor of the GPU/accelerator, one of: `nvidia`, `amd`, `google` (alias: `tpu`), `intel`","allOf":[{"$ref":"#/definitions/AcceleratorVendor"}]},"name":{"title":"Name","description":"The name of the GPU (e.g., `A100` or `H100`)","type":"array","items":{"type":"string"}},"count":{"title":"Count","description":"The number of GPUs","default":{"min":1,"max":null},"anyOf":[{"$ref":"#/definitions/Range_int_"},{"type":"integer"},{"type":"string"}]},"memory":{"title":"Memory","description":"The RAM size (e.g., `16GB`). Can be set to a range (e.g. `16GB..`, or `16GB..80GB`)","anyOf":[{"$ref":"#/definitions/Range_Memory_"},{"type":"integer"},{"type":"string"}]},"total_memory":{"title":"Total Memory","description":"The total RAM size (e.g., `32GB`). Can be set to a range (e.g. `16GB..`, or `16GB..80GB`)","anyOf":[{"$ref":"#/definitions/Range_Memory_"},{"type":"integer"},{"type":"string"}]},"compute_capability":{"title":"Compute Capability","description":"The minimum compute capability of the GPU (e.g., `7.5`)","type":"array","items":{}}},"additionalProperties":false},"DiskSpecRequest":{"title":"DiskSpecRequest","type":"object","properties":{"size":{"title":"Size","description":"Disk size","anyOf":[{"$ref":"#/definitions/Range_Memory_"},{"type":"integer"},{"type":"string"}]}},"required":["size"],"additionalProperties":false},"ResourcesSpecRequest":{"title":"ResourcesSpecRequest","type":"object","properties":{"cpu":{"title":"Cpu","description":"The CPU requirements","default":{"arch":null,"count":{"min":2,"max":null}},"anyOf":[{"$ref":"#/definitions/CPUSpecRequest"},{"$ref":"#/definitions/Range_int_"},{"type":"integer"},{"type":"string"}]},"memory":{"title":"Memory","description":"The RAM size (e.g., `8GB`)","default":{"min":8.0,"max":null},"anyOf":[{"$ref":"#/definitions/Range_Memory_"},{"type":"integer"},{"type":"string"}]},"shm_size":{"title":"Shm Size","description":"The size of shared memory (e.g., `8GB`). If you are using parallel communicating processes (e.g., dataloaders in PyTorch), you may need to configure this","anyOf":[{"type":"number"},{"type":"integer"},{"type":"string"}]},"gpu":{"title":"Gpu","description":"The GPU requirements","anyOf":[{"$ref":"#/definitions/GPUSpecRequest"},{"type":"integer"},{"type":"string"}]},"disk":{"title":"Disk","description":"The disk resources","default":{"size":{"min":100.0,"max":null}},"anyOf":[{"$ref":"#/definitions/DiskSpecRequest"},{"type":"integer"},{"type":"string"}]}},"additionalProperties":false},"VolumeMountPointRequest":{"title":"VolumeMountPointRequest","type":"object","properties":{"name":{"title":"Name","description":"The network volume name or the list of network volume names to mount. If a list is specified, one of the volumes in the list will be mounted. Specify volumes from different backends/regions to increase availability","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"path":{"title":"Path","description":"The absolute container path to mount the volume at","type":"string"}},"required":["name","path"],"additionalProperties":false},"InstanceMountPointRequest":{"title":"InstanceMountPointRequest","type":"object","properties":{"instance_path":{"title":"Instance Path","description":"The absolute path on the instance (host)","type":"string"},"path":{"title":"Path","description":"The absolute path in the container","type":"string"},"optional":{"title":"Optional","description":"Allow running without this volume in backends that do not support instance volumes","default":false,"type":"boolean"}},"required":["instance_path","path"],"additionalProperties":false},"FilePathMappingRequest":{"title":"FilePathMappingRequest","type":"object","properties":{"local_path":{"title":"Local Path","description":"The path on the user's machine. Relative paths are resolved relative to the parent directory of the the configuration file","type":"string"},"path":{"title":"Path","description":"The path in the container. Relative paths are resolved relative to the repo directory (`/workflow`)","type":"string"}},"required":["local_path","path"],"additionalProperties":false},"PortMappingRequest":{"title":"PortMappingRequest","type":"object","properties":{"local_port":{"title":"Local Port","exclusiveMinimum":0,"maximum":65536,"type":"integer"},"container_port":{"title":"Container Port","exclusiveMinimum":0,"maximum":65536,"type":"integer"}},"required":["container_port"],"additionalProperties":false},"BackendType":{"title":"BackendType","description":"Attributes:\n AWS (BackendType): Amazon Web Services\n AZURE (BackendType): Microsoft Azure\n CLOUDRIFT (BackendType): CloudRift\n CUDO (BackendType): Cudo\n DSTACK (BackendType): dstack Sky\n GCP (BackendType): Google Cloud Platform\n DATACRUNCH (BackendType): DataCrunch\n KUBERNETES (BackendType): Kubernetes\n LAMBDA (BackendType): Lambda Cloud\n NEBIUS (BackendType): Nebius AI Cloud\n OCI (BackendType): Oracle Cloud Infrastructure\n RUNPOD (BackendType): Runpod Cloud\n TENSORDOCK (BackendType): TensorDock Marketplace\n VASTAI (BackendType): Vast.ai Marketplace\n VULTR (BackendType): Vultr","enum":["aws","azure","cloudrift","cudo","datacrunch","dstack","gcp","kubernetes","lambda","local","remote","nebius","oci","runpod","tensordock","vastai","vultr"],"type":"string"},"SpotPolicy":{"title":"SpotPolicy","description":"An enumeration.","enum":["spot","on-demand","auto"],"type":"string"},"RetryEvent":{"title":"RetryEvent","description":"An enumeration.","enum":["no-capacity","interruption","error"],"type":"string"},"ProfileRetryRequest":{"title":"ProfileRetryRequest","type":"object","properties":{"on_events":{"description":"The list of events that should be handled with retry. Supported events are `no-capacity`, `interruption`, `error`. Omit to retry on all events","type":"array","items":{"$ref":"#/definitions/RetryEvent"}},"duration":{"title":"Duration","description":"The maximum period of retrying the run, e.g., `4h` or `1d`","anyOf":[{"type":"integer"},{"type":"string"}]}},"additionalProperties":false},"CreationPolicy":{"title":"CreationPolicy","description":"An enumeration.","enum":["reuse","reuse-or-create"],"type":"string"},"UtilizationPolicyRequest":{"title":"UtilizationPolicyRequest","type":"object","properties":{"min_gpu_utilization":{"title":"Min Gpu Utilization","description":"Minimum required GPU utilization, percent. If any GPU has utilization below specified value during the whole time window, the run is terminated","minimum":0,"maximum":100,"type":"integer"},"time_window":{"title":"Time Window","description":"The time window of metric samples taking into account to measure utilization (e.g., `30m`, `1h`). Minimum is `5m`","anyOf":[{"type":"integer"},{"type":"string"}]}},"required":["min_gpu_utilization","time_window"],"additionalProperties":false},"StartupOrder":{"title":"StartupOrder","description":"An enumeration.","enum":["any","master-first","workers-first"],"type":"string"},"StopCriteria":{"title":"StopCriteria","description":"An enumeration.","enum":["all-done","master-done"],"type":"string"},"ProfileRetryPolicyRequest":{"title":"ProfileRetryPolicyRequest","type":"object","properties":{"retry":{"title":"Retry","description":"Whether to retry the run on failure or not","default":false,"type":"boolean"},"duration":{"title":"Duration","description":"The maximum period of retrying the run, e.g., `4h` or `1d`","anyOf":[{"type":"integer"},{"type":"string"}]}},"additionalProperties":false},"TerminationPolicy":{"title":"TerminationPolicy","description":"An enumeration.","enum":["dont-destroy","destroy-after-idle"],"type":"string"},"DevEnvironmentConfigurationRequest":{"title":"DevEnvironmentConfigurationRequest","type":"object","properties":{"ide":{"title":"Ide","description":"The IDE to run. Supported values include `vscode` and `cursor`","anyOf":[{"enum":["vscode"],"type":"string"},{"enum":["cursor"],"type":"string"}]},"version":{"title":"Version","description":"The version of the IDE","type":"string"},"init":{"title":"Init","description":"The shell commands to run on startup","default":[],"type":"array","items":{"type":"string"}},"inactivity_duration":{"title":"Inactivity Duration","description":"The maximum amount of time the dev environment can be inactive (e.g., `2h`, `1d`, etc). After it elapses, the dev environment is automatically stopped. Inactivity is defined as the absence of SSH connections to the dev environment, including VS Code connections, `ssh <run name>` shells, and attached `dstack apply` or `dstack attach` commands. Use `off` for unlimited duration. Can be updated in-place. Defaults to `off`","anyOf":[{"enum":["off"],"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"string"}]},"type":{"title":"Type","default":"dev-environment","enum":["dev-environment"],"type":"string"},"name":{"title":"Name","description":"The run name. If not specified, a random name is generated","type":"string"},"image":{"title":"Image","description":"The name of the Docker image to run","type":"string"},"user":{"title":"User","description":"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user","type":"string"},"privileged":{"title":"Privileged","description":"Run the container in privileged mode","default":false,"type":"boolean"},"entrypoint":{"title":"Entrypoint","description":"The Docker entrypoint","type":"string"},"working_dir":{"title":"Working Dir","description":"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\".\"` ","type":"string"},"home_dir":{"title":"Home Dir","default":"/root","type":"string"},"registry_auth":{"title":"Registry Auth","description":"Credentials for pulling a private Docker image","allOf":[{"$ref":"#/definitions/RegistryAuthRequest"}]},"python":{"description":"The major version of Python. Mutually exclusive with `image` and `docker`","allOf":[{"$ref":"#/definitions/PythonVersion"}]},"nvcc":{"title":"Nvcc","description":"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`","type":"boolean"},"single_branch":{"title":"Single Branch","description":"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services","type":"boolean"},"env":{"title":"Env","description":"The mapping or the list of environment variables","default":{"__root__":{}},"allOf":[{"$ref":"#/definitions/Env"}]},"shell":{"title":"Shell","description":"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise","type":"string"},"resources":{"title":"Resources","description":"The resources requirements to run the configuration","default":{"cpu":{"min":2,"max":null},"memory":{"min":8.0,"max":null},"shm_size":null,"gpu":null,"disk":{"size":{"min":100.0,"max":null}}},"allOf":[{"$ref":"#/definitions/ResourcesSpecRequest"}]},"priority":{"title":"Priority","description":"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`","minimum":0,"maximum":100,"type":"integer"},"volumes":{"title":"Volumes","description":"The volumes mount points","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/VolumeMountPointRequest"},{"$ref":"#/definitions/InstanceMountPointRequest"},{"type":"string"}]}},"docker":{"title":"Docker","description":"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`","type":"boolean"},"files":{"title":"Files","description":"The local to container file path mappings","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/FilePathMappingRequest"},{"type":"string"}]}},"setup":{"title":"Setup","default":[],"type":"array","items":{"type":"string"}},"ports":{"title":"Ports","description":"Port numbers/mapping to expose","default":[],"type":"array","items":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":65536},{"type":"string","pattern":"^(?:[0-9]+|\\*):[0-9]+$"},{"$ref":"#/definitions/PortMappingRequest"}]}},"backends":{"description":"The backends to consider for provisioning (e.g., `[aws, gcp]`)","type":"array","items":{"$ref":"#/definitions/BackendType"}},"regions":{"title":"Regions","description":"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)","type":"array","items":{"type":"string"}},"availability_zones":{"title":"Availability Zones","description":"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)","type":"array","items":{"type":"string"}},"instance_types":{"title":"Instance Types","description":"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)","type":"array","items":{"type":"string"}},"reservation":{"title":"Reservation","description":"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks","type":"string"},"spot_policy":{"description":"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`","allOf":[{"$ref":"#/definitions/SpotPolicy"}]},"retry":{"title":"Retry","description":"The policy for resubmitting the run. Defaults to `false`","anyOf":[{"$ref":"#/definitions/ProfileRetryRequest"},{"type":"boolean"}]},"max_duration":{"title":"Max Duration","description":"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"stop_duration":{"title":"Stop Duration","description":"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"max_price":{"title":"Max Price","description":"The maximum instance price per hour, in dollars","exclusiveMinimum":0.0,"type":"number"},"creation_policy":{"description":"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`","allOf":[{"$ref":"#/definitions/CreationPolicy"}]},"idle_duration":{"title":"Idle Duration","description":"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"utilization_policy":{"title":"Utilization Policy","description":"Run termination policy based on utilization","allOf":[{"$ref":"#/definitions/UtilizationPolicyRequest"}]},"startup_order":{"description":"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`","allOf":[{"$ref":"#/definitions/StartupOrder"}]},"stop_criteria":{"description":"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`","allOf":[{"$ref":"#/definitions/StopCriteria"}]},"fleets":{"title":"Fleets","description":"The fleets considered for reuse","type":"array","items":{"type":"string"}},"tags":{"title":"Tags","description":"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"required":["ide"],"additionalProperties":false},"TaskConfigurationRequest":{"title":"TaskConfigurationRequest","type":"object","properties":{"nodes":{"title":"Nodes","description":"Number of nodes","default":1,"minimum":1,"type":"integer"},"type":{"title":"Type","default":"task","enum":["task"],"type":"string"},"name":{"title":"Name","description":"The run name. If not specified, a random name is generated","type":"string"},"image":{"title":"Image","description":"The name of the Docker image to run","type":"string"},"user":{"title":"User","description":"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user","type":"string"},"privileged":{"title":"Privileged","description":"Run the container in privileged mode","default":false,"type":"boolean"},"entrypoint":{"title":"Entrypoint","description":"The Docker entrypoint","type":"string"},"working_dir":{"title":"Working Dir","description":"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\".\"` ","type":"string"},"home_dir":{"title":"Home Dir","default":"/root","type":"string"},"registry_auth":{"title":"Registry Auth","description":"Credentials for pulling a private Docker image","allOf":[{"$ref":"#/definitions/RegistryAuthRequest"}]},"python":{"description":"The major version of Python. Mutually exclusive with `image` and `docker`","allOf":[{"$ref":"#/definitions/PythonVersion"}]},"nvcc":{"title":"Nvcc","description":"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`","type":"boolean"},"single_branch":{"title":"Single Branch","description":"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services","type":"boolean"},"env":{"title":"Env","description":"The mapping or the list of environment variables","default":{"__root__":{}},"allOf":[{"$ref":"#/definitions/Env"}]},"shell":{"title":"Shell","description":"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise","type":"string"},"resources":{"title":"Resources","description":"The resources requirements to run the configuration","default":{"cpu":{"min":2,"max":null},"memory":{"min":8.0,"max":null},"shm_size":null,"gpu":null,"disk":{"size":{"min":100.0,"max":null}}},"allOf":[{"$ref":"#/definitions/ResourcesSpecRequest"}]},"priority":{"title":"Priority","description":"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`","minimum":0,"maximum":100,"type":"integer"},"volumes":{"title":"Volumes","description":"The volumes mount points","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/VolumeMountPointRequest"},{"$ref":"#/definitions/InstanceMountPointRequest"},{"type":"string"}]}},"docker":{"title":"Docker","description":"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`","type":"boolean"},"files":{"title":"Files","description":"The local to container file path mappings","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/FilePathMappingRequest"},{"type":"string"}]}},"setup":{"title":"Setup","default":[],"type":"array","items":{"type":"string"}},"ports":{"title":"Ports","description":"Port numbers/mapping to expose","default":[],"type":"array","items":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":65536},{"type":"string","pattern":"^(?:[0-9]+|\\*):[0-9]+$"},{"$ref":"#/definitions/PortMappingRequest"}]}},"commands":{"title":"Commands","description":"The shell commands to run","default":[],"type":"array","items":{"type":"string"}},"backends":{"description":"The backends to consider for provisioning (e.g., `[aws, gcp]`)","type":"array","items":{"$ref":"#/definitions/BackendType"}},"regions":{"title":"Regions","description":"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)","type":"array","items":{"type":"string"}},"availability_zones":{"title":"Availability Zones","description":"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)","type":"array","items":{"type":"string"}},"instance_types":{"title":"Instance Types","description":"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)","type":"array","items":{"type":"string"}},"reservation":{"title":"Reservation","description":"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks","type":"string"},"spot_policy":{"description":"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`","allOf":[{"$ref":"#/definitions/SpotPolicy"}]},"retry":{"title":"Retry","description":"The policy for resubmitting the run. Defaults to `false`","anyOf":[{"$ref":"#/definitions/ProfileRetryRequest"},{"type":"boolean"}]},"max_duration":{"title":"Max Duration","description":"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"stop_duration":{"title":"Stop Duration","description":"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"max_price":{"title":"Max Price","description":"The maximum instance price per hour, in dollars","exclusiveMinimum":0.0,"type":"number"},"creation_policy":{"description":"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`","allOf":[{"$ref":"#/definitions/CreationPolicy"}]},"idle_duration":{"title":"Idle Duration","description":"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"utilization_policy":{"title":"Utilization Policy","description":"Run termination policy based on utilization","allOf":[{"$ref":"#/definitions/UtilizationPolicyRequest"}]},"startup_order":{"description":"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`","allOf":[{"$ref":"#/definitions/StartupOrder"}]},"stop_criteria":{"description":"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`","allOf":[{"$ref":"#/definitions/StopCriteria"}]},"fleets":{"title":"Fleets","description":"The fleets considered for reuse","type":"array","items":{"type":"string"}},"tags":{"title":"Tags","description":"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"TGIChatModelRequest":{"title":"TGIChatModelRequest","description":"Mapping of the model for the OpenAI-compatible endpoint.\n\nAttributes:\n type (str): The type of the model, e.g. \"chat\"\n name (str): The name of the model. This name will be used both to load model configuration from the HuggingFace Hub and in the OpenAI-compatible endpoint.\n format (str): The format of the model, e.g. \"tgi\" if the model is served with HuggingFace's Text Generation Inference.\n chat_template (Optional[str]): The custom prompt template for the model. If not specified, the default prompt template from the HuggingFace Hub configuration will be used.\n eos_token (Optional[str]): The custom end of sentence token. If not specified, the default end of sentence token from the HuggingFace Hub configuration will be used.","type":"object","properties":{"type":{"title":"Type","description":"The type of the model","default":"chat","enum":["chat"],"type":"string"},"name":{"title":"Name","description":"The name of the model","type":"string"},"format":{"title":"Format","description":"The serving format. Must be set to `tgi`","enum":["tgi"],"type":"string"},"chat_template":{"title":"Chat Template","description":"The custom prompt template for the model. If not specified, the default prompt template from the HuggingFace Hub configuration will be used","type":"string"},"eos_token":{"title":"Eos Token","description":"The custom end of sentence token. If not specified, the default end of sentence token from the HuggingFace Hub configuration will be used","type":"string"}},"required":["name","format"],"additionalProperties":false},"OpenAIChatModelRequest":{"title":"OpenAIChatModelRequest","description":"Mapping of the model for the OpenAI-compatible endpoint.\n\nAttributes:\n type (str): The type of the model, e.g. \"chat\"\n name (str): The name of the model. This name will be used both to load model configuration from the HuggingFace Hub and in the OpenAI-compatible endpoint.\n format (str): The format of the model, i.e. \"openai\".\n prefix (str): The `base_url` prefix: `http://hostname/{prefix}/chat/completions`. Defaults to `/v1`.","type":"object","properties":{"type":{"title":"Type","description":"The type of the model","default":"chat","enum":["chat"],"type":"string"},"name":{"title":"Name","description":"The name of the model","type":"string"},"format":{"title":"Format","description":"The serving format. Must be set to `openai`","enum":["openai"],"type":"string"},"prefix":{"title":"Prefix","description":"The `base_url` prefix (after hostname)","default":"/v1","type":"string"}},"required":["name","format"],"additionalProperties":false},"ScalingSpecRequest":{"title":"ScalingSpecRequest","type":"object","properties":{"metric":{"title":"Metric","description":"The target metric to track. Currently, the only supported value is `rps` (meaning requests per second)","enum":["rps"],"type":"string"},"target":{"title":"Target","description":"The target value of the metric. The number of replicas is calculated based on this number and automatically adjusts (scales up or down) as this metric changes","exclusiveMinimum":0,"type":"number"},"scale_up_delay":{"title":"Scale Up Delay","description":"The delay in seconds before scaling up","default":300,"type":"integer"},"scale_down_delay":{"title":"Scale Down Delay","description":"The delay in seconds before scaling down","default":600,"type":"integer"}},"required":["metric","target"],"additionalProperties":false},"IPAddressPartitioningKeyRequest":{"title":"IPAddressPartitioningKeyRequest","type":"object","properties":{"type":{"title":"Type","description":"Partitioning type","default":"ip_address","enum":["ip_address"],"type":"string"}},"additionalProperties":false},"HeaderPartitioningKeyRequest":{"title":"HeaderPartitioningKeyRequest","type":"object","properties":{"type":{"title":"Type","description":"Partitioning type","default":"header","enum":["header"],"type":"string"},"header":{"title":"Header","description":"Name of the header to use for partitioning","maxLength":500,"pattern":"^[a-zA-Z0-9-_]+$","type":"string"}},"required":["header"],"additionalProperties":false},"RateLimitRequest":{"title":"RateLimitRequest","type":"object","properties":{"prefix":{"title":"Prefix","description":"URL path prefix to which this limit is applied. If an incoming request matches several prefixes, the longest prefix is applied","default":"/","maxLength":4094,"pattern":"^/[^\\s\\\\{}]*$","type":"string"},"key":{"title":"Key","description":"The partitioning key. Each incoming request belongs to a partition and rate limits are applied per partition. Defaults to partitioning by client IP address","default":{"type":"ip_address"},"discriminator":{"propertyName":"type","mapping":{"ip_address":"#/definitions/IPAddressPartitioningKeyRequest","header":"#/definitions/HeaderPartitioningKeyRequest"}},"oneOf":[{"$ref":"#/definitions/IPAddressPartitioningKeyRequest"},{"$ref":"#/definitions/HeaderPartitioningKeyRequest"}]},"rps":{"title":"Rps","description":"Max allowed number of requests per second. Requests are tracked at millisecond granularity. For example, `rps: 10` means at most 1 request per 100ms","minimum":0.016666666666666666,"maximum":153722867280912930,"type":"number"},"burst":{"title":"Burst","description":"Max number of requests that can be passed to the service ahead of the rate limit","default":0,"minimum":0,"maximum":9223372036854775807,"type":"integer"}},"required":["rps"],"additionalProperties":false},"ServiceConfigurationRequest":{"title":"ServiceConfigurationRequest","type":"object","properties":{"port":{"title":"Port","description":"The port, that application listens on or the mapping","anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":65536},{"type":"string","pattern":"^[0-9]+:[0-9]+$"},{"$ref":"#/definitions/PortMappingRequest"}]},"gateway":{"title":"Gateway","description":"The name of the gateway. Specify boolean `false` to run without a gateway. Omit to run with the default gateway","anyOf":[{"type":"boolean"},{"type":"string"}]},"strip_prefix":{"title":"Strip Prefix","description":"Strip the `/proxy/services/<project name>/<run name>/` path prefix when forwarding requests to the service. Only takes effect when running the service without a gateway","default":true,"type":"boolean"},"model":{"title":"Model","description":"Mapping of the model for the OpenAI-compatible endpoint provided by `dstack`. Can be a full model format definition or just a model name. If it's a name, the service is expected to expose an OpenAI-compatible API at the `/v1` path","anyOf":[{"oneOf":[{"$ref":"#/definitions/TGIChatModelRequest"},{"$ref":"#/definitions/OpenAIChatModelRequest"}]},{"type":"string"}]},"https":{"title":"Https","description":"Enable HTTPS if running with a gateway","default":true,"type":"boolean"},"auth":{"title":"Auth","description":"Enable the authorization","default":true,"type":"boolean"},"replicas":{"title":"Replicas","description":"The number of replicas. Can be a number (e.g. `2`) or a range (`0..4` or `1..8`). If it's a range, the `scaling` property is required","default":{"min":1,"max":1},"anyOf":[{"type":"integer","minimum":1},{"type":"string","pattern":"^[0-9]+..[1-9][0-9]*$"},{"$ref":"#/definitions/Range_int_"}]},"scaling":{"title":"Scaling","description":"The auto-scaling rules. Required if `replicas` is set to a range","allOf":[{"$ref":"#/definitions/ScalingSpecRequest"}]},"rate_limits":{"title":"Rate Limits","description":"Rate limiting rules","default":[],"type":"array","items":{"$ref":"#/definitions/RateLimitRequest"}},"type":{"title":"Type","default":"service","enum":["service"],"type":"string"},"name":{"title":"Name","description":"The run name. If not specified, a random name is generated","type":"string"},"image":{"title":"Image","description":"The name of the Docker image to run","type":"string"},"user":{"title":"User","description":"The user inside the container, `user_name_or_id[:group_name_or_id]` (e.g., `ubuntu`, `1000:1000`). Defaults to the default `image` user","type":"string"},"privileged":{"title":"Privileged","description":"Run the container in privileged mode","default":false,"type":"boolean"},"entrypoint":{"title":"Entrypoint","description":"The Docker entrypoint","type":"string"},"working_dir":{"title":"Working Dir","description":"The path to the working directory inside the container. It's specified relative to the repository directory (`/workflow`) and should be inside it. Defaults to `\".\"` ","type":"string"},"home_dir":{"title":"Home Dir","default":"/root","type":"string"},"registry_auth":{"title":"Registry Auth","description":"Credentials for pulling a private Docker image","allOf":[{"$ref":"#/definitions/RegistryAuthRequest"}]},"python":{"description":"The major version of Python. Mutually exclusive with `image` and `docker`","allOf":[{"$ref":"#/definitions/PythonVersion"}]},"nvcc":{"title":"Nvcc","description":"Use image with NVIDIA CUDA Compiler (NVCC) included. Mutually exclusive with `image` and `docker`","type":"boolean"},"single_branch":{"title":"Single Branch","description":"Whether to clone and track only the current branch or all remote branches. Relevant only when using remote Git repos. Defaults to `false` for dev environments and to `true` for tasks and services","type":"boolean"},"env":{"title":"Env","description":"The mapping or the list of environment variables","default":{"__root__":{}},"allOf":[{"$ref":"#/definitions/Env"}]},"shell":{"title":"Shell","description":"The shell used to run commands. Allowed values are `sh`, `bash`, or an absolute path, e.g., `/usr/bin/zsh`. Defaults to `/bin/sh` if the `image` is specified, `/bin/bash` otherwise","type":"string"},"resources":{"title":"Resources","description":"The resources requirements to run the configuration","default":{"cpu":{"min":2,"max":null},"memory":{"min":8.0,"max":null},"shm_size":null,"gpu":null,"disk":{"size":{"min":100.0,"max":null}}},"allOf":[{"$ref":"#/definitions/ResourcesSpecRequest"}]},"priority":{"title":"Priority","description":"The priority of the run, an integer between `0` and `100`. `dstack` tries to provision runs with higher priority first. Defaults to `0`","minimum":0,"maximum":100,"type":"integer"},"volumes":{"title":"Volumes","description":"The volumes mount points","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/VolumeMountPointRequest"},{"$ref":"#/definitions/InstanceMountPointRequest"},{"type":"string"}]}},"docker":{"title":"Docker","description":"Use Docker inside the container. Mutually exclusive with `image`, `python`, and `nvcc`. Overrides `privileged`","type":"boolean"},"files":{"title":"Files","description":"The local to container file path mappings","default":[],"type":"array","items":{"anyOf":[{"$ref":"#/definitions/FilePathMappingRequest"},{"type":"string"}]}},"setup":{"title":"Setup","default":[],"type":"array","items":{"type":"string"}},"commands":{"title":"Commands","description":"The shell commands to run","default":[],"type":"array","items":{"type":"string"}},"backends":{"description":"The backends to consider for provisioning (e.g., `[aws, gcp]`)","type":"array","items":{"$ref":"#/definitions/BackendType"}},"regions":{"title":"Regions","description":"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)","type":"array","items":{"type":"string"}},"availability_zones":{"title":"Availability Zones","description":"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)","type":"array","items":{"type":"string"}},"instance_types":{"title":"Instance Types","description":"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)","type":"array","items":{"type":"string"}},"reservation":{"title":"Reservation","description":"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks","type":"string"},"spot_policy":{"description":"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`","allOf":[{"$ref":"#/definitions/SpotPolicy"}]},"retry":{"title":"Retry","description":"The policy for resubmitting the run. Defaults to `false`","anyOf":[{"$ref":"#/definitions/ProfileRetryRequest"},{"type":"boolean"}]},"max_duration":{"title":"Max Duration","description":"The maximum duration of a run (e.g., `2h`, `1d`, etc). After it elapses, the run is automatically stopped. Use `off` for unlimited duration. Defaults to `off`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"stop_duration":{"title":"Stop Duration","description":"The maximum duration of a run graceful stopping. After it elapses, the run is automatically forced stopped. This includes force detaching volumes used by the run. Use `off` for unlimited duration. Defaults to `5m`","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"max_price":{"title":"Max Price","description":"The maximum instance price per hour, in dollars","exclusiveMinimum":0.0,"type":"number"},"creation_policy":{"description":"The policy for using instances from fleets: `reuse`, `reuse-or-create`. Defaults to `reuse-or-create`","allOf":[{"$ref":"#/definitions/CreationPolicy"}]},"idle_duration":{"title":"Idle Duration","description":"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"utilization_policy":{"title":"Utilization Policy","description":"Run termination policy based on utilization","allOf":[{"$ref":"#/definitions/UtilizationPolicyRequest"}]},"startup_order":{"description":"The order in which master and workers jobs are started: `any`, `master-first`, `workers-first`. Defaults to `any`","allOf":[{"$ref":"#/definitions/StartupOrder"}]},"stop_criteria":{"description":"The criteria determining when a multi-node run should be considered finished: `all-done`, `master-done`. Defaults to `all-done`","allOf":[{"$ref":"#/definitions/StopCriteria"}]},"fleets":{"title":"Fleets","description":"The fleets considered for reuse","type":"array","items":{"type":"string"}},"tags":{"title":"Tags","description":"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"required":["port"],"additionalProperties":false},"SSHKeyRequest":{"title":"SSHKeyRequest","type":"object","properties":{"public":{"title":"Public","type":"string"},"private":{"title":"Private","type":"string"}},"required":["public"],"additionalProperties":false},"SSHProxyParamsRequest":{"title":"SSHProxyParamsRequest","type":"object","properties":{"hostname":{"title":"Hostname","description":"The IP address or domain of proxy host","type":"string"},"port":{"title":"Port","description":"The SSH port of proxy host","type":"integer"},"user":{"title":"User","description":"The user to log in with for proxy host","type":"string"},"identity_file":{"title":"Identity File","description":"The private key to use for proxy host","type":"string"},"ssh_key":{"$ref":"#/definitions/SSHKeyRequest"}},"required":["hostname","user","identity_file"],"additionalProperties":false},"SSHHostParamsRequest":{"title":"SSHHostParamsRequest","type":"object","properties":{"hostname":{"title":"Hostname","description":"The IP address or domain to connect to","type":"string"},"port":{"title":"Port","description":"The SSH port to connect to for this host","type":"integer"},"user":{"title":"User","description":"The user to log in with for this host","type":"string"},"identity_file":{"title":"Identity File","description":"The private key to use for this host","type":"string"},"proxy_jump":{"title":"Proxy Jump","description":"The SSH proxy configuration for this host","allOf":[{"$ref":"#/definitions/SSHProxyParamsRequest"}]},"internal_ip":{"title":"Internal Ip","description":"The internal IP of the host used for communication inside the cluster. If not specified, `dstack` will use the IP address from `network` or from the first found internal network.","type":"string"},"ssh_key":{"$ref":"#/definitions/SSHKeyRequest"},"blocks":{"title":"Blocks","description":"The amount of blocks to split the instance into, a number or `auto`. `auto` means as many as possible. The number of GPUs and CPUs must be divisible by the number of blocks. Defaults to `1`, i.e. do not split","default":1,"anyOf":[{"enum":["auto"],"type":"string"},{"type":"integer","minimum":1}]}},"required":["hostname"],"additionalProperties":false},"SSHParamsRequest":{"title":"SSHParamsRequest","type":"object","properties":{"user":{"title":"User","description":"The user to log in with on all hosts","type":"string"},"port":{"title":"Port","description":"The SSH port to connect to","type":"integer"},"identity_file":{"title":"Identity File","description":"The private key to use for all hosts","type":"string"},"ssh_key":{"$ref":"#/definitions/SSHKeyRequest"},"proxy_jump":{"title":"Proxy Jump","description":"The SSH proxy configuration for all hosts","allOf":[{"$ref":"#/definitions/SSHProxyParamsRequest"}]},"hosts":{"title":"Hosts","description":"The per host connection parameters: a hostname or an object that overrides default ssh parameters","type":"array","items":{"anyOf":[{"$ref":"#/definitions/SSHHostParamsRequest"},{"type":"string"}]}},"network":{"title":"Network","description":"The network address for cluster setup in the format `<ip>/<netmask>`. `dstack` will use IP addresses from this network for communication between hosts. If not specified, `dstack` will use IPs from the first found internal network.","type":"string"}},"required":["hosts"],"additionalProperties":false},"InstanceGroupPlacement":{"title":"InstanceGroupPlacement","description":"An enumeration.","enum":["any","cluster"],"type":"string"},"FleetConfigurationRequest":{"title":"FleetConfigurationRequest","type":"object","properties":{"type":{"title":"Type","default":"fleet","enum":["fleet"],"type":"string"},"name":{"title":"Name","description":"The fleet name","type":"string"},"env":{"title":"Env","description":"The mapping or the list of environment variables","default":{"__root__":{}},"allOf":[{"$ref":"#/definitions/Env"}]},"ssh_config":{"title":"Ssh Config","description":"The parameters for adding instances via SSH","allOf":[{"$ref":"#/definitions/SSHParamsRequest"}]},"nodes":{"title":"Nodes","description":"The number of instances","anyOf":[{"$ref":"#/definitions/Range_int_"},{"type":"integer"},{"type":"string"}]},"placement":{"description":"The placement of instances: `any` or `cluster`","allOf":[{"$ref":"#/definitions/InstanceGroupPlacement"}]},"reservation":{"title":"Reservation","description":"The existing reservation to use for instance provisioning. Supports AWS Capacity Reservations and Capacity Blocks","type":"string"},"resources":{"title":"Resources","description":"The resources requirements","default":{"cpu":{"min":2,"max":null},"memory":{"min":8.0,"max":null},"shm_size":null,"gpu":null,"disk":{"size":{"min":100.0,"max":null}}},"allOf":[{"$ref":"#/definitions/ResourcesSpecRequest"}]},"blocks":{"title":"Blocks","description":"The amount of blocks to split the instance into, a number or `auto`. `auto` means as many as possible. The number of GPUs and CPUs must be divisible by the number of blocks. Defaults to `1`, i.e. do not split","default":1,"anyOf":[{"enum":["auto"],"type":"string"},{"type":"integer","minimum":1}]},"backends":{"description":"The backends to consider for provisioning (e.g., `[aws, gcp]`)","type":"array","items":{"$ref":"#/definitions/BackendType"}},"regions":{"title":"Regions","description":"The regions to consider for provisioning (e.g., `[eu-west-1, us-west4, westeurope]`)","type":"array","items":{"type":"string"}},"availability_zones":{"title":"Availability Zones","description":"The availability zones to consider for provisioning (e.g., `[eu-west-1a, us-west4-a]`)","type":"array","items":{"type":"string"}},"instance_types":{"title":"Instance Types","description":"The cloud-specific instance types to consider for provisioning (e.g., `[p3.8xlarge, n1-standard-4]`)","type":"array","items":{"type":"string"}},"spot_policy":{"description":"The policy for provisioning spot or on-demand instances: `spot`, `on-demand`, `auto`. Defaults to `on-demand`","allOf":[{"$ref":"#/definitions/SpotPolicy"}]},"retry":{"title":"Retry","description":"The policy for provisioning retry. Defaults to `false`","anyOf":[{"$ref":"#/definitions/ProfileRetryRequest"},{"type":"boolean"}]},"max_price":{"title":"Max Price","description":"The maximum instance price per hour, in dollars","exclusiveMinimum":0.0,"type":"number"},"idle_duration":{"title":"Idle Duration","description":"Time to wait before terminating idle instances. Defaults to `5m` for runs and `3d` for fleets. Use `off` for unlimited duration","anyOf":[{"enum":["off"],"type":"string"},{"type":"string"},{"type":"integer"}]},"tags":{"title":"Tags","description":"The custom tags to associate with the resource. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"LetsEncryptGatewayCertificateRequest":{"title":"LetsEncryptGatewayCertificateRequest","type":"object","properties":{"type":{"title":"Type","description":"Automatic certificates by Let's Encrypt","default":"lets-encrypt","enum":["lets-encrypt"],"type":"string"}},"additionalProperties":false},"ACMGatewayCertificateRequest":{"title":"ACMGatewayCertificateRequest","type":"object","properties":{"type":{"title":"Type","description":"Certificates by AWS Certificate Manager (ACM)","default":"acm","enum":["acm"],"type":"string"},"arn":{"title":"Arn","description":"The ARN of the wildcard ACM certificate for the domain","type":"string"}},"required":["arn"],"additionalProperties":false},"GatewayConfigurationRequest":{"title":"GatewayConfigurationRequest","type":"object","properties":{"type":{"title":"Type","default":"gateway","enum":["gateway"],"type":"string"},"name":{"title":"Name","description":"The gateway name","type":"string"},"default":{"title":"Default","description":"Make the gateway default","default":false,"type":"boolean"},"backend":{"description":"The gateway backend","allOf":[{"$ref":"#/definitions/BackendType"}]},"region":{"title":"Region","description":"The gateway region","type":"string"},"domain":{"title":"Domain","description":"The gateway domain, e.g. `example.com`","type":"string"},"public_ip":{"title":"Public Ip","description":"Allocate public IP for the gateway","default":true,"type":"boolean"},"certificate":{"title":"Certificate","description":"The SSL certificate configuration. Defaults to `type: lets-encrypt`","default":{"type":"lets-encrypt"},"anyOf":[{"$ref":"#/definitions/LetsEncryptGatewayCertificateRequest"},{"$ref":"#/definitions/ACMGatewayCertificateRequest"}]},"tags":{"title":"Tags","description":"The custom tags to associate with the gateway. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"required":["backend","region"],"additionalProperties":false},"VolumeConfigurationRequest":{"title":"VolumeConfigurationRequest","type":"object","properties":{"type":{"title":"Type","default":"volume","enum":["volume"],"type":"string"},"name":{"title":"Name","description":"The volume name","type":"string"},"backend":{"description":"The volume backend","allOf":[{"$ref":"#/definitions/BackendType"}]},"region":{"title":"Region","description":"The volume region","type":"string"},"availability_zone":{"title":"Availability Zone","description":"The volume availability zone","type":"string"},"size":{"title":"Size","description":"The volume size. Must be specified when creating new volumes","type":"number"},"volume_id":{"title":"Volume Id","description":"The volume ID. Must be specified when registering external volumes","type":"string"},"tags":{"title":"Tags","description":"The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them","type":"object","additionalProperties":{"type":"string"}}},"required":["backend","region"],"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "DstackConfigurationRequest". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
DstackConfigurationRequest
|
schema-store
|
schema_store_211
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"dependency-cruiser configuration\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://dependency-cruiser.js.org/schema/configuration.schema.json\",\"description\":\"A set of properties describing what dependencies are forbidden and what dependencies are allowed + options on how to cruise through the code\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"$schema\":{\"type\":\"string\"},\"forbidden\":{\"type\":\"array\",\"description\":\"A list of rules that describe dependencies that are not allowed. dependency-cruiser will emit a separate error (warning/ informational) messages for each violated rule.\",\"items\":{\"$ref\":\"#/definitions/ForbiddenRuleType\"}},\"allowed\":{\"type\":\"array\",\"description\":\"A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.\",\"items\":{\"$ref\":\"#/definitions/AllowedRuleType\"}},\"allowedSeverity\":{\"$ref\":\"#/definitions/SeverityType\",\"description\":\"Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'\"},\"required\":{\"type\":\"array\",\"description\":\"A list of rules that describe what dependencies modules _must_ have. E.g. - every controller needs to (directly) depend on a base controller. - each source file should be the dependency of a spec file with the same base name\",\"items\":{\"$ref\":\"#/definitions/RequiredRuleType\"}},\"options\":{\"$ref\":\"#/definitions/OptionsType\"},\"extends\":{\"$ref\":\"#/definitions/ExtendsType\"}},\"definitions\":{\"RuleSetType\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"forbidden\":{\"type\":\"array\",\"description\":\"A list of rules that describe dependencies that are not allowed. dependency-cruiser will emit a separate error (warning/ informational) messages for each violated rule.\",\"items\":{\"$ref\":\"#/definitions/ForbiddenRuleType\"}},\"allowed\":{\"type\":\"array\",\"description\":\"A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.\",\"items\":{\"$ref\":\"#/definitions/AllowedRuleType\"}},\"allowedSeverity\":{\"$ref\":\"#/definitions/SeverityType\",\"description\":\"Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'\"},\"required\":{\"type\":\"array\",\"description\":\"A list of rules that describe what dependencies modules _must_ have. E.g. - every controller needs to (directly) depend on a base controller. - each source file should be the dependency of a spec file with the same base name\",\"items\":{\"$ref\":\"#/definitions/RequiredRuleType\"}}}},\"AllowedRuleType\":{\"oneOf\":[{\"$ref\":\"#/definitions/RegularAllowedRuleType\"},{\"$ref\":\"#/definitions/ReachabilityAllowedRuleType\"}]},\"RegularAllowedRuleType\":{\"type\":\"object\",\"required\":[\"from\",\"to\"],\"additionalProperties\":false,\"properties\":{\"comment\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Currently ignored for 'allowed' rules, defaulting to 'module'\",\"enum\":[\"module\",\"folder\"]},\"from\":{\"$ref\":\"#/definitions/FromRestrictionType\"},\"to\":{\"$ref\":\"#/definitions/ToRestrictionType\"}}},\"ReachabilityAllowedRuleType\":{\"type\":\"object\",\"required\":[\"from\",\"to\"],\"additionalProperties\":false,\"properties\":{\"comment\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Currently ignored for 'allowed' rules, defaulting to 'module'\",\"enum\":[\"module\",\"folder\"]},\"from\":{\"$ref\":\"#/definitions/ReachabilityFromRestrictionType\"},\"to\":{\"$ref\":\"#/definitions/ReachabilityToRestrictionType\"}}},\"ForbiddenRuleType\":{\"oneOf\":[{\"$ref\":\"#/definitions/RegularForbiddenRuleType\"},{\"$ref\":\"#/definitions/ReachabilityForbiddenRuleType\"},{\"$ref\":\"#/definitions/DependentsForbiddenRuleType\"}]},\"RegularForbiddenRuleType\":{\"type\":\"object\",\"required\":[\"from\",\"to\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A short name for the rule - will appear in reporters to enable customers to quickly identify a violated rule. Try to keep them short, eslint style. E.g. 'not-to-core' for a rule forbidding dependencies on core modules, or 'not-to-unresolvable' for one that prevents dependencies on modules that probably don't exist.\"},\"severity\":{\"$ref\":\"#/definitions/SeverityType\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Switching the scope to 'folder' can be useful in rules where this makes a difference like those regarding circular dependencies or instability. Only the to.moreUnstable, to.circular, and path (both from and to) attributes work at the moment. Other attributes will follow suit in later releases (depending on demand).\",\"enum\":[\"module\",\"folder\"]},\"comment\":{\"type\":\"string\",\"description\":\"You can use this field to document why the rule is there.\"},\"from\":{\"$ref\":\"#/definitions/FromRestrictionType\"},\"to\":{\"$ref\":\"#/definitions/ToRestrictionType\"}}},\"DependentsForbiddenRuleType\":{\"type\":\"object\",\"required\":[\"module\",\"from\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"severity\":{\"$ref\":\"#/definitions/SeverityType\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Currently ignored for DependentsForbiddenRules, defaulting to 'module'\",\"enum\":[\"module\",\"folder\"]},\"comment\":{\"type\":\"string\"},\"module\":{\"$ref\":\"#/definitions/DependentsModuleRestrictionType\"},\"from\":{\"$ref\":\"#/definitions/DependentsFromRestrictionType\"}}},\"ReachabilityForbiddenRuleType\":{\"type\":\"object\",\"required\":[\"from\",\"to\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"severity\":{\"$ref\":\"#/definitions/SeverityType\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Currently ignored for ReachabilityForbiddenRules, defaulting to 'module'\",\"enum\":[\"module\",\"folder\"]},\"comment\":{\"type\":\"string\"},\"from\":{\"$ref\":\"#/definitions/ReachabilityFromRestrictionType\"},\"to\":{\"$ref\":\"#/definitions/ReachabilityToRestrictionType\"}}},\"RequiredRuleType\":{\"type\":\"object\",\"required\":[\"module\",\"to\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"severity\":{\"$ref\":\"#/definitions/SeverityType\"},\"scope\":{\"type\":\"string\",\"description\":\"What to apply the rule to - modules (the default) or folders. Currently ignored for RequiredRules, defaulting to 'module'\",\"enum\":[\"module\",\"folder\"]},\"comment\":{\"type\":\"string\"},\"module\":{\"$ref\":\"#/definitions/RequiredModuleRestrictionType\"},\"to\":{\"$ref\":\"#/definitions/RequiredToRestrictionType\"}}},\"MiniDependencyRestrictionType\":{\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions the 'via' module should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an the 'via' module should _not_ match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"dependencyTypes\":{\"type\":\"array\",\"description\":\"Which dependency types the dependency between this via and the previous one in the 'via chain' should have to be caught by this rule.\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"}},\"dependencyTypesNot\":{\"type\":\"array\",\"description\":\"Which dependency types the dependency between this via and the previous one in the 'via chain' should _not_ have to be caught by this rule.\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"}}}}]},\"FromRestrictionType\":{\"type\":\"object\",\"description\":\"Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"orphan\":{\"type\":\"boolean\",\"description\":\"Whether or not to match when the module is an orphan (= has no incoming or outgoing dependencies). When this property it is part of a rule, dependency-cruiser will ignore the 'to' part.\"}}},\"ReachabilityFromRestrictionType\":{\"type\":\"object\",\"description\":\"Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"ToRestrictionType\":{\"type\":\"object\",\"description\":\"Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"couldNotResolve\":{\"type\":\"boolean\",\"description\":\"Whether or not to match modules dependency-cruiser could not resolve (and probably aren't on disk). For this one too: leave out if you don't care either way.\"},\"circular\":{\"type\":\"boolean\",\"description\":\"Whether or not to match when following to the to will ultimately end up in the from.\"},\"dynamic\":{\"type\":\"boolean\",\"description\":\"Whether or not to match when the dependency is a dynamic one.\"},\"exoticallyRequired\":{\"type\":\"boolean\",\"description\":\"Whether or not to match when the dependency is exotically required.\"},\"exoticRequire\":{\"description\":\"A regular expression to match against any 'exotic' require strings\",\"$ref\":\"#/definitions/REAsStringsType\"},\"exoticRequireNot\":{\"description\":\"A regular expression to match against any 'exotic' require strings - when it should NOT be caught by the rule\",\"$ref\":\"#/definitions/REAsStringsType\"},\"preCompilationOnly\":{\"type\":\"boolean\",\"description\":\"true if this dependency only exists before compilation (like type only imports), false in all other cases. Only returned when the tsPreCompilationDeps is set to 'specify'.\"},\"dependencyTypes\":{\"type\":\"array\",\"description\":\"Whether or not to match modules of any of these types (leaving out matches any of them)\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"}},\"dependencyTypesNot\":{\"type\":\"array\",\"description\":\"Whether or not to match modules NOT of any of these types (leaving out matches none of them)\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"}},\"moreThanOneDependencyType\":{\"type\":\"boolean\",\"description\":\"If true matches dependencies with more than one dependency type (e.g. defined in _both_ npm and npm-dev)\"},\"license\":{\"description\":\"Whether or not to match modules that were released under one of the mentioned licenses. E.g. to flag GPL-1.0, GPL-2.0 licensed modules (e.g. because your app is not compatible with the GPL) use \\\"GPL\\\"\",\"$ref\":\"#/definitions/REAsStringsType\"},\"licenseNot\":{\"description\":\"Whether or not to match modules that were NOT released under one of the mentioned licenses. E.g. to flag everything non MIT use \\\"MIT\\\" here\",\"$ref\":\"#/definitions/REAsStringsType\"},\"via\":{\"description\":\"For circular dependencies - whether or not to match cycles that include some modules with these conditions. If you want to match cycles that _exclusively_ include modules satisfying them use the viaOnly restriction.E.g. to allow all cycles, except when they go through one specific module. Typically to temporarily disallow some cycles with a lower severity - setting up a rule with a via that ignores them in an 'allowed' section.\",\"$ref\":\"#/definitions/MiniDependencyRestrictionType\"},\"viaOnly\":{\"description\":\"For circular dependencies - whether or not to match cycles that include exclusively modules with these conditions. This is different from the regular via that already matches when only _some_ of the modules in the cycle satisfy the condition.\",\"$ref\":\"#/definitions/MiniDependencyRestrictionType\"},\"viaNot\":{\"description\":\"This attribute is deprecated. Use 'viaOnly' with a 'pathNot' attribute in stead.\",\"deprecated\":true,\"$ref\":\"#/definitions/REAsStringsType\"},\"viaSomeNot\":{\"description\":\"This attribute is deprecated. Use 'via' with a 'pathNot' attribute in stead.\",\"deprecated\":true,\"$ref\":\"#/definitions/REAsStringsType\"},\"moreUnstable\":{\"type\":\"boolean\",\"description\":\"When set to true moreUnstable matches for any dependency that has a higher Instability than the module that depends on it. When set to false it matches when the opposite is true; the dependency has an equal or lower Instability. This attribute is useful when you want to check against Robert C. Martin's stable dependency principle. See online documentation for examples and details. Leave this out when you don't care either way.\"}}},\"DependentsModuleRestrictionType\":{\"description\":\"Criteria to select the module(s) this restriction should apply to\",\"required\":[],\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"numberOfDependentsLessThan\":{\"type\":\"integer\",\"description\":\"Matches when the number of times the 'to' module is used falls below (<) this number. Caveat: only works in concert with path and pathNot restrictions in the from and to parts of the rule; other conditions will be ignored. E.g. to flag modules that are used only once or not at all, use 2 here.\",\"minimum\":0,\"maximum\":100},\"numberOfDependentsMoreThan\":{\"type\":\"integer\",\"description\":\"Matches when the number of times the 'to' module is used raises above (>) this number. Caveat: only works in concert with path and pathNot restrictions in the from and to parts of the rule; other conditions will be ignored. E.g. to flag modules that are used more than 10 times, use 10 here.\",\"minimum\":0,\"maximum\":100}}},\"DependentsFromRestrictionType\":{\"description\":\"Criteria the dependents of the module should adhere to be caught by this rule rule. Leave it empty if you want any dependent to be matched.\",\"required\":[],\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"ReachabilityToRestrictionType\":{\"description\":\"Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.\",\"required\":[\"reachable\"],\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"reachable\":{\"type\":\"boolean\",\"description\":\"Whether or not to match modules that aren't reachable from the from part of the rule.\"}}},\"RequiredModuleRestrictionType\":{\"description\":\"Criteria to select the module(s) this restriction should apply to\",\"required\":[],\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"pathNot\":{\"description\":\"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"RequiredToRestrictionType\":{\"description\":\"Criteria for modules the associated module must depend on.\",\"required\":[],\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"Criteria at least one dependency of each matching module must adhere to.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"reachable\":{\"type\":\"boolean\",\"description\":\"Whether or not to match transitive ('indirect') dependencies as well as direct ones.\"}}},\"DependencyTypeType\":{\"type\":\"string\",\"enum\":[\"aliased-subpath-import\",\"aliased-tsconfig-base-url\",\"aliased-tsconfig-paths\",\"aliased-tsconfig\",\"aliased-webpack\",\"aliased-workspace\",\"aliased\",\"amd-define\",\"amd-require\",\"amd-exotic-require\",\"core\",\"deprecated\",\"dynamic-import\",\"exotic-require\",\"export\",\"import-equals\",\"import\",\"jsdoc\",\"jsdoc-bracket-import\",\"jsdoc-import-tag\",\"local\",\"localmodule\",\"npm-bundled\",\"npm-dev\",\"npm-no-pkg\",\"npm-optional\",\"npm-peer\",\"npm-unknown\",\"npm\",\"pre-compilation-only\",\"require\",\"triple-slash-amd-dependency\",\"triple-slash-directive\",\"triple-slash-file-reference\",\"triple-slash-type-reference\",\"type-import\",\"type-only\",\"undetermined\",\"unknown\"]},\"REAsStringsType\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"SeverityType\":{\"type\":\"string\",\"description\":\"How severe a violation of a rule is. The 'error' severity will make some reporters return a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated: use that.\",\"enum\":[\"error\",\"warn\",\"info\",\"ignore\"]},\"OptionsType\":{\"type\":\"object\",\"description\":\"Runtime configuration options\",\"additionalProperties\":false,\"properties\":{\"doNotFollow\":{\"description\":\"a regular expression for modules to include, but not follow further\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundDoNotFollowType\"}]},\"exclude\":{\"description\":\"a regular expression for modules to exclude from being cruised\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundExcludeType\"}]},\"includeOnly\":{\"description\":\"a regular expression for modules to cruise; anything outside it will be skipped\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundIncludeOnlyType\"}]},\"focus\":{\"description\":\"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundFocusType\"}]},\"reaches\":{\"description\":\"dependency-cruiser will include modules matching this regular expression in its output, as well as _any_ module that reaches them - either directly or via via\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundReachesType\"}]},\"affected\":{\"description\":\"dependency-cruiser will mark modules that have changed since the specified revision (or 'main', when not specified) in its output, as well as _any_ module that reaches them - either directly or via via. NOTE: this is currently a command line _only_ option, so if you pass this to the API or in a configuration file it will be ignored.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"boolean\"}]},\"highlight\":{\"description\":\"dependency-cruiser will mark modules matching this regular expression as 'highlighted' in its output\",\"oneOf\":[{\"$ref\":\"#/definitions/REAsStringsType\"},{\"$ref\":\"#/definitions/CompoundHighlightType\"}]},\"knownViolations\":{\"description\":\"baseline of known validations. Typically you'd specify these in a file called .dependency-cruiser-known-violations.json (which you'd generate with the --outputType 'baseline') - and which is easy to keep up to date. In a pinch you can specify them here as well. The known violations in .dependency-cruiser-known-violations.json always take precedence.\",\"$ref\":\"#/definitions/ViolationsType\"},\"collapse\":{\"description\":\"Collapse a to a folder depth by passing a single digit (e.g. 2). When passed a regex collapses to that pattern E.g. ^packages/[^/]+/ would collapse to modules/ folders directly under your packages folder.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\",\"minimum\":1,\"maximum\":9}]},\"maxDepth\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":99,\"description\":\"The maximum cruise depth specified. 0 means no maximum specified. While it might look attractive to regulate the size of the output, this is not the best option to do so. Filters (exclude, includeOnly, focus), the dot and archi reporter's collapsePattern and the collapse options offer better, more reliable and more understandable results.\"},\"moduleSystems\":{\"$ref\":\"#/definitions/ModuleSystemsType\"},\"detectJSDocImports\":{\"type\":\"boolean\",\"description\":\"When true, dependency-cruiser will detect dependencies in JSDoc-style import statements. Implies `\\\"parser\\\": \\\"tsc\\\"`. Defaults to false.\"},\"prefix\":{\"type\":\"string\"},\"preserveSymlinks\":{\"type\":\"boolean\",\"description\":\"if true leave symlinks untouched, otherwise use the realpath. Defaults to `false` (which is also nodejs's default behavior since version 6)\"},\"combinedDependencies\":{\"type\":\"boolean\",\"description\":\"if true combines the package.jsons found from the module up to the base folder the cruise is initiated from. Useful for how (some) mono-repos manage dependencies & dependency definitions. Defaults to `false`.\"},\"tsConfig\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"TypeScript project file ('tsconfig.json') to use for (1) compilation and (2) resolution (e.g. with the paths property)\",\"properties\":{\"fileName\":{\"description\":\"The TypeScript project file to use. The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './tsconfig.json'.\",\"type\":\"string\"}}},\"tsPreCompilationDeps\":{\"description\":\"if true detect dependencies that only exist before typescript-to-javascript compilation.\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"enum\":[\"specify\"]}]},\"extraExtensionsToScan\":{\"type\":\"array\",\"description\":\"List of extensions to scan _in addition_ to the extensions already covered by any available parser. Dependency-cruiser will consider files ending in these extensions but it will _not_ examine its content or derive any of their dependencies Sample value: [\\\".jpg\\\", \\\".png\\\", \\\".json\\\"]\",\"items\":{\"type\":\"string\"}},\"externalModuleResolutionStrategy\":{\"type\":\"string\",\"description\":\"What external module resolution strategy to use. Defaults to 'node_modules' (not used anymore - module resolution strategy determination is automatic now)\",\"enum\":[\"node_modules\",\"yarn-pnp\"]},\"builtInModules\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Options to tweak what dependency-cruiser considers 'built-in' modules. If you're targeting nodejs, or don't use any built-in modules you can probably leave this alone.\",\"properties\":{\"override\":{\"type\":\"array\",\"description\":\"List of module names that are to be considered as 'built-in'. By default dependency-cruiser uses the list of built-ins from nodejs. If you code for another environment (e.g. the browser) and you use shims for nodejs builtins like 'path' from node_modules, you could pass an empty array here. If you want to just add a couple of extra built-ins to the default list, use the 'add' attribute instead.\",\"items\":{\"type\":\"string\"}},\"add\":{\"type\":\"array\",\"description\":\"List of module names that are to be considered as 'built-in' in addition to the default list of the environment you're currently in. Use this e.g. if you're writing electron code and want to add 'electron' as built-in.\",\"items\":{\"type\":\"string\"}}}},\"forceDeriveDependents\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Hasn't had any effect on dependency-cruiser's behaviour since a few major versions ago. If there's a need to manipulate this use the `skipAnalysisNotInRules` option in stead. Previously documented behaviour: When true includes de-normalized dependents in the cruise-result, even though there's no rule in the rule set that requires them. Defaults to false.\"},\"webpackConfig\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Webpack configuration file to use to get resolve options from\",\"properties\":{\"fileName\":{\"type\":\"string\",\"description\":\"The webpack conf file to use (typically something like 'webpack.conf.js'). The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './webpack.conf.js'.\"},\"env\":{\"description\":\"Environment to pass if your config file returns a function\",\"oneOf\":[{\"type\":\"object\"},{\"type\":\"string\"}]},\"arguments\":{\"type\":\"object\",\"description\":\"Arguments to pass if your config file returns a function. E.g. {mode: 'production'} if you want to use webpack 4's 'mode' feature\"}}},\"enhancedResolveOptions\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Options used in module resolution that for dependency-cruiser's use cannot go in a webpack config. For details please refer to the documentation of enhanced-resolve itself.\",\"properties\":{\"exportsFields\":{\"type\":\"array\",\"description\":\"List of strings to consider as 'exports' fields in package.json. Use ['exports'] when you use packages that use such a field and your environment supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).\",\"items\":{\"type\":\"string\"}},\"conditionNames\":{\"type\":\"array\",\"description\":\"List of conditions to check for in the exports field. e.g. use `['imports']` if you're only interested in exposed es6 modules, ['require'] for commonjs, or all conditions at once (['import', 'require', 'node', 'default']) if anything goes for you. Only works when the 'exportsFields' array is non-empty\",\"items\":{\"type\":\"string\"}},\"extensions\":{\"type\":\"array\",\"description\":\"List of extensions to scan for when resolving. Typically you want to leave this alone as dependency-cruiser figures out what extensions to scan based on 1. what is available in your environment 2. in the order your environment (nodejs, typescript) applies the resolution itself. However, if you want it to scan less you can specify so with the extensions attribute. E.g. when you're 100% sure you _only_ have typescript & json and nothing else you can pass ['.ts', '.json'] - which can lead to performance gains on systems with slow i/o (like ms-windows), especially when your tsconfig contains paths/ aliases.\",\"items\":{\"type\":\"string\"}},\"mainFields\":{\"type\":\"array\",\"description\":\"A list of main fields in manifests (package.json s). Typically you'd want to keep leave this this on its default (['main']) , but if you e.g. use external packages that only expose types, and you still want references to these types to be resolved you could expand this to ['main', 'types', 'typings']\",\"items\":{\"type\":\"string\"}},\"mainFiles\":{\"type\":\"array\",\"description\":\"A list of files to consider 'main' files, defaults to ['index']. Only set this when you have really special needs that warrant it.\"},\"aliasFields\":{\"type\":\"array\",\"description\":\"A list of alias fields in manifests (package.jsons). Specify a field, such as browser, to be parsed according to [this specification](https://github.com/defunctzombie/package-browser-field-spec). Also see [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields) in the webpack docs. Defaults to an empty array (don't use any alias fields).\",\"items\":{\"type\":\"string\"}},\"cachedInputFileSystem\":{\"type\":\"object\",\"description\":\"Options to pass to the resolver (webpack's 'enhanced resolve') regarding caching.\",\"additionalProperties\":false,\"properties\":{\"cacheDuration\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":1800000,\"description\":\"The number of milliseconds [enhanced-resolve](webpack/enhanced-resolve)'s cached file system should use for cache duration. Typically you won't have to touch this - the default works well for repos up to 5000 modules/ 20000 dependencies, and likely for numbers above as well. If you experience memory problems on a (humongous) repository you can use the cacheDuration attribute to tame enhanced-resolve's memory usage by lowering the cache duration trading off against some (for values over 1000ms) or significant (for values below 500ms) performance. Dependency-cruiser currently uses 4000ms, and in the past has used 1000ms - both with good results.\"}}}}},\"babelConfig\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Babel configuration (e.g. '.babelrc.json') to use.\",\"properties\":{\"fileName\":{\"description\":\"The Babel configuration file to use. The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './.babelrc.json'. Dependency-cruiser currently supports only the json variant. Support for (js|cjs|mjs) variants and configuration in package.json might follow in future releases.\",\"type\":\"string\"}}},\"parser\":{\"type\":\"string\",\"description\":\"overrides the parser dependency-cruiser will use - EXPERIMENTAL. The use of 'swc' as a parser here is deprecated.\",\"enum\":[\"acorn\",\"tsc\",\"swc\"]},\"exoticRequireStrings\":{\"type\":\"array\",\"description\":\"List of strings you have in use in addition to cjs/ es6 requires & imports to declare module dependencies. Use this e.g. if you've re-declared require (`const want = require`), use a require-wrapper (like semver-try-require) or use window.require as a hack to workaround something\",\"items\":{\"type\":\"string\"}},\"reporterOptions\":{\"$ref\":\"#/definitions/ReporterOptionsType\"},\"progress\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"How dependency-cruiser shows progress. Defaults to 'none'.\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"cli-feedback\",\"performance-log\",\"ndjson\",\"none\"]},\"maximumLevel\":{\"description\":\"The maximum log level to emit messages at. Ranges from OFF (-1, don't show any messages), via SUMMARY (40), INFO (50), DEBUG (60) all the way to show ALL messages (99).\",\"type\":\"number\",\"enum\":[-1,40,50,60,70,80,99]}}},\"metrics\":{\"type\":\"boolean\",\"description\":\"When this flag is set to true, dependency-cruiser will calculate (stability) metrics for all modules and folders. Defaults to false.\"},\"experimentalStats\":{\"type\":\"boolean\",\"description\":\"When this flag is set to true, dependency-cruiser will calculate some stats for each module. Has some performance impact. EXPERIMENTAL Will be renamed when the 'experimental' state is lifted. Defaults to false.\"},\"skipAnalysisNotInRules\":{\"type\":\"boolean\",\"description\":\"When this flag is set to true, dependency-cruiser will skip all analysis that don't serve a rule. E.g. if there's no 'circular' rule in the rule set it won't analyse cycles. This flag affects cycle, dependents and orphan analysis. If you have a rule set that doesn't use one of these features, switching it to true will make cruises faster. Defaults to false for backwards compatibility. For most uses of dependency-cruiser we recommend to switch this option to true, though.\"},\"baseDir\":{\"type\":\"string\",\"description\":\"The directory dependency-cruiser should run its cruise from. Defaults to the current working directory.\"},\"cache\":{\"oneOf\":[{\"type\":\"boolean\"},{\"deprecated\":true,\"type\":\"string\"},{\"$ref\":\"#/definitions/CacheOptionsType\"}],\"description\":\"- false: don't use caching. \\n- true or empty object: use caching with the default settings \\n- a string (deprecated): cache in the folder denoted by the string & use the \\n default caching strategy. This is deprecated - instead pass a cache object \\n e.g. ```{ folder: 'your/cache/location' }```.\\n\\nDefaults to false (no caching).\\nWhen caching is switched on the default cache folder is 'node_modules/.cache/dependency-cruiser/'\"}}},\"ModuleSystemType\":{\"type\":\"string\",\"enum\":[\"cjs\",\"es6\",\"amd\",\"tsd\"]},\"ModuleSystemsType\":{\"type\":\"array\",\"description\":\"List of module systems to cruise. Defaults to [amd, cjs, es6]\",\"items\":{\"$ref\":\"#/definitions/ModuleSystemType\"}},\"CompoundExcludeType\":{\"type\":\"object\",\"description\":\"Criteria for dependencies to exclude\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"a regular expression for modules to exclude from being cruised\",\"$ref\":\"#/definitions/REAsStringsType\"},\"dynamic\":{\"type\":\"boolean\",\"description\":\"a boolean indicating whether or not to exclude dynamic dependencies\"}}},\"CompoundDoNotFollowType\":{\"type\":\"object\",\"description\":\"Criteria for modules to include, but not to follow further\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"a regular expression for modules to include, but not follow further\",\"$ref\":\"#/definitions/REAsStringsType\"},\"dependencyTypes\":{\"type\":\"array\",\"description\":\"an array of dependency types to include, but not follow further\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"}}}},\"CompoundIncludeOnlyType\":{\"type\":\"object\",\"description\":\"Criteria for modules to only include\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"CompoundFocusType\":{\"type\":\"object\",\"description\":\"Criteria for modules to 'focus' on\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)\",\"$ref\":\"#/definitions/REAsStringsType\"},\"depth\":{\"description\":\"by default 'focus' only inlcudes the direct neighbours of the focus'ed module(s). This property makes dependency-cruiser will also include neighbors of neighbors, up to the specified depth.\",\"type\":\"number\",\"minimum\":1,\"maximum\":4}}},\"CompoundReachesType\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"dependency-cruiser will include modules matching this regular expression in its output, as well as _any_ module that reaches them - either directly or via via\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"CompoundHighlightType\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"description\":\"dependency-cruiser will mark modules matching this regular expression as 'highlighted' in its output\",\"$ref\":\"#/definitions/REAsStringsType\"}}},\"ReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to tweak the output of reporters\",\"additionalProperties\":false,\"properties\":{\"anon\":{\"$ref\":\"#/definitions/AnonReporterOptionsType\"},\"archi\":{\"$ref\":\"#/definitions/DotReporterOptionsType\"},\"dot\":{\"$ref\":\"#/definitions/DotReporterOptionsType\"},\"ddot\":{\"$ref\":\"#/definitions/DotReporterOptionsType\"},\"flat\":{\"$ref\":\"#/definitions/DotReporterOptionsType\"},\"markdown\":{\"$ref\":\"#/definitions/MarkdownReporterOptionsType\"},\"metrics\":{\"$ref\":\"#/definitions/MetricsReporterOptionsType\"},\"mermaid\":{\"$ref\":\"#/definitions/MermaidReporterOptionsType\"},\"text\":{\"$ref\":\"#/definitions/TextReporterOptionsType\"}}},\"AnonReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to tweak the output of the anonymous reporter\",\"additionalProperties\":false,\"properties\":{\"wordlist\":{\"type\":\"array\",\"description\":\"List of words to use to replace path elements of file names in the output with so the output isn't directly traceable to its intended purpose. When the list is exhausted, the anon reporter will use random strings patterned after the original file name in stead. The list is empty by default. Read more in https://github.com/sverweij/dependency-cruiser/blob/main/doc/cli.md#anon---obfuscated-json\",\"items\":{\"type\":\"string\"}}}},\"MetricsReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to tweak the output of the metrics reporter\",\"additionalProperties\":false,\"properties\":{\"orderBy\":{\"type\":\"string\",\"enum\":[\"instability\",\"moduleCount\",\"afferentCouplings\",\"efferentCouplings\",\"name\",\"size\",\"topLevelStatementCount\"],\"description\":\"By what attribute (in addition to the names of the folders/ modules) to order the metrics by. Defaults to 'instability'.\"},\"hideModules\":{\"type\":\"boolean\",\"description\":\"When true hides module metrics from the report. Defaults to false\"},\"hideFolders\":{\"type\":\"boolean\",\"description\":\"When true hides folder metrics from the report. Defaults to false\"}}},\"MarkdownReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to show and hide sections of the markdown reporter and to provide alternate boilerplate text\",\"additionalProperties\":false,\"properties\":{\"showTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not to show a title in the report. Defaults to true.\"},\"title\":{\"type\":\"string\",\"description\":\"The text to show as a title of the report. E.g. '## dependency-cruiser forbidden dependency check - results'. When left out shows a default value.\"},\"showSummary\":{\"type\":\"boolean\",\"description\":\"Whether or not to show a summary in the report. Defaults to true.\"},\"showSummaryHeader\":{\"type\":\"boolean\",\"description\":\"Whether or not to give the summary a header. Defaults to true.\"},\"summaryHeader\":{\"type\":\"string\",\"description\":\"The text to show as a header on top of the summary. E.g. '### Summary'. When left out shows a default value.\"},\"showStatsSummary\":{\"type\":\"boolean\",\"description\":\"Whether or not to show high level stats in the summary. Defaults to true.\"},\"showRulesSummary\":{\"type\":\"boolean\",\"description\":\"Whether or not to show a list of violated rules in the summary. Defaults to true.\"},\"includeIgnoredInSummary\":{\"type\":\"boolean\",\"description\":\"Whether or not to show rules in the list of rules for which all violations are ignored. Defaults to true.\"},\"showDetails\":{\"type\":\"boolean\",\"description\":\"Whether or not to show a detailed list of violations. Defaults to true.\"},\"includeIgnoredInDetails\":{\"type\":\"boolean\",\"description\":\"Whether or not to show ignored violations in the detailed list. Defaults to true.\"},\"showDetailsHeader\":{\"type\":\"boolean\",\"description\":\"Whether or not to give the detailed list of violations a header. Defaults to true.\"},\"detailsHeader\":{\"type\":\"string\",\"description\":\"The text to show as a header on top of the detailed list of violations. E.g. '### All violations'. When left out shows a default value.\"},\"collapseDetails\":{\"type\":\"boolean\",\"description\":\"Whether or not to collapse the list of violations in a <details> block. Defaults to true.\"},\"collapsedMessage\":{\"type\":\"string\",\"description\":\"The text to in the <summary> section of the <details> block. E.g. 'click to see all violations'. When left out shows a default value.\"},\"noViolationsMessage\":{\"type\":\"string\",\"description\":\"The text to show when no violations were found. E.g. 'No violations found'. When left out shows a default value.\"},\"showFooter\":{\"type\":\"boolean\",\"description\":\"Whether or not to show a footer (with version & run date) at the bottom of the report. Defaults to true\"}}},\"MermaidReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to tweak the output of the mermaid reporters\",\"additionalProperties\":false,\"properties\":{\"minify\":{\"type\":\"boolean\",\"description\":\"Whether or not to compresses the output text. Defaults to true.\"}}},\"TextReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options that influence rendition of the text reporter\",\"additionalProperties\":false,\"properties\":{\"highlightFocused\":{\"type\":\"boolean\",\"description\":\"Whether or not to highlight modules that are focused with the --focus command line option (/ general option). Defaults to false\"}}},\"DotReporterOptionsType\":{\"type\":\"object\",\"description\":\"Options to tweak the output of the dot reporters\",\"additionalProperties\":false,\"properties\":{\"collapsePattern\":{\"description\":\"Regular expressions to collapse to. For the \\\"dot\\\" reporter defaults to null, but \\\"node_modules/[^/]+\\\" is recommended for most use cases.\",\"$ref\":\"#/definitions/REAsStringsType\"},\"filters\":{\"$ref\":\"#/definitions/ReporterFiltersType\"},\"showMetrics\":{\"description\":\"When passed the value 'true', shows instability metrics in the output if dependency-cruiser calculated them. Doesn't show them in all other cases. Defaults to false\",\"type\":\"boolean\"},\"theme\":{\"$ref\":\"#/definitions/DotThemeType\"}}},\"DotThemeType\":{\"type\":\"object\",\"description\":\"A bunch of criteria to conditionally theme the dot output\",\"additionalProperties\":false,\"properties\":{\"replace\":{\"type\":\"boolean\",\"description\":\"If passed with the value 'true', the passed theme replaces the default one. In all other cases it extends the default theme.\"},\"graph\":{\"description\":\"Name- value pairs of GraphViz dot (global) attributes.\",\"type\":\"object\"},\"node\":{\"description\":\"Name- value pairs of GraphViz dot node attributes.\",\"type\":\"object\"},\"edge\":{\"description\":\"Name- value pairs of GraphViz dot edge attributes.\",\"type\":\"object\"},\"modules\":{\"description\":\"List of criteria and attributes to apply for modules when the criteria are met. Conditions can use any module attribute. Attributes can be any that are valid in GraphViz dot nodes.\",\"$ref\":\"#/definitions/DotThemeArrayType\"},\"dependencies\":{\"description\":\"List of criteria and attributes to apply for dependencies when the criteria are met. Conditions can use any dependency attribute. Attributes can be any that are valid in GraphViz dot edges.\",\"$ref\":\"#/definitions/DotThemeArrayType\"}}},\"DotThemeArrayType\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/DotThemeEntryType\"}},\"DotThemeEntryType\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"criteria\":{\"type\":\"object\"},\"attributes\":{\"type\":\"object\"}}},\"ReporterFiltersType\":{\"type\":\"object\",\"description\":\"filters to apply to the reporter before rendering it (e.g. to leave out details from the graphical output that are not relevant for the goal of the report)\",\"additionalProperties\":false,\"properties\":{\"exclude\":{\"$ref\":\"#/definitions/CompoundExcludeType\"},\"includeOnly\":{\"$ref\":\"#/definitions/CompoundIncludeOnlyType\"},\"focus\":{\"$ref\":\"#/definitions/CompoundFocusType\"},\"reaches\":{\"$ref\":\"#/definitions/CompoundReachesType\"}}},\"ViolationsType\":{\"type\":\"array\",\"description\":\"A list of violations found in the dependencies. The dependencies themselves also contain this information, this summary is here for convenience.\",\"items\":{\"$ref\":\"#/definitions/ViolationType\"}},\"ViolationType\":{\"type\":\"object\",\"required\":[\"from\",\"to\",\"rule\"],\"additionalProperties\":false,\"properties\":{\"from\":{\"type\":\"string\"},\"to\":{\"type\":\"string\"},\"type\":{\"$ref\":\"#/definitions/ViolationTypeType\"},\"rule\":{\"$ref\":\"#/definitions/RuleSummaryType\"},\"cycle\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/MiniDependency\"},\"description\":\"The circular path if the violation is about circularity\"},\"via\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/MiniDependency\"},\"description\":\"The path from the from to the to if the violation is transitive\"},\"metrics\":{\"type\":\"object\",\"required\":[\"from\",\"to\"],\"additionalProperties\":false,\"properties\":{\"from\":{\"type\":\"object\",\"required\":[\"instability\"],\"additionalProperties\":false,\"properties\":{\"instability\":{\"type\":\"number\"}}},\"to\":{\"type\":\"object\",\"required\":[\"instability\"],\"additionalProperties\":false,\"properties\":{\"instability\":{\"type\":\"number\"}}}}},\"comment\":{\"type\":\"string\",\"description\":\"Free format text you can e.g. use to explain why this violation can be ignored or is quarantined (only used in _known-violations_) \"}}},\"RuleSummaryType\":{\"type\":\"object\",\"description\":\"If there was a rule violation (valid === false), this object contains the name of the rule and severity of violating it.\",\"required\":[\"name\",\"severity\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The (short, eslint style) name of the violated rule. Typically something like 'no-core-punycode' or 'no-outside-deps'.\"},\"severity\":{\"$ref\":\"#/definitions/SeverityType\"}}},\"ViolationTypeType\":{\"type\":\"string\",\"enum\":[\"dependency\",\"module\",\"reachability\",\"cycle\",\"instability\",\"folder\"]},\"MiniDependency\":{\"type\":\"object\",\"description\":\"A small dependency object with the uniquely identifying name of the module +the dependency types it has relative to the _previous_ module in the chain it is part of (e.g. a cycle).\",\"required\":[\"name\",\"dependencyTypes\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the module\"},\"dependencyTypes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/DependencyTypeType\"},\"description\":\"The dependency types of the module relative to the previous module in the chain it is a part of (e.g. a cycle)\"}}},\"CacheOptionsType\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"folder\":{\"type\":\"string\",\"description\":\"The folder to store the cache in. Defaults to node_modules/.cache/dependency-cruiser\"},\"strategy\":{\"$ref\":\"#/definitions/CacheStrategyType\"},\"compress\":{\"type\":\"boolean\",\"description\":\"Whether to compress the cache or not\\nSetting this to true will adds a few ms to the execution time, but\\ntypically reduces the cache size by 80-90%.\\n\\nDefaults to false.\",\"default\":false}}},\"CacheStrategyType\":{\"type\":\"string\",\"description\":\"The strategy to use for caching.\\n- 'metadata': use git metadata to detect changes;\\n- 'content': use (a checksum of) the contents of files to detect changes.\\n\\n'content' is useful if you're not using git or work on partial clones (which is typical on CI's). Trade-of: the 'content' strategy is typically slower.\\n\\nDefaults to 'metadata'.\",\"enum\":[\"metadata\",\"content\"]},\"ExtendsType\":{\"description\":\"A configuration (or an array of configurations) this configuration uses as a base\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dependency-cruiser configuration\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"dependency-cruiser configuration","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/configuration.schema.json","description":"A set of properties describing what dependencies are forbidden and what dependencies are allowed + options on how to cruise through the code","type":"object","additionalProperties":false,"properties":{"$schema":{"type":"string"},"forbidden":{"type":"array","description":"A list of rules that describe dependencies that are not allowed. dependency-cruiser will emit a separate error (warning/ informational) messages for each violated rule.","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","description":"A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType","description":"Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'"},"required":{"type":"array","description":"A list of rules that describe what dependencies modules _must_ have. E.g. - every controller needs to (directly) depend on a base controller. - each source file should be the dependency of a spec file with the same base name","items":{"$ref":"#/definitions/RequiredRuleType"}},"options":{"$ref":"#/definitions/OptionsType"},"extends":{"$ref":"#/definitions/ExtendsType"}},"definitions":{"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","description":"A list of rules that describe dependencies that are not allowed. dependency-cruiser will emit a separate error (warning/ informational) messages for each violated rule.","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","description":"A list of rules that describe dependencies that are allowed. dependency-cruiser will emit the warning message 'not-in-allowed' for each dependency that does not at least meet one of them.","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType","description":"Severity to use when a dependency is not in the 'allowed' set of rules. Defaults to 'warn'"},"required":{"type":"array","description":"A list of rules that describe what dependencies modules _must_ have. E.g. - every controller needs to (directly) depend on a base controller. - each source file should be the dependency of a spec file with the same base name","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"AllowedRuleType":{"oneOf":[{"$ref":"#/definitions/RegularAllowedRuleType"},{"$ref":"#/definitions/ReachabilityAllowedRuleType"}]},"RegularAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Currently ignored for 'allowed' rules, defaulting to 'module'","enum":["module","folder"]},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"ReachabilityAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Currently ignored for 'allowed' rules, defaulting to 'module'","enum":["module","folder"]},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"ForbiddenRuleType":{"oneOf":[{"$ref":"#/definitions/RegularForbiddenRuleType"},{"$ref":"#/definitions/ReachabilityForbiddenRuleType"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"A short name for the rule - will appear in reporters to enable customers to quickly identify a violated rule. Try to keep them short, eslint style. E.g. 'not-to-core' for a rule forbidding dependencies on core modules, or 'not-to-unresolvable' for one that prevents dependencies on modules that probably don't exist."},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Switching the scope to 'folder' can be useful in rules where this makes a difference like those regarding circular dependencies or instability. Only the to.moreUnstable, to.circular, and path (both from and to) attributes work at the moment. Other attributes will follow suit in later releases (depending on demand).","enum":["module","folder"]},"comment":{"type":"string","description":"You can use this field to document why the rule is there."},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Currently ignored for DependentsForbiddenRules, defaulting to 'module'","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"ReachabilityForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Currently ignored for ReachabilityForbiddenRules, defaulting to 'module'","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","description":"What to apply the rule to - modules (the default) or folders. Currently ignored for RequiredRules, defaulting to 'module'","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"MiniDependencyRestrictionType":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"type":"object","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions the 'via' module should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an the 'via' module should _not_ match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","description":"Which dependency types the dependency between this via and the previous one in the 'via chain' should have to be caught by this rule.","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","description":"Which dependency types the dependency between this via and the previous one in the 'via chain' should _not_ have to be caught by this rule.","items":{"$ref":"#/definitions/DependencyTypeType"}}}}]},"FromRestrictionType":{"type":"object","description":"Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean","description":"Whether or not to match when the module is an orphan (= has no incoming or outgoing dependencies). When this property it is part of a rule, dependency-cruiser will ignore the 'to' part."}}},"ReachabilityFromRestrictionType":{"type":"object","description":"Criteria an end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","description":"Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean","description":"Whether or not to match modules dependency-cruiser could not resolve (and probably aren't on disk). For this one too: leave out if you don't care either way."},"circular":{"type":"boolean","description":"Whether or not to match when following to the to will ultimately end up in the from."},"dynamic":{"type":"boolean","description":"Whether or not to match when the dependency is a dynamic one."},"exoticallyRequired":{"type":"boolean","description":"Whether or not to match when the dependency is exotically required."},"exoticRequire":{"description":"A regular expression to match against any 'exotic' require strings","$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"description":"A regular expression to match against any 'exotic' require strings - when it should NOT be caught by the rule","$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean","description":"true if this dependency only exists before compilation (like type only imports), false in all other cases. Only returned when the tsPreCompilationDeps is set to 'specify'."},"dependencyTypes":{"type":"array","description":"Whether or not to match modules of any of these types (leaving out matches any of them)","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","description":"Whether or not to match modules NOT of any of these types (leaving out matches none of them)","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean","description":"If true matches dependencies with more than one dependency type (e.g. defined in _both_ npm and npm-dev)"},"license":{"description":"Whether or not to match modules that were released under one of the mentioned licenses. E.g. to flag GPL-1.0, GPL-2.0 licensed modules (e.g. because your app is not compatible with the GPL) use \"GPL\"","$ref":"#/definitions/REAsStringsType"},"licenseNot":{"description":"Whether or not to match modules that were NOT released under one of the mentioned licenses. E.g. to flag everything non MIT use \"MIT\" here","$ref":"#/definitions/REAsStringsType"},"via":{"description":"For circular dependencies - whether or not to match cycles that include some modules with these conditions. If you want to match cycles that _exclusively_ include modules satisfying them use the viaOnly restriction.E.g. to allow all cycles, except when they go through one specific module. Typically to temporarily disallow some cycles with a lower severity - setting up a rule with a via that ignores them in an 'allowed' section.","$ref":"#/definitions/MiniDependencyRestrictionType"},"viaOnly":{"description":"For circular dependencies - whether or not to match cycles that include exclusively modules with these conditions. This is different from the regular via that already matches when only _some_ of the modules in the cycle satisfy the condition.","$ref":"#/definitions/MiniDependencyRestrictionType"},"viaNot":{"description":"This attribute is deprecated. Use 'viaOnly' with a 'pathNot' attribute in stead.","deprecated":true,"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"description":"This attribute is deprecated. Use 'via' with a 'pathNot' attribute in stead.","deprecated":true,"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean","description":"When set to true moreUnstable matches for any dependency that has a higher Instability than the module that depends on it. When set to false it matches when the opposite is true; the dependency has an equal or lower Instability. This attribute is useful when you want to check against Robert C. Martin's stable dependency principle. See online documentation for examples and details. Leave this out when you don't care either way."}}},"DependentsModuleRestrictionType":{"description":"Criteria to select the module(s) this restriction should apply to","required":[],"type":"object","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","description":"Matches when the number of times the 'to' module is used falls below (<) this number. Caveat: only works in concert with path and pathNot restrictions in the from and to parts of the rule; other conditions will be ignored. E.g. to flag modules that are used only once or not at all, use 2 here.","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","description":"Matches when the number of times the 'to' module is used raises above (>) this number. Caveat: only works in concert with path and pathNot restrictions in the from and to parts of the rule; other conditions will be ignored. E.g. to flag modules that are used more than 10 times, use 10 here.","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"description":"Criteria the dependents of the module should adhere to be caught by this rule rule. Leave it empty if you want any dependent to be matched.","required":[],"type":"object","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"description":"Criteria the 'to' end of a dependency should match to be caught by this rule. Leave it empty if you want any module to be matched.","required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean","description":"Whether or not to match modules that aren't reachable from the from part of the rule."}}},"RequiredModuleRestrictionType":{"description":"Criteria to select the module(s) this restriction should apply to","required":[],"type":"object","additionalProperties":false,"properties":{"path":{"description":"A regular expression or an array of regular expressions an end of a dependency should match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"},"pathNot":{"description":"A regular expression or an array of regular expressions an end of a dependency should NOT match to be caught by this rule.","$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"description":"Criteria for modules the associated module must depend on.","required":[],"type":"object","additionalProperties":false,"properties":{"path":{"description":"Criteria at least one dependency of each matching module must adhere to.","$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean","description":"Whether or not to match transitive ('indirect') dependencies as well as direct ones."}}},"DependencyTypeType":{"type":"string","enum":["aliased-subpath-import","aliased-tsconfig-base-url","aliased-tsconfig-paths","aliased-tsconfig","aliased-webpack","aliased-workspace","aliased","amd-define","amd-require","amd-exotic-require","core","deprecated","dynamic-import","exotic-require","export","import-equals","import","jsdoc","jsdoc-bracket-import","jsdoc-import-tag","local","localmodule","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","npm","pre-compilation-only","require","triple-slash-amd-dependency","triple-slash-directive","triple-slash-file-reference","triple-slash-type-reference","type-import","type-only","undetermined","unknown"]},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"SeverityType":{"type":"string","description":"How severe a violation of a rule is. The 'error' severity will make some reporters return a non-zero exit code, so if you want e.g. a build to stop when there's a rule violated: use that.","enum":["error","warn","info","ignore"]},"OptionsType":{"type":"object","description":"Runtime configuration options","additionalProperties":false,"properties":{"doNotFollow":{"description":"a regular expression for modules to include, but not follow further","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundDoNotFollowType"}]},"exclude":{"description":"a regular expression for modules to exclude from being cruised","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundExcludeType"}]},"includeOnly":{"description":"a regular expression for modules to cruise; anything outside it will be skipped","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"description":"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundFocusType"}]},"reaches":{"description":"dependency-cruiser will include modules matching this regular expression in its output, as well as _any_ module that reaches them - either directly or via via","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundReachesType"}]},"affected":{"description":"dependency-cruiser will mark modules that have changed since the specified revision (or 'main', when not specified) in its output, as well as _any_ module that reaches them - either directly or via via. NOTE: this is currently a command line _only_ option, so if you pass this to the API or in a configuration file it will be ignored.","oneOf":[{"type":"string"},{"type":"boolean"}]},"highlight":{"description":"dependency-cruiser will mark modules matching this regular expression as 'highlighted' in its output","oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundHighlightType"}]},"knownViolations":{"description":"baseline of known validations. Typically you'd specify these in a file called .dependency-cruiser-known-violations.json (which you'd generate with the --outputType 'baseline') - and which is easy to keep up to date. In a pinch you can specify them here as well. The known violations in .dependency-cruiser-known-violations.json always take precedence.","$ref":"#/definitions/ViolationsType"},"collapse":{"description":"Collapse a to a folder depth by passing a single digit (e.g. 2). When passed a regex collapses to that pattern E.g. ^packages/[^/]+/ would collapse to modules/ folders directly under your packages folder.","oneOf":[{"type":"string"},{"type":"integer","minimum":1,"maximum":9}]},"maxDepth":{"type":"integer","minimum":0,"maximum":99,"description":"The maximum cruise depth specified. 0 means no maximum specified. While it might look attractive to regulate the size of the output, this is not the best option to do so. Filters (exclude, includeOnly, focus), the dot and archi reporter's collapsePattern and the collapse options offer better, more reliable and more understandable results."},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"detectJSDocImports":{"type":"boolean","description":"When true, dependency-cruiser will detect dependencies in JSDoc-style import statements. Implies `\"parser\": \"tsc\"`. Defaults to false."},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean","description":"if true leave symlinks untouched, otherwise use the realpath. Defaults to `false` (which is also nodejs's default behavior since version 6)"},"combinedDependencies":{"type":"boolean","description":"if true combines the package.jsons found from the module up to the base folder the cruise is initiated from. Useful for how (some) mono-repos manage dependencies & dependency definitions. Defaults to `false`."},"tsConfig":{"type":"object","additionalProperties":false,"description":"TypeScript project file ('tsconfig.json') to use for (1) compilation and (2) resolution (e.g. with the paths property)","properties":{"fileName":{"description":"The TypeScript project file to use. The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './tsconfig.json'.","type":"string"}}},"tsPreCompilationDeps":{"description":"if true detect dependencies that only exist before typescript-to-javascript compilation.","oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","description":"List of extensions to scan _in addition_ to the extensions already covered by any available parser. Dependency-cruiser will consider files ending in these extensions but it will _not_ examine its content or derive any of their dependencies Sample value: [\".jpg\", \".png\", \".json\"]","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","description":"What external module resolution strategy to use. Defaults to 'node_modules' (not used anymore - module resolution strategy determination is automatic now)","enum":["node_modules","yarn-pnp"]},"builtInModules":{"type":"object","additionalProperties":false,"description":"Options to tweak what dependency-cruiser considers 'built-in' modules. If you're targeting nodejs, or don't use any built-in modules you can probably leave this alone.","properties":{"override":{"type":"array","description":"List of module names that are to be considered as 'built-in'. By default dependency-cruiser uses the list of built-ins from nodejs. If you code for another environment (e.g. the browser) and you use shims for nodejs builtins like 'path' from node_modules, you could pass an empty array here. If you want to just add a couple of extra built-ins to the default list, use the 'add' attribute instead.","items":{"type":"string"}},"add":{"type":"array","description":"List of module names that are to be considered as 'built-in' in addition to the default list of the environment you're currently in. Use this e.g. if you're writing electron code and want to add 'electron' as built-in.","items":{"type":"string"}}}},"forceDeriveDependents":{"type":"boolean","deprecated":true,"description":"Hasn't had any effect on dependency-cruiser's behaviour since a few major versions ago. If there's a need to manipulate this use the `skipAnalysisNotInRules` option in stead. Previously documented behaviour: When true includes de-normalized dependents in the cruise-result, even though there's no rule in the rule set that requires them. Defaults to false."},"webpackConfig":{"type":"object","additionalProperties":false,"description":"Webpack configuration file to use to get resolve options from","properties":{"fileName":{"type":"string","description":"The webpack conf file to use (typically something like 'webpack.conf.js'). The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './webpack.conf.js'."},"env":{"description":"Environment to pass if your config file returns a function","oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object","description":"Arguments to pass if your config file returns a function. E.g. {mode: 'production'} if you want to use webpack 4's 'mode' feature"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"description":"Options used in module resolution that for dependency-cruiser's use cannot go in a webpack config. For details please refer to the documentation of enhanced-resolve itself.","properties":{"exportsFields":{"type":"array","description":"List of strings to consider as 'exports' fields in package.json. Use ['exports'] when you use packages that use such a field and your environment supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).","items":{"type":"string"}},"conditionNames":{"type":"array","description":"List of conditions to check for in the exports field. e.g. use `['imports']` if you're only interested in exposed es6 modules, ['require'] for commonjs, or all conditions at once (['import', 'require', 'node', 'default']) if anything goes for you. Only works when the 'exportsFields' array is non-empty","items":{"type":"string"}},"extensions":{"type":"array","description":"List of extensions to scan for when resolving. Typically you want to leave this alone as dependency-cruiser figures out what extensions to scan based on 1. what is available in your environment 2. in the order your environment (nodejs, typescript) applies the resolution itself. However, if you want it to scan less you can specify so with the extensions attribute. E.g. when you're 100% sure you _only_ have typescript & json and nothing else you can pass ['.ts', '.json'] - which can lead to performance gains on systems with slow i/o (like ms-windows), especially when your tsconfig contains paths/ aliases.","items":{"type":"string"}},"mainFields":{"type":"array","description":"A list of main fields in manifests (package.json s). Typically you'd want to keep leave this this on its default (['main']) , but if you e.g. use external packages that only expose types, and you still want references to these types to be resolved you could expand this to ['main', 'types', 'typings']","items":{"type":"string"}},"mainFiles":{"type":"array","description":"A list of files to consider 'main' files, defaults to ['index']. Only set this when you have really special needs that warrant it."},"aliasFields":{"type":"array","description":"A list of alias fields in manifests (package.jsons). Specify a field, such as browser, to be parsed according to [this specification](https://github.com/defunctzombie/package-browser-field-spec). Also see [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields) in the webpack docs. Defaults to an empty array (don't use any alias fields).","items":{"type":"string"}},"cachedInputFileSystem":{"type":"object","description":"Options to pass to the resolver (webpack's 'enhanced resolve') regarding caching.","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000,"description":"The number of milliseconds [enhanced-resolve](webpack/enhanced-resolve)'s cached file system should use for cache duration. Typically you won't have to touch this - the default works well for repos up to 5000 modules/ 20000 dependencies, and likely for numbers above as well. If you experience memory problems on a (humongous) repository you can use the cacheDuration attribute to tame enhanced-resolve's memory usage by lowering the cache duration trading off against some (for values over 1000ms) or significant (for values below 500ms) performance. Dependency-cruiser currently uses 4000ms, and in the past has used 1000ms - both with good results."}}}}},"babelConfig":{"type":"object","additionalProperties":false,"description":"Babel configuration (e.g. '.babelrc.json') to use.","properties":{"fileName":{"description":"The Babel configuration file to use. The fileName is relative to dependency-cruiser's current working directory. When not provided defaults to './.babelrc.json'. Dependency-cruiser currently supports only the json variant. Support for (js|cjs|mjs) variants and configuration in package.json might follow in future releases.","type":"string"}}},"parser":{"type":"string","description":"overrides the parser dependency-cruiser will use - EXPERIMENTAL. The use of 'swc' as a parser here is deprecated.","enum":["acorn","tsc","swc"]},"exoticRequireStrings":{"type":"array","description":"List of strings you have in use in addition to cjs/ es6 requires & imports to declare module dependencies. Use this e.g. if you've re-declared require (`const want = require`), use a require-wrapper (like semver-try-require) or use window.require as a hack to workaround something","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"description":"How dependency-cruiser shows progress. Defaults to 'none'.","properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","ndjson","none"]},"maximumLevel":{"description":"The maximum log level to emit messages at. Ranges from OFF (-1, don't show any messages), via SUMMARY (40), INFO (50), DEBUG (60) all the way to show ALL messages (99).","type":"number","enum":[-1,40,50,60,70,80,99]}}},"metrics":{"type":"boolean","description":"When this flag is set to true, dependency-cruiser will calculate (stability) metrics for all modules and folders. Defaults to false."},"experimentalStats":{"type":"boolean","description":"When this flag is set to true, dependency-cruiser will calculate some stats for each module. Has some performance impact. EXPERIMENTAL Will be renamed when the 'experimental' state is lifted. Defaults to false."},"skipAnalysisNotInRules":{"type":"boolean","description":"When this flag is set to true, dependency-cruiser will skip all analysis that don't serve a rule. E.g. if there's no 'circular' rule in the rule set it won't analyse cycles. This flag affects cycle, dependents and orphan analysis. If you have a rule set that doesn't use one of these features, switching it to true will make cruises faster. Defaults to false for backwards compatibility. For most uses of dependency-cruiser we recommend to switch this option to true, though."},"baseDir":{"type":"string","description":"The directory dependency-cruiser should run its cruise from. Defaults to the current working directory."},"cache":{"oneOf":[{"type":"boolean"},{"deprecated":true,"type":"string"},{"$ref":"#/definitions/CacheOptionsType"}],"description":"- false: don't use caching. \n- true or empty object: use caching with the default settings \n- a string (deprecated): cache in the folder denoted by the string & use the \n default caching strategy. This is deprecated - instead pass a cache object \n e.g. ```{ folder: 'your/cache/location' }```.\n\nDefaults to false (no caching).\nWhen caching is switched on the default cache folder is 'node_modules/.cache/dependency-cruiser/'"}}},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"ModuleSystemsType":{"type":"array","description":"List of module systems to cruise. Defaults to [amd, cjs, es6]","items":{"$ref":"#/definitions/ModuleSystemType"}},"CompoundExcludeType":{"type":"object","description":"Criteria for dependencies to exclude","additionalProperties":false,"properties":{"path":{"description":"a regular expression for modules to exclude from being cruised","$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean","description":"a boolean indicating whether or not to exclude dynamic dependencies"}}},"CompoundDoNotFollowType":{"type":"object","description":"Criteria for modules to include, but not to follow further","additionalProperties":false,"properties":{"path":{"description":"a regular expression for modules to include, but not follow further","$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","description":"an array of dependency types to include, but not follow further","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","description":"Criteria for modules to only include","additionalProperties":false,"properties":{"path":{"description":"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)","$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","description":"Criteria for modules to 'focus' on","additionalProperties":false,"properties":{"path":{"description":"dependency-cruiser will include modules matching this regular expression in its output, as well as their neighbours (direct dependencies and dependents)","$ref":"#/definitions/REAsStringsType"},"depth":{"description":"by default 'focus' only inlcudes the direct neighbours of the focus'ed module(s). This property makes dependency-cruiser will also include neighbors of neighbors, up to the specified depth.","type":"number","minimum":1,"maximum":4}}},"CompoundReachesType":{"type":"object","additionalProperties":false,"properties":{"path":{"description":"dependency-cruiser will include modules matching this regular expression in its output, as well as _any_ module that reaches them - either directly or via via","$ref":"#/definitions/REAsStringsType"}}},"CompoundHighlightType":{"type":"object","additionalProperties":false,"properties":{"path":{"description":"dependency-cruiser will mark modules matching this regular expression as 'highlighted' in its output","$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","description":"Options to tweak the output of reporters","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"markdown":{"$ref":"#/definitions/MarkdownReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"},"mermaid":{"$ref":"#/definitions/MermaidReporterOptionsType"},"text":{"$ref":"#/definitions/TextReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","description":"Options to tweak the output of the anonymous reporter","additionalProperties":false,"properties":{"wordlist":{"type":"array","description":"List of words to use to replace path elements of file names in the output with so the output isn't directly traceable to its intended purpose. When the list is exhausted, the anon reporter will use random strings patterned after the original file name in stead. The list is empty by default. Read more in https://github.com/sverweij/dependency-cruiser/blob/main/doc/cli.md#anon---obfuscated-json","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","description":"Options to tweak the output of the metrics reporter","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name","size","topLevelStatementCount"],"description":"By what attribute (in addition to the names of the folders/ modules) to order the metrics by. Defaults to 'instability'."},"hideModules":{"type":"boolean","description":"When true hides module metrics from the report. Defaults to false"},"hideFolders":{"type":"boolean","description":"When true hides folder metrics from the report. Defaults to false"}}},"MarkdownReporterOptionsType":{"type":"object","description":"Options to show and hide sections of the markdown reporter and to provide alternate boilerplate text","additionalProperties":false,"properties":{"showTitle":{"type":"boolean","description":"Whether or not to show a title in the report. Defaults to true."},"title":{"type":"string","description":"The text to show as a title of the report. E.g. '## dependency-cruiser forbidden dependency check - results'. When left out shows a default value."},"showSummary":{"type":"boolean","description":"Whether or not to show a summary in the report. Defaults to true."},"showSummaryHeader":{"type":"boolean","description":"Whether or not to give the summary a header. Defaults to true."},"summaryHeader":{"type":"string","description":"The text to show as a header on top of the summary. E.g. '### Summary'. When left out shows a default value."},"showStatsSummary":{"type":"boolean","description":"Whether or not to show high level stats in the summary. Defaults to true."},"showRulesSummary":{"type":"boolean","description":"Whether or not to show a list of violated rules in the summary. Defaults to true."},"includeIgnoredInSummary":{"type":"boolean","description":"Whether or not to show rules in the list of rules for which all violations are ignored. Defaults to true."},"showDetails":{"type":"boolean","description":"Whether or not to show a detailed list of violations. Defaults to true."},"includeIgnoredInDetails":{"type":"boolean","description":"Whether or not to show ignored violations in the detailed list. Defaults to true."},"showDetailsHeader":{"type":"boolean","description":"Whether or not to give the detailed list of violations a header. Defaults to true."},"detailsHeader":{"type":"string","description":"The text to show as a header on top of the detailed list of violations. E.g. '### All violations'. When left out shows a default value."},"collapseDetails":{"type":"boolean","description":"Whether or not to collapse the list of violations in a <details> block. Defaults to true."},"collapsedMessage":{"type":"string","description":"The text to in the <summary> section of the <details> block. E.g. 'click to see all violations'. When left out shows a default value."},"noViolationsMessage":{"type":"string","description":"The text to show when no violations were found. E.g. 'No violations found'. When left out shows a default value."},"showFooter":{"type":"boolean","description":"Whether or not to show a footer (with version & run date) at the bottom of the report. Defaults to true"}}},"MermaidReporterOptionsType":{"type":"object","description":"Options to tweak the output of the mermaid reporters","additionalProperties":false,"properties":{"minify":{"type":"boolean","description":"Whether or not to compresses the output text. Defaults to true."}}},"TextReporterOptionsType":{"type":"object","description":"Options that influence rendition of the text reporter","additionalProperties":false,"properties":{"highlightFocused":{"type":"boolean","description":"Whether or not to highlight modules that are focused with the --focus command line option (/ general option). Defaults to false"}}},"DotReporterOptionsType":{"type":"object","description":"Options to tweak the output of the dot reporters","additionalProperties":false,"properties":{"collapsePattern":{"description":"Regular expressions to collapse to. For the \"dot\" reporter defaults to null, but \"node_modules/[^/]+\" is recommended for most use cases.","$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"description":"When passed the value 'true', shows instability metrics in the output if dependency-cruiser calculated them. Doesn't show them in all other cases. Defaults to false","type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","description":"A bunch of criteria to conditionally theme the dot output","additionalProperties":false,"properties":{"replace":{"type":"boolean","description":"If passed with the value 'true', the passed theme replaces the default one. In all other cases it extends the default theme."},"graph":{"description":"Name- value pairs of GraphViz dot (global) attributes.","type":"object"},"node":{"description":"Name- value pairs of GraphViz dot node attributes.","type":"object"},"edge":{"description":"Name- value pairs of GraphViz dot edge attributes.","type":"object"},"modules":{"description":"List of criteria and attributes to apply for modules when the criteria are met. Conditions can use any module attribute. Attributes can be any that are valid in GraphViz dot nodes.","$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"description":"List of criteria and attributes to apply for dependencies when the criteria are met. Conditions can use any dependency attribute. Attributes can be any that are valid in GraphViz dot edges.","$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","description":"filters to apply to the reporter before rendering it (e.g. to leave out details from the graphical output that are not relevant for the goal of the report)","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"},"reaches":{"$ref":"#/definitions/CompoundReachesType"}}},"ViolationsType":{"type":"array","description":"A list of violations found in the dependencies. The dependencies themselves also contain this information, this summary is here for convenience.","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"$ref":"#/definitions/MiniDependency"},"description":"The circular path if the violation is about circularity"},"via":{"type":"array","items":{"$ref":"#/definitions/MiniDependency"},"description":"The path from the from to the to if the violation is transitive"},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string","description":"Free format text you can e.g. use to explain why this violation can be ignored or is quarantined (only used in _known-violations_) "}}},"RuleSummaryType":{"type":"object","description":"If there was a rule violation (valid === false), this object contains the name of the rule and severity of violating it.","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The (short, eslint style) name of the violated rule. Typically something like 'no-core-punycode' or 'no-outside-deps'."},"severity":{"$ref":"#/definitions/SeverityType"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"MiniDependency":{"type":"object","description":"A small dependency object with the uniquely identifying name of the module +the dependency types it has relative to the _previous_ module in the chain it is part of (e.g. a cycle).","required":["name","dependencyTypes"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the module"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"},"description":"The dependency types of the module relative to the previous module in the chain it is a part of (e.g. a cycle)"}}},"CacheOptionsType":{"type":"object","additionalProperties":false,"properties":{"folder":{"type":"string","description":"The folder to store the cache in. Defaults to node_modules/.cache/dependency-cruiser"},"strategy":{"$ref":"#/definitions/CacheStrategyType"},"compress":{"type":"boolean","description":"Whether to compress the cache or not\nSetting this to true will adds a few ms to the execution time, but\ntypically reduces the cache size by 80-90%.\n\nDefaults to false.","default":false}}},"CacheStrategyType":{"type":"string","description":"The strategy to use for caching.\n- 'metadata': use git metadata to detect changes;\n- 'content': use (a checksum of) the contents of files to detect changes.\n\n'content' is useful if you're not using git or work on partial clones (which is typical on CI's). Trade-of: the 'content' strategy is typically slower.\n\nDefaults to 'metadata'.","enum":["metadata","content"]},"ExtendsType":{"description":"A configuration (or an array of configurations) this configuration uses as a base","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}}
|
Provide a JSON object that satisfies the schema "dependency-cruiser configuration". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
dependency-cruiser configuration
|
schema-store
|
schema_store_212
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"types\":{\"$ref\":\"#/definitions/TypesDefinition\"},\"services\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/ServiceDefinition\"}}},\"definitions\":{\"TypesDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"conjure-imports\":{\"type\":\"object\",\"description\":\"A map between a namespace and a relative path to a Conjure definition file.\",\"additionalProperties\":false,\"patternProperties\":{\"^[_a-zA-Z][_a-zA-Z0-9]*$\":{\"type\":\"string\"}}},\"imports\":{\"type\":\"object\",\"description\":\"A map between a type alias and its external definition. Type aliases MUST be in PascalCase.\",\"additionalProperties\":{\"$ref\":\"#/definitions/ExternalTypeDefinition\"}},\"definitions\":{\"$ref\":\"#/definitions/NamedTypesDefinition\",\"description\":\"The types specified in this definition.\"}}},\"ExternalTypeDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"base-type\":{\"$ref\":\"#/definitions/ConjureType\",\"description\":\"A base-type is provided as a hint to generators for how to handle this type when no external type reference is provided. Note that the serialization format of the base-type fallback should match the format of the imported type. If the imported type is a non-primitive JSON object, then a base-type of any should be used.\"},\"external\":{\"$ref\":\"#/definitions/ExternalImportDefinition\",\"description\":\"The external types to reference.\"}}},\"ExternalImportDefinition\":{\"type\":\"object\",\"description\":\"References to types that are not defined within Conjure.\",\"additionalProperties\":false,\"properties\":{\"java\":{\"description\":\"The fully qualified Java type.\",\"type\":\"string\"}}},\"NamedTypesDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"default-package\":{\"type\":\"string\"},\"objects\":{\"type\":\"object\",\"additionalProperties\":false,\"propertyNames\":{\"$ref\":\"#/definitions/TypeName\"},\"patternProperties\":{\"\":{\"oneOf\":[{\"$ref\":\"#/definitions/AliasDefinition\"},{\"$ref\":\"#/definitions/ObjectTypeDefinition\"},{\"$ref\":\"#/definitions/UnionTypeDefinition\"},{\"$ref\":\"#/definitions/EnumTypeDefinition\"}]}}},\"errors\":{\"type\":\"object\",\"additionalProperties\":false,\"propertyNames\":{\"$ref\":\"#/definitions/TypeName\"},\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/ErrorDefinition\"}}}}},\"ConjureType\":{\"anyOf\":[{\"$ref\":\"#/definitions/TypeName\"},{\"$ref\":\"#/definitions/ContainerType\"},{\"$ref\":\"#/definitions/BuiltIn\"}]},\"TypeName\":{\"description\":\"Named types must be in PascalCase and be unique within a package.\",\"type\":\"string\",\"pattern\":\"^([a-zA-Z]+[.])?[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$\"},\"ContainerType\":{\"description\":\"Container types like optional<T>, list<T>, set<T> and map<K, V> can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:\",\"type\":\"string\",\"pattern\":\"^(optional|list|set|map)<.*>$\"},\"BuiltIn\":{\"enum\":[\"any\",\"bearertoken\",\"binary\",\"boolean\",\"datetime\",\"double\",\"integer\",\"rid\",\"safelong\",\"string\",\"uuid\"]},\"AliasDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"alias\":{\"description\":\"The Conjure type to be aliased.\",\"$ref\":\"#/definitions/ConjureType\"},\"safety\":{\"$ref\":\"#/definitions/LogSafety\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"}},\"required\":[\"alias\"]},\"ObjectTypeDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"fields\":{\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/definitions/FieldDefinition\"},{\"$ref\":\"#/definitions/ConjureType\"}]}},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"}},\"required\":[\"fields\"]},\"FieldDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"$ref\":\"#/definitions/ConjureType\"},\"safety\":{\"$ref\":\"#/definitions/LogSafety\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"},\"deprecated\":{\"$ref\":\"#/definitions/DocString\"}},\"required\":[\"type\"]},\"UnionTypeDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"union\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/definitions/FieldDefinition\"},{\"$ref\":\"#/definitions/ConjureType\"}]}},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"}},\"required\":[\"union\"]},\"EnumTypeDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"values\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/UpperCase\"},{\"$ref\":\"#/definitions/EnumValueDefinition\"}]}},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"}},\"required\":[\"values\"]},\"EnumValueDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"value\":{\"$ref\":\"#/definitions/UpperCase\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"package\":{\"type\":\"string\"},\"deprecated\":{\"$ref\":\"#/definitions/DocString\"}},\"required\":[\"value\"]},\"ErrorDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"namespace\":{\"$ref\":\"#/definitions/PascalCase\"},\"code\":{\"$ref\":\"#/definitions/ErrorCode\"},\"package\":{\"type\":\"string\"},\"safe-args\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/definitions/FieldDefinition\"},{\"$ref\":\"#/definitions/ConjureType\"}]}},\"unsafe-args\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/definitions/FieldDefinition\"},{\"$ref\":\"#/definitions/ConjureType\"}]}},\"docs\":{\"$ref\":\"#/definitions/DocString\"}},\"required\":[\"namespace\",\"code\"]},\"ErrorCode\":{\"enum\":[\"PERMISSION_DENIED\",\"INVALID_ARGUMENT\",\"NOT_FOUND\",\"CONFLICT\",\"REQUEST_ENTITY_TOO_LARGE\",\"FAILED_PRECONDITION\",\"INTERNAL\",\"TIMEOUT\",\"CUSTOM_CLIENT\",\"CUSTOM_SERVER\"]},\"ServiceDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"package\":{\"type\":\"string\"},\"base-path\":{\"$ref\":\"#/definitions/PathString\"},\"default-auth\":{\"$ref\":\"#/definitions/AuthDefinition\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"endpoints\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/EndpointDefinition\"}}},\"required\":[\"package\",\"endpoints\"]},\"PathString\":{\"type\":\"string\"},\"AuthDefinition\":{\"oneOf\":[{\"enum\":[\"none\",\"header\"]},{\"type\":\"string\",\"pattern\":\"^cookie:[a-zA-Z0-9]+$\"}]},\"EndpointDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"http\":{\"type\":\"string\",\"pattern\":\"^(GET|DELETE|POST|PUT) .*$\"},\"auth\":{\"$ref\":\"#/definitions/AuthDefinition\"},\"returns\":{\"$ref\":\"#/definitions/ConjureType\"},\"errors\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TypeName\"},{\"$ref\":\"#/definitions/EndpointError\"}]}},\"args\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/definitions/ArgumentDefinition\"},{\"$ref\":\"#/definitions/ConjureType\"}]}},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"deprecated\":{\"$ref\":\"#/definitions/DocString\"},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}},\"required\":[\"http\"]},\"ArgumentDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"$ref\":\"#/definitions/ConjureType\"},\"param-id\":{\"type\":\"string\"},\"param-type\":{\"$ref\":\"#/definitions/ArgumentDefinitionParamType\"},\"safety\":{\"$ref\":\"#/definitions/LogSafety\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"markers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}},\"required\":[\"type\"]},\"ArgumentDefinitionParamType\":{\"enum\":[\"auto\",\"path\",\"body\",\"header\",\"query\"]},\"EndpointError\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"error\":{\"$ref\":\"#/definitions/TypeName\"},\"docs\":{\"$ref\":\"#/definitions/DocString\"}},\"required\":[\"error\"]},\"DocString\":{\"type\":\"string\"},\"LogSafety\":{\"enum\":[\"safe\",\"unsafe\",\"do-not-log\"]},\"UpperCase\":{\"pattern\":\"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$\"},\"PascalCase\":{\"type\":\"string\",\"pattern\":\"^[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"conjure.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","additionalProperties":false,"properties":{"types":{"$ref":"#/definitions/TypesDefinition"},"services":{"type":"object","additionalProperties":{"$ref":"#/definitions/ServiceDefinition"}}},"definitions":{"TypesDefinition":{"type":"object","additionalProperties":false,"properties":{"conjure-imports":{"type":"object","description":"A map between a namespace and a relative path to a Conjure definition file.","additionalProperties":false,"patternProperties":{"^[_a-zA-Z][_a-zA-Z0-9]*$":{"type":"string"}}},"imports":{"type":"object","description":"A map between a type alias and its external definition. Type aliases MUST be in PascalCase.","additionalProperties":{"$ref":"#/definitions/ExternalTypeDefinition"}},"definitions":{"$ref":"#/definitions/NamedTypesDefinition","description":"The types specified in this definition."}}},"ExternalTypeDefinition":{"type":"object","additionalProperties":false,"properties":{"base-type":{"$ref":"#/definitions/ConjureType","description":"A base-type is provided as a hint to generators for how to handle this type when no external type reference is provided. Note that the serialization format of the base-type fallback should match the format of the imported type. If the imported type is a non-primitive JSON object, then a base-type of any should be used."},"external":{"$ref":"#/definitions/ExternalImportDefinition","description":"The external types to reference."}}},"ExternalImportDefinition":{"type":"object","description":"References to types that are not defined within Conjure.","additionalProperties":false,"properties":{"java":{"description":"The fully qualified Java type.","type":"string"}}},"NamedTypesDefinition":{"type":"object","additionalProperties":false,"properties":{"default-package":{"type":"string"},"objects":{"type":"object","additionalProperties":false,"propertyNames":{"$ref":"#/definitions/TypeName"},"patternProperties":{"":{"oneOf":[{"$ref":"#/definitions/AliasDefinition"},{"$ref":"#/definitions/ObjectTypeDefinition"},{"$ref":"#/definitions/UnionTypeDefinition"},{"$ref":"#/definitions/EnumTypeDefinition"}]}}},"errors":{"type":"object","additionalProperties":false,"propertyNames":{"$ref":"#/definitions/TypeName"},"patternProperties":{"":{"$ref":"#/definitions/ErrorDefinition"}}}}},"ConjureType":{"anyOf":[{"$ref":"#/definitions/TypeName"},{"$ref":"#/definitions/ContainerType"},{"$ref":"#/definitions/BuiltIn"}]},"TypeName":{"description":"Named types must be in PascalCase and be unique within a package.","type":"string","pattern":"^([a-zA-Z]+[.])?[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$"},"ContainerType":{"description":"Container types like optional<T>, list<T>, set<T> and map<K, V> can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:","type":"string","pattern":"^(optional|list|set|map)<.*>$"},"BuiltIn":{"enum":["any","bearertoken","binary","boolean","datetime","double","integer","rid","safelong","string","uuid"]},"AliasDefinition":{"type":"object","additionalProperties":false,"properties":{"alias":{"description":"The Conjure type to be aliased.","$ref":"#/definitions/ConjureType"},"safety":{"$ref":"#/definitions/LogSafety"},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"}},"required":["alias"]},"ObjectTypeDefinition":{"type":"object","additionalProperties":false,"properties":{"fields":{"additionalProperties":{"anyOf":[{"$ref":"#/definitions/FieldDefinition"},{"$ref":"#/definitions/ConjureType"}]}},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"}},"required":["fields"]},"FieldDefinition":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/definitions/ConjureType"},"safety":{"$ref":"#/definitions/LogSafety"},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"},"deprecated":{"$ref":"#/definitions/DocString"}},"required":["type"]},"UnionTypeDefinition":{"type":"object","additionalProperties":false,"properties":{"union":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/definitions/FieldDefinition"},{"$ref":"#/definitions/ConjureType"}]}},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"}},"required":["union"]},"EnumTypeDefinition":{"type":"object","additionalProperties":false,"properties":{"values":{"type":"array","uniqueItems":true,"items":{"anyOf":[{"$ref":"#/definitions/UpperCase"},{"$ref":"#/definitions/EnumValueDefinition"}]}},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"}},"required":["values"]},"EnumValueDefinition":{"type":"object","additionalProperties":false,"properties":{"value":{"$ref":"#/definitions/UpperCase"},"docs":{"$ref":"#/definitions/DocString"},"package":{"type":"string"},"deprecated":{"$ref":"#/definitions/DocString"}},"required":["value"]},"ErrorDefinition":{"type":"object","additionalProperties":false,"properties":{"namespace":{"$ref":"#/definitions/PascalCase"},"code":{"$ref":"#/definitions/ErrorCode"},"package":{"type":"string"},"safe-args":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/definitions/FieldDefinition"},{"$ref":"#/definitions/ConjureType"}]}},"unsafe-args":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/definitions/FieldDefinition"},{"$ref":"#/definitions/ConjureType"}]}},"docs":{"$ref":"#/definitions/DocString"}},"required":["namespace","code"]},"ErrorCode":{"enum":["PERMISSION_DENIED","INVALID_ARGUMENT","NOT_FOUND","CONFLICT","REQUEST_ENTITY_TOO_LARGE","FAILED_PRECONDITION","INTERNAL","TIMEOUT","CUSTOM_CLIENT","CUSTOM_SERVER"]},"ServiceDefinition":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"package":{"type":"string"},"base-path":{"$ref":"#/definitions/PathString"},"default-auth":{"$ref":"#/definitions/AuthDefinition"},"docs":{"$ref":"#/definitions/DocString"},"endpoints":{"type":"object","additionalProperties":{"$ref":"#/definitions/EndpointDefinition"}}},"required":["package","endpoints"]},"PathString":{"type":"string"},"AuthDefinition":{"oneOf":[{"enum":["none","header"]},{"type":"string","pattern":"^cookie:[a-zA-Z0-9]+$"}]},"EndpointDefinition":{"type":"object","additionalProperties":false,"properties":{"http":{"type":"string","pattern":"^(GET|DELETE|POST|PUT) .*$"},"auth":{"$ref":"#/definitions/AuthDefinition"},"returns":{"$ref":"#/definitions/ConjureType"},"errors":{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/TypeName"},{"$ref":"#/definitions/EndpointError"}]}},"args":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/definitions/ArgumentDefinition"},{"$ref":"#/definitions/ConjureType"}]}},"docs":{"$ref":"#/definitions/DocString"},"deprecated":{"$ref":"#/definitions/DocString"},"tags":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"required":["http"]},"ArgumentDefinition":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/definitions/ConjureType"},"param-id":{"type":"string"},"param-type":{"$ref":"#/definitions/ArgumentDefinitionParamType"},"safety":{"$ref":"#/definitions/LogSafety"},"docs":{"$ref":"#/definitions/DocString"},"tags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"markers":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"required":["type"]},"ArgumentDefinitionParamType":{"enum":["auto","path","body","header","query"]},"EndpointError":{"type":"object","additionalProperties":false,"properties":{"error":{"$ref":"#/definitions/TypeName"},"docs":{"$ref":"#/definitions/DocString"}},"required":["error"]},"DocString":{"type":"string"},"LogSafety":{"enum":["safe","unsafe","do-not-log"]},"UpperCase":{"pattern":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"},"PascalCase":{"type":"string","pattern":"^[A-Z][a-z0-9]+([A-Z][a-z0-9]+)*$"}}}
|
Provide a JSON object that satisfies the schema "conjure.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
conjure.schema
|
schema-store
|
schema_store_213
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"type\":[\"object\",\"null\"],\"title\":\"Connections\",\"description\":\"Connection catalog\",\"patternProperties\":{\".\":{\"type\":\"object\",\"$ref\":\"#/definitions/connection\"}},\"definitions\":{\"connection\":{\"type\":\"object\",\"if\":{\"properties\":{\"type\":{\"enum\":[\"cassandra\",\"mysql\",\"postgresql\",\"sqlserver\"]}}},\"then\":{\"properties\":{\"driver\":{\"description\":\"Explicit driver to use, if not using default\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\"},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\"},\"debug\":{\"title\":\"Debug mode\",\"description\":\"Echo all SQL commands to stdout\",\"type\":\"boolean\",\"default\":false}}},\"required\":[\"type\"],\"oneOf\":[{\"title\":\"Cassandra\",\"description\":\"Schema for configuring Cassandra database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"DB type\",\"type\":\"string\",\"const\":\"cassandra\"},\"hosts\":{\"description\":\"Cassandra hosts\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"Address of Cassandra node\"}},\"port\":{\"description\":\"Cassandra DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535,\"default\":9042},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"}},\"additionalProperties\":false,\"required\":[\"type\",\"hosts\"],\"examples\":[{\"cache\":{\"type\":\"cassandra\",\"hosts\":[\"localhost\"],\"port\":9042,\"database\":\"myDB\",\"user\":\"myUser\",\"password\":\"myPassword\"}}]},{\"title\":\"DB2\",\"description\":\"Schema for configuring DB2 database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"db2\"},\"host\":{\"description\":\"DB host\",\"type\":\"string\"},\"port\":{\"description\":\"DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"type\",\"host\",\"port\",\"database\",\"user\"],\"examples\":[{\"db2\":{\"type\":\"db2\",\"host\":\"localhost\",\"port\":50000,\"database\":\"sample\",\"user\":\"myuser\",\"password\":\"mypass\",\"connect_args\":{\"ssl_ca\":\"/opt/ssl/ca.crt\",\"ssl_cert\":\"/opt/ssl/client.crt\",\"ssl_key\":\"/opt/ssl/client.key\"}}}]},{\"title\":\"HTTP Connection\",\"description\":\"Schema for configuring HTTP connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"http\"},\"base_uri\":{\"description\":\"Base URI for the API endpoint\",\"type\":\"string\"},\"headers\":{\"description\":\"HTTP headers, including authorization token\",\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"expression\":{\"description\":\"Expression\",\"type\":\"string\"},\"language\":{\"description\":\"Language\",\"type\":\"string\",\"enum\":[\"jmespath\",\"sql\"]}},\"required\":[\"expression\",\"language\"]}]}},\"query_parameters\":{\"description\":\"Default query parameters for all API endpoints\",\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"expression\":{\"description\":\"Expression\",\"type\":\"string\"},\"language\":{\"description\":\"Language\",\"type\":\"string\",\"enum\":[\"jmespath\",\"sql\"]}},\"required\":[\"expression\",\"language\"]}]}},\"timeout\":{\"description\":\"Timeout for HTTP connection in seconds\",\"type\":\"integer\",\"default\":10}},\"required\":[\"type\",\"base_uri\"],\"additionalProperties\":false,\"examples\":[{\"base_uri\":\"https://api.example.com\",\"headers\":{\"Authorization\":{\"expression\":\"concat([ 'Bearer ', token])\",\"language\":\"jmespath\"},\"Content-Type\":\"application/json\"},\"query_parameters\":{\"id\":{\"expression\":\"user_id\",\"language\":\"jmespath\"},\"timestamp\":{\"expression\":\"date('now')\",\"language\":\"sql\"}}}]},{\"title\":\"MySQL\",\"description\":\"Schema for configuring MySQL database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"mysql\"},\"host\":{\"description\":\"DB host\",\"type\":\"string\"},\"port\":{\"description\":\"DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"type\",\"host\",\"port\",\"database\",\"user\"],\"examples\":[{\"hr\":{\"type\":\"mysql\",\"host\":\"localhost\",\"port\":3306,\"database\":\"hr\",\"user\":\"myuser\",\"password\":\"mypass\",\"connect_args\":{\"ssl_ca\":\"/opt/ssl/ca.crt\",\"ssl_cert\":\"/opt/ssl/client.crt\",\"ssl_key\":\"/opt/ssl/client.key\"}}}]},{\"title\":\"Oracle\",\"description\":\"Schema for configuring Oracle database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"oracle\"},\"host\":{\"description\":\"DB host\",\"type\":\"string\"},\"port\":{\"description\":\"DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"driver\":{\"description\":\"Driver\",\"type\":\"string\"},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"},\"oracle_thick_mode\":{\"description\":\"Enable oracle's thick mode(requires installed Oracle Client)\",\"type\":\"boolean\",\"default\":false},\"oracle_thick_mode_lib_dir\":{\"description\":\"Path to Oracle Client libraries\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"type\",\"host\",\"port\",\"database\",\"user\"],\"examples\":[{\"hr\":{\"type\":\"oracle\",\"host\":\"localhost\",\"port\":5432,\"database\":\"orcl\",\"user\":\"scott\",\"password\":\"tiger\",\"oracle_thick_mode\":true,\"oracle_thick_mode_lib_dir\":\"/opt/oracle/instantclient_21_8/\"}}]},{\"title\":\"PostgreSQL\",\"description\":\"Schema for configuring PostgreSQL database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"postgresql\"},\"host\":{\"description\":\"DB host\",\"type\":\"string\"},\"port\":{\"description\":\"DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"type\",\"host\",\"port\",\"database\",\"user\"],\"examples\":[{\"hr\":{\"type\":\"postgresql\",\"host\":\"localhost\",\"port\":5432,\"database\":\"postgres\",\"user\":\"postgres\",\"password\":\"postgres\",\"connect_args\":{\"connect_timeout\":10},\"query_args\":{\"sslmode\":\"verify-ca\",\"sslrootcert\":\"/opt/ssl/ca.crt\",\"sslcert\":\"/opt/ssl/client.crt\",\"sslkey\":\"/opt/ssl/client.key\"}}}]},{\"title\":\"Redis\",\"description\":\"Schema for configuring Redis database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"redis\"},\"host\":{\"description\":\"Redis DB host\",\"type\":\"string\"},\"port\":{\"description\":\"Redis DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"user\":{\"description\":\"Redis DB user\",\"type\":\"string\"},\"password\":{\"description\":\"Redis DB password\",\"type\":\"string\"},\"key\":{\"description\":\"Private key file to authenticate with\",\"type\":\"string\"},\"key_password\":{\"description\":\"Password for unlocking an encrypted private key\",\"type\":\"string\"},\"cert\":{\"description\":\"Client certificate file to authenticate with\",\"type\":\"string\"},\"cacert\":{\"description\":\"CA certificate file to verify with\",\"type\":\"string\"},\"socket_timeout\":{\"description\":\"Socket timeout in seconds\",\"type\":\"number\",\"minimum\":0,\"default\":10.0},\"socket_connect_timeout\":{\"description\":\"Socket connection timeout in seconds\",\"type\":\"number\",\"minimum\":0,\"default\":2.0},\"socket_keepalive\":{\"description\":\"Enable/disable TCP keepalive\",\"type\":\"boolean\",\"default\":true},\"health_check_interval\":{\"description\":\"Interval for health checks in seconds\",\"type\":\"number\",\"minimum\":0,\"default\":60}},\"additionalProperties\":false,\"required\":[\"type\",\"host\",\"port\"],\"dependentRequired\":{\"key\":[\"cert\"],\"cert\":[\"key\"],\"key_password\":[\"key\"]},\"examples\":[{\"cache\":{\"type\":\"redis\",\"host\":\"localhost\",\"port\":6379,\"socket_timeout\":10.0,\"socket_connect_timeout\":2.0,\"socket_keepalive\":true,\"health_check_interval\":60}}]},{\"title\":\"SQL Server\",\"description\":\"Schema for configuring SQL Server database connection parameters\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Connection type\",\"type\":\"string\",\"const\":\"sqlserver\"},\"host\":{\"description\":\"DB host\",\"type\":\"string\"},\"port\":{\"description\":\"DB port\",\"type\":\"integer\",\"minimum\":1,\"maximum\":65535},\"database\":{\"description\":\"DB name\",\"type\":\"string\"},\"user\":{\"description\":\"DB user\",\"type\":\"string\"},\"password\":{\"description\":\"DB password\",\"type\":\"string\"},\"connect_args\":{\"description\":\"Additional arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true},\"query_args\":{\"description\":\"Additional query string arguments to use when connecting to the DB\",\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"type\",\"host\",\"port\",\"database\",\"user\"],\"examples\":[{\"hr\":{\"type\":\"sqlserver\",\"host\":\"localhost\",\"port\":1433,\"database\":\"hr\",\"user\":\"myuser\",\"password\":\"mypass\"}}]}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Connections\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"type":["object","null"],"title":"Connections","description":"Connection catalog","patternProperties":{".":{"type":"object","$ref":"#/definitions/connection"}},"definitions":{"connection":{"type":"object","if":{"properties":{"type":{"enum":["cassandra","mysql","postgresql","sqlserver"]}}},"then":{"properties":{"driver":{"description":"Explicit driver to use, if not using default","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object"},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object"},"debug":{"title":"Debug mode","description":"Echo all SQL commands to stdout","type":"boolean","default":false}}},"required":["type"],"oneOf":[{"title":"Cassandra","description":"Schema for configuring Cassandra database connection parameters","type":"object","properties":{"type":{"description":"DB type","type":"string","const":"cassandra"},"hosts":{"description":"Cassandra hosts","type":"array","items":{"type":"string","title":"Address of Cassandra node"}},"port":{"description":"Cassandra DB port","type":"integer","minimum":1,"maximum":65535,"default":9042},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"}},"additionalProperties":false,"required":["type","hosts"],"examples":[{"cache":{"type":"cassandra","hosts":["localhost"],"port":9042,"database":"myDB","user":"myUser","password":"myPassword"}}]},{"title":"DB2","description":"Schema for configuring DB2 database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"db2"},"host":{"description":"DB host","type":"string"},"port":{"description":"DB port","type":"integer","minimum":1,"maximum":65535},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object","additionalProperties":true},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object","additionalProperties":true}},"required":["type","host","port","database","user"],"examples":[{"db2":{"type":"db2","host":"localhost","port":50000,"database":"sample","user":"myuser","password":"mypass","connect_args":{"ssl_ca":"/opt/ssl/ca.crt","ssl_cert":"/opt/ssl/client.crt","ssl_key":"/opt/ssl/client.key"}}}]},{"title":"HTTP Connection","description":"Schema for configuring HTTP connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"http"},"base_uri":{"description":"Base URI for the API endpoint","type":"string"},"headers":{"description":"HTTP headers, including authorization token","type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"expression":{"description":"Expression","type":"string"},"language":{"description":"Language","type":"string","enum":["jmespath","sql"]}},"required":["expression","language"]}]}},"query_parameters":{"description":"Default query parameters for all API endpoints","type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"expression":{"description":"Expression","type":"string"},"language":{"description":"Language","type":"string","enum":["jmespath","sql"]}},"required":["expression","language"]}]}},"timeout":{"description":"Timeout for HTTP connection in seconds","type":"integer","default":10}},"required":["type","base_uri"],"additionalProperties":false,"examples":[{"base_uri":"https://api.example.com","headers":{"Authorization":{"expression":"concat([ 'Bearer ', token])","language":"jmespath"},"Content-Type":"application/json"},"query_parameters":{"id":{"expression":"user_id","language":"jmespath"},"timestamp":{"expression":"date('now')","language":"sql"}}}]},{"title":"MySQL","description":"Schema for configuring MySQL database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"mysql"},"host":{"description":"DB host","type":"string"},"port":{"description":"DB port","type":"integer","minimum":1,"maximum":65535},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object","additionalProperties":true},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object","additionalProperties":true}},"required":["type","host","port","database","user"],"examples":[{"hr":{"type":"mysql","host":"localhost","port":3306,"database":"hr","user":"myuser","password":"mypass","connect_args":{"ssl_ca":"/opt/ssl/ca.crt","ssl_cert":"/opt/ssl/client.crt","ssl_key":"/opt/ssl/client.key"}}}]},{"title":"Oracle","description":"Schema for configuring Oracle database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"oracle"},"host":{"description":"DB host","type":"string"},"port":{"description":"DB port","type":"integer","minimum":1,"maximum":65535},"driver":{"description":"Driver","type":"string"},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"},"oracle_thick_mode":{"description":"Enable oracle's thick mode(requires installed Oracle Client)","type":"boolean","default":false},"oracle_thick_mode_lib_dir":{"description":"Path to Oracle Client libraries","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object","additionalProperties":true},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object","additionalProperties":true}},"required":["type","host","port","database","user"],"examples":[{"hr":{"type":"oracle","host":"localhost","port":5432,"database":"orcl","user":"scott","password":"tiger","oracle_thick_mode":true,"oracle_thick_mode_lib_dir":"/opt/oracle/instantclient_21_8/"}}]},{"title":"PostgreSQL","description":"Schema for configuring PostgreSQL database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"postgresql"},"host":{"description":"DB host","type":"string"},"port":{"description":"DB port","type":"integer","minimum":1,"maximum":65535},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object","additionalProperties":true},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object","additionalProperties":true}},"required":["type","host","port","database","user"],"examples":[{"hr":{"type":"postgresql","host":"localhost","port":5432,"database":"postgres","user":"postgres","password":"postgres","connect_args":{"connect_timeout":10},"query_args":{"sslmode":"verify-ca","sslrootcert":"/opt/ssl/ca.crt","sslcert":"/opt/ssl/client.crt","sslkey":"/opt/ssl/client.key"}}}]},{"title":"Redis","description":"Schema for configuring Redis database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"redis"},"host":{"description":"Redis DB host","type":"string"},"port":{"description":"Redis DB port","type":"integer","minimum":1,"maximum":65535},"user":{"description":"Redis DB user","type":"string"},"password":{"description":"Redis DB password","type":"string"},"key":{"description":"Private key file to authenticate with","type":"string"},"key_password":{"description":"Password for unlocking an encrypted private key","type":"string"},"cert":{"description":"Client certificate file to authenticate with","type":"string"},"cacert":{"description":"CA certificate file to verify with","type":"string"},"socket_timeout":{"description":"Socket timeout in seconds","type":"number","minimum":0,"default":10.0},"socket_connect_timeout":{"description":"Socket connection timeout in seconds","type":"number","minimum":0,"default":2.0},"socket_keepalive":{"description":"Enable/disable TCP keepalive","type":"boolean","default":true},"health_check_interval":{"description":"Interval for health checks in seconds","type":"number","minimum":0,"default":60}},"additionalProperties":false,"required":["type","host","port"],"dependentRequired":{"key":["cert"],"cert":["key"],"key_password":["key"]},"examples":[{"cache":{"type":"redis","host":"localhost","port":6379,"socket_timeout":10.0,"socket_connect_timeout":2.0,"socket_keepalive":true,"health_check_interval":60}}]},{"title":"SQL Server","description":"Schema for configuring SQL Server database connection parameters","type":"object","properties":{"type":{"description":"Connection type","type":"string","const":"sqlserver"},"host":{"description":"DB host","type":"string"},"port":{"description":"DB port","type":"integer","minimum":1,"maximum":65535},"database":{"description":"DB name","type":"string"},"user":{"description":"DB user","type":"string"},"password":{"description":"DB password","type":"string"},"connect_args":{"description":"Additional arguments to use when connecting to the DB","type":"object","additionalProperties":true},"query_args":{"description":"Additional query string arguments to use when connecting to the DB","type":"object","additionalProperties":true}},"required":["type","host","port","database","user"],"examples":[{"hr":{"type":"sqlserver","host":"localhost","port":1433,"database":"hr","user":"myuser","password":"mypass"}}]}]}}}
|
Provide a JSON object that satisfies the schema "Connections". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Connections
|
schema-store
|
schema_store_214
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/container-structure-test.json\",\"$comment\":\"https://github.com/GoogleContainerTools/container-structure-test\",\"additionalProperties\":false,\"definitions\":{\"envVar\":{\"$id\":\"#/definitions/envVar\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"key\",\"value\"],\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"The name of the environment variables\"},\"value\":{\"type\":\"string\",\"description\":\"The value of the environment variable\"}}},\"label\":{\"$id\":\"#/definitions/label\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"key\",\"value\"],\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"The name of the label\"},\"value\":{\"type\":\"string\",\"description\":\"The value of the label\"},\"isRegex\":{\"type\":\"boolean\",\"description\":\"Interpreted the value as regex\"}}}},\"description\":\"The Container Structure Tests provide a powerful framework to validate the structure of a container image. These tests can be used to check the output of commands in an image, as well as verify metadata and contents of the filesystem\",\"properties\":{\"schemaVersion\":{\"type\":\"string\",\"description\":\"The schema version of Structure Tests.\",\"default\":\"2.0.0\"},\"commandTests\":{\"type\":\"array\",\"description\":\"A list of command tests\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"command\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the test\"},\"setup\":{\"type\":\"array\",\"description\":\"A list of commands (each with optional flags) to run before the actual command under test.\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"teardown\":{\"type\":\"array\",\"description\":\"A list of commands (each with optional flags) to run after the actual command under test.\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"envVars\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/envVar\"}},\"command\":{\"type\":\"string\",\"description\":\"The command to run in the test.\"},\"args\":{\"type\":\"array\",\"description\":\"The arguments to pass to the command.\",\"items\":{\"type\":\"string\"}},\"expectedOutput\":{\"type\":\"array\",\"description\":\"List of regexes that should match the stdout from running the command.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"excludedOutput\":{\"type\":\"array\",\"description\":\"List of regexes that should not match the stdout from running the command..\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"expectedError\":{\"type\":\"array\",\"description\":\"List of regexes that should match the stderr from running the command.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"excludedError\":{\"type\":\"array\",\"description\":\"List of regexes that should not match the stderr from running the command.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"exitCode\":{\"type\":\"integer\",\"description\":\"Exit code that the command should exit with.\"}}}},\"fileExistenceTests\":{\"type\":\"array\",\"description\":\"File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"path\",\"shouldExist\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the test\"},\"path\":{\"type\":\"string\",\"description\":\"Path to the file or directory under test\",\"default\":\"/\"},\"shouldExist\":{\"type\":\"boolean\",\"description\":\"Whether or not the specified file or directory should exist in the file system\",\"default\":true},\"permissions\":{\"type\":\"string\",\"description\":\"The expected Unix permission string (e.g. drwxrwxrwx) of the files or directory.\"},\"uid\":{\"type\":\"number\",\"description\":\"The expected Unix user ID of the owner of the file or directory.\"},\"gid\":{\"type\":\"number\",\"description\":\"The expected Unix group ID of the owner of the file or directory.\"},\"isExecutableBy\":{\"type\":\"string\",\"description\":\"Checks if file is executable by a given user. \",\"enum\":[\"owner\",\"group\",\"any\",\"other\"]}}}},\"fileContentTests\":{\"description\":\"File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"path\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the test\"},\"path\":{\"type\":\"string\",\"description\":\"Path to the file under test\"},\"expectedContents\":{\"type\":\"array\",\"description\":\"List of regexes that should match the contents of the file\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"excludedContents\":{\"type\":\"array\",\"description\":\"List of regexes that should not match the contents of the file\",\"minItems\":1,\"items\":{\"type\":\"string\"}}}}},\"licenseTests\":{\"description\":\"License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"debian\"],\"properties\":{\"debian\":{\"type\":\"boolean\",\"default\":true,\"description\":\"if the image is based on Debian, check where Debian lists all licenses.\"},\"files\":{\"type\":\"array\",\"description\":\"A list of other files to check.\",\"minItems\":1,\"items\":{\"type\":\"string\"}}}}},\"metadataTest\":{\"type\":\"object\",\"properties\":{\"env\":{\"type\":\"array\",\"description\":\"A list of environment variable key/value pairs that should be set in the container.\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/envVar\"}},\"labels\":{\"type\":\"array\",\"description\":\"A list of image labels key/value pairs that should be set on the container.\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/label\"}},\"entrypoint\":{\"type\":\"array\",\"description\":\"The entrypoint of the container\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"cmd\":{\"type\":\"array\",\"description\":\"The CMD specified in the container\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"exposedPorts\":{\"type\":\"array\",\"description\":\"The ports exposed in the container.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"unexposedPorts\":{\"type\":\"array\",\"description\":\"The ports NOT exposed in the container.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"volumes\":{\"type\":\"array\",\"description\":\"The volumes exposed in the container.\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"unmountedVolumes\":{\"type\":\"array\",\"description\":\"The volumes NOT exposed in the container\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"workdir\":{\"type\":\"string\",\"description\":\"The default working directory of the container.\"}}},\"globalEnvVars\":{\"type\":\"array\",\"description\":\"A list of environment variables can optionally be specified as part of the test setup. \",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/envVar\"}}},\"required\":[\"schemaVersion\"],\"title\":\"Container Structure Tests\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Container Structure Tests\". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/container-structure-test.json","$comment":"https://github.com/GoogleContainerTools/container-structure-test","additionalProperties":false,"definitions":{"envVar":{"$id":"#/definitions/envVar","type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","description":"The name of the environment variables"},"value":{"type":"string","description":"The value of the environment variable"}}},"label":{"$id":"#/definitions/label","type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","description":"The name of the label"},"value":{"type":"string","description":"The value of the label"},"isRegex":{"type":"boolean","description":"Interpreted the value as regex"}}}},"description":"The Container Structure Tests provide a powerful framework to validate the structure of a container image. These tests can be used to check the output of commands in an image, as well as verify metadata and contents of the filesystem","properties":{"schemaVersion":{"type":"string","description":"The schema version of Structure Tests.","default":"2.0.0"},"commandTests":{"type":"array","description":"A list of command tests","items":{"type":"object","required":["name","command"],"properties":{"name":{"type":"string","description":"The name of the test"},"setup":{"type":"array","description":"A list of commands (each with optional flags) to run before the actual command under test.","items":{"type":"array","items":{"type":"string"}}},"teardown":{"type":"array","description":"A list of commands (each with optional flags) to run after the actual command under test.","items":{"type":"array","items":{"type":"string"}}},"envVars":{"type":"array","items":{"$ref":"#/definitions/envVar"}},"command":{"type":"string","description":"The command to run in the test."},"args":{"type":"array","description":"The arguments to pass to the command.","items":{"type":"string"}},"expectedOutput":{"type":"array","description":"List of regexes that should match the stdout from running the command.","minItems":1,"items":{"type":"string"}},"excludedOutput":{"type":"array","description":"List of regexes that should not match the stdout from running the command..","minItems":1,"items":{"type":"string"}},"expectedError":{"type":"array","description":"List of regexes that should match the stderr from running the command.","minItems":1,"items":{"type":"string"}},"excludedError":{"type":"array","description":"List of regexes that should not match the stderr from running the command.","minItems":1,"items":{"type":"string"}},"exitCode":{"type":"integer","description":"Exit code that the command should exit with."}}}},"fileExistenceTests":{"type":"array","description":"File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.","items":{"type":"object","required":["name","path","shouldExist"],"properties":{"name":{"type":"string","description":"The name of the test"},"path":{"type":"string","description":"Path to the file or directory under test","default":"/"},"shouldExist":{"type":"boolean","description":"Whether or not the specified file or directory should exist in the file system","default":true},"permissions":{"type":"string","description":"The expected Unix permission string (e.g. drwxrwxrwx) of the files or directory."},"uid":{"type":"number","description":"The expected Unix user ID of the owner of the file or directory."},"gid":{"type":"number","description":"The expected Unix group ID of the owner of the file or directory."},"isExecutableBy":{"type":"string","description":"Checks if file is executable by a given user. ","enum":["owner","group","any","other"]}}}},"fileContentTests":{"description":"File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists","type":"array","items":{"type":"object","required":["name","path"],"properties":{"name":{"type":"string","description":"The name of the test"},"path":{"type":"string","description":"Path to the file under test"},"expectedContents":{"type":"array","description":"List of regexes that should match the contents of the file","minItems":1,"items":{"type":"string"}},"excludedContents":{"type":"array","description":"List of regexes that should not match the contents of the file","minItems":1,"items":{"type":"string"}}}}},"licenseTests":{"description":"License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.","type":"array","items":{"type":"object","required":["debian"],"properties":{"debian":{"type":"boolean","default":true,"description":"if the image is based on Debian, check where Debian lists all licenses."},"files":{"type":"array","description":"A list of other files to check.","minItems":1,"items":{"type":"string"}}}}},"metadataTest":{"type":"object","properties":{"env":{"type":"array","description":"A list of environment variable key/value pairs that should be set in the container.","minItems":1,"items":{"$ref":"#/definitions/envVar"}},"labels":{"type":"array","description":"A list of image labels key/value pairs that should be set on the container.","minItems":1,"items":{"$ref":"#/definitions/label"}},"entrypoint":{"type":"array","description":"The entrypoint of the container","minItems":1,"items":{"type":"string"}},"cmd":{"type":"array","description":"The CMD specified in the container","minItems":1,"items":{"type":"string"}},"exposedPorts":{"type":"array","description":"The ports exposed in the container.","minItems":1,"items":{"type":"string"}},"unexposedPorts":{"type":"array","description":"The ports NOT exposed in the container.","minItems":1,"items":{"type":"string"}},"volumes":{"type":"array","description":"The volumes exposed in the container.","minItems":1,"items":{"type":"string"}},"unmountedVolumes":{"type":"array","description":"The volumes NOT exposed in the container","minItems":1,"items":{"type":"string"}},"workdir":{"type":"string","description":"The default working directory of the container."}}},"globalEnvVars":{"type":"array","description":"A list of environment variables can optionally be specified as part of the test setup. ","minItems":1,"items":{"$ref":"#/definitions/envVar"}}},"required":["schemaVersion"],"title":"Container Structure Tests","type":"object"}
|
Provide a JSON object that satisfies the schema "Container Structure Tests". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object.
|
Container Structure Tests
|
schema-store
|
schema_store_215
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"K9s context config schema\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"k9s\":{\"additionalProperties\":false,\"properties\":{\"cluster\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"skin\":{\"type\":\"string\"},\"proxy\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"address\":{\"type\":\"string\"}}}]},\"namespace\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"active\":{\"type\":\"string\"},\"lockFavorites\":{\"type\":\"boolean\"},\"favorites\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"view\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"active\":{\"type\":\"string\"}}},\"featureGates\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"nodeShell\":{\"type\":\"boolean\"}}}}}},\"required\":[\"k9s\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"K9s context config schema\". Here are the required top‑level fields: k9s. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"K9s context config schema","type":"object","additionalProperties":false,"properties":{"k9s":{"additionalProperties":false,"properties":{"cluster":{"type":"string"},"readOnly":{"type":"boolean"},"skin":{"type":"string"},"proxy":{"oneOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"address":{"type":"string"}}}]},"namespace":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"string"},"lockFavorites":{"type":"boolean"},"favorites":{"type":"array","items":{"type":"string"}}}},"view":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"string"}}},"featureGates":{"type":"object","additionalProperties":false,"properties":{"nodeShell":{"type":"boolean"}}}}}},"required":["k9s"]}
|
Provide a JSON object that satisfies the schema "K9s context config schema". Here are the required top‑level fields: k9s. Return only the valid JSON object.
|
K9s context config schema
|
schema-store
|
schema_store_216
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/contextive-glossary.json\",\"additionalProperties\":true,\"description\":\"https://docs.contextive.tech/community/guides/setting-up-glossaries/\",\"anyOf\":[{\"properties\":{\"imports\":{\"description\":\"A list of urls, paths or relative paths to be imported into the current glossary scope. See https://docs.contextive.tech/community/guides/setting-up-glossaries/#terms-defined-in-an-external-data-source.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true}},\"required\":[\"imports\"]},{\"properties\":{\"contexts\":{\"description\":\"A list of contexts. See https://docs.contextive.tech/community/guides/setting-up-glossaries/#bounded-contexts.\",\"type\":\"array\",\"items\":{\"title\":\"Context\",\"description\":\"A context in the ubiquitous language, consisting of a list of terms.\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The name of the Context.\",\"type\":\"string\",\"examples\":[\"The Context's Name\"]},\"domainVisionStatement\":{\"title\":\"Domain Vision Statement\",\"description\":\"A statement that describes the purpose of the Context.\",\"type\":\"string\",\"examples\":[\"A statement that describes the purpose of the context.\"]},\"paths\":{\"title\":\"Paths\",\"description\":\"A list of paths that the Context is involved in.\",\"type\":\"array\",\"items\":{\"title\":\"Path\",\"description\":\"A path that the Context is involved in.\",\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true},\"terms\":{\"title\":\"Terms\",\"description\":\"A list of Terms in the Context - see https://docs.contextive.tech/ide/guides/defining-terminology/.\",\"type\":\"array\",\"items\":{\"title\":\"Term\",\"description\":\"A Term in the Context.\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The name of the Term.\",\"type\":\"string\",\"examples\":[\"The Term's Name\"]},\"definition\":{\"title\":\"Definition\",\"description\":\"A definition of the Term in this Context.\",\"type\":\"string\",\"examples\":[\"A definition of the Term in this Context.\"]},\"examples\":{\"title\":\"Examples\",\"description\":\"A list of example sentences using the Term.\",\"type\":\"array\",\"items\":{\"title\":\"Example sentence\",\"description\":\"An example sentence using the Term.\",\"type\":\"string\",\"examples\":[\"An example sentence using the Term.\"]},\"minItems\":1,\"uniqueItems\":true},\"aliases\":{\"title\":\"Aliases\",\"description\":\"A list of aliases for the Term.\",\"type\":\"array\",\"items\":{\"title\":\"Alias\",\"description\":\"An alias for the Term.\",\"type\":\"string\",\"examples\":[\"An alias for the Term.\"]},\"minItems\":1,\"uniqueItems\":true}},\"required\":[\"name\"]},\"minItems\":1,\"uniqueItems\":true}},\"required\":[\"terms\"]},\"minItems\":1,\"uniqueItems\":true}},\"required\":[\"contexts\"]}],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"contextive-glossary\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/contextive-glossary.json","additionalProperties":true,"description":"https://docs.contextive.tech/community/guides/setting-up-glossaries/","anyOf":[{"properties":{"imports":{"description":"A list of urls, paths or relative paths to be imported into the current glossary scope. See https://docs.contextive.tech/community/guides/setting-up-glossaries/#terms-defined-in-an-external-data-source.","type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true}},"required":["imports"]},{"properties":{"contexts":{"description":"A list of contexts. See https://docs.contextive.tech/community/guides/setting-up-glossaries/#bounded-contexts.","type":"array","items":{"title":"Context","description":"A context in the ubiquitous language, consisting of a list of terms.","type":"object","properties":{"name":{"title":"Name","description":"The name of the Context.","type":"string","examples":["The Context's Name"]},"domainVisionStatement":{"title":"Domain Vision Statement","description":"A statement that describes the purpose of the Context.","type":"string","examples":["A statement that describes the purpose of the context."]},"paths":{"title":"Paths","description":"A list of paths that the Context is involved in.","type":"array","items":{"title":"Path","description":"A path that the Context is involved in.","type":"string"},"minItems":1,"uniqueItems":true},"terms":{"title":"Terms","description":"A list of Terms in the Context - see https://docs.contextive.tech/ide/guides/defining-terminology/.","type":"array","items":{"title":"Term","description":"A Term in the Context.","type":"object","properties":{"name":{"title":"Name","description":"The name of the Term.","type":"string","examples":["The Term's Name"]},"definition":{"title":"Definition","description":"A definition of the Term in this Context.","type":"string","examples":["A definition of the Term in this Context."]},"examples":{"title":"Examples","description":"A list of example sentences using the Term.","type":"array","items":{"title":"Example sentence","description":"An example sentence using the Term.","type":"string","examples":["An example sentence using the Term."]},"minItems":1,"uniqueItems":true},"aliases":{"title":"Aliases","description":"A list of aliases for the Term.","type":"array","items":{"title":"Alias","description":"An alias for the Term.","type":"string","examples":["An alias for the Term."]},"minItems":1,"uniqueItems":true}},"required":["name"]},"minItems":1,"uniqueItems":true}},"required":["terms"]},"minItems":1,"uniqueItems":true}},"required":["contexts"]}],"type":"object"}
|
Provide a JSON object that satisfies the schema "contextive-glossary". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
contextive-glossary
|
schema-store
|
schema_store_217
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/convex.json\",\"description\":\"Configuration for Convex project settings.\\n\\nDocumentation: https://docs.convex.dev/production/project-configuration#convexjson\",\"type\":\"object\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"node\":{\"type\":\"object\",\"description\":\"Configuration for the Convex Node.js runtime, where your actions run that have 'use node' at the top of the file.\",\"properties\":{\"externalPackages\":{\"type\":[\"array\"],\"description\":\"List of packages that should be installed on the server instead of being bundled by the CLI. Use this for packages that can't be bundled or need to be installed directly on the server.\\n\\nIf you want to mark all dependencies as external, you can use the string '*' instead of an array.\\n\\nhttps://docs.convex.dev/functions/bundling#external-packages\",\"items\":{\"type\":\"string\"},\"default\":[\"*\"],\"oneOf\":[{\"contains\":{\"const\":\"*\"},\"maxItems\":1},{\"not\":{\"contains\":{\"const\":\"*\"}}}]}}},\"generateCommonJSApi\":{\"type\":\"boolean\",\"description\":\"When true, generates CommonJS-compatible API files for projects not using ES modules. Enable this if your project uses require() syntax instead of ES modules.\\n\\nhttps://docs.convex.dev/client/javascript/node#javascript-with-commonjs-require-syntax\",\"default\":false},\"functions\":{\"type\":\"string\",\"description\":\"Path to the directory containing Convex functions. You can customize this to use a different location than the default 'convex/' directory.\\n\\nhttps://docs.convex.dev/production/project-configuration#changing-the-convex-folder-name-or-location\",\"default\":\"convex/\"}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"convex\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/convex.json","description":"Configuration for Convex project settings.\n\nDocumentation: https://docs.convex.dev/production/project-configuration#convexjson","type":"object","properties":{"$schema":{"type":"string"},"node":{"type":"object","description":"Configuration for the Convex Node.js runtime, where your actions run that have 'use node' at the top of the file.","properties":{"externalPackages":{"type":["array"],"description":"List of packages that should be installed on the server instead of being bundled by the CLI. Use this for packages that can't be bundled or need to be installed directly on the server.\n\nIf you want to mark all dependencies as external, you can use the string '*' instead of an array.\n\nhttps://docs.convex.dev/functions/bundling#external-packages","items":{"type":"string"},"default":["*"],"oneOf":[{"contains":{"const":"*"},"maxItems":1},{"not":{"contains":{"const":"*"}}}]}}},"generateCommonJSApi":{"type":"boolean","description":"When true, generates CommonJS-compatible API files for projects not using ES modules. Enable this if your project uses require() syntax instead of ES modules.\n\nhttps://docs.convex.dev/client/javascript/node#javascript-with-commonjs-require-syntax","default":false},"functions":{"type":"string","description":"Path to the directory containing Convex functions. You can customize this to use a different location than the default 'convex/' directory.\n\nhttps://docs.convex.dev/production/project-configuration#changing-the-convex-folder-name-or-location","default":"convex/"}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "convex". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
convex
|
schema-store
|
schema_store_218
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"id\":\"https://json.schemastore.org/cosmos-config.json\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"rootDir\":{\"description\":\"The root directory that all others paths in this config are relative to. Usually the root of your repo. If omitted, rootDir is equal to the directory containing your Cosmos config. When you don't use a Cosmos config, rootDir defaults to the current working directory.\",\"type\":\"string\",\"minLength\":1},\"exportPath\":{\"description\":\"Where to generate static exports on disk. [default: \\\"cosmos-export\\\"]\",\"type\":\"string\",\"minLength\":1},\"detectLocalPlugins\":{\"description\":\"Automatically detect and load local plugins\",\"type\":\"boolean\"},\"disablePlugins\":{\"description\":\"Disable plugins\",\"type\":\"boolean\"},\"staticPath\":{\"description\":\"Dir path to serve static assets from.\",\"type\":\"string\",\"minLength\":1},\"plugins\":{\"description\":\"Module IDs of Cosmos plugins (eg. \\\"react-cosmos-plugin-open-fixture\\\" or \\\"../path/to/my-plugin\\\").\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true},\"publicUrl\":{\"description\":\"Base URL for static assets. [default: \\\"/\\\"]\",\"type\":\"string\"},\"fixturesDir\":{\"description\":\"Name for directories that contain fixtures (eg. __fixtures__/example.jsx). [default: \\\"__fixtures__\\\"]\",\"type\":\"string\",\"minLength\":1},\"fixtureFileSuffix\":{\"description\":\"Suffix for fixture files (eg. example.fixture.jsx). [default: \\\"fixture\\\"]\",\"type\":\"string\",\"minLength\":1},\"ignore\":{\"description\":\"Patterns for ignoring fixture and decorator files (eg. [\\\"**/dist/**\\\"]]).\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true},\"watchDirs\":{\"description\":\"Directories where the Cosmos server watches for fixture files changes while running. [default: [\\\".\\\"]]\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true},\"lazy\":{\"description\":\"Dynamically import fixture and decorator modules as they are loaded. When false all fixture and decorator modules are imported statically and bundled together. [default: false]\",\"type\":\"boolean\"},\"exposeImports\":{\"description\":\"Expose user imports and config required for the Cosmos renderer. Used with React Native and in custom integrations. When a path is specified it requires a file extension (eg. \\\"src/cosmos.imports.ts\\\"). [default: false]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"boolean\"}]},\"hostname\":{\"description\":\"Dev server hostname. Set to null to accept connections with any hostname. [default: null]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]},\"port\":{\"description\":\"Dev server port. [default: 5000]\",\"type\":\"number\"},\"portRetries\":{\"description\":\"Max number of port retries. [default: 10]\",\"type\":\"number\"},\"https\":{\"description\":\"Server will be served over HTTPS.\",\"type\":\"boolean\"},\"httpsOptions\":{\"description\":\"Additional options for HTTPS server.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"certPath\":{\"description\":\"Path of a certificate file\",\"type\":\"string\"},\"keyPath\":{\"description\":\"Path of a certificate's key file\",\"type\":\"string\"}}},\"httpProxy\":{\"description\":\"Proxy some URLs to a different HTTP server (eg. an API backend dev server). Similar to devServer.proxy in webpack config.\",\"type\":\"object\",\"additionalProperties\":true,\"patternProperties\":{\".*\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"description\":\"Advanced HTTP proxy config.\",\"additionalProperties\":true,\"required\":[\"target\"],\"properties\":{\"target\":{\"type\":\"string\"},\"secure\":{\"type\":\"boolean\"},\"pathRewrite\":{\"type\":\"object\",\"patternProperties\":{\".*\":{\"type\":\"string\"}}},\"logLevel\":{\"type\":\"string\",\"enum\":[\"error\",\"debug\",\"info\",\"warn\",\"silent\"]}}}]}}},\"globalImports\":{\"description\":\"Modules to be imported before loading components. Stuff like reset.css, polyfills, etc.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true},\"rendererUrl\":{\"description\":\"Required when renderer doesn't run on the same port (or host) as the Playground. Useful for integrations with build tools. [default: null]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]},\"dom\":{\"description\":\"DOM-related options\",\"type\":\"object\",\"properties\":{\"containerQuerySelector\":{\"description\":\"Document selector for existing element to use as component parent (eg. #root). A blank container element is created from scratch if no selector is provided. [default: null]\",\"type\":[\"string\",\"null\"],\"minLength\":1}}},\"vite\":{\"description\":\"Vite-related options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"configPath\":{\"description\":\"Path to Vite config. Set to false to disable reading it from the default path. [default: \\\"vite.config.js\\\"]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"enum\":[false]}]},\"indexPath\":{\"description\":\"Path to index module (eg. \\\"src/my-index.tsx\\\"). [default: matches common index/main module paths]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]},\"port\":{\"description\":\"Vite renderer port. [default: 5050]\",\"type\":\"number\"}}},\"webpack\":{\"description\":\"Webpack-related options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"configPath\":{\"description\":\"Path to an existing webpack config, which Cosmos will reuse to build your code. Set to null to disable this behavior. [default: \\\"webpack.config.js\\\"]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]},\"overridePath\":{\"description\":\"Path to a user module that customizes the webpack config used by Cosmos. Set to null to disable this behavior. [default: \\\"webpack.override.js\\\"]\",\"anyOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]},\"includeHashInOutputFilename\":{\"description\":\"Changes output filename from \\\"[name].js\\\" to \\\"[name].[contenthash].js\\\". [default: false]\",\"type\":\"boolean\"},\"hotReload\":{\"description\":\"Enable webpack's Hot Module Replacement. [default: true]\",\"type\":\"boolean\"},\"reloadOnFail\":{\"description\":\"When using webpack's Hot Module Replacement, enable automatic location reload after webpack fails to update modules. [default: false]\",\"type\":\"boolean\"}}},\"ui\":{\"description\":\"UI plugin options\",\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"responsivePreview\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"devices\":{\"description\":\"List of device viewports\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"label\",\"width\",\"height\"],\"properties\":{\"label\":{\"type\":\"string\",\"minLength\":1},\"width\":{\"type\":\"number\",\"minimum\":1},\"height\":{\"type\":\"number\",\"minimum\":1}}}}}}}}},\"title\":\"JSON schema for React Cosmos configs\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for React Cosmos configs\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"id":"https://json.schemastore.org/cosmos-config.json","properties":{"$schema":{"type":"string"},"rootDir":{"description":"The root directory that all others paths in this config are relative to. Usually the root of your repo. If omitted, rootDir is equal to the directory containing your Cosmos config. When you don't use a Cosmos config, rootDir defaults to the current working directory.","type":"string","minLength":1},"exportPath":{"description":"Where to generate static exports on disk. [default: \"cosmos-export\"]","type":"string","minLength":1},"detectLocalPlugins":{"description":"Automatically detect and load local plugins","type":"boolean"},"disablePlugins":{"description":"Disable plugins","type":"boolean"},"staticPath":{"description":"Dir path to serve static assets from.","type":"string","minLength":1},"plugins":{"description":"Module IDs of Cosmos plugins (eg. \"react-cosmos-plugin-open-fixture\" or \"../path/to/my-plugin\").","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true},"publicUrl":{"description":"Base URL for static assets. [default: \"/\"]","type":"string"},"fixturesDir":{"description":"Name for directories that contain fixtures (eg. __fixtures__/example.jsx). [default: \"__fixtures__\"]","type":"string","minLength":1},"fixtureFileSuffix":{"description":"Suffix for fixture files (eg. example.fixture.jsx). [default: \"fixture\"]","type":"string","minLength":1},"ignore":{"description":"Patterns for ignoring fixture and decorator files (eg. [\"**/dist/**\"]]).","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true},"watchDirs":{"description":"Directories where the Cosmos server watches for fixture files changes while running. [default: [\".\"]]","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true},"lazy":{"description":"Dynamically import fixture and decorator modules as they are loaded. When false all fixture and decorator modules are imported statically and bundled together. [default: false]","type":"boolean"},"exposeImports":{"description":"Expose user imports and config required for the Cosmos renderer. Used with React Native and in custom integrations. When a path is specified it requires a file extension (eg. \"src/cosmos.imports.ts\"). [default: false]","anyOf":[{"type":"string","minLength":1},{"type":"boolean"}]},"hostname":{"description":"Dev server hostname. Set to null to accept connections with any hostname. [default: null]","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"port":{"description":"Dev server port. [default: 5000]","type":"number"},"portRetries":{"description":"Max number of port retries. [default: 10]","type":"number"},"https":{"description":"Server will be served over HTTPS.","type":"boolean"},"httpsOptions":{"description":"Additional options for HTTPS server.","type":"object","additionalProperties":false,"properties":{"certPath":{"description":"Path of a certificate file","type":"string"},"keyPath":{"description":"Path of a certificate's key file","type":"string"}}},"httpProxy":{"description":"Proxy some URLs to a different HTTP server (eg. an API backend dev server). Similar to devServer.proxy in webpack config.","type":"object","additionalProperties":true,"patternProperties":{".*":{"anyOf":[{"type":"string"},{"type":"object","description":"Advanced HTTP proxy config.","additionalProperties":true,"required":["target"],"properties":{"target":{"type":"string"},"secure":{"type":"boolean"},"pathRewrite":{"type":"object","patternProperties":{".*":{"type":"string"}}},"logLevel":{"type":"string","enum":["error","debug","info","warn","silent"]}}}]}}},"globalImports":{"description":"Modules to be imported before loading components. Stuff like reset.css, polyfills, etc.","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true},"rendererUrl":{"description":"Required when renderer doesn't run on the same port (or host) as the Playground. Useful for integrations with build tools. [default: null]","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"dom":{"description":"DOM-related options","type":"object","properties":{"containerQuerySelector":{"description":"Document selector for existing element to use as component parent (eg. #root). A blank container element is created from scratch if no selector is provided. [default: null]","type":["string","null"],"minLength":1}}},"vite":{"description":"Vite-related options","type":"object","additionalProperties":false,"properties":{"configPath":{"description":"Path to Vite config. Set to false to disable reading it from the default path. [default: \"vite.config.js\"]","anyOf":[{"type":"string","minLength":1},{"enum":[false]}]},"indexPath":{"description":"Path to index module (eg. \"src/my-index.tsx\"). [default: matches common index/main module paths]","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"port":{"description":"Vite renderer port. [default: 5050]","type":"number"}}},"webpack":{"description":"Webpack-related options","type":"object","additionalProperties":false,"properties":{"configPath":{"description":"Path to an existing webpack config, which Cosmos will reuse to build your code. Set to null to disable this behavior. [default: \"webpack.config.js\"]","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"overridePath":{"description":"Path to a user module that customizes the webpack config used by Cosmos. Set to null to disable this behavior. [default: \"webpack.override.js\"]","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"includeHashInOutputFilename":{"description":"Changes output filename from \"[name].js\" to \"[name].[contenthash].js\". [default: false]","type":"boolean"},"hotReload":{"description":"Enable webpack's Hot Module Replacement. [default: true]","type":"boolean"},"reloadOnFail":{"description":"When using webpack's Hot Module Replacement, enable automatic location reload after webpack fails to update modules. [default: false]","type":"boolean"}}},"ui":{"description":"UI plugin options","type":"object","additionalProperties":true,"properties":{"responsivePreview":{"type":"object","additionalProperties":false,"properties":{"devices":{"description":"List of device viewports","type":"array","items":{"type":"object","additionalProperties":false,"required":["label","width","height"],"properties":{"label":{"type":"string","minLength":1},"width":{"type":"number","minimum":1},"height":{"type":"number","minimum":1}}}}}}}}},"title":"JSON schema for React Cosmos configs","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for React Cosmos configs". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for React Cosmos configs
|
schema-store
|
schema_store_219
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"$id\":\"https://cps-org.github.io/cps/cps.schema.json\",\"title\":\"Common Package Specification v0.13\",\"definitions\":{\"types\":{\"string\":{\"type\":\"string\"},\"list(string)\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/types/string\"}},\"map(list(string))\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/list(string)\"}}},\"list(string)|map(list(string))\":{\"oneOf\":[{\"$ref\":\"#/definitions/types/list(string)\"},{\"$ref\":\"#/definitions/types/map(list(string))\"}]},\"map(component)\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/component\"}}},\"map(configuration)\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/configuration\"}}},\"string|null\":{\"oneOf\":[{\"$ref\":\"#/definitions/types/string\"},{\"$ref\":\"#/definitions/types/null\"}]},\"map(string|null)\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/string|null\"}}},\"map(map(string|null))\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/map(string|null)\"}}},\"map(requirement)\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"$ref\":\"#/definitions/types/requirement\"}}},\"package\":{\"type\":\"object\",\"description\":\"The root of a CPS document is a package object. A package object describes a single package.\",\"properties\":{\"compat_version\":{\"$ref\":\"#/definitions/attributes/compat_version@0\"},\"components\":{\"$ref\":\"#/definitions/attributes/components@0\"},\"configuration\":{\"$ref\":\"#/definitions/attributes/configuration@0\"},\"configurations\":{\"$ref\":\"#/definitions/attributes/configurations@0\"},\"cps_path\":{\"$ref\":\"#/definitions/attributes/cps_path@0\"},\"cps_version\":{\"$ref\":\"#/definitions/attributes/cps_version@0\"},\"default_components\":{\"$ref\":\"#/definitions/attributes/default_components@0\"},\"name\":{\"$ref\":\"#/definitions/attributes/name@0\"},\"platform\":{\"$ref\":\"#/definitions/attributes/platform@0\"},\"prefix\":{\"$ref\":\"#/definitions/attributes/prefix@0\"},\"requires\":{\"$ref\":\"#/definitions/attributes/requires@1\"},\"version\":{\"$ref\":\"#/definitions/attributes/version@0\"},\"version_schema\":{\"$ref\":\"#/definitions/attributes/version_schema@0\"},\"default_license\":{\"$ref\":\"#/definitions/attributes/default_license@0\"},\"description\":{\"$ref\":\"#/definitions/attributes/description@0\"},\"display_name\":{\"$ref\":\"#/definitions/attributes/display_name@0\"},\"license\":{\"$ref\":\"#/definitions/attributes/license@0\"},\"meta_comment\":{\"$ref\":\"#/definitions/attributes/meta_comment@0\"},\"meta_schema\":{\"$ref\":\"#/definitions/attributes/meta_schema@0\"},\"website\":{\"$ref\":\"#/definitions/attributes/website@0\"}},\"required\":[\"components\",\"cps_version\",\"name\"],\"additionalProperties\":true},\"platform\":{\"type\":\"object\",\"description\":\"A platform describes the platform on which a package's components may run.\",\"properties\":{\"c_runtime_vendor\":{\"$ref\":\"#/definitions/attributes/c_runtime_vendor@0\"},\"c_runtime_version\":{\"$ref\":\"#/definitions/attributes/c_runtime_version@0\"},\"clr_vendor\":{\"$ref\":\"#/definitions/attributes/clr_vendor@0\"},\"clr_version\":{\"$ref\":\"#/definitions/attributes/clr_version@0\"},\"cpp_runtime_vendor\":{\"$ref\":\"#/definitions/attributes/cpp_runtime_vendor@0\"},\"cpp_runtime_version\":{\"$ref\":\"#/definitions/attributes/cpp_runtime_version@0\"},\"isa\":{\"$ref\":\"#/definitions/attributes/isa@0\"},\"jvm_vendor\":{\"$ref\":\"#/definitions/attributes/jvm_vendor@0\"},\"jvm_version\":{\"$ref\":\"#/definitions/attributes/jvm_version@0\"},\"kernel\":{\"$ref\":\"#/definitions/attributes/kernel@0\"},\"kernel_version\":{\"$ref\":\"#/definitions/attributes/kernel_version@0\"}},\"required\":[],\"additionalProperties\":true},\"requirement\":{\"type\":\"object\",\"description\":\"A requirement describes the specifics of a package dependency.\",\"properties\":{\"components\":{\"$ref\":\"#/definitions/attributes/components@1\"},\"hints\":{\"$ref\":\"#/definitions/attributes/hints@0\"},\"version\":{\"$ref\":\"#/definitions/attributes/version@1\"}},\"required\":[],\"additionalProperties\":true},\"component\":{\"type\":\"object\",\"description\":\"A component is a consumable part of a package. Typical components include libraries and executables.\",\"properties\":{\"compile_features\":{\"$ref\":\"#/definitions/attributes/compile_features@0\"},\"compile_flags\":{\"$ref\":\"#/definitions/attributes/compile_flags@0\"},\"configurations\":{\"$ref\":\"#/definitions/attributes/configurations@1\"},\"definitions\":{\"$ref\":\"#/definitions/attributes/definitions@0\"},\"includes\":{\"$ref\":\"#/definitions/attributes/includes@0\"},\"link_features\":{\"$ref\":\"#/definitions/attributes/link_features@0\"},\"link_flags\":{\"$ref\":\"#/definitions/attributes/link_flags@0\"},\"link_languages\":{\"$ref\":\"#/definitions/attributes/link_languages@0\"},\"link_libraries\":{\"$ref\":\"#/definitions/attributes/link_libraries@0\"},\"link_location\":{\"$ref\":\"#/definitions/attributes/link_location@0\"},\"link_requires\":{\"$ref\":\"#/definitions/attributes/link_requires@0\"},\"location\":{\"$ref\":\"#/definitions/attributes/location@0\"},\"requires\":{\"$ref\":\"#/definitions/attributes/requires@0\"},\"type\":{\"$ref\":\"#/definitions/attributes/type@0\"},\"description\":{\"$ref\":\"#/definitions/attributes/description@0\"},\"license\":{\"$ref\":\"#/definitions/attributes/license@0\"}},\"required\":[\"type\"],\"additionalProperties\":true},\"configuration\":{\"type\":\"object\",\"description\":\"A configuration holds attributes that are specific to a particular configuration of a component.\",\"properties\":{\"compile_features\":{\"$ref\":\"#/definitions/attributes/compile_features@0\"},\"compile_flags\":{\"$ref\":\"#/definitions/attributes/compile_flags@0\"},\"definitions\":{\"$ref\":\"#/definitions/attributes/definitions@0\"},\"includes\":{\"$ref\":\"#/definitions/attributes/includes@0\"},\"link_features\":{\"$ref\":\"#/definitions/attributes/link_features@0\"},\"link_flags\":{\"$ref\":\"#/definitions/attributes/link_flags@0\"},\"link_languages\":{\"$ref\":\"#/definitions/attributes/link_languages@0\"},\"link_libraries\":{\"$ref\":\"#/definitions/attributes/link_libraries@0\"},\"link_location\":{\"$ref\":\"#/definitions/attributes/link_location@0\"},\"link_requires\":{\"$ref\":\"#/definitions/attributes/link_requires@0\"},\"location\":{\"$ref\":\"#/definitions/attributes/location@0\"},\"requires\":{\"$ref\":\"#/definitions/attributes/requires@0\"}},\"required\":[],\"additionalProperties\":true}},\"attributes\":{\"c_runtime_vendor@0\":{\"description\":\"Specifies that the package's CABI components require the specified C standard/runtime library. Typical (case-insensitive) values include \\\"bsd\\\" (libc), \\\"gnu\\\" (glibc), \\\"mingw\\\" and \\\"microsoft\\\".\",\"$ref\":\"#/definitions/types/string\"},\"c_runtime_version@0\":{\"description\":\"Specifies the minimum C standard/runtime library version required by the package's CABI components.\",\"$ref\":\"#/definitions/types/string\"},\"clr_vendor@0\":{\"description\":\"Specifies that the package's CLR (.NET) components require the specified Common Language Runtime vendor. Typical (case-insensitive) values include \\\"microsoft\\\" and \\\"mono\\\".\",\"$ref\":\"#/definitions/types/string\"},\"clr_version@0\":{\"description\":\"Specifies the minimum Common Language Runtime version required to use the package's CLR (.NET) components.\",\"$ref\":\"#/definitions/types/string\"},\"compat_version@0\":{\"description\":\"Specifies the oldest version of the package with which this version is compatible. This information is used when a consumer requests a specific version. If the version requested is equal to or newer than the compat_version, the package may be used.\\n\\nIf not specified, the package is not compatible with previous versions (i.e. compat_version is implicitly equal to version).\",\"$ref\":\"#/definitions/types/string\"},\"compile_features@0\":{\"description\":\"Specifies a list of Compiler Features that must be enabled or disabled when compiling code that consumes the component.\",\"$ref\":\"#/definitions/types/list(string)\"},\"compile_flags@0\":{\"description\":\"Specifies a list of additional flags that must be supplied to the compiler when compiling code that consumes the component. Note that compiler flags may not be portable; use of this attribute is discouraged.\\n\\nA map may be used instead to give different values depending on the language of the consuming source file. Handling of such shall be the same as for definitions.\",\"$ref\":\"#/definitions/types/list(string)|map(list(string))\"},\"components@0\":{\"description\":\"Specifies the components which the package provides. Keys are the component names.\",\"$ref\":\"#/definitions/types/map(component)\"},\"components@1\":{\"description\":\"Specifies a list of components which must be present in the required package in order for the requirement to be satisfied. Although the build tool will generally produce an error if a consumer uses a component which in turn requires a component that was not found, early specification via this attribute may help build tools to diagnose such issues earlier and/or produce better diagnostics.\\n\\nThis may also be used to specify dependencies that are not expressed in component level dependencies, such as a package's requirement that a dependency includes a certain symbolic component, or if a dependency is only expressed at run-time.\",\"$ref\":\"#/definitions/types/list(string)\"},\"configuration@0\":{\"description\":\"Specifies the name of the configuration described by a configuration-specific .cps (see Configuration Merging). This attribute is required in a configuration-specific .cps, and shall be ignored otherwise.\",\"$ref\":\"#/definitions/types/string\"},\"configurations@0\":{\"description\":\"Specifies the configurations that are preferred. See Package Configurations for a description of how configurations are used.\",\"$ref\":\"#/definitions/types/list(string)\"},\"configurations@1\":{\"description\":\"Specifies a set of configuration-specific attributes for a component. Keys are the configuration names.\",\"$ref\":\"#/definitions/types/map(configuration)\"},\"cpp_runtime_vendor@0\":{\"description\":\"Specifies that the package's CABI components require the specified C++ standard/runtime library. Typical (case-insensitive) values include \\\"gnu\\\" (libstdc++), \\\"llvm\\\" (libc++) and \\\"microsoft\\\".\",\"$ref\":\"#/definitions/types/string\"},\"cpp_runtime_version@0\":{\"description\":\"Specifies the minimum C++ standard/runtime library version required by the package's CABI components.\",\"$ref\":\"#/definitions/types/string\"},\"cps_path@0\":{\"description\":\"Specifies the directory portion location of the .cps file. This shall be an \\\"absolute\\\" path which starts with @prefix@. This provides a mechanism by which the tool may deduce the prefix of a relocatable package from the absolute location of the .cps file (which will be known by the tool). See also Prefix Determination for details.\\n\\nExactly one of cps_path or prefix is required.\",\"$ref\":\"#/definitions/types/string\"},\"cps_version@0\":{\"description\":\"Specifies the version of the CPS to which this .cps file conforms. This may be used by tools to provide backwards compatibility in case of compatibility-breaking changes in the CPS.\\n\\nCPS version numbering follows semver. That is, tools that support CPS version <X>.<Y> are expected to be able to read files with cps_version <X>.<Z>, even for Z > Y (with the understanding that, in such cases, the tool may miss non-critical information that the CPS provided).\",\"$ref\":\"#/definitions/types/string\"},\"default_components@0\":{\"description\":\"Specifies a list of components that should be inferred if a consumer specifies a dependency on a package, but not a specific component.\",\"$ref\":\"#/definitions/types/list(string)\"},\"definitions@0\":{\"description\":\"Specifies a collection of compile definitions that must be defined when compiling code that consumes the component. Each key in the inner map(s) is the name of a compile definition, such that e.g. -Dkey=value is passed to the compiler. A value may be null, indicating a definition with no value (e.g. -Dkey is passed to the compiler). Note that an empty string indicates -Dkey=, which may have a different effect than -Dkey.\\n\\nThe outer map is used to describe language-specific definitions. The build tool shall include only those definitions whose language matches (case-sensitive) that of the (lower case) language of the source file being compiled. Recognized languages shall include \\\"c\\\", \\\"cpp\\\", and \\\"fortran\\\". Additionally, the value \\\"*\\\" indicates that the corresponding definitions apply to all languages.\\n\\nIf a definition name is repeated in both \\\"*\\\" and a specific language, the latter, when applicable to the source being compiled, shall have precedence.\",\"$ref\":\"#/definitions/types/map(map(string|null))\"},\"hints@0\":{\"description\":\"Specifies a list of paths where a required dependency might be located. When given, this will usually provide the location of the dependency as it was consumed by the package when the package was built, so that consumers can easily find (correct) dependencies if they are in a location that is not searched by default.\",\"$ref\":\"#/definitions/types/list(string)\"},\"includes@0\":{\"description\":\"Specifies a list of directories which should be added to the include search path when compiling code that consumes the component. If a path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.\\n\\nA map may be used instead to give different values depending on the language of the consuming source file. Handling of such shall be the same as for definitions.\",\"$ref\":\"#/definitions/types/list(string)|map(list(string))\"},\"isa@0\":{\"description\":\"Specifies that the package's CABI components require the specified Instruction Set Architecture. The value is case insensitive and should follow the output of uname -m.\",\"$ref\":\"#/definitions/types/string\"},\"jvm_vendor@0\":{\"description\":\"Specifies that the package's Java components require the specified Java vendor. Typical (case-insensitive) values include \\\"oracle\\\" and \\\"openjdk\\\".\",\"$ref\":\"#/definitions/types/string\"},\"jvm_version@0\":{\"description\":\"Specifies the minimum Java Virtual Machine version required to use the package's Java components.\",\"$ref\":\"#/definitions/types/string\"},\"kernel@0\":{\"description\":\"Specifies the name of the operating system kernel required by the package's components. The value is case insensitive and should follow the output of uname -s. Typical values include \\\"windows\\\", \\\"cygwin\\\", \\\"linux\\\" and \\\"darwin\\\".\",\"$ref\":\"#/definitions/types/string\"},\"kernel_version@0\":{\"description\":\"Specifies the minimum operating system kernel version required by the package's components.\",\"$ref\":\"#/definitions/types/string\"},\"link_features@0\":{\"description\":\"Specifies a list of Linker Features that must be enabled or disabled when linking code that consumes the component.\",\"$ref\":\"#/definitions/types/list(string)\"},\"link_flags@0\":{\"description\":\"Specifies a list of additional flags that must be supplied to the linker when linking code that consumes the component. Note that linker flags may not be portable; use of this attribute is discouraged.\",\"$ref\":\"#/definitions/types/list(string)\"},\"link_languages@0\":{\"description\":\"Specifies the ABI language or languages of a static library (type \\\"archive\\\"). Officially supported (case-insensitive) values are \\\"c\\\" (no special handling required) and \\\"cpp\\\" (consuming the static library also requires linking against the C++ standard runtime).\",\"$ref\":\"#/definitions/types/list(string)\",\"default\":[\"c\"]},\"link_libraries@0\":{\"description\":\"Specifies a list of additional libraries that must be linked against when linking code that consumes the component. (Note that packages should avoid using this attribute if at all possible. Use requires (component) instead whenever possible.)\",\"$ref\":\"#/definitions/types/list(string)\"},\"link_location@0\":{\"description\":\"Specifies an alternate location of the component that should be used when linking against the component. This attribute typically applies only to \\\"dylib\\\" components on platforms where the library is separated into multiple file components. For example, on Windows, this attribute shall give the location of the .lib, while location shall give the location of the .dll.\\n\\nIf the path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.\",\"$ref\":\"#/definitions/types/string\"},\"link_requires@0\":{\"description\":\"Specifies additional components required by a component which are needed only at the link stage. Unlike requires (component), only the required components' link dependencies should be applied transitively; additional properties such as compile and include attributes of the required component(s) should be ignored.\",\"$ref\":\"#/definitions/types/list(string)\"},\"location@0\":{\"description\":\"Specifies the location of the component. The exact meaning of this attribute depends on the component type, but typically it provides the path to the component's primary artifact, such as a .so or .jar. (For Windows DLL components, this should be the location of the .dll. See also link_location.)\\n\\nIf the path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.\\n\\nThis attribute is required for components that are not of \\\"interface\\\" type.\",\"$ref\":\"#/definitions/types/string\"},\"name@0\":{\"description\":\"Specifies the canonical name of the package. In order for searching to succeed, the name of the CPS file without the .cps suffix must exactly match (including case) either name as-is, or name converted to lower case.\",\"$ref\":\"#/definitions/types/string\"},\"platform@0\":{\"description\":\"Specifies the platform on which a package's components may run. This allows tools to ignore packages which target a different platform than the platform that the consumer targets (see Package Searching). Any platform attribute not specified implies that the package's components are agnostic to that platform attribute. If this attribute is not specified, the package is implied to be platform agnostic. (This might be the case for a \\\"library\\\" which consists entirely of C/C++ headers. Note that JVM/CLR versions are platform attributes, so packages consisting entirely of Java and/or CLR components will still typically use this attribute.)\",\"$ref\":\"#/definitions/types/platform\"},\"prefix@0\":{\"description\":\"Specifies the package's prefix for non-relocatable package. See also Prefix Determination.\\n\\nExactly one of cps_path or prefix is required.\",\"$ref\":\"#/definitions/types/string\"},\"requires@0\":{\"description\":\"Specifies additional components required by a component. This is used, for example, to indicate transitive dependencies. Relative component names are interpreted relative to the current package. Absolute component names must refer to a package required by this package (see requires (package)). Compile and link attributes should be applied transitively, as if the consuming component also directly consumed the components required by the component being consumed.\\n\\nSee also link_requires.\",\"$ref\":\"#/definitions/types/list(string)\"},\"requires@1\":{\"description\":\"Specifies additional packages that are required by this package. Keys are the name of another required package. Values are a valid requirement object or null (equivalent to an empty requirement object) describing the package required.\",\"$ref\":\"#/definitions/types/map(requirement)\"},\"type@0\":{\"description\":\"Specifies the type of a component. The component type affects how the component may be used. Officially supported values are \\\"executable\\\" (any artifact which the target platform can directly execute), \\\"archive\\\" (CABI static library), \\\"dylib\\\" (CABI shared library), \\\"module\\\" (CABI plugin library), \\\"jar\\\" (Java Archive), \\\"interface\\\" and \\\"symbolic\\\". If the type is not recognized by the parser, the component shall be ignored. (Parsers are permitted to support additional types as a conforming extension.)\\n\\nA \\\"dylib\\\" is meant to be linked at compile time; the location specifies the artifact required for such linking (i.e. the import library on PE platforms). A \\\"module\\\" is meant to be loaded at run time with dlopen or similar; again, the location specifies the appropriate artifact.\\n\\nAn \\\"interface\\\" component is a special case; it may have the usual attributes of a component, but does not have a location. This can be used to create \\\"virtual\\\" components that do not have an associated artifact.\\n\\nA \\\"symbolic\\\" component is even more special, as it has no (required) attributes at all, and the meaning of any attributes or configurations assigned to such a component is unspecified. A \\\"symbolic\\\" component is intended to be used as a form of feature testing; a package that has a feature that is meaningful to users but does not otherwise map directly to a component may use a symbolic component to indicate availability of the feature to users.\",\"$ref\":\"#/definitions/types/string\"},\"version@0\":{\"description\":\"Specifies the version of the package. The format of this string is determined by version_schema.\\n\\nIf not provided, the CPS will not satisfy any request for a specific version of the package.\",\"$ref\":\"#/definitions/types/string\"},\"version@1\":{\"description\":\"Specifies the required version of a package. If omitted, any version of the required package is acceptable. Semantics are the same as for the version attribute of a package.\",\"$ref\":\"#/definitions/types/string\"},\"version_schema@0\":{\"description\":\"Specifies the structure to which the package's version numbering conforms. Tools may use this to determine how to perform version comparisons. Officially supported (case-insensitive) values are \\\"simple\\\" and \\\"custom\\\" (\\\"rpm\\\" or \\\"dpkg\\\" should be used where applicable, but may not be supported by all tools). If a package uses \\\"custom\\\", version numbers may be compared, but version ordering is not possible.\\n\\nNeedless to say, changing a package's version scheme between releases is very strongly discouraged.\\n\\nNote that this attribute determines only how version numbers are ordered. It does not imply anything about the compatibility or incompatibility of various versions of a package. See also compat_version.\\n\\nsimple\\n\\nThe package's version number shall match the regular expression [0-9]+([.][0-9]+)*([-+].*)?.\\n\\nThe portion of the version which precedes the optional - or + may be interpreted as a tuple of integers, in which leading zeros are ignored. Version numbers are compared according to numerical order, starting from the first (left-most) number of the tuples. If two version numbers have different tuple sizes, the shorter tuple shall be implicitly filled with zeros.\\n\\nDeprecated since version 0.9.0: \\\"semver\\\" is a deprecated alias for \\\"simple\\\".\",\"$ref\":\"#/definitions/types/string\",\"default\":\"simple\"},\"default_license@0\":{\"description\":\"Specifies the license that is assumed to apply to a component, if none is otherwise specified. This is convenient for packages that wish their license to reflect portions of the package that are not reflected by a component (such as data files) when most or all of the compiled artifacts use the same license.\\n\\nThe value shall be a well formed SPDX License Expression .\",\"$ref\":\"#/definitions/types/string\"},\"description@0\":{\"description\":\"Provides a human readable description of the function which the package or component provides.\",\"$ref\":\"#/definitions/types/string\"},\"display_name@0\":{\"description\":\"Provides a human readable name of the package. If provided, tools may use this in informational messages instead of, or in addition to, the canonical package name.\",\"$ref\":\"#/definitions/types/string\"},\"license@0\":{\"description\":\"Specifies the license or licenses under which the package is distributed. The value shall be a well formed SPDX License Expression .\\n\\nIf parts of a package use different licenses, this attribute may also be specified on a component if doing so helps to clarifying the licensing. (See also default_license.)\",\"$ref\":\"#/definitions/types/string\"},\"meta_comment@0\":{\"description\":\"Provides a description of the file contents, for readers that may not be familiar with CPS files. The typical value is \\\"Common Package Specification for <package name>\\\".\",\"$ref\":\"#/definitions/types/string\"},\"meta_schema@0\":{\"description\":\"Provides a URI link to a document describing the format of the CPS file. The typical value is \\\"https://cps-org.github.io/cps/\\\" (i.e. the top level page of this site).\",\"$ref\":\"#/definitions/types/string\"},\"website@0\":{\"description\":\"Specifies the URI at which the package's website may be found.\",\"$ref\":\"#/definitions/types/string\",\"format\":\"uri\"}}},\"$ref\":\"#/definitions/types/package\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Common Package Specification v0.13\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema","$id":"https://cps-org.github.io/cps/cps.schema.json","title":"Common Package Specification v0.13","definitions":{"types":{"string":{"type":"string"},"list(string)":{"type":"array","items":{"$ref":"#/definitions/types/string"}},"map(list(string))":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/list(string)"}}},"list(string)|map(list(string))":{"oneOf":[{"$ref":"#/definitions/types/list(string)"},{"$ref":"#/definitions/types/map(list(string))"}]},"map(component)":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/component"}}},"map(configuration)":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/configuration"}}},"string|null":{"oneOf":[{"$ref":"#/definitions/types/string"},{"$ref":"#/definitions/types/null"}]},"map(string|null)":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/string|null"}}},"map(map(string|null))":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/map(string|null)"}}},"map(requirement)":{"type":"object","patternProperties":{"":{"$ref":"#/definitions/types/requirement"}}},"package":{"type":"object","description":"The root of a CPS document is a package object. A package object describes a single package.","properties":{"compat_version":{"$ref":"#/definitions/attributes/compat_version@0"},"components":{"$ref":"#/definitions/attributes/components@0"},"configuration":{"$ref":"#/definitions/attributes/configuration@0"},"configurations":{"$ref":"#/definitions/attributes/configurations@0"},"cps_path":{"$ref":"#/definitions/attributes/cps_path@0"},"cps_version":{"$ref":"#/definitions/attributes/cps_version@0"},"default_components":{"$ref":"#/definitions/attributes/default_components@0"},"name":{"$ref":"#/definitions/attributes/name@0"},"platform":{"$ref":"#/definitions/attributes/platform@0"},"prefix":{"$ref":"#/definitions/attributes/prefix@0"},"requires":{"$ref":"#/definitions/attributes/requires@1"},"version":{"$ref":"#/definitions/attributes/version@0"},"version_schema":{"$ref":"#/definitions/attributes/version_schema@0"},"default_license":{"$ref":"#/definitions/attributes/default_license@0"},"description":{"$ref":"#/definitions/attributes/description@0"},"display_name":{"$ref":"#/definitions/attributes/display_name@0"},"license":{"$ref":"#/definitions/attributes/license@0"},"meta_comment":{"$ref":"#/definitions/attributes/meta_comment@0"},"meta_schema":{"$ref":"#/definitions/attributes/meta_schema@0"},"website":{"$ref":"#/definitions/attributes/website@0"}},"required":["components","cps_version","name"],"additionalProperties":true},"platform":{"type":"object","description":"A platform describes the platform on which a package's components may run.","properties":{"c_runtime_vendor":{"$ref":"#/definitions/attributes/c_runtime_vendor@0"},"c_runtime_version":{"$ref":"#/definitions/attributes/c_runtime_version@0"},"clr_vendor":{"$ref":"#/definitions/attributes/clr_vendor@0"},"clr_version":{"$ref":"#/definitions/attributes/clr_version@0"},"cpp_runtime_vendor":{"$ref":"#/definitions/attributes/cpp_runtime_vendor@0"},"cpp_runtime_version":{"$ref":"#/definitions/attributes/cpp_runtime_version@0"},"isa":{"$ref":"#/definitions/attributes/isa@0"},"jvm_vendor":{"$ref":"#/definitions/attributes/jvm_vendor@0"},"jvm_version":{"$ref":"#/definitions/attributes/jvm_version@0"},"kernel":{"$ref":"#/definitions/attributes/kernel@0"},"kernel_version":{"$ref":"#/definitions/attributes/kernel_version@0"}},"required":[],"additionalProperties":true},"requirement":{"type":"object","description":"A requirement describes the specifics of a package dependency.","properties":{"components":{"$ref":"#/definitions/attributes/components@1"},"hints":{"$ref":"#/definitions/attributes/hints@0"},"version":{"$ref":"#/definitions/attributes/version@1"}},"required":[],"additionalProperties":true},"component":{"type":"object","description":"A component is a consumable part of a package. Typical components include libraries and executables.","properties":{"compile_features":{"$ref":"#/definitions/attributes/compile_features@0"},"compile_flags":{"$ref":"#/definitions/attributes/compile_flags@0"},"configurations":{"$ref":"#/definitions/attributes/configurations@1"},"definitions":{"$ref":"#/definitions/attributes/definitions@0"},"includes":{"$ref":"#/definitions/attributes/includes@0"},"link_features":{"$ref":"#/definitions/attributes/link_features@0"},"link_flags":{"$ref":"#/definitions/attributes/link_flags@0"},"link_languages":{"$ref":"#/definitions/attributes/link_languages@0"},"link_libraries":{"$ref":"#/definitions/attributes/link_libraries@0"},"link_location":{"$ref":"#/definitions/attributes/link_location@0"},"link_requires":{"$ref":"#/definitions/attributes/link_requires@0"},"location":{"$ref":"#/definitions/attributes/location@0"},"requires":{"$ref":"#/definitions/attributes/requires@0"},"type":{"$ref":"#/definitions/attributes/type@0"},"description":{"$ref":"#/definitions/attributes/description@0"},"license":{"$ref":"#/definitions/attributes/license@0"}},"required":["type"],"additionalProperties":true},"configuration":{"type":"object","description":"A configuration holds attributes that are specific to a particular configuration of a component.","properties":{"compile_features":{"$ref":"#/definitions/attributes/compile_features@0"},"compile_flags":{"$ref":"#/definitions/attributes/compile_flags@0"},"definitions":{"$ref":"#/definitions/attributes/definitions@0"},"includes":{"$ref":"#/definitions/attributes/includes@0"},"link_features":{"$ref":"#/definitions/attributes/link_features@0"},"link_flags":{"$ref":"#/definitions/attributes/link_flags@0"},"link_languages":{"$ref":"#/definitions/attributes/link_languages@0"},"link_libraries":{"$ref":"#/definitions/attributes/link_libraries@0"},"link_location":{"$ref":"#/definitions/attributes/link_location@0"},"link_requires":{"$ref":"#/definitions/attributes/link_requires@0"},"location":{"$ref":"#/definitions/attributes/location@0"},"requires":{"$ref":"#/definitions/attributes/requires@0"}},"required":[],"additionalProperties":true}},"attributes":{"c_runtime_vendor@0":{"description":"Specifies that the package's CABI components require the specified C standard/runtime library. Typical (case-insensitive) values include \"bsd\" (libc), \"gnu\" (glibc), \"mingw\" and \"microsoft\".","$ref":"#/definitions/types/string"},"c_runtime_version@0":{"description":"Specifies the minimum C standard/runtime library version required by the package's CABI components.","$ref":"#/definitions/types/string"},"clr_vendor@0":{"description":"Specifies that the package's CLR (.NET) components require the specified Common Language Runtime vendor. Typical (case-insensitive) values include \"microsoft\" and \"mono\".","$ref":"#/definitions/types/string"},"clr_version@0":{"description":"Specifies the minimum Common Language Runtime version required to use the package's CLR (.NET) components.","$ref":"#/definitions/types/string"},"compat_version@0":{"description":"Specifies the oldest version of the package with which this version is compatible. This information is used when a consumer requests a specific version. If the version requested is equal to or newer than the compat_version, the package may be used.\n\nIf not specified, the package is not compatible with previous versions (i.e. compat_version is implicitly equal to version).","$ref":"#/definitions/types/string"},"compile_features@0":{"description":"Specifies a list of Compiler Features that must be enabled or disabled when compiling code that consumes the component.","$ref":"#/definitions/types/list(string)"},"compile_flags@0":{"description":"Specifies a list of additional flags that must be supplied to the compiler when compiling code that consumes the component. Note that compiler flags may not be portable; use of this attribute is discouraged.\n\nA map may be used instead to give different values depending on the language of the consuming source file. Handling of such shall be the same as for definitions.","$ref":"#/definitions/types/list(string)|map(list(string))"},"components@0":{"description":"Specifies the components which the package provides. Keys are the component names.","$ref":"#/definitions/types/map(component)"},"components@1":{"description":"Specifies a list of components which must be present in the required package in order for the requirement to be satisfied. Although the build tool will generally produce an error if a consumer uses a component which in turn requires a component that was not found, early specification via this attribute may help build tools to diagnose such issues earlier and/or produce better diagnostics.\n\nThis may also be used to specify dependencies that are not expressed in component level dependencies, such as a package's requirement that a dependency includes a certain symbolic component, or if a dependency is only expressed at run-time.","$ref":"#/definitions/types/list(string)"},"configuration@0":{"description":"Specifies the name of the configuration described by a configuration-specific .cps (see Configuration Merging). This attribute is required in a configuration-specific .cps, and shall be ignored otherwise.","$ref":"#/definitions/types/string"},"configurations@0":{"description":"Specifies the configurations that are preferred. See Package Configurations for a description of how configurations are used.","$ref":"#/definitions/types/list(string)"},"configurations@1":{"description":"Specifies a set of configuration-specific attributes for a component. Keys are the configuration names.","$ref":"#/definitions/types/map(configuration)"},"cpp_runtime_vendor@0":{"description":"Specifies that the package's CABI components require the specified C++ standard/runtime library. Typical (case-insensitive) values include \"gnu\" (libstdc++), \"llvm\" (libc++) and \"microsoft\".","$ref":"#/definitions/types/string"},"cpp_runtime_version@0":{"description":"Specifies the minimum C++ standard/runtime library version required by the package's CABI components.","$ref":"#/definitions/types/string"},"cps_path@0":{"description":"Specifies the directory portion location of the .cps file. This shall be an \"absolute\" path which starts with @prefix@. This provides a mechanism by which the tool may deduce the prefix of a relocatable package from the absolute location of the .cps file (which will be known by the tool). See also Prefix Determination for details.\n\nExactly one of cps_path or prefix is required.","$ref":"#/definitions/types/string"},"cps_version@0":{"description":"Specifies the version of the CPS to which this .cps file conforms. This may be used by tools to provide backwards compatibility in case of compatibility-breaking changes in the CPS.\n\nCPS version numbering follows semver. That is, tools that support CPS version <X>.<Y> are expected to be able to read files with cps_version <X>.<Z>, even for Z > Y (with the understanding that, in such cases, the tool may miss non-critical information that the CPS provided).","$ref":"#/definitions/types/string"},"default_components@0":{"description":"Specifies a list of components that should be inferred if a consumer specifies a dependency on a package, but not a specific component.","$ref":"#/definitions/types/list(string)"},"definitions@0":{"description":"Specifies a collection of compile definitions that must be defined when compiling code that consumes the component. Each key in the inner map(s) is the name of a compile definition, such that e.g. -Dkey=value is passed to the compiler. A value may be null, indicating a definition with no value (e.g. -Dkey is passed to the compiler). Note that an empty string indicates -Dkey=, which may have a different effect than -Dkey.\n\nThe outer map is used to describe language-specific definitions. The build tool shall include only those definitions whose language matches (case-sensitive) that of the (lower case) language of the source file being compiled. Recognized languages shall include \"c\", \"cpp\", and \"fortran\". Additionally, the value \"*\" indicates that the corresponding definitions apply to all languages.\n\nIf a definition name is repeated in both \"*\" and a specific language, the latter, when applicable to the source being compiled, shall have precedence.","$ref":"#/definitions/types/map(map(string|null))"},"hints@0":{"description":"Specifies a list of paths where a required dependency might be located. When given, this will usually provide the location of the dependency as it was consumed by the package when the package was built, so that consumers can easily find (correct) dependencies if they are in a location that is not searched by default.","$ref":"#/definitions/types/list(string)"},"includes@0":{"description":"Specifies a list of directories which should be added to the include search path when compiling code that consumes the component. If a path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.\n\nA map may be used instead to give different values depending on the language of the consuming source file. Handling of such shall be the same as for definitions.","$ref":"#/definitions/types/list(string)|map(list(string))"},"isa@0":{"description":"Specifies that the package's CABI components require the specified Instruction Set Architecture. The value is case insensitive and should follow the output of uname -m.","$ref":"#/definitions/types/string"},"jvm_vendor@0":{"description":"Specifies that the package's Java components require the specified Java vendor. Typical (case-insensitive) values include \"oracle\" and \"openjdk\".","$ref":"#/definitions/types/string"},"jvm_version@0":{"description":"Specifies the minimum Java Virtual Machine version required to use the package's Java components.","$ref":"#/definitions/types/string"},"kernel@0":{"description":"Specifies the name of the operating system kernel required by the package's components. The value is case insensitive and should follow the output of uname -s. Typical values include \"windows\", \"cygwin\", \"linux\" and \"darwin\".","$ref":"#/definitions/types/string"},"kernel_version@0":{"description":"Specifies the minimum operating system kernel version required by the package's components.","$ref":"#/definitions/types/string"},"link_features@0":{"description":"Specifies a list of Linker Features that must be enabled or disabled when linking code that consumes the component.","$ref":"#/definitions/types/list(string)"},"link_flags@0":{"description":"Specifies a list of additional flags that must be supplied to the linker when linking code that consumes the component. Note that linker flags may not be portable; use of this attribute is discouraged.","$ref":"#/definitions/types/list(string)"},"link_languages@0":{"description":"Specifies the ABI language or languages of a static library (type \"archive\"). Officially supported (case-insensitive) values are \"c\" (no special handling required) and \"cpp\" (consuming the static library also requires linking against the C++ standard runtime).","$ref":"#/definitions/types/list(string)","default":["c"]},"link_libraries@0":{"description":"Specifies a list of additional libraries that must be linked against when linking code that consumes the component. (Note that packages should avoid using this attribute if at all possible. Use requires (component) instead whenever possible.)","$ref":"#/definitions/types/list(string)"},"link_location@0":{"description":"Specifies an alternate location of the component that should be used when linking against the component. This attribute typically applies only to \"dylib\" components on platforms where the library is separated into multiple file components. For example, on Windows, this attribute shall give the location of the .lib, while location shall give the location of the .dll.\n\nIf the path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.","$ref":"#/definitions/types/string"},"link_requires@0":{"description":"Specifies additional components required by a component which are needed only at the link stage. Unlike requires (component), only the required components' link dependencies should be applied transitively; additional properties such as compile and include attributes of the required component(s) should be ignored.","$ref":"#/definitions/types/list(string)"},"location@0":{"description":"Specifies the location of the component. The exact meaning of this attribute depends on the component type, but typically it provides the path to the component's primary artifact, such as a .so or .jar. (For Windows DLL components, this should be the location of the .dll. See also link_location.)\n\nIf the path starts with @prefix@, the package's prefix is substituted (see Package Searching). This is recommended, as it allows packages to be relocatable.\n\nThis attribute is required for components that are not of \"interface\" type.","$ref":"#/definitions/types/string"},"name@0":{"description":"Specifies the canonical name of the package. In order for searching to succeed, the name of the CPS file without the .cps suffix must exactly match (including case) either name as-is, or name converted to lower case.","$ref":"#/definitions/types/string"},"platform@0":{"description":"Specifies the platform on which a package's components may run. This allows tools to ignore packages which target a different platform than the platform that the consumer targets (see Package Searching). Any platform attribute not specified implies that the package's components are agnostic to that platform attribute. If this attribute is not specified, the package is implied to be platform agnostic. (This might be the case for a \"library\" which consists entirely of C/C++ headers. Note that JVM/CLR versions are platform attributes, so packages consisting entirely of Java and/or CLR components will still typically use this attribute.)","$ref":"#/definitions/types/platform"},"prefix@0":{"description":"Specifies the package's prefix for non-relocatable package. See also Prefix Determination.\n\nExactly one of cps_path or prefix is required.","$ref":"#/definitions/types/string"},"requires@0":{"description":"Specifies additional components required by a component. This is used, for example, to indicate transitive dependencies. Relative component names are interpreted relative to the current package. Absolute component names must refer to a package required by this package (see requires (package)). Compile and link attributes should be applied transitively, as if the consuming component also directly consumed the components required by the component being consumed.\n\nSee also link_requires.","$ref":"#/definitions/types/list(string)"},"requires@1":{"description":"Specifies additional packages that are required by this package. Keys are the name of another required package. Values are a valid requirement object or null (equivalent to an empty requirement object) describing the package required.","$ref":"#/definitions/types/map(requirement)"},"type@0":{"description":"Specifies the type of a component. The component type affects how the component may be used. Officially supported values are \"executable\" (any artifact which the target platform can directly execute), \"archive\" (CABI static library), \"dylib\" (CABI shared library), \"module\" (CABI plugin library), \"jar\" (Java Archive), \"interface\" and \"symbolic\". If the type is not recognized by the parser, the component shall be ignored. (Parsers are permitted to support additional types as a conforming extension.)\n\nA \"dylib\" is meant to be linked at compile time; the location specifies the artifact required for such linking (i.e. the import library on PE platforms). A \"module\" is meant to be loaded at run time with dlopen or similar; again, the location specifies the appropriate artifact.\n\nAn \"interface\" component is a special case; it may have the usual attributes of a component, but does not have a location. This can be used to create \"virtual\" components that do not have an associated artifact.\n\nA \"symbolic\" component is even more special, as it has no (required) attributes at all, and the meaning of any attributes or configurations assigned to such a component is unspecified. A \"symbolic\" component is intended to be used as a form of feature testing; a package that has a feature that is meaningful to users but does not otherwise map directly to a component may use a symbolic component to indicate availability of the feature to users.","$ref":"#/definitions/types/string"},"version@0":{"description":"Specifies the version of the package. The format of this string is determined by version_schema.\n\nIf not provided, the CPS will not satisfy any request for a specific version of the package.","$ref":"#/definitions/types/string"},"version@1":{"description":"Specifies the required version of a package. If omitted, any version of the required package is acceptable. Semantics are the same as for the version attribute of a package.","$ref":"#/definitions/types/string"},"version_schema@0":{"description":"Specifies the structure to which the package's version numbering conforms. Tools may use this to determine how to perform version comparisons. Officially supported (case-insensitive) values are \"simple\" and \"custom\" (\"rpm\" or \"dpkg\" should be used where applicable, but may not be supported by all tools). If a package uses \"custom\", version numbers may be compared, but version ordering is not possible.\n\nNeedless to say, changing a package's version scheme between releases is very strongly discouraged.\n\nNote that this attribute determines only how version numbers are ordered. It does not imply anything about the compatibility or incompatibility of various versions of a package. See also compat_version.\n\nsimple\n\nThe package's version number shall match the regular expression [0-9]+([.][0-9]+)*([-+].*)?.\n\nThe portion of the version which precedes the optional - or + may be interpreted as a tuple of integers, in which leading zeros are ignored. Version numbers are compared according to numerical order, starting from the first (left-most) number of the tuples. If two version numbers have different tuple sizes, the shorter tuple shall be implicitly filled with zeros.\n\nDeprecated since version 0.9.0: \"semver\" is a deprecated alias for \"simple\".","$ref":"#/definitions/types/string","default":"simple"},"default_license@0":{"description":"Specifies the license that is assumed to apply to a component, if none is otherwise specified. This is convenient for packages that wish their license to reflect portions of the package that are not reflected by a component (such as data files) when most or all of the compiled artifacts use the same license.\n\nThe value shall be a well formed SPDX License Expression .","$ref":"#/definitions/types/string"},"description@0":{"description":"Provides a human readable description of the function which the package or component provides.","$ref":"#/definitions/types/string"},"display_name@0":{"description":"Provides a human readable name of the package. If provided, tools may use this in informational messages instead of, or in addition to, the canonical package name.","$ref":"#/definitions/types/string"},"license@0":{"description":"Specifies the license or licenses under which the package is distributed. The value shall be a well formed SPDX License Expression .\n\nIf parts of a package use different licenses, this attribute may also be specified on a component if doing so helps to clarifying the licensing. (See also default_license.)","$ref":"#/definitions/types/string"},"meta_comment@0":{"description":"Provides a description of the file contents, for readers that may not be familiar with CPS files. The typical value is \"Common Package Specification for <package name>\".","$ref":"#/definitions/types/string"},"meta_schema@0":{"description":"Provides a URI link to a document describing the format of the CPS file. The typical value is \"https://cps-org.github.io/cps/\" (i.e. the top level page of this site).","$ref":"#/definitions/types/string"},"website@0":{"description":"Specifies the URI at which the package's website may be found.","$ref":"#/definitions/types/string","format":"uri"}}},"$ref":"#/definitions/types/package"}
|
Provide a JSON object that satisfies the schema "Common Package Specification v0.13". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Common Package Specification v0.13
|
schema-store
|
schema_store_220
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"id\":\"https://json.schemastore.org/creatomic.json\",\"properties\":{\"tslint.enable\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Control whether tslint is enabled for TypeScript files or not.\"},\"tslint.jsEnable\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Control whether tslint is enabled for JavaScript files or not.\",\"scope\":\"resource\"},\"tslint.rulesDirectory\":{\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"},\"description\":\"An additional rules directory\",\"default\":\"\",\"scope\":\"resource\"},\"tslint.validateWithDefaultConfig\":{\"type\":\"boolean\",\"description\":\"Validate a file when there is only a default tslint configuration is found\",\"default\":false,\"scope\":\"resource\"},\"tslint.configFile\":{\"type\":\"string\",\"description\":\"The path to the rules configuration file\",\"default\":\"\",\"scope\":\"resource\"},\"tslint.ignoreDefinitionFiles\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Control if TypeScript definition files should be ignored\",\"scope\":\"resource\"},\"tslint.exclude\":{\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"},\"description\":\"Configure glob patterns of file paths to exclude from linting\",\"scope\":\"resource\"},\"tslint.run\":{\"type\":\"string\",\"enum\":[\"onSave\",\"onType\"],\"default\":\"onType\",\"description\":\"Run the linter on save (onSave) or on type (onType)\",\"scope\":\"window\"},\"tslint.nodePath\":{\"type\":\"string\",\"default\":\"\",\"description\":\"A path added to NODE_PATH when resolving the tslint module.\",\"scope\":\"resource\"},\"tslint.autoFixOnSave\":{\"type\":[\"boolean\",\"array\"],\"items\":{\"type\":\"string\"},\"default\":false,\"description\":\"Turns auto fix on save on or off, or defines which rules (e.g. `no-var-keyword`) to auto fix on save.\",\"scope\":\"resource\"},\"tslint.alwaysShowRuleFailuresAsWarnings\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Always show rule failures as warnings, independent of the tslint configuration.\",\"scope\":\"resource\"}},\"title\":\"JSON schema for Creatomic configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Creatomic configuration file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","id":"https://json.schemastore.org/creatomic.json","properties":{"tslint.enable":{"type":"boolean","default":true,"description":"Control whether tslint is enabled for TypeScript files or not."},"tslint.jsEnable":{"type":"boolean","default":false,"description":"Control whether tslint is enabled for JavaScript files or not.","scope":"resource"},"tslint.rulesDirectory":{"type":["string","array"],"items":{"type":"string"},"description":"An additional rules directory","default":"","scope":"resource"},"tslint.validateWithDefaultConfig":{"type":"boolean","description":"Validate a file when there is only a default tslint configuration is found","default":false,"scope":"resource"},"tslint.configFile":{"type":"string","description":"The path to the rules configuration file","default":"","scope":"resource"},"tslint.ignoreDefinitionFiles":{"type":"boolean","default":true,"description":"Control if TypeScript definition files should be ignored","scope":"resource"},"tslint.exclude":{"type":["string","array"],"items":{"type":"string"},"description":"Configure glob patterns of file paths to exclude from linting","scope":"resource"},"tslint.run":{"type":"string","enum":["onSave","onType"],"default":"onType","description":"Run the linter on save (onSave) or on type (onType)","scope":"window"},"tslint.nodePath":{"type":"string","default":"","description":"A path added to NODE_PATH when resolving the tslint module.","scope":"resource"},"tslint.autoFixOnSave":{"type":["boolean","array"],"items":{"type":"string"},"default":false,"description":"Turns auto fix on save on or off, or defines which rules (e.g. `no-var-keyword`) to auto fix on save.","scope":"resource"},"tslint.alwaysShowRuleFailuresAsWarnings":{"type":"boolean","default":false,"description":"Always show rule failures as warnings, independent of the tslint configuration.","scope":"resource"}},"title":"JSON schema for Creatomic configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Creatomic configuration file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Creatomic configuration file
|
schema-store
|
schema_store_221
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$comment\":\"https://support.crowdin.com/configuration-file/\",\"description\":\"Configuration for Crowdin, a crowd-translation platform.\",\"id\":\"https://json.schemastore.org/crowdin.json\",\"properties\":{\"project_id\":{\"title\":\"Project ID\",\"type\":\"string\"},\"project_id_env\":{\"title\":\"Project ID Environment Variable\",\"type\":\"string\"},\"api_token\":{\"title\":\"API Token\",\"type\":\"string\"},\"api_token_env\":{\"title\":\"API Token Environment Variable\",\"type\":\"string\"},\"base_path\":{\"title\":\"Base Path\",\"type\":\"string\"},\"base_path_env\":{\"title\":\"Base Path Environment Variable\",\"type\":\"string\"},\"base_url\":{\"title\":\"Base URL\",\"type\":\"string\",\"format\":\"uri\"},\"base_url_env\":{\"title\":\"Base URL Environment Variable\",\"type\":\"string\"},\"preserve_hierarchy\":{\"title\":\"Preserve Hierarchy\",\"type\":\"boolean\"},\"commit_message\":{\"title\":\"Commit Message\",\"type\":\"string\"},\"append_commit_message\":{\"title\":\"Append Commit Message\",\"description\":\"Replace the default commit message with the one specified in commit_message.\",\"type\":\"boolean\"},\"export_languages\":{\"title\":\"Export Languages\",\"description\":\"Specify a list of specific languages to export.\",\"type\":\"array\",\"items\":{\"title\":\"Language\",\"type\":\"string\"}},\"files\":{\"title\":\"Files\",\"type\":\"array\",\"items\":{\"title\":\"File\",\"type\":\"object\",\"properties\":{\"source\":{\"title\":\"Source\",\"type\":\"string\"},\"translation\":{\"title\":\"Translation\",\"type\":\"string\"},\"ignore\":{\"title\":\"Ignore\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"translation_replace\":{\"title\":\"Translation Replace\",\"additionalProperties\":{\"type\":\"string\"}},\"excluded_target_languages\":{\"title\":\"Excluded Target Languages\",\"type\":\"array\",\"items\":{\"title\":\"Excluded Target Language\",\"type\":\"string\"}},\"scheme\":{\"title\":\"Scheme\",\"type\":\"string\"},\"dest\":{\"title\":\"Destination\",\"type\":\"string\"},\"type\":{\"title\":\"Type\",\"type\":\"string\"},\"update_option\":{\"title\":\"Update Option\",\"enum\":[\"update_as_unapproved\",\"update_without_changes\"]},\"translate_content\":{\"title\":\"Translate Content\",\"description\":\"Defines whether to translate texts placed inside the tags.\",\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"default\":1},\"translate_attributes\":{\"title\":\"Translate Attributes\",\"description\":\"Defines whether to translate tags' attributes.\",\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"default\":1},\"content_segmentation\":{\"title\":\"Content Segmentation\",\"description\":\"Defines whether to split long texts into smaller text segments.\",\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"default\":1},\"translatable_elements\":{\"title\":\"Translatable Elements\",\"description\":\"An array of strings, where each item is the XPaths to DOM element that should be imported. \",\"type\":\"array\",\"items\":{\"title\":\"Translatable Element\",\"type\":\"string\"}},\"skip_untranslated_strings\":{\"title\":\"Skip Untranslated Strings\",\"type\":\"boolean\"},\"skip_untranslated_files\":{\"title\":\"Skip Untranslated Files\",\"type\":\"boolean\"},\"export_only_approved\":{\"title\":\"Export Only Approved\",\"type\":\"boolean\"},\"escape_quotes\":{\"title\":\"Escape Quotes\",\"description\":\"Defines whether a single quote should be escaped by another single quote or backslash in exported translations.\",\"type\":\"number\",\"minimum\":0,\"maximum\":3,\"default\":3},\"escape_special_characters\":{\"title\":\"Escape Special Characters\",\"description\":\"Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.\",\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"default\":1},\"first_line_contains_header\":{\"title\":\"First Line Contains Header\",\"type\":\"boolean\"},\"languages_mapping\":{\"title\":\"Language Mapping\",\"properties\":{\"two_letters_code\":{\"additionalProperties\":{\"type\":\"string\"}},\"android_code\":{\"additionalProperties\":{\"type\":\"string\"}}}},\"labels\":{\"title\":\"Labels\",\"type\":\"array\",\"items\":{\"title\":\"Label\",\"type\":\"string\"}}}}}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"crowdin\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$comment":"https://support.crowdin.com/configuration-file/","description":"Configuration for Crowdin, a crowd-translation platform.","id":"https://json.schemastore.org/crowdin.json","properties":{"project_id":{"title":"Project ID","type":"string"},"project_id_env":{"title":"Project ID Environment Variable","type":"string"},"api_token":{"title":"API Token","type":"string"},"api_token_env":{"title":"API Token Environment Variable","type":"string"},"base_path":{"title":"Base Path","type":"string"},"base_path_env":{"title":"Base Path Environment Variable","type":"string"},"base_url":{"title":"Base URL","type":"string","format":"uri"},"base_url_env":{"title":"Base URL Environment Variable","type":"string"},"preserve_hierarchy":{"title":"Preserve Hierarchy","type":"boolean"},"commit_message":{"title":"Commit Message","type":"string"},"append_commit_message":{"title":"Append Commit Message","description":"Replace the default commit message with the one specified in commit_message.","type":"boolean"},"export_languages":{"title":"Export Languages","description":"Specify a list of specific languages to export.","type":"array","items":{"title":"Language","type":"string"}},"files":{"title":"Files","type":"array","items":{"title":"File","type":"object","properties":{"source":{"title":"Source","type":"string"},"translation":{"title":"Translation","type":"string"},"ignore":{"title":"Ignore","type":"array","items":{"type":"string"}},"translation_replace":{"title":"Translation Replace","additionalProperties":{"type":"string"}},"excluded_target_languages":{"title":"Excluded Target Languages","type":"array","items":{"title":"Excluded Target Language","type":"string"}},"scheme":{"title":"Scheme","type":"string"},"dest":{"title":"Destination","type":"string"},"type":{"title":"Type","type":"string"},"update_option":{"title":"Update Option","enum":["update_as_unapproved","update_without_changes"]},"translate_content":{"title":"Translate Content","description":"Defines whether to translate texts placed inside the tags.","type":"number","minimum":0,"maximum":1,"default":1},"translate_attributes":{"title":"Translate Attributes","description":"Defines whether to translate tags' attributes.","type":"number","minimum":0,"maximum":1,"default":1},"content_segmentation":{"title":"Content Segmentation","description":"Defines whether to split long texts into smaller text segments.","type":"number","minimum":0,"maximum":1,"default":1},"translatable_elements":{"title":"Translatable Elements","description":"An array of strings, where each item is the XPaths to DOM element that should be imported. ","type":"array","items":{"title":"Translatable Element","type":"string"}},"skip_untranslated_strings":{"title":"Skip Untranslated Strings","type":"boolean"},"skip_untranslated_files":{"title":"Skip Untranslated Files","type":"boolean"},"export_only_approved":{"title":"Export Only Approved","type":"boolean"},"escape_quotes":{"title":"Escape Quotes","description":"Defines whether a single quote should be escaped by another single quote or backslash in exported translations.","type":"number","minimum":0,"maximum":3,"default":3},"escape_special_characters":{"title":"Escape Special Characters","description":"Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.","type":"number","minimum":0,"maximum":1,"default":1},"first_line_contains_header":{"title":"First Line Contains Header","type":"boolean"},"languages_mapping":{"title":"Language Mapping","properties":{"two_letters_code":{"additionalProperties":{"type":"string"}},"android_code":{"additionalProperties":{"type":"string"}}}},"labels":{"title":"Labels","type":"array","items":{"title":"Label","type":"string"}}}}}},"type":"object"}
|
Provide a JSON object that satisfies the schema "crowdin". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
crowdin
|
schema-store
|
schema_store_222
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$comment\":\"JSON Schema for CRYENGINE *\",\"definitions\":{\"cvars\":{\"type\":\"string\",\"title\":\"Variable name\",\"description\":\"CVar name\",\"default\":\"sys_target_platforms\",\"enum\":[\"a_poseAlignerDebugDraw\",\"a_poseAlignerEnable\",\"a_poseAlignerForceLock\",\"a_poseAlignerForceNoIntersections\",\"a_poseAlignerForceNoRootOffset\",\"a_poseAlignerForceTargetSmoothing\",\"a_poseAlignerForceWeightOne\",\"ac_ColliderModeAI\",\"ac_ColliderModePlayer\",\"ac_debugAnimEffects\",\"ac_debugAnimTarget\",\"ac_debugColliderMode\",\"ac_debugEntityParams\",\"ac_DebugFilter\",\"ac_debugLocations\",\"ac_debugLocationsGraphs\",\"ac_debugMotionParams\",\"ac_debugMovementControlMethods\",\"ac_debugText\",\"ac_debugXXXValues\",\"ac_disableSlidingContactEvents\",\"ac_enableExtraSolidCollider\",\"ac_entityAnimClamp\",\"ac_forceSimpleMovement\",\"ac_frametime\",\"ac_movementControlMethodFilter\",\"ac_movementControlMethodHor\",\"ac_movementControlMethodVer\",\"ac_templateMCMs\",\"ac_useMovementPrediction\",\"ac_useQueuedRotation\",\"ag_debugExactPos\",\"ag_defaultAIStance\",\"ag_travelSpeedSmoothing\",\"ag_turnAngleSmoothing\",\"ag_turnSpeedParamScale\",\"ag_turnSpeedSmoothing\",\"ai_AdjustPathsAroundDynamicObstacles\",\"ai_AgentStatsDist\",\"ai_AllowedToHit\",\"ai_AllowedToHitPlayer\",\"ai_AllTime\",\"ai_AmbientFireEnable\",\"ai_AmbientFireQuota\",\"ai_AmbientFireUpdateInterval\",\"ai_AttemptStraightPath\",\"ai_BannedNavSoTime\",\"ai_BeautifyPath\",\"ai_BubblesSystem\",\"ai_BubblesSystemAlertnessFilter\",\"ai_BubblesSystemAllowPrototypeDialogBubbles\",\"ai_BubblesSystemDecayTime\",\"ai_BubblesSystemFontSize\",\"ai_BubblesSystemNameFilter\",\"ai_BubblesSystemUseDepthTest\",\"ai_BurstWhileMovingDestinationRange\",\"ai_CheckWalkabilityOptimalSectionLength\",\"ai_CollisionAvoidanceAgentExtraFat\",\"ai_CollisionAvoidanceAgentTimeHorizon\",\"ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh\",\"ai_CollisionAvoidanceEnableRadiusIncrement\",\"ai_CollisionAvoidanceMinSpeed\",\"ai_CollisionAvoidanceObstacleTimeHorizon\",\"ai_CollisionAvoidancePathEndCutoffRange\",\"ai_CollisionAvoidanceRadiusIncrementDecreaseRate\",\"ai_CollisionAvoidanceRadiusIncrementIncreaseRate\",\"ai_CollisionAvoidanceRange\",\"ai_CollisionAvoidanceSmartObjectCutoffRange\",\"ai_CollisionAvoidanceTargetCutoffRange\",\"ai_CollisionAvoidanceTimestep\",\"ai_CollisionAvoidanceUpdateVelocities\",\"ai_CommunicationForceTestVoicePack\",\"ai_CommunicationManagerHeighThresholdForTargetPosition\",\"ai_CompatibilityMode\",\"ai_CoolMissesBoxHeight\",\"ai_CoolMissesBoxSize\",\"ai_CoolMissesCooldown\",\"ai_CoolMissesMaxLightweightEntityMass\",\"ai_CoolMissesMinMissDistance\",\"ai_CoolMissesProbability\",\"ai_CoverExactPositioning\",\"ai_CoverMaxEyeCount\",\"ai_CoverPredictTarget\",\"ai_CoverSpacing\",\"ai_CoverSystem\",\"ai_CrouchVisibleRange\",\"ai_CrowdControlInPathfind\",\"ai_DebugCollisionAvoidanceForceSpeed\",\"ai_DebugDraw\",\"ai_DebugDrawAdaptiveUrgency\",\"ai_DebugDrawAmbientFire\",\"ai_DebugDrawArrowLabelsVisibilityDistance\",\"ai_DebugDrawAStarOpenList\",\"ai_DebugDrawAStarOpenListTime\",\"ai_DebugDrawBannedNavsos\",\"ai_DebugDrawCollisionAvoidance\",\"ai_DebugDrawCollisionAvoidanceAgentName\",\"ai_DebugDrawCommunication\",\"ai_DebugDrawCommunicationHistoryDepth\",\"ai_DebugDrawCoolMisses\",\"ai_DebugDrawCover\",\"ai_DebugDrawCoverLocations\",\"ai_DebugDrawCoverOccupancy\",\"ai_DebugDrawCoverPlanes\",\"ai_DebugDrawCoverSampler\",\"ai_DebugDrawCrowdControl\",\"ai_DebugDrawDamageControl\",\"ai_DebugDrawDamageParts\",\"ai_DebugDrawDynamicCoverSampler\",\"ai_DebugDrawDynamicHideObjectsRange\",\"ai_DebugDrawEnabledActors\",\"ai_DebugDrawEnabledPlayers\",\"ai_DebugDrawExpensiveAccessoryQuota\",\"ai_DebugDrawFireCommand\",\"ai_DebugDrawGroups\",\"ai_DebugDrawHidespotRange\",\"ai_DebugDrawHideSpotSearchRays\",\"ai_DebugDrawLightLevel\",\"ai_DebugDrawNavigation\",\"ai_DebugDrawNavigationWorldMonitor\",\"ai_DebugDrawPhysicsAccess\",\"ai_DebugDrawPlayerActions\",\"ai_DebugDrawReinforcements\",\"ai_DebugDrawStanceSize\",\"ai_DebugDrawVegetationCollisionDist\",\"ai_DebugDrawVisionMap\",\"ai_DebugDrawVisionMapObservables\",\"ai_DebugDrawVisionMapObservers\",\"ai_DebugDrawVisionMapObserversFOV\",\"ai_DebugDrawVisionMapStats\",\"ai_DebugDrawVisionMapVisibilityChecks\",\"ai_DebugDrawVolumeVoxels\",\"ai_DebugGlobalPerceptionScale\",\"ai_DebugInterestSystem\",\"ai_DebugMovementSystem\",\"ai_DebugMovementSystemActorRequests\",\"ai_DebugPathfinding\",\"ai_DebugPerceptionManager\",\"ai_DebugRangeSignaling\",\"ai_DebugSignalTimers\",\"ai_DebugTacticalPoints\",\"ai_DebugTacticalPointsBlocked\",\"ai_DebugTargetSilhouette\",\"ai_DebugTargetTracksAgent\",\"ai_DebugTargetTracksConfig\",\"ai_DebugTargetTracksConfig_Filter\",\"ai_DebugTargetTracksTarget\",\"ai_DebugTimestamps\",\"ai_DrawAgentFOV\",\"ai_DrawAgentStats\",\"ai_DrawAgentStatsGroupFilter\",\"ai_DrawAreas\",\"ai_DrawAttentionTargetPositions\",\"ai_DrawBadAnchors\",\"ai_DrawBulletEvents\",\"ai_DrawCollisionEvents\",\"ai_DrawDistanceLUT\",\"ai_DrawExplosions\",\"ai_DrawFakeDamageInd\",\"ai_DrawFakeHitEffects\",\"ai_DrawFakeTracers\",\"ai_DrawFireEffectDecayRange\",\"ai_DrawFireEffectEnabled\",\"ai_DrawFireEffectMaxAngle\",\"ai_DrawFireEffectMinDistance\",\"ai_DrawFireEffectMinTargetFOV\",\"ai_DrawFireEffectTimeScale\",\"ai_DrawFormations\",\"ai_DrawGetEnclosingFailures\",\"ai_DrawGoals\",\"ai_DrawGrenadeEvents\",\"ai_DrawGroupTactic\",\"ai_DrawHidespots\",\"ai_DrawModifiers\",\"ai_DrawModularBehaviorTreeStatistics\",\"ai_DrawNode\",\"ai_DrawNodeLinkCutoff\",\"ai_DrawNodeLinkType\",\"ai_DrawOffset\",\"ai_DrawPath\",\"ai_DrawPathAdjustment\",\"ai_DrawPathFollower\",\"ai_DrawPerceptionDebugging\",\"ai_DrawPerceptionHandlerModifiers\",\"ai_DrawPerceptionIndicators\",\"ai_DrawPerceptionModifiers\",\"ai_DrawPlayerRanges\",\"ai_DrawProbableTarget\",\"ai_DrawRadar\",\"ai_DrawRadarDist\",\"ai_DrawReadibilities\",\"ai_DrawRefPoints\",\"ai_DrawSelectedTargets\",\"ai_DrawShooting\",\"ai_DrawSmartObjects\",\"ai_DrawSoundEvents\",\"ai_DrawStats\",\"ai_DrawTargets\",\"ai_DrawTrajectory\",\"ai_DrawType\",\"ai_DrawUpdate\",\"ai_DynamicHidespotsEnabled\",\"ai_EnableCoolMisses\",\"ai_EnableORCA\",\"ai_EnablePerceptionStanceVisibleRange\",\"ai_EnableWarningsErrors\",\"ai_EnableWaterOcclusion\",\"ai_ExtraForbiddenRadiusDuringBeautification\",\"ai_ExtraRadiusDuringBeautification\",\"ai_ExtraVehicleAvoidanceRadiusBig\",\"ai_ExtraVehicleAvoidanceRadiusSmall\",\"ai_FilterAgentName\",\"ai_FlowNodeAlertnessCheck\",\"ai_ForceAGAction\",\"ai_ForceAGSignal\",\"ai_ForceAllowStrafing\",\"ai_ForceLookAimTarget\",\"ai_ForcePosture\",\"ai_ForceSerializeAllObjects\",\"ai_ForceStance\",\"ai_IgnoreBulletRainStimulus\",\"ai_IgnorePlayer\",\"ai_IgnoreSoundStimulus\",\"ai_IgnoreVisibilityChecks\",\"ai_IgnoreVisualStimulus\",\"ai_InterestSystem\",\"ai_InterestSystemCastRays\",\"ai_IntersectionTesterQuota\",\"ai_IslandConnectionsSystemProfileMemory\",\"ai_LobThrowMinAllowedDistanceFromFriends\",\"ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation\",\"ai_LobThrowTimePredictionForFriendPositions\",\"ai_LobThrowUseRandomForInaccuracySimulation\",\"ai_Locate\",\"ai_LogConsoleVerbosity\",\"ai_LogFileVerbosity\",\"ai_LogModularBehaviorTreeExecutionStacks\",\"ai_LogSignals\",\"ai_MinActorDynamicObstacleAvoidanceRadius\",\"ai_MNMAllowDynamicRegenInEditor\",\"ai_MNMDebugAccessibility\",\"ai_MNMDebugDrawFlag\",\"ai_MNMDebugTriangleOnCursor\",\"ai_MNMEditorBackgroundUpdate\",\"ai_MNMPathfinderConcurrentRequests\",\"ai_MNMPathFinderDebug\",\"ai_MNMPathfinderMT\",\"ai_MNMPathfinderPositionInTrianglePredictionType\",\"ai_MNMPathFinderQuota\",\"ai_MNMProfileMemory\",\"ai_MNMRaycastImplementation\",\"ai_ModularBehaviorTree\",\"ai_MovementSystemPathReplanningEnabled\",\"ai_NavGenThreadJobs\",\"ai_NavigationSystemMT\",\"ai_NavmeshStabilizationTimeToUpdate\",\"ai_NavmeshTileDistanceDraw\",\"ai_NetworkDebug\",\"ai_NoUpdate\",\"ai_ObstacleSizeThreshold\",\"ai_OutputPersonalLogToConsole\",\"ai_OverlayMessageDuration\",\"ai_PathfinderAvoidanceCostForGroupMates\",\"ai_PathfinderDangerCostForAttentionTarget\",\"ai_PathfinderDangerCostForExplosives\",\"ai_PathfinderExplosiveDangerMaxThreatDistance\",\"ai_PathfinderExplosiveDangerRadius\",\"ai_PathfinderGroupMatesAvoidanceRadius\",\"ai_PathfinderUpdateTime\",\"ai_PathfindTimeLimit\",\"ai_PathStringPullingIterations\",\"ai_PlayerAffectedByLight\",\"ai_PredictivePathFollowing\",\"ai_ProfileGoals\",\"ai_ProneVisibleRange\",\"ai_RayCasterQuota\",\"ai_RecordCommunicationStats\",\"ai_Recorder\",\"ai_Recorder_Auto\",\"ai_Recorder_Buffer\",\"ai_RecordLog\",\"ai_RODAliveTime\",\"ai_RODAmbientFireInc\",\"ai_RODCombatRangeMod\",\"ai_RODCoverFireTimeMod\",\"ai_RODDirInc\",\"ai_RODFakeHitChance\",\"ai_RODKillRangeMod\",\"ai_RODKillZoneInc\",\"ai_RODLowHealthMercyTime\",\"ai_RODMoveInc\",\"ai_RODReactionDarkIllumInc\",\"ai_RODReactionDirInc\",\"ai_RODReactionDistInc\",\"ai_RODReactionLeanInc\",\"ai_RODReactionMediumIllumInc\",\"ai_RODReactionSuperDarkIllumInc\",\"ai_RODReactionTime\",\"ai_RODStanceInc\",\"ai_ShowBehaviorCalls\",\"ai_SightRangeDarkIllumMod\",\"ai_SightRangeMediumIllumMod\",\"ai_SightRangeSuperDarkIllumMod\",\"ai_SimpleWayptPassability\",\"ai_SmartPathFollower_decelerationHuman\",\"ai_SmartPathFollower_decelerationVehicle\",\"ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint\",\"ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk\",\"ai_SmartPathFollower_useAdvancedPathShortcutting\",\"ai_SmartPathFollower_useAdvancedPathShortcutting_debug\",\"ai_SOMSpeedCombat\",\"ai_SOMSpeedRelaxed\",\"ai_SoundPerception\",\"ai_StatsDisplayMode\",\"ai_StatsTarget\",\"ai_SteepSlopeAcrossValue\",\"ai_SteepSlopeUpValue\",\"ai_SystemUpdate\",\"ai_TacticalPointsDebugDrawMode\",\"ai_TacticalPointsDebugFadeMode\",\"ai_TacticalPointsDebugScaling\",\"ai_TacticalPointsDebugTime\",\"ai_TacticalPointsWarnings\",\"ai_TacticalPointUpdateTime\",\"ai_TargetTracking\",\"ai_TargetTracks_GlobalTargetLimit\",\"ai_UpdateAllAlways\",\"ai_UpdateInterval\",\"ai_UpdateProxy\",\"ai_UseCalculationStopperCounter\",\"ai_UseSimplePathfindingHeuristic\",\"ai_UseSmartPathFollower\",\"ai_UseSmartPathFollower_AABB_based\",\"ai_UseSmartPathFollower_LookAheadDistance\",\"ai_VisionMapNumberOfPVSUpdatesPerFrame\",\"ai_VisionMapNumberOfVisibilityUpdatesPerFrame\",\"ai_WaterOcclusion\",\"ban_timeout\",\"br_breakmaxworldsize\",\"br_breakworldoffsetx\",\"br_breakworldoffsety\",\"c_shakeMult\",\"ca_AllowMultipleEffectsOfSameName\",\"ca_AnimWarningLevel\",\"ca_ApplyJointVelocitiesMode\",\"ca_AttachmentCullingRation\",\"ca_AttachmentCullingRationMP\",\"ca_AttachmentMergingMemoryBudget\",\"ca_AttachmentTextureMemoryBudget\",\"ca_CharEditModel\",\"ca_cloth_air_resistance\",\"ca_cloth_damping\",\"ca_cloth_friction\",\"ca_cloth_max_safe_step\",\"ca_cloth_max_timestep\",\"ca_cloth_stiffness\",\"ca_cloth_stiffness_norm\",\"ca_cloth_stiffness_tang\",\"ca_cloth_thickness\",\"ca_cloth_vars_reset\",\"ca_ClothBlending\",\"ca_ClothBypassSimulation\",\"ca_ClothForceSkinningAfterNFrames\",\"ca_ClothMaxChars\",\"ca_DBAUnloadRemoveTime\",\"ca_DBAUnloadUnregisterTime\",\"ca_DeathBlendTime\",\"ca_DebugADIKTargets\",\"ca_DebugAnimationStreaming\",\"ca_DebugAnimMemTracking\",\"ca_DebugAnimUpdates\",\"ca_DebugAnimUsage\",\"ca_DebugAnimUsageOnFileAccess\",\"ca_DebugAttachmentsProxies\",\"ca_DebugCommandBuffer\",\"ca_DebugCommandBufferFilter\",\"ca_DebugCriticalErrors\",\"ca_DebugFacial\",\"ca_DebugFacialEyes\",\"ca_DebugModelCache\",\"ca_DebugSegmentation\",\"ca_DebugSkeletonEffects\",\"ca_DebugSWSkinning\",\"ca_DecalSizeMultiplier\",\"ca_disable_thread\",\"ca_DisableAnimationUnloading\",\"ca_DisableAuxPhysics\",\"ca_DrawAimIKVEGrid\",\"ca_DrawAimPoses\",\"ca_DrawAllSimulatedSockets\",\"ca_DrawAttachmentOBB\",\"ca_DrawAttachmentProjection\",\"ca_DrawAttachments\",\"ca_DrawAttachmentsMergedForShadows\",\"ca_DrawBaseMesh\",\"ca_DrawBBox\",\"ca_DrawBinormals\",\"ca_DrawCC\",\"ca_DrawCGA\",\"ca_DrawCHR\",\"ca_DrawCloth\",\"ca_DrawDecalsBBoxes\",\"ca_DrawEmptyAttachments\",\"ca_DrawLocator\",\"ca_DrawLookIK\",\"ca_DrawNormals\",\"ca_DrawPose\",\"ca_DrawPositionPost\",\"ca_DrawSkeleton\",\"ca_DrawTangents\",\"ca_DrawVEGInfo\",\"ca_DrawWireframe\",\"ca_DumpUsedAnims\",\"ca_eyes_procedural\",\"ca_FacialAnimationRadius\",\"ca_FilterJoints\",\"ca_ForceAnimationLod\",\"ca_ForceUpdateSkeletons\",\"ca_KeepModels\",\"ca_lipsync_debug\",\"ca_lipsync_phoneme_crossfade\",\"ca_lipsync_phoneme_offset\",\"ca_lipsync_phoneme_strength\",\"ca_lipsync_vertex_drag\",\"ca_LoadUncompressedChunks\",\"ca_LockFeetWithIK\",\"ca_MemoryDefragEnabled\",\"ca_MemoryDefragPoolSize\",\"ca_MemoryUsageLog\",\"ca_MinInPlaceCAFStreamSize\",\"ca_MotionBlurMovementThreshold\",\"ca_NoAnim\",\"ca_ParametricPoolSize\",\"ca_physicsProcessImpact\",\"ca_PrecacheAnimationSets\",\"ca_PreloadAllCAFs\",\"ca_ReloadAllCHRPARAMS\",\"ca_ResetCulledJointsToBindPose\",\"ca_SampleQuatHemisphereFromCurrentPose\",\"ca_SaveAABB\",\"ca_SerializeSkeletonAnim\",\"ca_SnapToVGrid\",\"ca_StoreAnimNamesOnLoad\",\"ca_StreamCHR\",\"ca_StreamDBAInPlace\",\"ca_thread\",\"ca_thread0Affinity\",\"ca_thread1Affinity\",\"ca_UnloadAnimationCAF\",\"ca_UnloadAnimationDBA\",\"ca_useADIKTargets\",\"ca_UseAimIK\",\"ca_UseAssetDefinedLod\",\"ca_UseDecals\",\"ca_UseFacialAnimation\",\"ca_UseIMG_AIM\",\"ca_UseIMG_CAF\",\"ca_UseJointMasking\",\"ca_UseLookIK\",\"ca_UseMorph\",\"ca_UsePhysics\",\"ca_UseRecoil\",\"ca_UseScaling\",\"ca_vaBlendCullingDebug\",\"ca_vaBlendCullingThreshold\",\"ca_vaBlendEnable\",\"ca_vaBlendPostSkinning\",\"ca_vaEnable\",\"ca_Validate\",\"ca_vaProfile\",\"ca_vaScaleFactor\",\"ca_vaSkipVertexAnimationLOD\",\"ca_vaUpdateTangents\",\"ca_VClothMode\",\"capture_file_format\",\"capture_file_name\",\"capture_file_prefix\",\"capture_folder\",\"capture_frame_once\",\"capture_frames\",\"cl_AISystem\",\"cl_bandwidth\",\"cl_camera_noise\",\"cl_camera_noise_freq\",\"cl_comment\",\"cl_DefaultNearPlane\",\"cl_DisableHUDText\",\"cl_ETColorOverrideB\",\"cl_ETColorOverrideEnable\",\"cl_ETColorOverrideG\",\"cl_ETColorOverrideR\",\"cl_ETFontSizeMultiplier\",\"cl_ETHideAIDebug\",\"cl_ETHideAll\",\"cl_ETHideBehaviour\",\"cl_ETHideFlowgraph\",\"cl_ETHideReadability\",\"cl_ETHideScriptBind\",\"cl_ETLog\",\"cl_ETMaxDisplayDistance\",\"cl_nickname\",\"cl_packetRate\",\"cl_serveraddr\",\"cl_serverpassword\",\"cl_serverport\",\"cl_tokenid\",\"cl_useCurrentUserNameAsDefault\",\"cl_ViewApplyHmdOffset\",\"cl_ViewSystemDebug\",\"cl_voice_recording\",\"cl_voice_volume\",\"co_coopAnimDebug\",\"co_slideWhileStreaming\",\"co_usenewcoopanimsystem\",\"con_debug\",\"con_display_last_messages\",\"con_line_buffer_size\",\"con_restricted\",\"con_showonload\",\"connect_repeatedly_num_attempts\",\"connect_repeatedly_time_between_attempts\",\"cvDoVerboseWindowTitle\",\"d3d11_CBUpdateStats\",\"d3d11_debugBreakOnce\",\"d3d11_debugBreakOnMsgID\",\"d3d11_debugMuteMsgID\",\"d3d11_debugMuteSeverity\",\"d3d11_forcedFeatureLevel\",\"d3d11_preventDriverThreading\",\"demo_ai\",\"demo_file\",\"demo_finish_cmd\",\"demo_finish_memreplay_sizer\",\"demo_finish_memreplay_stop\",\"demo_fixed_timestep\",\"demo_game_state\",\"demo_max_frames\",\"demo_noinfo\",\"demo_num_orientations\",\"demo_num_runs\",\"demo_panoramic\",\"demo_profile\",\"demo_quit\",\"demo_restart_level\",\"demo_save_every_frame\",\"demo_savestats\",\"demo_screenshot_frame\",\"demo_scroll_pause\",\"demo_time_of_day\",\"demo_use_hmd_rotation\",\"demo_vtune\",\"dlc_directory\",\"doc_use_subfolder_for_crash_backup\",\"doc_validate_surface_types\",\"drs_dataPath\",\"drs_dialogAudio\",\"drs_dialogBinaryFileFormat\",\"drs_dialogEntityRtpcName\",\"drs_dialogGlobalRtpcName\",\"drs_dialogsDefaultMaxQueueTime\",\"drs_dialogsDefaultPauseAfterLines\",\"drs_dialogsDefaultTalkAnimation\",\"drs_dialogsLipsyncAnimationLayer\",\"drs_dialogsLipsyncTransitionTime\",\"drs_dialogsSamePriorityCancels\",\"drs_dialogSubtitles\",\"drs_fileFormat\",\"drs_loggingOptions\",\"ds_AutoReloadScripts\",\"ds_LevelNameOverride\",\"ds_LoadExcelScripts\",\"ds_LoadSoundsSync\",\"ds_LogLevel\",\"ds_PrecacheSounds\",\"ds_WarnOnMissingLoc\",\"e_3dEngineLogAlways\",\"e_3dEngineTempPoolSize\",\"e_AutoPrecacheCameraJumpDist\",\"e_AutoPrecacheCgf\",\"e_AutoPrecacheTerrainAndProcVeget\",\"e_AutoPrecacheTexturesAndShaders\",\"e_BBoxes\",\"e_Brushes\",\"e_BrushUseTerrainColor\",\"e_CacheNearestCubePicking\",\"e_CameraFreeze\",\"e_CameraGoto\",\"e_CameraRotationSpeed\",\"e_CGFMaxFileSize\",\"e_CharLodMin\",\"e_CheckOcclusion\",\"e_CheckOcclusionOutputQueueSize\",\"e_CheckOcclusionQueueSize\",\"e_CheckOctreeObjectsBoxSize\",\"e_Clouds\",\"e_CoverageBuffer\",\"e_CoverageBufferAABBExpand\",\"e_CoverageBufferBias\",\"e_CoverageBufferCullIndividualBrushesMaxNodeSize\",\"e_CoverageBufferDebug\",\"e_CoverageBufferDebugFreeze\",\"e_CoverageBufferDrawOccluders\",\"e_CoverageBufferEarlyOut\",\"e_CoverageBufferEarlyOutDelay\",\"e_CoverageBufferOccludersViewDistRatio\",\"e_CoverageBufferRastPolyLimit\",\"e_CoverageBufferReproj\",\"e_CoverageBufferShowOccluder\",\"e_CoverageBufferTerrain\",\"e_CoverageBufferTerrainExpand\",\"e_CoverCgfDebug\",\"e_CullVegActivation\",\"e_DebugDraw\",\"e_DebugDrawFilter\",\"e_DebugDrawListBBoxIndex\",\"e_DebugDrawListFilter\",\"e_DebugDrawListSize\",\"e_DebugDrawShowOnlyCompound\",\"e_DebugDrawShowOnlyLod\",\"e_DebugGeomPrep\",\"e_DebugLights\",\"e_Decals\",\"e_DecalsAllowGameDecals\",\"e_DecalsClip\",\"e_DecalsDeferredDynamic\",\"e_DecalsDeferredDynamicDepthScale\",\"e_DecalsDeferredDynamicMinSize\",\"e_DecalsDeferredStatic\",\"e_DecalsForceDeferred\",\"e_DecalsHitCache\",\"e_DecalsLifeTimeScale\",\"e_DecalsMaxTrisInObject\",\"e_DecalsMaxUpdatesPerFrame\",\"e_DecalsMaxValidFrames\",\"e_DecalsMerge\",\"e_DecalsNeighborMaxLifeTime\",\"e_DecalsOverlapping\",\"e_DecalsPlacementTestAreaSize\",\"e_DecalsPlacementTestMinDepth\",\"e_DecalsPreCreate\",\"e_DecalsRange\",\"e_DecalsSpawnDistRatio\",\"e_DefaultMaterial\",\"e_DeferredPhysicsEvents\",\"e_DeformableObjects\",\"e_DisplayMemoryUsageIcon\",\"e_DynamicDistanceShadows\",\"e_DynamicLights\",\"e_DynamicLightsConsistentSortOrder\",\"e_DynamicLightsForceDeferred\",\"e_DynamicLightsFrameIdVisTest\",\"e_DynamicLightsMaxCount\",\"e_DynamicLightsMaxEntityLights\",\"e_Entities\",\"e_EntitySuppressionLevel\",\"e_ExecuteRenderAsJobMask\",\"e_Fog\",\"e_FogVolumes\",\"e_FoliageBranchesDamping\",\"e_FoliageBranchesStiffness\",\"e_FoliageBranchesTimeout\",\"e_FoliageBrokenBranchesDamping\",\"e_FoliageStiffness\",\"e_FoliageWindActivationDist\",\"e_ForceDetailLevelForScreenRes\",\"e_GeomCacheBufferSize\",\"e_GeomCacheDebug\",\"e_GeomCacheDebugDrawMode\",\"e_GeomCacheDebugFilter\",\"e_GeomCacheDecodeAheadTime\",\"e_GeomCacheLerpBetweenFrames\",\"e_GeomCacheMaxBufferAheadTime\",\"e_GeomCacheMaxPlaybackFromMemorySize\",\"e_GeomCacheMinBufferAheadTime\",\"e_GeomCachePreferredDiskRequestSize\",\"e_GeomCaches\",\"e_GI\",\"e_GsmCastFromTerrain\",\"e_GsmDepthBoundsDebug\",\"e_GsmLodsNum\",\"e_GsmRange\",\"e_GsmRangeStep\",\"e_GsmStats\",\"e_HwOcclusionCullingWater\",\"e_JointStrengthScale\",\"e_levelStartupFrameDelay\",\"e_levelStartupFrameNum\",\"e_LightIlluminanceThreshold\",\"e_LightVolumes\",\"e_LightVolumesDebug\",\"e_LodCompMaxSize\",\"e_LodFaceArea\",\"e_LodFaceAreaTargetSize\",\"e_LodMax\",\"e_LodMin\",\"e_LodMinTtris\",\"e_LodRatio\",\"e_Lods\",\"e_LodsForceUse\",\"e_LodTransitionSpriteDistRatio\",\"e_LodTransitionSpriteMinDist\",\"e_LodTransitionTime\",\"e_MaxDrawCalls\",\"e_MaxViewDistance\",\"e_MaxViewDistFullDistCamHeight\",\"e_MaxViewDistSpecLerp\",\"e_MergedMeshes\",\"e_MergedMeshesActiveDist\",\"e_MergedMeshesBulletLifetime\",\"e_MergedMeshesBulletScale\",\"e_MergedMeshesBulletSpeedFactor\",\"e_MergedMeshesClusterVisualization\",\"e_MergedMeshesClusterVisualizationDimension\",\"e_MergedMeshesDebug\",\"e_MergedMeshesDeformViewDistMod\",\"e_MergedMeshesInstanceDist\",\"e_MergedMeshesLodRatio\",\"e_MergedMeshesMaxTriangles\",\"e_MergedMeshesOutdoorOnly\",\"e_MergedMeshesPool\",\"e_MergedMeshesPoolSpines\",\"e_MergedMeshesTesselationSupport\",\"e_MergedMeshesUseSpines\",\"e_MergedMeshesViewDistRatio\",\"e_MinMassDistanceCheckRenderMeshCollision\",\"e_ObjectLayersActivation\",\"e_ObjectLayersActivationPhysics\",\"e_Objects\",\"e_ObjectsTreeBBoxes\",\"e_ObjectsTreeLevelsDebug\",\"e_ObjectsTreeNodeMinSize\",\"e_ObjectsTreeNodeSizeRatio\",\"e_ObjFastRegister\",\"e_ObjQuality\",\"e_ObjShadowCastSpec\",\"e_ObjStats\",\"e_OcclusionCullingViewDistRatio\",\"e_OcclusionLazyHideFrames\",\"e_OcclusionVolumes\",\"e_OcclusionVolumesViewDistRatio\",\"e_OnDemandMaxSize\",\"e_OnDemandPhysics\",\"e_Particles\",\"e_ParticlesAllowRuntimeLoad\",\"e_ParticlesAnimBlend\",\"e_ParticlesAudio\",\"e_ParticlesConvertPfx1\",\"e_ParticlesCullAgainstOcclusionBuffer\",\"e_ParticlesCullAgainstViewFrustum\",\"e_ParticlesDebug\",\"e_ParticlesDumpMemoryAfterMapLoad\",\"e_ParticlesForceSeed\",\"e_ParticlesGI\",\"e_ParticleShadowsNumGSMs\",\"e_ParticlesIndexPoolSize\",\"e_ParticlesJobsPerThread\",\"e_ParticlesLights\",\"e_ParticlesLightsViewDistRatio\",\"e_ParticlesLod\",\"e_ParticlesMaxDrawScreen\",\"e_ParticlesMaxScreenFill\",\"e_ParticlesMinDrawAlpha\",\"e_ParticlesMinDrawPixels\",\"e_ParticlesMinPhysicsDynamicBounds\",\"e_ParticlesMotionBlur\",\"e_ParticlesObjectCollisions\",\"e_ParticlesPoolSize\",\"e_ParticlesPreload\",\"e_ParticlesProfile\",\"e_ParticlesProfiler\",\"e_ParticlesProfilerCountBudget\",\"e_ParticlesProfilerOutputFolder\",\"e_ParticlesProfilerOutputName\",\"e_ParticlesProfilerTimingBudget\",\"e_ParticlesQuality\",\"e_ParticlesSerializeNamedFields\",\"e_ParticlesShadows\",\"e_ParticlesSoftIntersect\",\"e_ParticlesSortQuality\",\"e_ParticlesThread\",\"e_ParticlesUseLevelSpecificLibs\",\"e_ParticlesVertexPoolSize\",\"e_PermanentRenderObjects\",\"e_PhysFoliage\",\"e_PhysMinCellSize\",\"e_PhysOceanCell\",\"e_PhysProxyTriLimit\",\"e_Portals\",\"e_PortalsBigEntitiesFix\",\"e_PortalsBlend\",\"e_PortalsMaxRecursion\",\"e_PrecacheLevel\",\"e_PreloadDecals\",\"e_PreloadMaterials\",\"e_PrepareDeformableObjectsAtLoadTime\",\"e_ProcVegetation\",\"e_ProcVegetationMaxCacheLevels\",\"e_ProcVegetationMaxChunksInCache\",\"e_ProcVegetationMaxObjectsInChunk\",\"e_ProcVegetationMaxSectorsInCache\",\"e_ProcVegetationMaxViewDistance\",\"e_Recursion\",\"e_RecursionViewDistRatio\",\"e_Render\",\"e_RenderMeshCollisionTolerance\",\"e_RenderMeshUpdateAsync\",\"e_RNTmpDataPoolMaxFrames\",\"e_Roads\",\"e_Ropes\",\"e_ScissorDebug\",\"e_ScreenShot\",\"e_ScreenShotDebug\",\"e_ScreenShotFileFormat\",\"e_ScreenShotHeight\",\"e_ScreenShotMapCamHeight\",\"e_ScreenShotMapCenterX\",\"e_ScreenShotMapCenterY\",\"e_ScreenShotMapOrientation\",\"e_ScreenShotMapSizeX\",\"e_ScreenShotMapSizeY\",\"e_ScreenShotMinSlices\",\"e_ScreenShotQuality\",\"e_ScreenShotWidth\",\"e_Shadows\",\"e_ShadowsAdaptScale\",\"e_ShadowsAutoBias\",\"e_ShadowsBlendCascades\",\"e_ShadowsBlendCascadesVal\",\"e_ShadowsCacheExtendLastCascade\",\"e_ShadowsCacheMaxNodesPerFrame\",\"e_ShadowsCacheObjectLod\",\"e_ShadowsCacheRenderCharacters\",\"e_ShadowsCacheUpdate\",\"e_ShadowsCascadesCentered\",\"e_ShadowsCascadesDebug\",\"e_ShadowsCastViewDistRatio\",\"e_ShadowsCastViewDistRatioLights\",\"e_ShadowsClouds\",\"e_ShadowsConstBias\",\"e_ShadowsConstBiasHQ\",\"e_ShadowsDebug\",\"e_ShadowsFrustums\",\"e_ShadowsLodBiasFixed\",\"e_ShadowsLodBiasInvis\",\"e_ShadowsMasksLimit\",\"e_ShadowsMaxTexRes\",\"e_ShadowsPerObject\",\"e_ShadowsPerObjectResolutionScale\",\"e_ShadowsPoolSize\",\"e_ShadowsResScale\",\"e_ShadowsSlopeBias\",\"e_ShadowsSlopeBiasHQ\",\"e_ShadowsTessellateCascades\",\"e_ShadowsTessellateDLights\",\"e_ShadowsUpdateViewDistRatio\",\"e_SkyBox\",\"e_SkyQuality\",\"e_SkyType\",\"e_SkyUpdateRate\",\"e_Sleep\",\"e_SQTestBegin\",\"e_SQTestCount\",\"e_SQTestDelay\",\"e_SQTestDistance\",\"e_SQTestExitOnFinish\",\"e_SQTestMip\",\"e_SQTestMoveSpeed\",\"e_SQTestTextureName\",\"e_StaticInstancing\",\"e_StaticInstancingMinInstNum\",\"e_StatObjBufferRenderTasks\",\"e_StatObjMerge\",\"e_StatObjMergeMaxTrisPerDrawCall\",\"e_StatObjPreload\",\"e_StatObjRenderFilter\",\"e_StatObjRenderFilterMode\",\"e_StatObjStoreMesh\",\"e_StatObjTessellationMode\",\"e_StatObjValidate\",\"e_StatoscopeAllowFpsOverride\",\"e_StatoscopeConnectTimeout\",\"e_StatoscopeCreateLogFilePerLevel\",\"e_StatoscopeDataGroups\",\"e_StatoscopeDumpAll\",\"e_StatoscopeEnabled\",\"e_StatoscopeFilenameUseBuildInfo\",\"e_StatoscopeFilenameUseDatagroups\",\"e_StatoscopeFilenameUseMap\",\"e_StatoscopeFilenameUseTag\",\"e_StatoscopeFilenameUseTime\",\"e_StatoscopeIvDataGroups\",\"e_StatoscopeLogDestination\",\"e_StatoscopeMaxNumFuncsPerFrame\",\"e_StatoscopeMinFuncLengthMs\",\"e_StatoscopeScreenCapWhenGPULimited\",\"e_StatoscopeScreenshotCapturePeriod\",\"e_StatoscopeWriteTimeout\",\"e_StreamAutoMipFactorMax\",\"e_StreamAutoMipFactorMaxDVD\",\"e_StreamAutoMipFactorMin\",\"e_StreamAutoMipFactorSpeedThreshold\",\"e_StreamCgf\",\"e_StreamCgfDebug\",\"e_StreamCgfDebugFilter\",\"e_StreamCgfDebugHeatMap\",\"e_StreamCgfDebugMinObjSize\",\"e_StreamCgfFastUpdateMaxDistance\",\"e_StreamCgfGridUpdateDistance\",\"e_StreamCgfMaxNewTasksPerUpdate\",\"e_StreamCgfMaxTasksInProgress\",\"e_StreamCgfPoolSize\",\"e_StreamCgfUpdatePerNodeDistance\",\"e_StreamCgfVisObjPriority\",\"e_StreamInstances\",\"e_StreamInstancesDistRatio\",\"e_StreamInstancesMaxTasks\",\"e_StreamPredictionAhead\",\"e_StreamPredictionAheadDebug\",\"e_StreamPredictionAlwaysIncludeOutside\",\"e_StreamPredictionBoxRadius\",\"e_StreamPredictionDistanceFar\",\"e_StreamPredictionDistanceNear\",\"e_StreamPredictionMaxVisAreaRecursion\",\"e_StreamPredictionMinFarZoneDistance\",\"e_StreamPredictionMinReportDistance\",\"e_StreamPredictionTexelDensity\",\"e_StreamPredictionUpdateTimeSlice\",\"e_StreamSaveStartupResultsIntoXML\",\"e_Sun\",\"e_SunAngleSnapDot\",\"e_SunAngleSnapSec\",\"e_svoDebug\",\"e_svoDispatchX\",\"e_svoDispatchY\",\"e_svoDVR\",\"e_svoDVR_DistRatio\",\"e_svoEnabled\",\"e_svoLoadTree\",\"e_svoMaxAreaMeshSizeKB\",\"e_svoMaxAreaSize\",\"e_svoMaxBricksOnCPU\",\"e_svoMaxBrickUpdates\",\"e_svoMaxNodeSize\",\"e_svoMaxStreamRequests\",\"e_svoMinNodeSize\",\"e_svoRender\",\"e_svoRootless\",\"e_svoStreamVoxels\",\"e_svoTI_Active\",\"e_svoTI_AnalyticalGI\",\"e_svoTI_AnalyticalOccluders\",\"e_svoTI_AnalyticalOccludersRange\",\"e_svoTI_AnalyticalOccludersSoftness\",\"e_svoTI_Apply\",\"e_svoTI_AsyncCompute\",\"e_svoTI_ConeMaxLength\",\"e_svoTI_ConstantAmbientDebug\",\"e_svoTI_Diffuse_Cache\",\"e_svoTI_Diffuse_Spr\",\"e_svoTI_DiffuseAmplifier\",\"e_svoTI_DiffuseBias\",\"e_svoTI_DiffuseConeWidth\",\"e_svoTI_DistantSsaoAmount\",\"e_svoTI_DualTracing\",\"e_svoTI_DynLights\",\"e_svoTI_EmissiveMultiplier\",\"e_svoTI_ForceGIForAllLights\",\"e_svoTI_GsmCascadeLod\",\"e_svoTI_HalfresKernelPrimary\",\"e_svoTI_HalfresKernelSecondary\",\"e_svoTI_HighGlossOcclusion\",\"e_svoTI_InjectionMultiplier\",\"e_svoTI_IntegrationMode\",\"e_svoTI_LowSpecMode\",\"e_svoTI_MaxSyncUpdateTime\",\"e_svoTI_MinReflectance\",\"e_svoTI_MinVoxelOpacity\",\"e_svoTI_NumberOfBounces\",\"e_svoTI_NumStreamingThreads\",\"e_svoTI_ObjectsLod\",\"e_svoTI_ObjectsMaxViewDistance\",\"e_svoTI_ObjectsMaxViewDistanceScale\",\"e_svoTI_PointLightsBias\",\"e_svoTI_PointLightsMaxDistance\",\"e_svoTI_PointLightsMultiplier\",\"e_svoTI_PortalsDeform\",\"e_svoTI_PortalsInject\",\"e_svoTI_PropagationBooster\",\"e_svoTI_Reflect_Vox_Max\",\"e_svoTI_Reflect_Vox_Max_Overhead\",\"e_svoTI_Reflect_Vox_MaxEdit\",\"e_svoTI_ResScaleAir\",\"e_svoTI_ResScaleBase\",\"e_svoTI_RsmConeMaxLength\",\"e_svoTI_RsmUseColors\",\"e_svoTI_RT_MaxDist\",\"e_svoTI_Saturation\",\"e_svoTI_ShadowsFromSun\",\"e_svoTI_ShadowsSoftness\",\"e_svoTI_SkipNonGILights\",\"e_svoTI_SkyColorMultiplier\",\"e_svoTI_SkyLightBottomMultiplier\",\"e_svoTI_Specular_FromDiff\",\"e_svoTI_Specular_Reproj\",\"e_svoTI_Specular_Sev\",\"e_svoTI_SpecularAmplifier\",\"e_svoTI_SSAOAmount\",\"e_svoTI_SSDepthTrace\",\"e_svoTI_SunRSMInject\",\"e_svoTI_TemporalFilteringBase\",\"e_svoTI_TraceVoxels\",\"e_svoTI_TranslucentBrightness\",\"e_svoTI_Troposphere_Active\",\"e_svoTI_Troposphere_Brightness\",\"e_svoTI_Troposphere_CloudGen_Freq\",\"e_svoTI_Troposphere_CloudGen_FreqStep\",\"e_svoTI_Troposphere_CloudGen_Height\",\"e_svoTI_Troposphere_CloudGen_Scale\",\"e_svoTI_Troposphere_CloudGenTurb_Freq\",\"e_svoTI_Troposphere_CloudGenTurb_Scale\",\"e_svoTI_Troposphere_Density\",\"e_svoTI_Troposphere_Ground_Height\",\"e_svoTI_Troposphere_Layer0_Dens\",\"e_svoTI_Troposphere_Layer0_Height\",\"e_svoTI_Troposphere_Layer0_Rand\",\"e_svoTI_Troposphere_Layer1_Dens\",\"e_svoTI_Troposphere_Layer1_Height\",\"e_svoTI_Troposphere_Layer1_Rand\",\"e_svoTI_Troposphere_Snow_Height\",\"e_svoTI_Troposphere_Subdivide\",\"e_svoTI_UpdateGeometry\",\"e_svoTI_UpdateLighting\",\"e_svoTI_UseLightProbes\",\"e_svoTI_UseTODSkyColor\",\"e_svoTI_VegetationMaxOpacity\",\"e_svoTI_VoxelizationLODRatio\",\"e_svoTI_VoxelizationMapBorder\",\"e_svoTI_VoxelizationPostpone\",\"e_svoTI_VoxelizeHiddenObjects\",\"e_svoTI_VoxelizeUnderTerrain\",\"e_svoTI_VoxelOpacityMultiplier\",\"e_svoVoxDistRatio\",\"e_svoVoxelPoolResolution\",\"e_svoVoxGenRes\",\"e_svoVoxNodeRatio\",\"e_Terrain\",\"e_TerrainAutoGenerateBaseTexture\",\"e_TerrainAutoGenerateBaseTextureTiling\",\"e_TerrainBBoxes\",\"e_TerrainDeformations\",\"e_TerrainDetailMaterials\",\"e_TerrainDetailMaterialsDebug\",\"e_TerrainDetailMaterialsViewDistXY\",\"e_TerrainDetailMaterialsViewDistZ\",\"e_TerrainDrawThisSectorOnly\",\"e_TerrainEditPostponeTexturesUpdate\",\"e_TerrainIntegrateObjectsMaxHeight\",\"e_TerrainIntegrateObjectsMaxVertices\",\"e_TerrainLodDistanceRatio\",\"e_TerrainLodErrorRatio\",\"e_TerrainMeshInstancingMinLod\",\"e_TerrainMeshInstancingShadowBias\",\"e_TerrainMeshInstancingShadowLodRatio\",\"e_TerrainOcclusionCulling\",\"e_TerrainOcclusionCullingDebug\",\"e_TerrainOcclusionCullingMaxDist\",\"e_TerrainOcclusionCullingMaxSteps\",\"e_TerrainOcclusionCullingPrecision\",\"e_TerrainOcclusionCullingPrecisionDistRatio\",\"e_TerrainOcclusionCullingStepSize\",\"e_TerrainOcclusionCullingStepSizeDelta\",\"e_TerrainTextureLodRatio\",\"e_TerrainTextureStreamingDebug\",\"e_TerrainTextureStreamingPoolItemsNum\",\"e_Tessellation\",\"e_TessellationMaxDistance\",\"e_TimeOfDay\",\"e_TimeOfDayDebug\",\"e_TimeOfDaySpeed\",\"e_UseConsoleMtl\",\"e_Vegetation\",\"e_VegetationBending\",\"e_VegetationBillboards\",\"e_VegetationBoneInfo\",\"e_VegetationMinSize\",\"e_VegetationSprites\",\"e_VegetationSpritesBatching\",\"e_VegetationSpritesDistanceCustomRatioMin\",\"e_VegetationSpritesDistanceRatio\",\"e_VegetationSpritesMinDistance\",\"e_VegetationSpritesScaleFactor\",\"e_VegetationUseTerrainColor\",\"e_VegetationUseTerrainColorDistance\",\"e_ViewDistCompMaxSize\",\"e_ViewDistMin\",\"e_ViewDistRatio\",\"e_ViewDistRatio3Planar\",\"e_ViewDistRatioCustom\",\"e_ViewDistRatioDetail\",\"e_ViewDistRatioLights\",\"e_ViewDistRatioModifierGameDecals\",\"e_ViewDistRatioPortals\",\"e_ViewDistRatioVegetation\",\"e_VolObjShadowStrength\",\"e_VolumetricFog\",\"e_WaterOcean\",\"e_WaterOceanBottom\",\"e_WaterOceanFFT\",\"e_WaterRipplesDebug\",\"e_WaterTessellationAmount\",\"e_WaterTessellationAmountX\",\"e_WaterTessellationAmountY\",\"e_WaterTessellationSwathWidth\",\"e_WaterVolumes\",\"e_WaterWaves\",\"e_WaterWavesTessellationAmount\",\"e_Wind\",\"e_WindAreas\",\"e_WindBendingAreaStrength\",\"e_WindBendingDistRatio\",\"e_WindBendingStrength\",\"ed_combineFileChanges\",\"ed_enableAssetPickers\",\"ed_generateThumbnails\",\"ed_indexfiles\",\"ed_keepEditorActive\",\"ed_killmemory_size\",\"ed_logFileChanges\",\"ed_PhysToolHitExplPress0\",\"ed_PhysToolHitExplPress1\",\"ed_PhysToolHitExplR\",\"ed_PhysToolHitProjMass\",\"ed_PhysToolHitProjVel0\",\"ed_PhysToolHitProjVel1\",\"ed_PhysToolHitVelMax\",\"ed_PhysToolHitVelMin\",\"ed_useDevManager\",\"es_bboxes\",\"es_DebrisLifetimeScale\",\"es_debugContainers\",\"es_debugDrawEntityIDs\",\"es_debugEntityLifetime\",\"es_DebugEntityUsage\",\"es_DebugEntityUsageFilter\",\"es_DebugEntityUsageSortMode\",\"es_DebugEvents\",\"es_DebugFindEntity\",\"es_DebugTimers\",\"es_DrawAreaDebug\",\"es_DrawAreaGrid\",\"es_DrawAreaGridCells\",\"es_DrawAreas\",\"es_enable_full_script_save\",\"es_EntityUpdatePosDelta\",\"es_FarPhysTimeout\",\"es_HitCharacters\",\"es_HitDeadBodies\",\"es_ImpulseScale\",\"es_LayerDebugInfo\",\"es_LayerSaveLoadSerialization\",\"es_log_collisions\",\"es_MaxImpulseAdjMass\",\"es_MaxJointFx\",\"es_MaxPhysDist\",\"es_MaxPhysDistCloth\",\"es_MaxPhysDistInvisible\",\"es_MinImpulseVel\",\"es_profileComponentUpdates\",\"es_removeEntity\",\"es_SaveLoadUseLUANoSaveFlag\",\"es_UpdateEntities\",\"es_UpdateScript\",\"es_UsePhysVisibilityChecks\",\"ExitOnQuit\",\"ffs_debug\",\"fg_abortOnLoadError\",\"fg_debugmodules\",\"fg_debugmodules_filter\",\"fg_iDebugNextStep\",\"fg_iEnableFlowgraphNodeDebugging\",\"fg_inspectorLog\",\"fg_noDebugText\",\"fg_profile\",\"fg_SystemEnable\",\"g_aimdebug\",\"g_allowDisconnectIfUpdateFails\",\"g_allowSaveLoadInEditor\",\"g_asynclevelload\",\"g_breakage_debug\",\"g_breakage_mem_limit\",\"g_breakage_particles_limit\",\"g_breakageFadeDelay\",\"g_breakageFadeTime\",\"g_breakagelog\",\"g_breakageMinAxisInertia\",\"g_breakageNoDebrisCollisions\",\"g_breakageTreeDec\",\"g_breakageTreeInc\",\"g_breakageTreeIncGlass\",\"g_breakageTreeMax\",\"g_breakImpulseScale\",\"g_breaktimeoutframes\",\"g_debug_stats\",\"g_debugAspectChanges\",\"g_debugAspectFilterClass\",\"g_debugAspectFilterEntity\",\"g_debugAspectTrap\",\"g_debugAspectTrapCount\",\"g_debugDialogBuffers\",\"g_debugHardwareMouse\",\"g_debugRMI\",\"g_debugSaveLoadMemory\",\"g_disableInputKeyFlowNodeInDevMode\",\"g_disableSequencePlayback\",\"g_disableWinKeys\",\"g_displayCheckpointName\",\"g_distanceForceNoIk\",\"g_distanceForceNoLegRaycasts\",\"g_enableitems\",\"g_enableloadingscreen\",\"g_EnableLoadSave\",\"g_enableMergedMeshRuntimeAreas\",\"g_forceFastUpdate\",\"g_gameplayAnalyst\",\"g_glassAutoShatter\",\"g_glassAutoShatterMinArea\",\"g_glassAutoShatterOnExplosions\",\"g_glassForceTimeout\",\"g_glassForceTimeoutSpread\",\"g_glassMaxPanesToBreakPerFrame\",\"g_glassNoDecals\",\"g_glassSystemEnable\",\"g_groundAlignAll\",\"g_groundeffectsdebug\",\"g_handleEvents\",\"g_hostMigrationServerDelay\",\"g_immersive\",\"g_joint_breaking\",\"g_landingBobLandTimeFactor\",\"g_landingBobTimeFactor\",\"g_language\",\"g_languageAudio\",\"g_localPacketRate\",\"g_manualFrameStepFrequency\",\"g_multiplayerEnableVehicles\",\"g_no_breaking_by_objects\",\"g_no_secondary_breaking\",\"g_playerInteractorRadius\",\"g_procedural_breaking\",\"g_saveLoadBasicEntityOptimization\",\"g_saveLoadExtendedLog\",\"g_saveLoadUseExportedEntityList\",\"g_showUpdateState\",\"g_spectatorCollisions\",\"g_statisticsMode\",\"g_syncClassRegistry\",\"g_tree_cut_reuse_dist\",\"g_userNeverAutoSignsIn\",\"g_useSinglePosition\",\"g_useXMLCPBinForSaveLoad\",\"g_visibilityTimeout\",\"g_visibilityTimeoutTime\",\"g_waterHitOnly\",\"g_XMLCPBAddExtraDebugInfoToXmlDebugFiles\",\"g_XMLCPBBlockQueueLimit\",\"g_XMLCPBGenerateXmlDebugFiles\",\"g_XMLCPBSizeReportThreshold\",\"g_XMLCPBUseExtraZLibCompression\",\"gfx_ampserver\",\"gfx_debugdraw\",\"gfx_draw\",\"gfx_enabled\",\"gfx_FlashReloadEnabled\",\"gfx_FlashReloadTime\",\"gfx_inputevents_triggerrepeat\",\"gfx_inputevents_triggerstart\",\"gfx_loadtimethread\",\"gfx_reloadonlanguagechange\",\"gfx_uiaction_enable\",\"gfx_uiaction_folder\",\"gfx_uiaction_log\",\"gfx_uiaction_log_filter\",\"gfx_uievents_editorenabled\",\"gpu_particle_physics\",\"gt_show\",\"gt_showFilter\",\"gt_showLines\",\"gt_showPosX\",\"gt_showPosY\",\"hmd_device\",\"hmd_info\",\"hmd_resolution_scale\",\"hmd_social_screen\",\"hmd_social_screen_keep_aspect\",\"hmd_tracking_origin\",\"http_password\",\"i_bufferedkeys\",\"i_debug\",\"i_debugDigitalButtons\",\"i_forcefeedback\",\"i_inventory_capacity\",\"i_itemSystemDebugMemStats\",\"i_kinectDebug\",\"i_kinectXboxConnect\",\"i_kinectXboxConnectIP\",\"i_kinectXboxConnectPort\",\"i_kinGlobalExpCorrectionFactor\",\"i_kinGlobalExpDeviationRadius\",\"i_kinGlobalExpJitterRadius\",\"i_kinGlobalExpPredictionFactor\",\"i_kinGlobalExpSmoothFactor\",\"i_kinSkeletonMovedDistance\",\"i_kinSkeletonSmoothType\",\"i_listActionMaps\",\"i_lying_item_limit_mp\",\"i_lying_item_limit_sp\",\"i_mouse_accel\",\"i_mouse_accel_max\",\"i_mouse_buffered\",\"i_mouse_inertia\",\"i_mouse_scroll_coordinate_origin\",\"i_mouse_sensitivity\",\"i_mouse_smooth\",\"i_precache\",\"i_seatedTracking\",\"i_useKinect\",\"i_xinput\",\"i_xinput_deadzone_handling\",\"i_xinput_poll_time\",\"log_EnableRemoteConsole\",\"log_IncludeTime\",\"log_Module\",\"log_SpamDelay\",\"log_tick\",\"log_Verbosity\",\"log_VerbosityOverridesWriteToFile\",\"log_WriteToFile\",\"log_WriteToFileVerbosity\",\"lua_CodeCoverage\",\"lua_debugger\",\"lua_stackonmalloc\",\"lua_StopOnError\",\"MemInfo\",\"MemStats\",\"MemStatsMaxDepth\",\"MemStatsThreshold\",\"mfx_Debug\",\"mfx_DebugFlowGraphFX\",\"mfx_DebugVisual\",\"mfx_DebugVisualFilter\",\"mfx_Enable\",\"mfx_EnableAttachedEffects\",\"mfx_EnableFGEffects\",\"mfx_ParticleImpactThresh\",\"mfx_pfx_maxDist\",\"mfx_pfx_maxScale\",\"mfx_pfx_minScale\",\"mfx_RaisedSoundImpactThresh\",\"mfx_SerializeFGEffects\",\"mfx_SoundImpactThresh\",\"mfx_Timeout\",\"mi_defaultMaterial\",\"mi_jointSize\",\"mi_lazyLodGeneration\",\"mn_allowEditableDatabasesInPureGame\",\"mn_LogToFile\",\"mn_override_preview_file\",\"mn_sequence_path\",\"mov_cameraPrecacheTime\",\"mov_debugSequences\",\"mov_NoCutscenes\",\"mov_overrideCam\",\"movie_physicalentity_animation_lerp\",\"movie_timeJumpTransitionTime\",\"net_availableBandwidthClient\",\"net_availableBandwidthServer\",\"net_backofftimeout\",\"net_breakage_sync_entities\",\"net_bw_aggressiveness\",\"net_channelstats\",\"net_connectivity_detection_interval\",\"net_debug_draw_scale\",\"net_debugChannelIndex\",\"net_debugEntityInfo\",\"net_debugEntityInfoClassName\",\"net_debugInfo\",\"net_debugVerboseLevel\",\"net_dedi_scheduler_client_base_port\",\"net_dedi_scheduler_server_port\",\"net_defaultBandwidthShares\",\"net_defaultPacketRate\",\"net_defaultPacketRateIdle\",\"net_disconnect_on_rmi_error\",\"net_enable_tfrc\",\"net_enable_voice_chat\",\"net_enable_watchdog_timer\",\"net_fragment_expiration_time\",\"net_highlatencythreshold\",\"net_highlatencytimelimit\",\"net_inactivitytimeout\",\"net_inactivitytimeoutDevmode\",\"net_keepalive_time\",\"net_lan_scanport_first\",\"net_lan_scanport_num\",\"net_lanbrowser\",\"net_lobbyUpdateFrequency\",\"net_log\",\"net_log_remote_methods\",\"net_max_fragmented_packets_per_source\",\"net_maxpacketsize\",\"net_meminfo\",\"net_minTCPFriendlyBitRate\",\"net_netMsgDispatcherDebug\",\"net_netMsgDispatcherLogging\",\"net_netMsgDispatcherWarnThreshold\",\"net_new_queue_behaviour\",\"net_numNetIDHighBitBits\",\"net_numNetIDLowBitBits\",\"net_numNetIDMediumBitBits\",\"net_packet_read_debug_output\",\"net_packetfragmentlossrate\",\"net_PacketLagMax\",\"net_PacketLagMin\",\"net_PacketLossRate\",\"net_phys_debug\",\"net_phys_lagsmooth\",\"net_phys_pingsmooth\",\"net_ping_time\",\"net_profile_budget_logging\",\"net_profile_budget_logname\",\"net_profile_deep_bandwidth_logging\",\"net_profile_deep_bandwidth_logname\",\"net_profile_enable\",\"net_profile_logging\",\"net_profile_logname\",\"net_profile_show_socket_measurements\",\"net_profile_untouched_delay\",\"net_profile_worst_num_channels\",\"net_receiveQueueSize\",\"net_remotetimeestimationwarning\",\"net_safetysleeps\",\"net_scheduler_debug\",\"net_scheduler_debug_mode\",\"net_scheduler_expiration_period\",\"net_sendQueueSize\",\"net_sim_loadprofiles\",\"net_SimUseProfile\",\"net_socketBoostTimeout\",\"net_socketMaxTimeout\",\"net_socketMaxTimeoutMultiplayer\",\"net_stats_login\",\"net_stats_pass\",\"osm_debug\",\"osm_enabled\",\"osm_fbMinScale\",\"osm_fbScaleDeltaDown\",\"osm_fbScaleDeltaUp\",\"osm_historyLength\",\"osm_stress\",\"osm_targetFPS\",\"osm_targetFPSTolerance\",\"p_accuracy_LCPCG\",\"p_accuracy_LCPCG_no_improvement\",\"p_accuracy_MC\",\"p_approx_caps_len\",\"p_break_on_awake_ent_id\",\"p_break_on_validation\",\"p_check_out_of_bounds\",\"p_collision_mode\",\"p_cull_distance\",\"p_damping_group_size\",\"p_debug_explosions\",\"p_debug_joints\",\"p_do_step\",\"p_draw_helpers\",\"p_draw_helpers_num\",\"p_draw_helpers_opacity\",\"p_enforce_contacts\",\"p_ent_grid_use_obb\",\"p_fixed_timestep\",\"p_fly_mode\",\"p_force_sync\",\"p_GEB_max_cells\",\"p_gravity_z\",\"p_group_damping\",\"p_joint_damage_accum\",\"p_joint_damage_accum_threshold\",\"p_joint_gravity_step\",\"p_jump_to_profile_ent\",\"p_lattice_max_iters\",\"p_limit_simple_solver_energy\",\"p_list_active_objects\",\"p_log_lattice_tension\",\"p_max_approx_caps\",\"p_max_bone_velocity\",\"p_max_contact_gap\",\"p_max_contact_gap_player\",\"p_max_contact_gap_simple\",\"p_max_contacts\",\"p_max_debris_mass\",\"p_max_entity_cells\",\"p_max_LCPCG_contacts\",\"p_max_LCPCG_fruitless_iters\",\"p_max_LCPCG_iters\",\"p_max_LCPCG_microiters\",\"p_max_LCPCG_microiters_final\",\"p_max_LCPCG_subiters\",\"p_max_LCPCG_subiters_final\",\"p_max_MC_iters\",\"p_max_MC_mass_ratio\",\"p_max_MC_vel\",\"p_max_object_splashes\",\"p_max_plane_contacts\",\"p_max_plane_contacts_distress\",\"p_max_player_velocity\",\"p_max_substeps\",\"p_max_substeps_large_group\",\"p_max_unproj_vel\",\"p_max_velocity\",\"p_max_world_step\",\"p_min_LCPCG_improvement\",\"p_min_MC_iters\",\"p_min_separation_speed\",\"p_net_debugDraw\",\"p_net_extrapmax\",\"p_net_interp\",\"p_net_sequencefrequency\",\"p_num_bodies_large_group\",\"p_num_startup_overload_checks\",\"p_num_threads\",\"p_penalty_scale\",\"p_physics_library\",\"p_players_can_break\",\"p_profile\",\"p_profile_entities\",\"p_profile_functions\",\"p_prohibit_unprojection\",\"p_proxy_highlight_range\",\"p_proxy_highlight_threshold\",\"p_ray_fadeout\",\"p_ray_peak_time\",\"p_rope_collider_size_limit\",\"p_single_step_mode\",\"p_skip_redundant_colldet\",\"p_splash_dist0\",\"p_splash_dist1\",\"p_splash_force0\",\"p_splash_force1\",\"p_splash_vel0\",\"p_splash_vel1\",\"p_tick_breakable\",\"p_time_granularity\",\"p_unproj_vel_scale\",\"p_use_distance_contacts\",\"p_use_unproj_vel\",\"p_wireframe_distance\",\"pp_LoadOnlineAttributes\",\"pp_RichSaveGames\",\"pp_RSFDebugWrite\",\"pp_RSFDebugWriteOnLoad\",\"profile\",\"profile_additionalsub\",\"profile_callstack\",\"profile_col\",\"profile_deep\",\"profile_disk\",\"profile_disk_budget\",\"profile_disk_max_draw_items\",\"profile_disk_max_items\",\"profile_disk_timeframe\",\"profile_disk_type_filter\",\"profile_filter\",\"profile_filter_thread\",\"profile_graph\",\"profile_graphScale\",\"profile_log\",\"profile_min_display_ms\",\"profile_network\",\"profile_pagefaults\",\"profile_peak\",\"profile_peak_display\",\"profile_row\",\"profile_sampler\",\"profile_sampler_max_samples\",\"profile_smooth\",\"profile_weighting\",\"profileStreaming\",\"q_Renderer\",\"q_ShaderFX\",\"q_ShaderGeneral\",\"q_ShaderGlass\",\"q_ShaderHDR\",\"q_ShaderIce\",\"q_ShaderMetal\",\"q_ShaderPostProcess\",\"q_ShaderShadow\",\"q_ShaderSky\",\"q_ShaderTerrain\",\"q_ShaderVegetation\",\"q_ShaderWater\",\"r_3MonHack\",\"r_3MonHackHUDFOVX\",\"r_3MonHackHUDFOVY\",\"r_3MonHackLeftCGFOffsetX\",\"r_3MonHackRightCGFOffsetX\",\"r_AllowLiveMoCap\",\"r_AntialiasingMode\",\"r_AntialiasingModeDebug\",\"r_AntialiasingModeEditor\",\"r_AntialiasingModeSCull\",\"r_AntialiasingTAAFalloffHiFreq\",\"r_AntialiasingTAAFalloffLowFreq\",\"r_AntialiasingTAAPattern\",\"r_AntialiasingTAASharpening\",\"r_AntialiasingTSAAMipBias\",\"r_AntialiasingTSAASmoothness\",\"r_AntialiasingTSAASubpixelDetection\",\"r_ArmourPulseSpeedMultiplier\",\"r_auxGeom\",\"r_Batching\",\"r_BatchType\",\"r_BreakOnError\",\"r_Brightness\",\"r_buffer_banksize\",\"r_buffer_enable_lockless_updates\",\"r_buffer_pool_defrag_dynamic\",\"r_buffer_pool_defrag_max_moves\",\"r_buffer_pool_defrag_static\",\"r_buffer_pool_max_allocs\",\"r_buffer_sli_workaround\",\"r_CBufferUseNativeDepth\",\"r_Character_NoDeform\",\"r_ChromaticAberration\",\"r_CloakFadeByDist\",\"r_CloakFadeLightScale\",\"r_CloakFadeMaxDistSq\",\"r_CloakFadeMinDistSq\",\"r_CloakFadeMinValue\",\"r_CloakHeatScale\",\"r_cloakHighlightStrength\",\"r_CloakInterferenceSparksAlpha\",\"r_CloakLightScale\",\"r_CloakMinAmbientIndoors\",\"r_CloakMinAmbientOutdoors\",\"r_CloakMinLightValue\",\"r_CloakRefractionFadeByDist\",\"r_CloakRefractionFadeMaxDistSq\",\"r_CloakRefractionFadeMinDistSq\",\"r_CloakRefractionFadeMinValue\",\"r_CloakRenderInThermalVision\",\"r_CloakSparksAlpha\",\"r_CloakTransitionLightScale\",\"r_ColorBits\",\"r_ColorGrading\",\"r_ColorGradingCharts\",\"r_ColorGradingChartsCache\",\"r_ColorGradingFilters\",\"r_ColorGradingLevels\",\"r_ColorGradingSelectiveColor\",\"r_ColorRangeCompression\",\"r_ComputeSkinning\",\"r_ComputeSkinningDebugDraw\",\"r_ComputeSkinningMorphs\",\"r_ComputeSkinningTangents\",\"r_ConditionalRendering\",\"r_constantbuffer_banksize\",\"r_constantbuffer_watermarm\",\"r_Contrast\",\"r_CustomResHeight\",\"r_CustomResMaxSize\",\"r_CustomResPreview\",\"r_CustomResWidth\",\"r_CustomVisions\",\"r_D3D12AsynchronousCompute\",\"r_D3D12BatchResourceBarriers\",\"r_D3D12EarlyResourceBarriers\",\"r_D3D12HardwareComputeQueue\",\"r_D3D12HardwareCopyQueue\",\"r_D3D12SubmissionThread\",\"r_D3D12WaitableSwapChain\",\"r_DebugFontRendering\",\"r_DebugGBuffer\",\"r_DebugLayerEffect\",\"r_DebugLights\",\"r_DebugLightVolumes\",\"r_DebugRefraction\",\"r_DebugRenderMode\",\"r_DeferredDecals\",\"r_deferredDecalsDebug\",\"r_DeferredShadingAmbient\",\"r_DeferredShadingAmbientLights\",\"r_DeferredShadingAreaLights\",\"r_DeferredShadingDBTstencil\",\"r_DeferredShadingDepthBoundsTest\",\"r_DeferredShadingEnvProbes\",\"r_DeferredShadingFilterGBuffer\",\"r_DeferredShadingLBuffersFmt\",\"r_DeferredShadingLightLodRatio\",\"r_DeferredShadingLights\",\"r_DeferredShadingLightStencilRatio\",\"r_DeferredShadingLightVolumes\",\"r_DeferredShadingScissor\",\"r_DeferredShadingSortLights\",\"r_DeferredShadingSSS\",\"r_DeferredShadingStencilPrepass\",\"r_DeferredShadingTiled\",\"r_DeferredShadingTiledDebug\",\"r_DeferredShadingTiledHairQuality\",\"r_DepthBits\",\"r_DepthOfField\",\"r_DepthOfFieldBokehQuality\",\"r_DepthOfFieldDilation\",\"r_DepthOfFieldMode\",\"r_DetailDistance\",\"r_DetailTextures\",\"r_DisplayInfo\",\"r_displayinfoTargetFPS\",\"r_dofMinZ\",\"r_dofMinZBlendMult\",\"r_dofMinZScale\",\"r_DrawNearFarPlane\",\"r_DrawNearFoV\",\"r_DrawNearShadows\",\"r_DrawNearZRange\",\"r_Driver\",\"r_durango_async_dips\",\"r_durango_async_dips_sync\",\"r_DynTexAtlasCloudsMaxSize\",\"r_DynTexAtlasDynTexSrcSize\",\"r_DynTexAtlasSpritesMaxSize\",\"r_DynTexAtlasVoxTerrainMaxSize\",\"r_DynTexMaxSize\",\"r_DynTexSourceSharedRTHeight\",\"r_DynTexSourceSharedRTWidth\",\"r_DynTexSourceUseSharedRT\",\"r_enable_full_gpu_sync\",\"r_enableAltTab\",\"r_enableAuxGeom\",\"r_EnableDebugLayer\",\"r_EnvCMResolution\",\"r_EnvTexResolution\",\"r_EnvTexUpdateInterval\",\"r_ExcludeMesh\",\"r_ExcludeShader\",\"r_FlareHqShafts\",\"r_Flares\",\"r_FlaresChromaShift\",\"r_FlaresEnableColorGrading\",\"r_FlaresIrisShaftMaxPolyNum\",\"r_FlaresTessellationRatio\",\"r_FlashMatTexResQuality\",\"r_FogDepthTest\",\"r_FogShadows\",\"r_FogShadowsMode\",\"r_FogShadowsWater\",\"r_Fullscreen\",\"r_FullscreenNativeRes\",\"r_FullscreenPreemption\",\"r_Gamma\",\"r_GeomCacheInstanceThreshold\",\"r_GeomInstancing\",\"r_GeomInstancingDebug\",\"r_GeomInstancingThreshold\",\"r_GetScreenShot\",\"r_GpuParticles\",\"r_GpuParticlesConstantRadiusBoundingBoxes\",\"r_GpuPhysicsFluidDynamicsDebug\",\"r_GrainEnableExposureThreshold\",\"r_GraphicsPipeline\",\"r_GraphicsPipelineMobile\",\"r_GraphicsPipelinePassScheduler\",\"r_GraphStyle\",\"r_HDRBloom\",\"r_HDRBloomQuality\",\"r_HDRDebug\",\"r_HDREyeAdaptationMode\",\"r_HDREyeAdaptationSpeed\",\"r_HDRGrainAmount\",\"r_HDRRangeAdapt\",\"r_HDRRangeAdaptationSpeed\",\"r_HDRRangeAdaptLBufferMax\",\"r_HDRRangeAdaptLBufferMaxRange\",\"r_HDRRangeAdaptMax\",\"r_HDRRangeAdaptMaxRange\",\"r_HDRRendering\",\"r_HDRTexFormat\",\"r_HDRVignetting\",\"r_Height\",\"r_HeightMapAO\",\"r_HeightMapAOAmount\",\"r_HeightMapAORange\",\"r_HeightMapAOResolution\",\"r_HideSunInCubemaps\",\"r_LightsSinglePass\",\"r_Log\",\"r_LogShaders\",\"r_LogTexStreaming\",\"r_LogVBuffers\",\"r_LogVidMem\",\"r_MaterialsBatching\",\"r_MaxSuitPulseSpeedMultiplier\",\"r_MeasureOverdrawScale\",\"r_MergeShadowDrawcalls\",\"r_MeshInstancePoolSize\",\"r_MeshPoolSize\",\"r_MeshPrecache\",\"r_minimizeLatency\",\"r_MotionBlur\",\"r_MotionBlurCameraMotionScale\",\"r_MotionBlurGBufferVelocity\",\"r_MotionBlurMaxViewDist\",\"r_MotionBlurQuality\",\"r_MotionBlurShutterSpeed\",\"r_MotionBlurThreshold\",\"r_MotionVectors\",\"r_MouseCursorTexture\",\"r_MultiGPU\",\"r_MultiThreaded\",\"r_MultiThreadedDrawing\",\"r_MultiThreadedDrawingMinJobSize\",\"r_NightVision\",\"r_NightVisionBrightLevel\",\"r_NightVisionCamMovNoiseAmount\",\"r_NightVisionCamMovNoiseBlendSpeed\",\"r_NightVisionFinalMul\",\"r_NightVisionSonarLifetime\",\"r_NightVisionSonarMultiplier\",\"r_NightVisionSonarRadius\",\"r_NoDraw\",\"r_NoDrawNear\",\"r_NoHWGamma\",\"r_NormalsLength\",\"r_overrideDXGIAdapter\",\"r_overrideRefreshRate\",\"r_overrideScanlineOrder\",\"r_OverscanBorderScaleX\",\"r_OverscanBorderScaleY\",\"r_OverscanBordersDrawDebugView\",\"r_ParticlesAmountGI\",\"r_ParticlesDebug\",\"r_ParticlesHalfRes\",\"r_ParticlesHalfResAmount\",\"r_ParticlesHalfResBlendMode\",\"r_ParticlesInstanceVertices\",\"r_ParticlesRefraction\",\"r_ParticlesSoftIsec\",\"r_ParticlesTessellation\",\"r_ParticlesTessellationTriSize\",\"r_ParticleVerticePoolSize\",\"r_PostProcessEffects\",\"r_PostProcessFilters\",\"r_PostProcessGameFx\",\"r_PostProcessHUD3D\",\"r_PostProcessHUD3DCache\",\"r_PostProcessHUD3DDebugView\",\"r_PostProcessHUD3DGlowAmount\",\"r_PostProcessHUD3DShadowAmount\",\"r_PostProcessHUD3DStencilClear\",\"r_PostProcessNanoGlassDebugView\",\"r_PostProcessParamsBlending\",\"r_PostprocessParamsBlendingTimeScale\",\"r_PostProcessReset\",\"r_PrintMemoryLeaks\",\"r_profiler\",\"r_profilerSmoothingWeight\",\"r_profilerTargetFPS\",\"r_Rain\",\"r_RainAmount\",\"r_RainDistMultiplier\",\"r_RainDropsEffect\",\"r_RainIgnoreNearest\",\"r_RainMaxViewDist\",\"r_RainMaxViewDist_Deferred\",\"r_RainOccluderSizeTreshold\",\"r_RC_AutoInvoke\",\"r_ReadZBufferDirectlyFromVMEM\",\"r_Reflections\",\"r_ReflectionsOffset\",\"r_ReflectionsQuality\",\"r_ReflectTextureSlots\",\"r_Refraction\",\"r_RefractionPartialResolves\",\"r_RefractionPartialResolvesDebug\",\"r_ReleaseAllResourcesOnExit\",\"r_ReloadShaders\",\"r_RenderMeshHashGridUnitSize\",\"r_RenderTargetPoolSize\",\"r_ReprojectOnlyStaticObjects\",\"r_ReverseDepth\",\"r_Scissor\",\"r_ShaderCompilerDontCache\",\"r_ShaderCompilerFolderName\",\"r_ShaderCompilerFolderSuffix\",\"r_ShaderCompilerPort\",\"r_ShaderCompilerServer\",\"r_ShaderEmailCCs\",\"r_ShaderEmailTags\",\"r_ShadersAllowCompilation\",\"r_ShadersAsyncActivation\",\"r_ShadersAsyncCompiling\",\"r_ShadersAsyncMaxThreads\",\"r_ShadersCacheDeterministic\",\"r_ShadersCacheInMemory\",\"r_ShadersCompileAutoActivate\",\"r_ShadersCompileCompatible\",\"r_ShadersCompileStrict\",\"r_ShadersDebug\",\"r_ShadersEditing\",\"r_ShadersExport\",\"r_ShadersIgnoreIncludesChanging\",\"r_ShadersImport\",\"r_ShadersLazyUnload\",\"r_ShadersLogCacheMisses\",\"r_ShadersPrecacheAllLights\",\"r_ShadersRemoteCompiler\",\"r_ShadersSubmitRequestline\",\"r_ShaderTarget\",\"r_ShadowBluriness\",\"r_ShadowCastingLightsMaxCount\",\"r_ShadowGen\",\"r_ShadowGenDepthClip\",\"r_ShadowGenMode\",\"r_ShadowJittering\",\"r_ShadowMaskStencilPrepass\",\"r_ShadowPass\",\"r_ShadowPoolMaxFrames\",\"r_ShadowPoolMaxTimeslicedUpdatesPerFrame\",\"r_ShadowsAdaptionMin\",\"r_ShadowsAdaptionRangeClamp\",\"r_ShadowsAdaptionSize\",\"r_ShadowsBias\",\"r_ShadowsCache\",\"r_ShadowsCacheFormat\",\"r_ShadowsCacheResolutions\",\"r_ShadowsDepthBoundNV\",\"r_ShadowsGridAligned\",\"r_ShadowsMaskDownScale\",\"r_ShadowsMaskResolution\",\"r_ShadowsNearestMapResolution\",\"r_ShadowsParticleAnimJitterAmount\",\"r_ShadowsParticleJitterAmount\",\"r_ShadowsParticleKernelSize\",\"r_ShadowsParticleNormalEffect\",\"r_ShadowsPCFiltering\",\"r_ShadowsScreenSpace\",\"r_ShadowsScreenSpaceLength\",\"r_ShadowsStencilPrePass\",\"r_ShadowsUseClipVolume\",\"r_ShadowTexFormat\",\"r_Sharpening\",\"r_ShowBufferUsage\",\"r_ShowDynTextures\",\"r_ShowDynTexturesFilter\",\"r_ShowDynTexturesMaxCount\",\"r_ShowLightBounds\",\"r_ShowLines\",\"r_ShowNormals\",\"r_ShowTangents\",\"r_ShowTexture\",\"r_ShowTimeGraph\",\"r_ShowVideoMemoryStats\",\"r_SilhouettePOM\",\"r_SkipAlphaTested\",\"r_Snow\",\"r_SnowDisplacement\",\"r_SnowFlakeClusters\",\"r_SnowHalfRes\",\"r_SonarVision\",\"r_ssdo\",\"r_ssdoAmountAmbient\",\"r_ssdoAmountDirect\",\"r_ssdoAmountReflection\",\"r_ssdoColorBleeding\",\"r_ssdoHalfRes\",\"r_ssdoRadius\",\"r_ssdoRadiusMax\",\"r_ssdoRadiusMin\",\"r_SSReflections\",\"r_SSReflHalfRes\",\"r_Stats\",\"r_statsMinDrawCalls\",\"r_StencilBits\",\"r_StereoDevice\",\"r_StereoEnableMgpu\",\"r_StereoEyeDist\",\"r_StereoFlipEyes\",\"r_StereoGammaAdjustment\",\"r_StereoHudScreenDist\",\"r_stereoMirrorProjection\",\"r_StereoMode\",\"r_StereoNearGeoScale\",\"r_StereoOutput\",\"r_stereoScaleCoefficient\",\"r_StereoScreenDist\",\"r_StereoStrength\",\"r_sunshafts\",\"r_Supersampling\",\"r_SupersamplingFilter\",\"r_SyncToFrameFence\",\"r_TessellationDebug\",\"r_TessellationTriangleSize\",\"r_TexAtlasSize\",\"r_TexBindMode\",\"r_TexelsPerMeter\",\"r_TexLog\",\"r_TexMaxAnisotropy\",\"r_TexMinAnisotropy\",\"r_TexNoAnisoAlphaTest\",\"r_TexNoLoad\",\"r_TexPostponeLoading\",\"r_TexPreallocateAtlases\",\"r_TextureCompiling\",\"r_TextureCompilingIndicator\",\"r_TextureCompressor\",\"r_TextureLodDistanceRatio\",\"r_TexturesStreaming\",\"r_TexturesStreamingDebug\",\"r_TexturesStreamingDebugDumpIntoLog\",\"r_TexturesStreamingDebugFilter\",\"r_TexturesStreamingDebugMinMip\",\"r_TexturesStreamingDebugMinSize\",\"r_texturesstreamingDeferred\",\"r_TexturesStreamingDisableNoStreamDuringLoad\",\"r_texturesstreamingJobUpdate\",\"r_TexturesStreamingMaxRequestedJobs\",\"r_TexturesStreamingMaxRequestedMB\",\"r_TexturesStreamingMinReadSizeKB\",\"r_texturesstreamingMinUsableMips\",\"r_TexturesStreamingMipBias\",\"r_TexturesStreamingMipClampDVD\",\"r_TexturesStreamingMipFading\",\"r_TexturesStreamingNoUpload\",\"r_TexturesStreamingOnlyVideo\",\"r_TexturesStreamingPostponeMips\",\"r_TexturesStreamingPostponeThresholdKB\",\"r_texturesstreamingPostponeThresholdMip\",\"r_TexturesStreamingPrecacheRounds\",\"r_texturesstreamingSkipMips\",\"r_TexturesStreamingSuppress\",\"r_TexturesStreamingUpdateType\",\"r_texturesstreampooldefragmentation\",\"r_texturesstreampooldefragmentationmaxamount\",\"r_texturesstreampooldefragmentationmaxmoves\",\"r_TexturesStreamPoolSecondarySize\",\"r_TexturesStreamPoolSize\",\"r_ThermalVision\",\"r_ThermalVisionViewCloakFlickerMaxIntensity\",\"r_ThermalVisionViewCloakFlickerMinIntensity\",\"r_ThermalVisionViewCloakFrequencyPrimary\",\"r_ThermalVisionViewCloakFrequencySecondary\",\"r_ThermalVisionViewDistance\",\"r_transient_pool_size\",\"r_TransparentPasses\",\"r_TranspDepthFixup\",\"r_Unlit\",\"r_UpdateInstances\",\"r_UseDisplacementFactor\",\"r_UseESRAM\",\"r_UseHWSkinning\",\"r_UseMaterialLayers\",\"r_UseMergedPosts\",\"r_UsePersistentRTForModelHUD\",\"r_UseShadowsPool\",\"r_UseZPass\",\"r_ValidateDraw\",\"r_VegetationSpritesDebug\",\"r_VegetationSpritesGenAlways\",\"r_VegetationSpritesMaxLightingUpdates\",\"r_VegetationSpritesNoGen\",\"r_VegetationSpritesTexRes\",\"r_VisAreaClipLightsPerPixel\",\"r_VolumetricClouds\",\"r_VolumetricCloudsPipeline\",\"r_VolumetricCloudsRaymarchStepNum\",\"r_VolumetricCloudsShadowResolution\",\"r_VolumetricCloudsStereoReprojection\",\"r_VolumetricCloudsTemporalReprojection\",\"r_VolumetricFogDownscaledSunShadow\",\"r_VolumetricFogDownscaledSunShadowRatio\",\"r_VolumetricFogMinimumLightBulbSize\",\"r_VolumetricFogReprojectionBlendFactor\",\"r_VolumetricFogReprojectionMode\",\"r_VolumetricFogSample\",\"r_VolumetricFogShadow\",\"r_VolumetricFogSunLightCorrection\",\"r_VolumetricFogTexDepth\",\"r_VolumetricFogTexScale\",\"r_VrProjectionPreset\",\"r_VrProjectionType\",\"r_VSync\",\"r_WaterCaustics\",\"r_WaterCausticsDeferred\",\"r_WaterCausticsDistance\",\"r_WaterGodRays\",\"r_WaterGodRaysDistortion\",\"r_WaterReflections\",\"r_WaterReflectionsMGPU\",\"r_WaterReflectionsMinVisiblePixelsUpdate\",\"r_WaterReflectionsMinVisUpdateDistanceMul\",\"r_WaterReflectionsMinVisUpdateFactorMul\",\"r_WaterReflectionsQuality\",\"r_WaterReflectionsUseMinOffset\",\"r_WaterTessellationHW\",\"r_WaterUpdateDistance\",\"r_WaterUpdateFactor\",\"r_WaterUpdateThread\",\"r_WaterVolumeCaustics\",\"r_WaterVolumeCausticsDensity\",\"r_WaterVolumeCausticsMaxDist\",\"r_WaterVolumeCausticsRes\",\"r_WaterVolumeCausticsSnapFactor\",\"r_Width\",\"r_WindowIconTexture\",\"r_WindowType\",\"r_wireframe\",\"r_ZFightingDepthScale\",\"r_ZFightingExtrude\",\"r_ZPassDepthSorting\",\"r_ZPassOnly\",\"r_ZPrepassMaxDist\",\"rc_debugVerboseLevel\",\"rcon_password\",\"s_AccumulateOcclusion\",\"s_AudioEventPoolSize\",\"s_AudioImplName\",\"s_AudioObjectPoolSize\",\"s_AudioObjectsRayType\",\"s_AudioStandaloneFilePoolSize\",\"s_DebugDistance\",\"s_DebugFilter\",\"s_DefaultStandaloneFilesAudioTrigger\",\"s_DrawAudioDebug\",\"s_FileCacheManagerDebugFilter\",\"s_FileCacheManagerSize\",\"s_FullObstructionMaxDistance\",\"s_HideInactiveAudioObjects\",\"s_IgnoreWindowFocus\",\"s_ListenerOcclusionPlaneSize\",\"s_LoggingOptions\",\"s_OcclusionHighDistance\",\"s_OcclusionMaxDistance\",\"s_OcclusionMaxSyncDistance\",\"s_OcclusionMediumDistance\",\"s_OcclusionMinDistance\",\"s_OcclusionRayLengthOffset\",\"s_PositionUpdateThresholdMultiplier\",\"s_SDLMixerStandaloneFileExtension\",\"s_VelocityTrackingThreshold\",\"sc_allowFlowGraphNodes\",\"sc_DiscardOnSave\",\"sc_DisplayCriticalErrors\",\"sc_EnableScriptPartitioning\",\"sc_EntityDebugConfig\",\"sc_EntityDebugFilter\",\"sc_EntityDebugTextPos\",\"sc_ExperimentalFeatures\",\"sc_FileFormat\",\"sc_FunctionTimeLimit\",\"sc_IgnorePAKFiles\",\"sc_IgnoreUnderscoredFolders\",\"sc_LogFileMessageTypes\",\"sc_LogFileStreams\",\"sc_LogToFile\",\"sc_MaxRecursionDepth\",\"sc_RelevanceGridCellSize\",\"sc_RelevanceGridDebugStatic\",\"sc_RootFolder\",\"sc_RunUnitTests\",\"sc_Update\",\"sc_UseNewGraphPipeline\",\"sensor_Debug\",\"sensor_DebugRange\",\"STAP_DEBUG\",\"STAP_DISABLE\",\"STAP_LOCK_EFFECTOR\",\"STAP_OVERRIDE_TRACK_FACTOR\",\"STAP_TRANSLATION_FEATHER\",\"STAP_TRANSLATION_FUDGE\",\"stats_FpsBuckets\",\"stats_PakFile\",\"stats_Particles\",\"stats_RenderBatchStats\",\"stats_RenderSummary\",\"stats_Warnings\",\"sv_AISystem\",\"sv_autoconfigurl\",\"sv_bandwidth\",\"sv_bind\",\"sv_DedicatedCPUPercent\",\"sv_DedicatedCPUVariance\",\"sv_DedicatedMaxRate\",\"sv_dumpstats\",\"sv_dumpstatsperiod\",\"sv_gamerules\",\"sv_gamerulesdefault\",\"sv_lanonly\",\"sv_levelrotation\",\"sv_LoadAllLayersForResList\",\"sv_map\",\"sv_maxmemoryusage\",\"sv_maxplayers\",\"sv_maxspectators\",\"sv_packetRate\",\"sv_password\",\"sv_port\",\"sv_ranked\",\"sv_requireinputdevice\",\"sv_servername\",\"sv_timeofdayenable\",\"sv_timeofdaylength\",\"sv_timeofdaystart\",\"sv_timeout_disconnect\",\"sys_AI\",\"sys_archive_host_xml_version\",\"sys_asserts\",\"sys_audio_disable\",\"sys_bp_enabled\",\"sys_bp_format\",\"sys_bp_frames\",\"sys_bp_frames_sample_period\",\"sys_bp_frames_sample_period_rnd\",\"sys_bp_frames_threshold\",\"sys_bp_frames_worker_thread\",\"sys_bp_level_load\",\"sys_bp_time_threshold\",\"sys_budget_frametime\",\"sys_budget_numdrawcalls\",\"sys_budget_numpolys\",\"sys_budget_soundchannels\",\"sys_budget_soundCPU\",\"sys_budget_soundmem\",\"sys_budget_streamingthroughput\",\"sys_budget_sysmem\",\"sys_budget_videomem\",\"sys_build_folder\",\"sys_crashrpt\",\"sys_crashrpt_appname\",\"sys_crashrpt_appversion\",\"sys_crashrpt_email\",\"sys_crashrpt_privacypolicy\",\"sys_crashrpt_server\",\"sys_DeactivateConsole\",\"sys_debugger_adjustments\",\"sys_deferAudioUpdateOptim\",\"sys_display_threads\",\"sys_dll_ai\",\"sys_dll_game\",\"sys_dll_response_system\",\"sys_dump_aux_threads\",\"sys_dump_type\",\"sys_enable_budgetmonitoring\",\"sys_enable_crash_handler\",\"sys_entities\",\"sys_error_debugbreak\",\"sys_filesystemCaseSensitivity\",\"sys_firstlaunch\",\"sys_flash\",\"sys_flash_address_space\",\"sys_flash_allow_reset_mesh_cache\",\"sys_flash_check_filemodtime\",\"sys_flash_curve_tess_error\",\"sys_flash_debugdraw\",\"sys_flash_debugdraw_depth\",\"sys_flash_debuglog\",\"sys_flash_edgeaa\",\"sys_flash_info\",\"sys_flash_info_histo_scale\",\"sys_flash_info_peak_exclude\",\"sys_flash_info_peak_tolerance\",\"sys_flash_log_options\",\"sys_flash_reset_mesh_cache\",\"sys_flash_static_pool_size\",\"sys_flash_stereo_maxparallax\",\"sys_flash_use_arenas\",\"sys_flash_video_soundvolume\",\"sys_flash_video_subaudiovolume\",\"sys_flash_warning_level\",\"sys_float_exceptions\",\"sys_force_installtohdd_mode\",\"sys_game_folder\",\"sys_game_name\",\"sys_highrestimer\",\"sys_ime\",\"sys_initpreloadpacks\",\"sys_intromoviesduringinit\",\"sys_job_system_enable\",\"sys_job_system_filter\",\"sys_job_system_max_worker\",\"sys_job_system_profiler\",\"sys_keyboard\",\"sys_keyboard_break\",\"sys_limit_phys_thread_count\",\"sys_livecreate\",\"sys_LoadFrontendShaderCache\",\"sys_localization_debug\",\"sys_localization_encode\",\"sys_localization_folder\",\"sys_LocalMemoryDiagramAlpha\",\"sys_LocalMemoryDiagramDistance\",\"sys_LocalMemoryDiagramRadius\",\"sys_LocalMemoryDiagramStreamingSpeedDistance\",\"sys_LocalMemoryDiagramStreamingSpeedRadius\",\"sys_LocalMemoryDiagramWidth\",\"sys_LocalMemoryDrawText\",\"sys_LocalMemoryGeometryLimit\",\"sys_LocalMemoryGeometryStreamingSpeedLimit\",\"sys_LocalMemoryInnerViewDistance\",\"sys_LocalMemoryLogText\",\"sys_LocalMemoryMaxMSecBetweenCalls\",\"sys_LocalMemoryObjectAlpha\",\"sys_LocalMemoryObjectHeight\",\"sys_LocalMemoryObjectWidth\",\"sys_LocalMemoryOptimalMSecPerSec\",\"sys_LocalMemoryOuterViewDistance\",\"sys_LocalMemoryStreamingSpeedObjectLength\",\"sys_LocalMemoryStreamingSpeedObjectWidth\",\"sys_LocalMemoryTextureLimit\",\"sys_LocalMemoryTextureStreamingSpeedLimit\",\"sys_LocalMemoryWarningRatio\",\"sys_log_asserts\",\"sys_logallocations\",\"sys_max_step\",\"sys_MaxFPS\",\"sys_maxTimeStepForMovieSystem\",\"sys_memory_debug\",\"sys_MemoryDeadListSize\",\"sys_menupreloadpacks\",\"sys_min_step\",\"sys_no_crash_dialog\",\"sys_noupdate\",\"sys_PakDisableNonLevelRelatedPaks\",\"sys_PakInMemorySizeLimit\",\"sys_PakLoadCache\",\"sys_PakLoadModePaks\",\"sys_PakLogAllFileAccess\",\"sys_PakLogInvalidFileAccess\",\"sys_PakLogMissingFiles\",\"sys_PakMessageInvalidFileAccess\",\"sys_PakPriority\",\"sys_PakReadSlice\",\"sys_PakSaveFastLoadResourceList\",\"sys_PakSaveLevelResourceList\",\"sys_PakSaveMenuCommonResourceList\",\"sys_PakSaveTotalResourceList\",\"sys_PakStreamCache\",\"sys_PakTotalInMemorySizeLimit\",\"sys_PakValidateFileHash\",\"sys_perfhud\",\"sys_perfhud_fpsBucketsExclusive\",\"sys_perfhud_pause\",\"sys_physics\",\"sys_physics_enable_MT\",\"sys_preload\",\"sys_ProfileLevelLoading\",\"sys_ProfileLevelLoadingDump\",\"sys_project\",\"sys_resource_cache_folder\",\"sys_root\",\"sys_scale3DMouseTranslation\",\"sys_Scale3DMouseYPR\",\"sys_SchematycPlugin\",\"sys_screensaver_allowed\",\"sys_simple_http_base_port\",\"sys_SimulateTask\",\"sys_spec\",\"sys_spec_full\",\"sys_spec_gameeffects\",\"sys_spec_light\",\"sys_spec_objectdetail\",\"sys_spec_particles\",\"sys_spec_physics\",\"sys_spec_postprocessing\",\"sys_spec_quality\",\"sys_spec_shading\",\"sys_spec_shadows\",\"sys_spec_sound\",\"sys_spec_texture\",\"sys_spec_textureresolution\",\"sys_spec_volumetriceffects\",\"sys_spec_water\",\"sys_splashscreen\",\"sys_SSInfo\",\"sys_streaming_debug\",\"sys_streaming_debug_filter\",\"sys_streaming_debug_filter_file_name\",\"sys_streaming_debug_filter_min_time\",\"sys_streaming_in_blocks\",\"sys_streaming_max_bandwidth\",\"sys_streaming_max_finalize_per_frame\",\"sys_streaming_memory_budget\",\"sys_streaming_requests_grouping_time_period\",\"sys_streaming_resetstats\",\"sys_streaming_use_optical_drive_thread\",\"sys_system_timer_resolution\",\"sys_target_platforms\",\"sys_trackview\",\"sys_UncachedStreamReads\",\"sys_update_profile_time\",\"sys_use_mono\",\"sys_usePlatformSavingAPI\",\"sys_usePlatformSavingAPIEncryption\",\"sys_user_folder\",\"sys_UserAnalyticsCollect\",\"sys_UserAnalyticsLogging\",\"sys_UserAnalyticsServerAddress\",\"sys_version\",\"sys_vr_support\",\"sys_vtune\",\"sys_warnings\",\"sys_WER\",\"t_Debug\",\"t_FixedStep\",\"t_MaxStep\",\"t_Scale\",\"t_Smoothing\",\"v_autoDisable\",\"v_clientPredict\",\"v_clientPredictAdditionalTime\",\"v_clientPredictMaxTime\",\"v_clientPredictSmoothing\",\"v_clientPredictSmoothingConst\",\"v_debug_flip_over\",\"v_debug_mem\",\"v_debug_reorient\",\"v_debugCollisionDamage\",\"v_debugdraw\",\"v_debugSuspensionIK\",\"v_debugVehicle\",\"v_debugViewAbove\",\"v_debugViewAboveH\",\"v_debugViewDetach\",\"v_disable_hull\",\"v_disableEntry\",\"v_draw_components\",\"v_draw_helpers\",\"v_draw_passengers\",\"v_draw_seats\",\"v_draw_tm\",\"v_driverControlledMountedGuns\",\"v_enableMannequin\",\"v_FlippedExplosionPlayerMinDistance\",\"v_FlippedExplosionRetryTimeMS\",\"v_FlippedExplosionTimeToExplode\",\"v_goliathMode\",\"v_independentMountedGuns\",\"v_lights\",\"v_lights_enable_always\",\"v_playerTransitions\",\"v_ragdollPassengers\",\"v_serverControlled\",\"v_set_passenger_tm\",\"v_show_all\",\"v_slipFrictionModFront\",\"v_slipFrictionModRear\",\"v_slipSlopeFront\",\"v_slipSlopeRear\",\"v_staticTreadDeform\",\"v_testClientPredict\",\"v_transitionAnimations\",\"v_vehicle_quality\",\"watchdog\"]},\"commands\":{\"type\":\"string\",\"title\":\"Command name\",\"description\":\"Console command name\",\"default\":\"\",\"enum\":[\"_TestFormatMessage\",\"ai_CheckGoalpipes\",\"ai_commTest\",\"ai_commTestStop\",\"ai_DebugAgent\",\"ai_debugMNMAgentType\",\"ai_MNMCalculateAccessibility\",\"ai_MNMComputeConnectedIslands\",\"ai_NavigationReloadConfig\",\"ai_Recorder_Start\",\"ai_Recorder_Stop\",\"ai_reload\",\"ai_resetCommStats\",\"ai_writeCommStats\",\"audit_cvars\",\"ban\",\"ban_remove\",\"ban_status\",\"Bind\",\"ca_DebugText\",\"ca_DefaultTransitionInterpolationType\",\"connect\",\"connect_repeatedly\",\"ConsoleHide\",\"ConsoleShow\",\"demo\",\"demo_StartDemoChain\",\"demo_StartDemoLevel\",\"disconnect\",\"disconnectchannel\",\"drs_sendSignal\",\"ds_Dump\",\"ds_DumpSessions\",\"ds_Reload\",\"dump_action_maps\",\"dump_maps\",\"dump_stats\",\"DumpCommandsVars\",\"DumpVars\",\"e_DebugDrawListCMD\",\"e_ParticleListEffects\",\"e_ParticleListEmitters\",\"e_ParticleMemory\",\"e_ReloadSurfaces\",\"e_StatoscopeAddUserMarker\",\"ed_disable_game_mode\",\"ed_GenerateBillboardTextures\",\"ed_goto\",\"ed_killmemory\",\"ed_randomize_variations\",\"eqp_DumpPacks\",\"es_compile_area_grid\",\"es_debugAnim\",\"es_dump_entities\",\"es_dump_entity_classes_in_use\",\"es_togglelayer\",\"exec\",\"ffs_PlayEffect\",\"ffs_Reload\",\"ffs_StopAllEffects\",\"fg_InspectAction\",\"fg_InspectEntity\",\"fg_Inspector\",\"fg_reloadClasses\",\"fg_writeDocumentation\",\"g_dump_stats\",\"g_dumpClassRegistry\",\"g_saveLoadDumpEntity\",\"gamedata_playback\",\"gamedata_record\",\"gamedata_stop_record_or_playback\",\"gfx_reload_all\",\"gt_AddToDebugList\",\"gt_RemoveFromDebugList\",\"hmd_recenter_pose\",\"http_startserver\",\"http_stopserver\",\"i_dropitem\",\"i_giveallitems\",\"i_giveammo\",\"i_givedebugitems\",\"i_giveitem\",\"i_listitems\",\"i_reloadActionMaps\",\"i_saveweaponposition\",\"kick\",\"kickid\",\"load\",\"LoadConfig\",\"LocalizationDumpLoadedInfo\",\"log_flush\",\"lua_debugger_show\",\"lua_dump_coverage\",\"lua_dump_state\",\"lua_garbagecollect\",\"lua_reload_script\",\"map\",\"memDumpAllocs\",\"memReplayAddSizerTree\",\"memReplayDumpSymbols\",\"memReplayInfo\",\"memReplayLabel\",\"memReplayPause\",\"memReplayResume\",\"memReplayStop\",\"memResetAllocs\",\"mfx_Reload\",\"mfx_ReloadFGEffects\",\"mn_DebugAI\",\"mn_listAssets\",\"mn_reload\",\"mono_reload\",\"mov_goToFrameEditor\",\"net_dump_object_state\",\"net_DumpMessageApproximations\",\"net_getChannelPerformanceMetrics\",\"net_netMsgDispatcherClearStats\",\"net_pb_cl_enable\",\"net_pb_sv_enable\",\"net_set_cdkey\",\"net_setChannelPerformanceMetrics\",\"open_url\",\"osm_setFBScale\",\"play\",\"py\",\"q_Quality\",\"r_ColorGradingChartImage\",\"r_DumpFontNames\",\"r_DumpFontTexture\",\"r_getposteffectparamf\",\"r_OptimiseShaders\",\"r_OverscanBorders\",\"r_PrecacheShaderList\",\"r_setposteffectparamf\",\"r_ShowRenderTarget\",\"r_StatsShaderList\",\"rcon_command\",\"rcon_connect\",\"rcon_disconnect\",\"rcon_startserver\",\"rcon_stopserver\",\"readabilityReload\",\"record\",\"RecordClip\",\"ReloadDialogData\",\"RunUnitTests\",\"s_ExecuteTrigger\",\"s_SetParameter\",\"s_SetSwitchState\",\"s_StopTrigger\",\"save\",\"save_genstrings\",\"SaveLevelStats\",\"sc_CriticalError\",\"sc_FatalError\",\"sc_rpcShow\",\"sc_SaveAllScriptFiles\",\"Screenshot\",\"sensor_SetOctreeBounds\",\"sensor_SetOctreeDepth\",\"status\",\"stopdemo\",\"stoprecording\",\"sys_crashrpt_generate\",\"sys_crashtest\",\"sys_crashtest_thread\",\"sys_dump_cvars\",\"sys_ignore_asserts_from_module\",\"sys_job_system_dump_job_list\",\"sys_LvlRes_finalstep\",\"sys_LvlRes_findunused\",\"sys_RestoreSpec\",\"sys_StroboscopeDumpResults\",\"sys_StroboscopeStart\",\"sys_StroboscopeStop\",\"sys_threads_dump_thread_config_list\",\"test_delegate\",\"test_playersBounds\",\"test_profile\",\"test_reset\",\"unload\",\"v_dump_classes\",\"v_exit_player\",\"v_reload_system\",\"version\",\"VisRegTest\",\"voice_mute\",\"wait_frames\",\"wait_seconds\"]}},\"id\":\"https://json.schemastore.org/cryproj\",\"properties\":{\"console_variables\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/cvars\"},\"value\":{\"type\":\"string\",\"title\":\"Value of the CVar\",\"description\":\"The default value of the CVar\",\"default\":\"pc,ps4,xboxone,linux\"}},\"required\":[\"name\",\"value\"]}},\"content\":{\"type\":\"object\",\"properties\":{\"assets\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"Assets folder\",\"description\":\"This indicates where the assets are stored\",\"default\":\"Assets\",\"examples\":[\"Assets\"]}},\"code\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"Code folder\",\"description\":\"This indicates where the code is stored\",\"default\":\"Code\",\"examples\":[\"Code\"]}},\"libs\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Lib's name\",\"default\":\"\",\"examples\":[\"Blank\"]},\"shared\":{\"type\":\"object\",\"properties\":{\"any\":{\"type\":\"string\",\"title\":\"Lib's name to import for all the supported platforms\",\"default\":\"\",\"examples\":[\"CryGameSDK\"]},\"win_x64\":{\"type\":\"string\",\"title\":\"Lib's name to import for the win_x64 platform\",\"default\":\"\",\"examples\":[\"bin/win_x64/Game.dll\"]},\"win_x86\":{\"type\":\"string\",\"title\":\"Lib's name to import for the win_x86 platform\",\"default\":\"\",\"examples\":[\"bin/win_x86/Game.dll\"]}}}}}}},\"required\":[\"code\"]},\"info\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Project name\",\"description\":\"This indicates the project name\",\"default\":\"\",\"examples\":[\"MyFancyProject\"]},\"guid\":{\"type\":\"string\",\"title\":\"Project GUID\",\"default\":\"\",\"pattern\":\"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}\"}},\"required\":[\"name\"]},\"require\":{\"type\":\"object\",\"properties\":{\"engine\":{\"type\":\"string\",\"title\":\"Engine version\",\"description\":\"This indicates which engine version will be used\",\"default\":\"\",\"examples\":[\"engine-5.4\"],\"enum\":[\"engine-5.2\",\"engine-5.3\",\"engine-5.4\",\"engine-5.5\",\"engine-dev\"]},\"plugins\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\",\"title\":\"Plugin name\",\"description\":\"Required plugin's name\",\"examples\":[\"CryDefaultEntities\",\"CrySensorSystem\",\"CryPerceptionSystem\",\"CryUserAnalytics\",\"CryOSVR\",\"CryOculusVR\",\"CryOpenVR\",\"CryLobby\"]},\"type\":{\"type\":\"string\",\"title\":\"Plugin type\",\"description\":\"EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one\",\"default\":\"\",\"examples\":[\"EPluginType::Native\",\"EPluginType::Managed\"],\"enum\":[\"EPluginType::Native\",\"EPluginType::Managed\"]},\"platforms\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"This plugin will be used only by these platforms\",\"default\":\"\",\"examples\":[\"PS4\"],\"enum\":[\"pc\",\"ps4\",\"xboxone\",\"linux\"]}}},\"required\":[\"path\",\"type\"]}}},\"required\":[\"engine\"]},\"type\":{\"type\":\"string\",\"title\":\"\",\"default\":\"\",\"examples\":[\"\"]},\"version\":{\"type\":\"integer\",\"title\":\"Project version\",\"default\":1,\"examples\":[1]},\"console_commands\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/commands\"},\"value\":{\"type\":\"string\",\"title\":\"Value of the command\",\"description\":\"Arguments that has to be passed to the command. Leave empty if it has not parameters\",\"default\":\"\"}},\"required\":[\"name\",\"value\"]}}},\"required\":[\"content\",\"info\",\"require\",\"version\"],\"title\":\"CryProj schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CryProj schema\". Here are the required top‑level fields: content, info, require, version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$comment":"JSON Schema for CRYENGINE *","definitions":{"cvars":{"type":"string","title":"Variable name","description":"CVar name","default":"sys_target_platforms","enum":["a_poseAlignerDebugDraw","a_poseAlignerEnable","a_poseAlignerForceLock","a_poseAlignerForceNoIntersections","a_poseAlignerForceNoRootOffset","a_poseAlignerForceTargetSmoothing","a_poseAlignerForceWeightOne","ac_ColliderModeAI","ac_ColliderModePlayer","ac_debugAnimEffects","ac_debugAnimTarget","ac_debugColliderMode","ac_debugEntityParams","ac_DebugFilter","ac_debugLocations","ac_debugLocationsGraphs","ac_debugMotionParams","ac_debugMovementControlMethods","ac_debugText","ac_debugXXXValues","ac_disableSlidingContactEvents","ac_enableExtraSolidCollider","ac_entityAnimClamp","ac_forceSimpleMovement","ac_frametime","ac_movementControlMethodFilter","ac_movementControlMethodHor","ac_movementControlMethodVer","ac_templateMCMs","ac_useMovementPrediction","ac_useQueuedRotation","ag_debugExactPos","ag_defaultAIStance","ag_travelSpeedSmoothing","ag_turnAngleSmoothing","ag_turnSpeedParamScale","ag_turnSpeedSmoothing","ai_AdjustPathsAroundDynamicObstacles","ai_AgentStatsDist","ai_AllowedToHit","ai_AllowedToHitPlayer","ai_AllTime","ai_AmbientFireEnable","ai_AmbientFireQuota","ai_AmbientFireUpdateInterval","ai_AttemptStraightPath","ai_BannedNavSoTime","ai_BeautifyPath","ai_BubblesSystem","ai_BubblesSystemAlertnessFilter","ai_BubblesSystemAllowPrototypeDialogBubbles","ai_BubblesSystemDecayTime","ai_BubblesSystemFontSize","ai_BubblesSystemNameFilter","ai_BubblesSystemUseDepthTest","ai_BurstWhileMovingDestinationRange","ai_CheckWalkabilityOptimalSectionLength","ai_CollisionAvoidanceAgentExtraFat","ai_CollisionAvoidanceAgentTimeHorizon","ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh","ai_CollisionAvoidanceEnableRadiusIncrement","ai_CollisionAvoidanceMinSpeed","ai_CollisionAvoidanceObstacleTimeHorizon","ai_CollisionAvoidancePathEndCutoffRange","ai_CollisionAvoidanceRadiusIncrementDecreaseRate","ai_CollisionAvoidanceRadiusIncrementIncreaseRate","ai_CollisionAvoidanceRange","ai_CollisionAvoidanceSmartObjectCutoffRange","ai_CollisionAvoidanceTargetCutoffRange","ai_CollisionAvoidanceTimestep","ai_CollisionAvoidanceUpdateVelocities","ai_CommunicationForceTestVoicePack","ai_CommunicationManagerHeighThresholdForTargetPosition","ai_CompatibilityMode","ai_CoolMissesBoxHeight","ai_CoolMissesBoxSize","ai_CoolMissesCooldown","ai_CoolMissesMaxLightweightEntityMass","ai_CoolMissesMinMissDistance","ai_CoolMissesProbability","ai_CoverExactPositioning","ai_CoverMaxEyeCount","ai_CoverPredictTarget","ai_CoverSpacing","ai_CoverSystem","ai_CrouchVisibleRange","ai_CrowdControlInPathfind","ai_DebugCollisionAvoidanceForceSpeed","ai_DebugDraw","ai_DebugDrawAdaptiveUrgency","ai_DebugDrawAmbientFire","ai_DebugDrawArrowLabelsVisibilityDistance","ai_DebugDrawAStarOpenList","ai_DebugDrawAStarOpenListTime","ai_DebugDrawBannedNavsos","ai_DebugDrawCollisionAvoidance","ai_DebugDrawCollisionAvoidanceAgentName","ai_DebugDrawCommunication","ai_DebugDrawCommunicationHistoryDepth","ai_DebugDrawCoolMisses","ai_DebugDrawCover","ai_DebugDrawCoverLocations","ai_DebugDrawCoverOccupancy","ai_DebugDrawCoverPlanes","ai_DebugDrawCoverSampler","ai_DebugDrawCrowdControl","ai_DebugDrawDamageControl","ai_DebugDrawDamageParts","ai_DebugDrawDynamicCoverSampler","ai_DebugDrawDynamicHideObjectsRange","ai_DebugDrawEnabledActors","ai_DebugDrawEnabledPlayers","ai_DebugDrawExpensiveAccessoryQuota","ai_DebugDrawFireCommand","ai_DebugDrawGroups","ai_DebugDrawHidespotRange","ai_DebugDrawHideSpotSearchRays","ai_DebugDrawLightLevel","ai_DebugDrawNavigation","ai_DebugDrawNavigationWorldMonitor","ai_DebugDrawPhysicsAccess","ai_DebugDrawPlayerActions","ai_DebugDrawReinforcements","ai_DebugDrawStanceSize","ai_DebugDrawVegetationCollisionDist","ai_DebugDrawVisionMap","ai_DebugDrawVisionMapObservables","ai_DebugDrawVisionMapObservers","ai_DebugDrawVisionMapObserversFOV","ai_DebugDrawVisionMapStats","ai_DebugDrawVisionMapVisibilityChecks","ai_DebugDrawVolumeVoxels","ai_DebugGlobalPerceptionScale","ai_DebugInterestSystem","ai_DebugMovementSystem","ai_DebugMovementSystemActorRequests","ai_DebugPathfinding","ai_DebugPerceptionManager","ai_DebugRangeSignaling","ai_DebugSignalTimers","ai_DebugTacticalPoints","ai_DebugTacticalPointsBlocked","ai_DebugTargetSilhouette","ai_DebugTargetTracksAgent","ai_DebugTargetTracksConfig","ai_DebugTargetTracksConfig_Filter","ai_DebugTargetTracksTarget","ai_DebugTimestamps","ai_DrawAgentFOV","ai_DrawAgentStats","ai_DrawAgentStatsGroupFilter","ai_DrawAreas","ai_DrawAttentionTargetPositions","ai_DrawBadAnchors","ai_DrawBulletEvents","ai_DrawCollisionEvents","ai_DrawDistanceLUT","ai_DrawExplosions","ai_DrawFakeDamageInd","ai_DrawFakeHitEffects","ai_DrawFakeTracers","ai_DrawFireEffectDecayRange","ai_DrawFireEffectEnabled","ai_DrawFireEffectMaxAngle","ai_DrawFireEffectMinDistance","ai_DrawFireEffectMinTargetFOV","ai_DrawFireEffectTimeScale","ai_DrawFormations","ai_DrawGetEnclosingFailures","ai_DrawGoals","ai_DrawGrenadeEvents","ai_DrawGroupTactic","ai_DrawHidespots","ai_DrawModifiers","ai_DrawModularBehaviorTreeStatistics","ai_DrawNode","ai_DrawNodeLinkCutoff","ai_DrawNodeLinkType","ai_DrawOffset","ai_DrawPath","ai_DrawPathAdjustment","ai_DrawPathFollower","ai_DrawPerceptionDebugging","ai_DrawPerceptionHandlerModifiers","ai_DrawPerceptionIndicators","ai_DrawPerceptionModifiers","ai_DrawPlayerRanges","ai_DrawProbableTarget","ai_DrawRadar","ai_DrawRadarDist","ai_DrawReadibilities","ai_DrawRefPoints","ai_DrawSelectedTargets","ai_DrawShooting","ai_DrawSmartObjects","ai_DrawSoundEvents","ai_DrawStats","ai_DrawTargets","ai_DrawTrajectory","ai_DrawType","ai_DrawUpdate","ai_DynamicHidespotsEnabled","ai_EnableCoolMisses","ai_EnableORCA","ai_EnablePerceptionStanceVisibleRange","ai_EnableWarningsErrors","ai_EnableWaterOcclusion","ai_ExtraForbiddenRadiusDuringBeautification","ai_ExtraRadiusDuringBeautification","ai_ExtraVehicleAvoidanceRadiusBig","ai_ExtraVehicleAvoidanceRadiusSmall","ai_FilterAgentName","ai_FlowNodeAlertnessCheck","ai_ForceAGAction","ai_ForceAGSignal","ai_ForceAllowStrafing","ai_ForceLookAimTarget","ai_ForcePosture","ai_ForceSerializeAllObjects","ai_ForceStance","ai_IgnoreBulletRainStimulus","ai_IgnorePlayer","ai_IgnoreSoundStimulus","ai_IgnoreVisibilityChecks","ai_IgnoreVisualStimulus","ai_InterestSystem","ai_InterestSystemCastRays","ai_IntersectionTesterQuota","ai_IslandConnectionsSystemProfileMemory","ai_LobThrowMinAllowedDistanceFromFriends","ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation","ai_LobThrowTimePredictionForFriendPositions","ai_LobThrowUseRandomForInaccuracySimulation","ai_Locate","ai_LogConsoleVerbosity","ai_LogFileVerbosity","ai_LogModularBehaviorTreeExecutionStacks","ai_LogSignals","ai_MinActorDynamicObstacleAvoidanceRadius","ai_MNMAllowDynamicRegenInEditor","ai_MNMDebugAccessibility","ai_MNMDebugDrawFlag","ai_MNMDebugTriangleOnCursor","ai_MNMEditorBackgroundUpdate","ai_MNMPathfinderConcurrentRequests","ai_MNMPathFinderDebug","ai_MNMPathfinderMT","ai_MNMPathfinderPositionInTrianglePredictionType","ai_MNMPathFinderQuota","ai_MNMProfileMemory","ai_MNMRaycastImplementation","ai_ModularBehaviorTree","ai_MovementSystemPathReplanningEnabled","ai_NavGenThreadJobs","ai_NavigationSystemMT","ai_NavmeshStabilizationTimeToUpdate","ai_NavmeshTileDistanceDraw","ai_NetworkDebug","ai_NoUpdate","ai_ObstacleSizeThreshold","ai_OutputPersonalLogToConsole","ai_OverlayMessageDuration","ai_PathfinderAvoidanceCostForGroupMates","ai_PathfinderDangerCostForAttentionTarget","ai_PathfinderDangerCostForExplosives","ai_PathfinderExplosiveDangerMaxThreatDistance","ai_PathfinderExplosiveDangerRadius","ai_PathfinderGroupMatesAvoidanceRadius","ai_PathfinderUpdateTime","ai_PathfindTimeLimit","ai_PathStringPullingIterations","ai_PlayerAffectedByLight","ai_PredictivePathFollowing","ai_ProfileGoals","ai_ProneVisibleRange","ai_RayCasterQuota","ai_RecordCommunicationStats","ai_Recorder","ai_Recorder_Auto","ai_Recorder_Buffer","ai_RecordLog","ai_RODAliveTime","ai_RODAmbientFireInc","ai_RODCombatRangeMod","ai_RODCoverFireTimeMod","ai_RODDirInc","ai_RODFakeHitChance","ai_RODKillRangeMod","ai_RODKillZoneInc","ai_RODLowHealthMercyTime","ai_RODMoveInc","ai_RODReactionDarkIllumInc","ai_RODReactionDirInc","ai_RODReactionDistInc","ai_RODReactionLeanInc","ai_RODReactionMediumIllumInc","ai_RODReactionSuperDarkIllumInc","ai_RODReactionTime","ai_RODStanceInc","ai_ShowBehaviorCalls","ai_SightRangeDarkIllumMod","ai_SightRangeMediumIllumMod","ai_SightRangeSuperDarkIllumMod","ai_SimpleWayptPassability","ai_SmartPathFollower_decelerationHuman","ai_SmartPathFollower_decelerationVehicle","ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint","ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk","ai_SmartPathFollower_useAdvancedPathShortcutting","ai_SmartPathFollower_useAdvancedPathShortcutting_debug","ai_SOMSpeedCombat","ai_SOMSpeedRelaxed","ai_SoundPerception","ai_StatsDisplayMode","ai_StatsTarget","ai_SteepSlopeAcrossValue","ai_SteepSlopeUpValue","ai_SystemUpdate","ai_TacticalPointsDebugDrawMode","ai_TacticalPointsDebugFadeMode","ai_TacticalPointsDebugScaling","ai_TacticalPointsDebugTime","ai_TacticalPointsWarnings","ai_TacticalPointUpdateTime","ai_TargetTracking","ai_TargetTracks_GlobalTargetLimit","ai_UpdateAllAlways","ai_UpdateInterval","ai_UpdateProxy","ai_UseCalculationStopperCounter","ai_UseSimplePathfindingHeuristic","ai_UseSmartPathFollower","ai_UseSmartPathFollower_AABB_based","ai_UseSmartPathFollower_LookAheadDistance","ai_VisionMapNumberOfPVSUpdatesPerFrame","ai_VisionMapNumberOfVisibilityUpdatesPerFrame","ai_WaterOcclusion","ban_timeout","br_breakmaxworldsize","br_breakworldoffsetx","br_breakworldoffsety","c_shakeMult","ca_AllowMultipleEffectsOfSameName","ca_AnimWarningLevel","ca_ApplyJointVelocitiesMode","ca_AttachmentCullingRation","ca_AttachmentCullingRationMP","ca_AttachmentMergingMemoryBudget","ca_AttachmentTextureMemoryBudget","ca_CharEditModel","ca_cloth_air_resistance","ca_cloth_damping","ca_cloth_friction","ca_cloth_max_safe_step","ca_cloth_max_timestep","ca_cloth_stiffness","ca_cloth_stiffness_norm","ca_cloth_stiffness_tang","ca_cloth_thickness","ca_cloth_vars_reset","ca_ClothBlending","ca_ClothBypassSimulation","ca_ClothForceSkinningAfterNFrames","ca_ClothMaxChars","ca_DBAUnloadRemoveTime","ca_DBAUnloadUnregisterTime","ca_DeathBlendTime","ca_DebugADIKTargets","ca_DebugAnimationStreaming","ca_DebugAnimMemTracking","ca_DebugAnimUpdates","ca_DebugAnimUsage","ca_DebugAnimUsageOnFileAccess","ca_DebugAttachmentsProxies","ca_DebugCommandBuffer","ca_DebugCommandBufferFilter","ca_DebugCriticalErrors","ca_DebugFacial","ca_DebugFacialEyes","ca_DebugModelCache","ca_DebugSegmentation","ca_DebugSkeletonEffects","ca_DebugSWSkinning","ca_DecalSizeMultiplier","ca_disable_thread","ca_DisableAnimationUnloading","ca_DisableAuxPhysics","ca_DrawAimIKVEGrid","ca_DrawAimPoses","ca_DrawAllSimulatedSockets","ca_DrawAttachmentOBB","ca_DrawAttachmentProjection","ca_DrawAttachments","ca_DrawAttachmentsMergedForShadows","ca_DrawBaseMesh","ca_DrawBBox","ca_DrawBinormals","ca_DrawCC","ca_DrawCGA","ca_DrawCHR","ca_DrawCloth","ca_DrawDecalsBBoxes","ca_DrawEmptyAttachments","ca_DrawLocator","ca_DrawLookIK","ca_DrawNormals","ca_DrawPose","ca_DrawPositionPost","ca_DrawSkeleton","ca_DrawTangents","ca_DrawVEGInfo","ca_DrawWireframe","ca_DumpUsedAnims","ca_eyes_procedural","ca_FacialAnimationRadius","ca_FilterJoints","ca_ForceAnimationLod","ca_ForceUpdateSkeletons","ca_KeepModels","ca_lipsync_debug","ca_lipsync_phoneme_crossfade","ca_lipsync_phoneme_offset","ca_lipsync_phoneme_strength","ca_lipsync_vertex_drag","ca_LoadUncompressedChunks","ca_LockFeetWithIK","ca_MemoryDefragEnabled","ca_MemoryDefragPoolSize","ca_MemoryUsageLog","ca_MinInPlaceCAFStreamSize","ca_MotionBlurMovementThreshold","ca_NoAnim","ca_ParametricPoolSize","ca_physicsProcessImpact","ca_PrecacheAnimationSets","ca_PreloadAllCAFs","ca_ReloadAllCHRPARAMS","ca_ResetCulledJointsToBindPose","ca_SampleQuatHemisphereFromCurrentPose","ca_SaveAABB","ca_SerializeSkeletonAnim","ca_SnapToVGrid","ca_StoreAnimNamesOnLoad","ca_StreamCHR","ca_StreamDBAInPlace","ca_thread","ca_thread0Affinity","ca_thread1Affinity","ca_UnloadAnimationCAF","ca_UnloadAnimationDBA","ca_useADIKTargets","ca_UseAimIK","ca_UseAssetDefinedLod","ca_UseDecals","ca_UseFacialAnimation","ca_UseIMG_AIM","ca_UseIMG_CAF","ca_UseJointMasking","ca_UseLookIK","ca_UseMorph","ca_UsePhysics","ca_UseRecoil","ca_UseScaling","ca_vaBlendCullingDebug","ca_vaBlendCullingThreshold","ca_vaBlendEnable","ca_vaBlendPostSkinning","ca_vaEnable","ca_Validate","ca_vaProfile","ca_vaScaleFactor","ca_vaSkipVertexAnimationLOD","ca_vaUpdateTangents","ca_VClothMode","capture_file_format","capture_file_name","capture_file_prefix","capture_folder","capture_frame_once","capture_frames","cl_AISystem","cl_bandwidth","cl_camera_noise","cl_camera_noise_freq","cl_comment","cl_DefaultNearPlane","cl_DisableHUDText","cl_ETColorOverrideB","cl_ETColorOverrideEnable","cl_ETColorOverrideG","cl_ETColorOverrideR","cl_ETFontSizeMultiplier","cl_ETHideAIDebug","cl_ETHideAll","cl_ETHideBehaviour","cl_ETHideFlowgraph","cl_ETHideReadability","cl_ETHideScriptBind","cl_ETLog","cl_ETMaxDisplayDistance","cl_nickname","cl_packetRate","cl_serveraddr","cl_serverpassword","cl_serverport","cl_tokenid","cl_useCurrentUserNameAsDefault","cl_ViewApplyHmdOffset","cl_ViewSystemDebug","cl_voice_recording","cl_voice_volume","co_coopAnimDebug","co_slideWhileStreaming","co_usenewcoopanimsystem","con_debug","con_display_last_messages","con_line_buffer_size","con_restricted","con_showonload","connect_repeatedly_num_attempts","connect_repeatedly_time_between_attempts","cvDoVerboseWindowTitle","d3d11_CBUpdateStats","d3d11_debugBreakOnce","d3d11_debugBreakOnMsgID","d3d11_debugMuteMsgID","d3d11_debugMuteSeverity","d3d11_forcedFeatureLevel","d3d11_preventDriverThreading","demo_ai","demo_file","demo_finish_cmd","demo_finish_memreplay_sizer","demo_finish_memreplay_stop","demo_fixed_timestep","demo_game_state","demo_max_frames","demo_noinfo","demo_num_orientations","demo_num_runs","demo_panoramic","demo_profile","demo_quit","demo_restart_level","demo_save_every_frame","demo_savestats","demo_screenshot_frame","demo_scroll_pause","demo_time_of_day","demo_use_hmd_rotation","demo_vtune","dlc_directory","doc_use_subfolder_for_crash_backup","doc_validate_surface_types","drs_dataPath","drs_dialogAudio","drs_dialogBinaryFileFormat","drs_dialogEntityRtpcName","drs_dialogGlobalRtpcName","drs_dialogsDefaultMaxQueueTime","drs_dialogsDefaultPauseAfterLines","drs_dialogsDefaultTalkAnimation","drs_dialogsLipsyncAnimationLayer","drs_dialogsLipsyncTransitionTime","drs_dialogsSamePriorityCancels","drs_dialogSubtitles","drs_fileFormat","drs_loggingOptions","ds_AutoReloadScripts","ds_LevelNameOverride","ds_LoadExcelScripts","ds_LoadSoundsSync","ds_LogLevel","ds_PrecacheSounds","ds_WarnOnMissingLoc","e_3dEngineLogAlways","e_3dEngineTempPoolSize","e_AutoPrecacheCameraJumpDist","e_AutoPrecacheCgf","e_AutoPrecacheTerrainAndProcVeget","e_AutoPrecacheTexturesAndShaders","e_BBoxes","e_Brushes","e_BrushUseTerrainColor","e_CacheNearestCubePicking","e_CameraFreeze","e_CameraGoto","e_CameraRotationSpeed","e_CGFMaxFileSize","e_CharLodMin","e_CheckOcclusion","e_CheckOcclusionOutputQueueSize","e_CheckOcclusionQueueSize","e_CheckOctreeObjectsBoxSize","e_Clouds","e_CoverageBuffer","e_CoverageBufferAABBExpand","e_CoverageBufferBias","e_CoverageBufferCullIndividualBrushesMaxNodeSize","e_CoverageBufferDebug","e_CoverageBufferDebugFreeze","e_CoverageBufferDrawOccluders","e_CoverageBufferEarlyOut","e_CoverageBufferEarlyOutDelay","e_CoverageBufferOccludersViewDistRatio","e_CoverageBufferRastPolyLimit","e_CoverageBufferReproj","e_CoverageBufferShowOccluder","e_CoverageBufferTerrain","e_CoverageBufferTerrainExpand","e_CoverCgfDebug","e_CullVegActivation","e_DebugDraw","e_DebugDrawFilter","e_DebugDrawListBBoxIndex","e_DebugDrawListFilter","e_DebugDrawListSize","e_DebugDrawShowOnlyCompound","e_DebugDrawShowOnlyLod","e_DebugGeomPrep","e_DebugLights","e_Decals","e_DecalsAllowGameDecals","e_DecalsClip","e_DecalsDeferredDynamic","e_DecalsDeferredDynamicDepthScale","e_DecalsDeferredDynamicMinSize","e_DecalsDeferredStatic","e_DecalsForceDeferred","e_DecalsHitCache","e_DecalsLifeTimeScale","e_DecalsMaxTrisInObject","e_DecalsMaxUpdatesPerFrame","e_DecalsMaxValidFrames","e_DecalsMerge","e_DecalsNeighborMaxLifeTime","e_DecalsOverlapping","e_DecalsPlacementTestAreaSize","e_DecalsPlacementTestMinDepth","e_DecalsPreCreate","e_DecalsRange","e_DecalsSpawnDistRatio","e_DefaultMaterial","e_DeferredPhysicsEvents","e_DeformableObjects","e_DisplayMemoryUsageIcon","e_DynamicDistanceShadows","e_DynamicLights","e_DynamicLightsConsistentSortOrder","e_DynamicLightsForceDeferred","e_DynamicLightsFrameIdVisTest","e_DynamicLightsMaxCount","e_DynamicLightsMaxEntityLights","e_Entities","e_EntitySuppressionLevel","e_ExecuteRenderAsJobMask","e_Fog","e_FogVolumes","e_FoliageBranchesDamping","e_FoliageBranchesStiffness","e_FoliageBranchesTimeout","e_FoliageBrokenBranchesDamping","e_FoliageStiffness","e_FoliageWindActivationDist","e_ForceDetailLevelForScreenRes","e_GeomCacheBufferSize","e_GeomCacheDebug","e_GeomCacheDebugDrawMode","e_GeomCacheDebugFilter","e_GeomCacheDecodeAheadTime","e_GeomCacheLerpBetweenFrames","e_GeomCacheMaxBufferAheadTime","e_GeomCacheMaxPlaybackFromMemorySize","e_GeomCacheMinBufferAheadTime","e_GeomCachePreferredDiskRequestSize","e_GeomCaches","e_GI","e_GsmCastFromTerrain","e_GsmDepthBoundsDebug","e_GsmLodsNum","e_GsmRange","e_GsmRangeStep","e_GsmStats","e_HwOcclusionCullingWater","e_JointStrengthScale","e_levelStartupFrameDelay","e_levelStartupFrameNum","e_LightIlluminanceThreshold","e_LightVolumes","e_LightVolumesDebug","e_LodCompMaxSize","e_LodFaceArea","e_LodFaceAreaTargetSize","e_LodMax","e_LodMin","e_LodMinTtris","e_LodRatio","e_Lods","e_LodsForceUse","e_LodTransitionSpriteDistRatio","e_LodTransitionSpriteMinDist","e_LodTransitionTime","e_MaxDrawCalls","e_MaxViewDistance","e_MaxViewDistFullDistCamHeight","e_MaxViewDistSpecLerp","e_MergedMeshes","e_MergedMeshesActiveDist","e_MergedMeshesBulletLifetime","e_MergedMeshesBulletScale","e_MergedMeshesBulletSpeedFactor","e_MergedMeshesClusterVisualization","e_MergedMeshesClusterVisualizationDimension","e_MergedMeshesDebug","e_MergedMeshesDeformViewDistMod","e_MergedMeshesInstanceDist","e_MergedMeshesLodRatio","e_MergedMeshesMaxTriangles","e_MergedMeshesOutdoorOnly","e_MergedMeshesPool","e_MergedMeshesPoolSpines","e_MergedMeshesTesselationSupport","e_MergedMeshesUseSpines","e_MergedMeshesViewDistRatio","e_MinMassDistanceCheckRenderMeshCollision","e_ObjectLayersActivation","e_ObjectLayersActivationPhysics","e_Objects","e_ObjectsTreeBBoxes","e_ObjectsTreeLevelsDebug","e_ObjectsTreeNodeMinSize","e_ObjectsTreeNodeSizeRatio","e_ObjFastRegister","e_ObjQuality","e_ObjShadowCastSpec","e_ObjStats","e_OcclusionCullingViewDistRatio","e_OcclusionLazyHideFrames","e_OcclusionVolumes","e_OcclusionVolumesViewDistRatio","e_OnDemandMaxSize","e_OnDemandPhysics","e_Particles","e_ParticlesAllowRuntimeLoad","e_ParticlesAnimBlend","e_ParticlesAudio","e_ParticlesConvertPfx1","e_ParticlesCullAgainstOcclusionBuffer","e_ParticlesCullAgainstViewFrustum","e_ParticlesDebug","e_ParticlesDumpMemoryAfterMapLoad","e_ParticlesForceSeed","e_ParticlesGI","e_ParticleShadowsNumGSMs","e_ParticlesIndexPoolSize","e_ParticlesJobsPerThread","e_ParticlesLights","e_ParticlesLightsViewDistRatio","e_ParticlesLod","e_ParticlesMaxDrawScreen","e_ParticlesMaxScreenFill","e_ParticlesMinDrawAlpha","e_ParticlesMinDrawPixels","e_ParticlesMinPhysicsDynamicBounds","e_ParticlesMotionBlur","e_ParticlesObjectCollisions","e_ParticlesPoolSize","e_ParticlesPreload","e_ParticlesProfile","e_ParticlesProfiler","e_ParticlesProfilerCountBudget","e_ParticlesProfilerOutputFolder","e_ParticlesProfilerOutputName","e_ParticlesProfilerTimingBudget","e_ParticlesQuality","e_ParticlesSerializeNamedFields","e_ParticlesShadows","e_ParticlesSoftIntersect","e_ParticlesSortQuality","e_ParticlesThread","e_ParticlesUseLevelSpecificLibs","e_ParticlesVertexPoolSize","e_PermanentRenderObjects","e_PhysFoliage","e_PhysMinCellSize","e_PhysOceanCell","e_PhysProxyTriLimit","e_Portals","e_PortalsBigEntitiesFix","e_PortalsBlend","e_PortalsMaxRecursion","e_PrecacheLevel","e_PreloadDecals","e_PreloadMaterials","e_PrepareDeformableObjectsAtLoadTime","e_ProcVegetation","e_ProcVegetationMaxCacheLevels","e_ProcVegetationMaxChunksInCache","e_ProcVegetationMaxObjectsInChunk","e_ProcVegetationMaxSectorsInCache","e_ProcVegetationMaxViewDistance","e_Recursion","e_RecursionViewDistRatio","e_Render","e_RenderMeshCollisionTolerance","e_RenderMeshUpdateAsync","e_RNTmpDataPoolMaxFrames","e_Roads","e_Ropes","e_ScissorDebug","e_ScreenShot","e_ScreenShotDebug","e_ScreenShotFileFormat","e_ScreenShotHeight","e_ScreenShotMapCamHeight","e_ScreenShotMapCenterX","e_ScreenShotMapCenterY","e_ScreenShotMapOrientation","e_ScreenShotMapSizeX","e_ScreenShotMapSizeY","e_ScreenShotMinSlices","e_ScreenShotQuality","e_ScreenShotWidth","e_Shadows","e_ShadowsAdaptScale","e_ShadowsAutoBias","e_ShadowsBlendCascades","e_ShadowsBlendCascadesVal","e_ShadowsCacheExtendLastCascade","e_ShadowsCacheMaxNodesPerFrame","e_ShadowsCacheObjectLod","e_ShadowsCacheRenderCharacters","e_ShadowsCacheUpdate","e_ShadowsCascadesCentered","e_ShadowsCascadesDebug","e_ShadowsCastViewDistRatio","e_ShadowsCastViewDistRatioLights","e_ShadowsClouds","e_ShadowsConstBias","e_ShadowsConstBiasHQ","e_ShadowsDebug","e_ShadowsFrustums","e_ShadowsLodBiasFixed","e_ShadowsLodBiasInvis","e_ShadowsMasksLimit","e_ShadowsMaxTexRes","e_ShadowsPerObject","e_ShadowsPerObjectResolutionScale","e_ShadowsPoolSize","e_ShadowsResScale","e_ShadowsSlopeBias","e_ShadowsSlopeBiasHQ","e_ShadowsTessellateCascades","e_ShadowsTessellateDLights","e_ShadowsUpdateViewDistRatio","e_SkyBox","e_SkyQuality","e_SkyType","e_SkyUpdateRate","e_Sleep","e_SQTestBegin","e_SQTestCount","e_SQTestDelay","e_SQTestDistance","e_SQTestExitOnFinish","e_SQTestMip","e_SQTestMoveSpeed","e_SQTestTextureName","e_StaticInstancing","e_StaticInstancingMinInstNum","e_StatObjBufferRenderTasks","e_StatObjMerge","e_StatObjMergeMaxTrisPerDrawCall","e_StatObjPreload","e_StatObjRenderFilter","e_StatObjRenderFilterMode","e_StatObjStoreMesh","e_StatObjTessellationMode","e_StatObjValidate","e_StatoscopeAllowFpsOverride","e_StatoscopeConnectTimeout","e_StatoscopeCreateLogFilePerLevel","e_StatoscopeDataGroups","e_StatoscopeDumpAll","e_StatoscopeEnabled","e_StatoscopeFilenameUseBuildInfo","e_StatoscopeFilenameUseDatagroups","e_StatoscopeFilenameUseMap","e_StatoscopeFilenameUseTag","e_StatoscopeFilenameUseTime","e_StatoscopeIvDataGroups","e_StatoscopeLogDestination","e_StatoscopeMaxNumFuncsPerFrame","e_StatoscopeMinFuncLengthMs","e_StatoscopeScreenCapWhenGPULimited","e_StatoscopeScreenshotCapturePeriod","e_StatoscopeWriteTimeout","e_StreamAutoMipFactorMax","e_StreamAutoMipFactorMaxDVD","e_StreamAutoMipFactorMin","e_StreamAutoMipFactorSpeedThreshold","e_StreamCgf","e_StreamCgfDebug","e_StreamCgfDebugFilter","e_StreamCgfDebugHeatMap","e_StreamCgfDebugMinObjSize","e_StreamCgfFastUpdateMaxDistance","e_StreamCgfGridUpdateDistance","e_StreamCgfMaxNewTasksPerUpdate","e_StreamCgfMaxTasksInProgress","e_StreamCgfPoolSize","e_StreamCgfUpdatePerNodeDistance","e_StreamCgfVisObjPriority","e_StreamInstances","e_StreamInstancesDistRatio","e_StreamInstancesMaxTasks","e_StreamPredictionAhead","e_StreamPredictionAheadDebug","e_StreamPredictionAlwaysIncludeOutside","e_StreamPredictionBoxRadius","e_StreamPredictionDistanceFar","e_StreamPredictionDistanceNear","e_StreamPredictionMaxVisAreaRecursion","e_StreamPredictionMinFarZoneDistance","e_StreamPredictionMinReportDistance","e_StreamPredictionTexelDensity","e_StreamPredictionUpdateTimeSlice","e_StreamSaveStartupResultsIntoXML","e_Sun","e_SunAngleSnapDot","e_SunAngleSnapSec","e_svoDebug","e_svoDispatchX","e_svoDispatchY","e_svoDVR","e_svoDVR_DistRatio","e_svoEnabled","e_svoLoadTree","e_svoMaxAreaMeshSizeKB","e_svoMaxAreaSize","e_svoMaxBricksOnCPU","e_svoMaxBrickUpdates","e_svoMaxNodeSize","e_svoMaxStreamRequests","e_svoMinNodeSize","e_svoRender","e_svoRootless","e_svoStreamVoxels","e_svoTI_Active","e_svoTI_AnalyticalGI","e_svoTI_AnalyticalOccluders","e_svoTI_AnalyticalOccludersRange","e_svoTI_AnalyticalOccludersSoftness","e_svoTI_Apply","e_svoTI_AsyncCompute","e_svoTI_ConeMaxLength","e_svoTI_ConstantAmbientDebug","e_svoTI_Diffuse_Cache","e_svoTI_Diffuse_Spr","e_svoTI_DiffuseAmplifier","e_svoTI_DiffuseBias","e_svoTI_DiffuseConeWidth","e_svoTI_DistantSsaoAmount","e_svoTI_DualTracing","e_svoTI_DynLights","e_svoTI_EmissiveMultiplier","e_svoTI_ForceGIForAllLights","e_svoTI_GsmCascadeLod","e_svoTI_HalfresKernelPrimary","e_svoTI_HalfresKernelSecondary","e_svoTI_HighGlossOcclusion","e_svoTI_InjectionMultiplier","e_svoTI_IntegrationMode","e_svoTI_LowSpecMode","e_svoTI_MaxSyncUpdateTime","e_svoTI_MinReflectance","e_svoTI_MinVoxelOpacity","e_svoTI_NumberOfBounces","e_svoTI_NumStreamingThreads","e_svoTI_ObjectsLod","e_svoTI_ObjectsMaxViewDistance","e_svoTI_ObjectsMaxViewDistanceScale","e_svoTI_PointLightsBias","e_svoTI_PointLightsMaxDistance","e_svoTI_PointLightsMultiplier","e_svoTI_PortalsDeform","e_svoTI_PortalsInject","e_svoTI_PropagationBooster","e_svoTI_Reflect_Vox_Max","e_svoTI_Reflect_Vox_Max_Overhead","e_svoTI_Reflect_Vox_MaxEdit","e_svoTI_ResScaleAir","e_svoTI_ResScaleBase","e_svoTI_RsmConeMaxLength","e_svoTI_RsmUseColors","e_svoTI_RT_MaxDist","e_svoTI_Saturation","e_svoTI_ShadowsFromSun","e_svoTI_ShadowsSoftness","e_svoTI_SkipNonGILights","e_svoTI_SkyColorMultiplier","e_svoTI_SkyLightBottomMultiplier","e_svoTI_Specular_FromDiff","e_svoTI_Specular_Reproj","e_svoTI_Specular_Sev","e_svoTI_SpecularAmplifier","e_svoTI_SSAOAmount","e_svoTI_SSDepthTrace","e_svoTI_SunRSMInject","e_svoTI_TemporalFilteringBase","e_svoTI_TraceVoxels","e_svoTI_TranslucentBrightness","e_svoTI_Troposphere_Active","e_svoTI_Troposphere_Brightness","e_svoTI_Troposphere_CloudGen_Freq","e_svoTI_Troposphere_CloudGen_FreqStep","e_svoTI_Troposphere_CloudGen_Height","e_svoTI_Troposphere_CloudGen_Scale","e_svoTI_Troposphere_CloudGenTurb_Freq","e_svoTI_Troposphere_CloudGenTurb_Scale","e_svoTI_Troposphere_Density","e_svoTI_Troposphere_Ground_Height","e_svoTI_Troposphere_Layer0_Dens","e_svoTI_Troposphere_Layer0_Height","e_svoTI_Troposphere_Layer0_Rand","e_svoTI_Troposphere_Layer1_Dens","e_svoTI_Troposphere_Layer1_Height","e_svoTI_Troposphere_Layer1_Rand","e_svoTI_Troposphere_Snow_Height","e_svoTI_Troposphere_Subdivide","e_svoTI_UpdateGeometry","e_svoTI_UpdateLighting","e_svoTI_UseLightProbes","e_svoTI_UseTODSkyColor","e_svoTI_VegetationMaxOpacity","e_svoTI_VoxelizationLODRatio","e_svoTI_VoxelizationMapBorder","e_svoTI_VoxelizationPostpone","e_svoTI_VoxelizeHiddenObjects","e_svoTI_VoxelizeUnderTerrain","e_svoTI_VoxelOpacityMultiplier","e_svoVoxDistRatio","e_svoVoxelPoolResolution","e_svoVoxGenRes","e_svoVoxNodeRatio","e_Terrain","e_TerrainAutoGenerateBaseTexture","e_TerrainAutoGenerateBaseTextureTiling","e_TerrainBBoxes","e_TerrainDeformations","e_TerrainDetailMaterials","e_TerrainDetailMaterialsDebug","e_TerrainDetailMaterialsViewDistXY","e_TerrainDetailMaterialsViewDistZ","e_TerrainDrawThisSectorOnly","e_TerrainEditPostponeTexturesUpdate","e_TerrainIntegrateObjectsMaxHeight","e_TerrainIntegrateObjectsMaxVertices","e_TerrainLodDistanceRatio","e_TerrainLodErrorRatio","e_TerrainMeshInstancingMinLod","e_TerrainMeshInstancingShadowBias","e_TerrainMeshInstancingShadowLodRatio","e_TerrainOcclusionCulling","e_TerrainOcclusionCullingDebug","e_TerrainOcclusionCullingMaxDist","e_TerrainOcclusionCullingMaxSteps","e_TerrainOcclusionCullingPrecision","e_TerrainOcclusionCullingPrecisionDistRatio","e_TerrainOcclusionCullingStepSize","e_TerrainOcclusionCullingStepSizeDelta","e_TerrainTextureLodRatio","e_TerrainTextureStreamingDebug","e_TerrainTextureStreamingPoolItemsNum","e_Tessellation","e_TessellationMaxDistance","e_TimeOfDay","e_TimeOfDayDebug","e_TimeOfDaySpeed","e_UseConsoleMtl","e_Vegetation","e_VegetationBending","e_VegetationBillboards","e_VegetationBoneInfo","e_VegetationMinSize","e_VegetationSprites","e_VegetationSpritesBatching","e_VegetationSpritesDistanceCustomRatioMin","e_VegetationSpritesDistanceRatio","e_VegetationSpritesMinDistance","e_VegetationSpritesScaleFactor","e_VegetationUseTerrainColor","e_VegetationUseTerrainColorDistance","e_ViewDistCompMaxSize","e_ViewDistMin","e_ViewDistRatio","e_ViewDistRatio3Planar","e_ViewDistRatioCustom","e_ViewDistRatioDetail","e_ViewDistRatioLights","e_ViewDistRatioModifierGameDecals","e_ViewDistRatioPortals","e_ViewDistRatioVegetation","e_VolObjShadowStrength","e_VolumetricFog","e_WaterOcean","e_WaterOceanBottom","e_WaterOceanFFT","e_WaterRipplesDebug","e_WaterTessellationAmount","e_WaterTessellationAmountX","e_WaterTessellationAmountY","e_WaterTessellationSwathWidth","e_WaterVolumes","e_WaterWaves","e_WaterWavesTessellationAmount","e_Wind","e_WindAreas","e_WindBendingAreaStrength","e_WindBendingDistRatio","e_WindBendingStrength","ed_combineFileChanges","ed_enableAssetPickers","ed_generateThumbnails","ed_indexfiles","ed_keepEditorActive","ed_killmemory_size","ed_logFileChanges","ed_PhysToolHitExplPress0","ed_PhysToolHitExplPress1","ed_PhysToolHitExplR","ed_PhysToolHitProjMass","ed_PhysToolHitProjVel0","ed_PhysToolHitProjVel1","ed_PhysToolHitVelMax","ed_PhysToolHitVelMin","ed_useDevManager","es_bboxes","es_DebrisLifetimeScale","es_debugContainers","es_debugDrawEntityIDs","es_debugEntityLifetime","es_DebugEntityUsage","es_DebugEntityUsageFilter","es_DebugEntityUsageSortMode","es_DebugEvents","es_DebugFindEntity","es_DebugTimers","es_DrawAreaDebug","es_DrawAreaGrid","es_DrawAreaGridCells","es_DrawAreas","es_enable_full_script_save","es_EntityUpdatePosDelta","es_FarPhysTimeout","es_HitCharacters","es_HitDeadBodies","es_ImpulseScale","es_LayerDebugInfo","es_LayerSaveLoadSerialization","es_log_collisions","es_MaxImpulseAdjMass","es_MaxJointFx","es_MaxPhysDist","es_MaxPhysDistCloth","es_MaxPhysDistInvisible","es_MinImpulseVel","es_profileComponentUpdates","es_removeEntity","es_SaveLoadUseLUANoSaveFlag","es_UpdateEntities","es_UpdateScript","es_UsePhysVisibilityChecks","ExitOnQuit","ffs_debug","fg_abortOnLoadError","fg_debugmodules","fg_debugmodules_filter","fg_iDebugNextStep","fg_iEnableFlowgraphNodeDebugging","fg_inspectorLog","fg_noDebugText","fg_profile","fg_SystemEnable","g_aimdebug","g_allowDisconnectIfUpdateFails","g_allowSaveLoadInEditor","g_asynclevelload","g_breakage_debug","g_breakage_mem_limit","g_breakage_particles_limit","g_breakageFadeDelay","g_breakageFadeTime","g_breakagelog","g_breakageMinAxisInertia","g_breakageNoDebrisCollisions","g_breakageTreeDec","g_breakageTreeInc","g_breakageTreeIncGlass","g_breakageTreeMax","g_breakImpulseScale","g_breaktimeoutframes","g_debug_stats","g_debugAspectChanges","g_debugAspectFilterClass","g_debugAspectFilterEntity","g_debugAspectTrap","g_debugAspectTrapCount","g_debugDialogBuffers","g_debugHardwareMouse","g_debugRMI","g_debugSaveLoadMemory","g_disableInputKeyFlowNodeInDevMode","g_disableSequencePlayback","g_disableWinKeys","g_displayCheckpointName","g_distanceForceNoIk","g_distanceForceNoLegRaycasts","g_enableitems","g_enableloadingscreen","g_EnableLoadSave","g_enableMergedMeshRuntimeAreas","g_forceFastUpdate","g_gameplayAnalyst","g_glassAutoShatter","g_glassAutoShatterMinArea","g_glassAutoShatterOnExplosions","g_glassForceTimeout","g_glassForceTimeoutSpread","g_glassMaxPanesToBreakPerFrame","g_glassNoDecals","g_glassSystemEnable","g_groundAlignAll","g_groundeffectsdebug","g_handleEvents","g_hostMigrationServerDelay","g_immersive","g_joint_breaking","g_landingBobLandTimeFactor","g_landingBobTimeFactor","g_language","g_languageAudio","g_localPacketRate","g_manualFrameStepFrequency","g_multiplayerEnableVehicles","g_no_breaking_by_objects","g_no_secondary_breaking","g_playerInteractorRadius","g_procedural_breaking","g_saveLoadBasicEntityOptimization","g_saveLoadExtendedLog","g_saveLoadUseExportedEntityList","g_showUpdateState","g_spectatorCollisions","g_statisticsMode","g_syncClassRegistry","g_tree_cut_reuse_dist","g_userNeverAutoSignsIn","g_useSinglePosition","g_useXMLCPBinForSaveLoad","g_visibilityTimeout","g_visibilityTimeoutTime","g_waterHitOnly","g_XMLCPBAddExtraDebugInfoToXmlDebugFiles","g_XMLCPBBlockQueueLimit","g_XMLCPBGenerateXmlDebugFiles","g_XMLCPBSizeReportThreshold","g_XMLCPBUseExtraZLibCompression","gfx_ampserver","gfx_debugdraw","gfx_draw","gfx_enabled","gfx_FlashReloadEnabled","gfx_FlashReloadTime","gfx_inputevents_triggerrepeat","gfx_inputevents_triggerstart","gfx_loadtimethread","gfx_reloadonlanguagechange","gfx_uiaction_enable","gfx_uiaction_folder","gfx_uiaction_log","gfx_uiaction_log_filter","gfx_uievents_editorenabled","gpu_particle_physics","gt_show","gt_showFilter","gt_showLines","gt_showPosX","gt_showPosY","hmd_device","hmd_info","hmd_resolution_scale","hmd_social_screen","hmd_social_screen_keep_aspect","hmd_tracking_origin","http_password","i_bufferedkeys","i_debug","i_debugDigitalButtons","i_forcefeedback","i_inventory_capacity","i_itemSystemDebugMemStats","i_kinectDebug","i_kinectXboxConnect","i_kinectXboxConnectIP","i_kinectXboxConnectPort","i_kinGlobalExpCorrectionFactor","i_kinGlobalExpDeviationRadius","i_kinGlobalExpJitterRadius","i_kinGlobalExpPredictionFactor","i_kinGlobalExpSmoothFactor","i_kinSkeletonMovedDistance","i_kinSkeletonSmoothType","i_listActionMaps","i_lying_item_limit_mp","i_lying_item_limit_sp","i_mouse_accel","i_mouse_accel_max","i_mouse_buffered","i_mouse_inertia","i_mouse_scroll_coordinate_origin","i_mouse_sensitivity","i_mouse_smooth","i_precache","i_seatedTracking","i_useKinect","i_xinput","i_xinput_deadzone_handling","i_xinput_poll_time","log_EnableRemoteConsole","log_IncludeTime","log_Module","log_SpamDelay","log_tick","log_Verbosity","log_VerbosityOverridesWriteToFile","log_WriteToFile","log_WriteToFileVerbosity","lua_CodeCoverage","lua_debugger","lua_stackonmalloc","lua_StopOnError","MemInfo","MemStats","MemStatsMaxDepth","MemStatsThreshold","mfx_Debug","mfx_DebugFlowGraphFX","mfx_DebugVisual","mfx_DebugVisualFilter","mfx_Enable","mfx_EnableAttachedEffects","mfx_EnableFGEffects","mfx_ParticleImpactThresh","mfx_pfx_maxDist","mfx_pfx_maxScale","mfx_pfx_minScale","mfx_RaisedSoundImpactThresh","mfx_SerializeFGEffects","mfx_SoundImpactThresh","mfx_Timeout","mi_defaultMaterial","mi_jointSize","mi_lazyLodGeneration","mn_allowEditableDatabasesInPureGame","mn_LogToFile","mn_override_preview_file","mn_sequence_path","mov_cameraPrecacheTime","mov_debugSequences","mov_NoCutscenes","mov_overrideCam","movie_physicalentity_animation_lerp","movie_timeJumpTransitionTime","net_availableBandwidthClient","net_availableBandwidthServer","net_backofftimeout","net_breakage_sync_entities","net_bw_aggressiveness","net_channelstats","net_connectivity_detection_interval","net_debug_draw_scale","net_debugChannelIndex","net_debugEntityInfo","net_debugEntityInfoClassName","net_debugInfo","net_debugVerboseLevel","net_dedi_scheduler_client_base_port","net_dedi_scheduler_server_port","net_defaultBandwidthShares","net_defaultPacketRate","net_defaultPacketRateIdle","net_disconnect_on_rmi_error","net_enable_tfrc","net_enable_voice_chat","net_enable_watchdog_timer","net_fragment_expiration_time","net_highlatencythreshold","net_highlatencytimelimit","net_inactivitytimeout","net_inactivitytimeoutDevmode","net_keepalive_time","net_lan_scanport_first","net_lan_scanport_num","net_lanbrowser","net_lobbyUpdateFrequency","net_log","net_log_remote_methods","net_max_fragmented_packets_per_source","net_maxpacketsize","net_meminfo","net_minTCPFriendlyBitRate","net_netMsgDispatcherDebug","net_netMsgDispatcherLogging","net_netMsgDispatcherWarnThreshold","net_new_queue_behaviour","net_numNetIDHighBitBits","net_numNetIDLowBitBits","net_numNetIDMediumBitBits","net_packet_read_debug_output","net_packetfragmentlossrate","net_PacketLagMax","net_PacketLagMin","net_PacketLossRate","net_phys_debug","net_phys_lagsmooth","net_phys_pingsmooth","net_ping_time","net_profile_budget_logging","net_profile_budget_logname","net_profile_deep_bandwidth_logging","net_profile_deep_bandwidth_logname","net_profile_enable","net_profile_logging","net_profile_logname","net_profile_show_socket_measurements","net_profile_untouched_delay","net_profile_worst_num_channels","net_receiveQueueSize","net_remotetimeestimationwarning","net_safetysleeps","net_scheduler_debug","net_scheduler_debug_mode","net_scheduler_expiration_period","net_sendQueueSize","net_sim_loadprofiles","net_SimUseProfile","net_socketBoostTimeout","net_socketMaxTimeout","net_socketMaxTimeoutMultiplayer","net_stats_login","net_stats_pass","osm_debug","osm_enabled","osm_fbMinScale","osm_fbScaleDeltaDown","osm_fbScaleDeltaUp","osm_historyLength","osm_stress","osm_targetFPS","osm_targetFPSTolerance","p_accuracy_LCPCG","p_accuracy_LCPCG_no_improvement","p_accuracy_MC","p_approx_caps_len","p_break_on_awake_ent_id","p_break_on_validation","p_check_out_of_bounds","p_collision_mode","p_cull_distance","p_damping_group_size","p_debug_explosions","p_debug_joints","p_do_step","p_draw_helpers","p_draw_helpers_num","p_draw_helpers_opacity","p_enforce_contacts","p_ent_grid_use_obb","p_fixed_timestep","p_fly_mode","p_force_sync","p_GEB_max_cells","p_gravity_z","p_group_damping","p_joint_damage_accum","p_joint_damage_accum_threshold","p_joint_gravity_step","p_jump_to_profile_ent","p_lattice_max_iters","p_limit_simple_solver_energy","p_list_active_objects","p_log_lattice_tension","p_max_approx_caps","p_max_bone_velocity","p_max_contact_gap","p_max_contact_gap_player","p_max_contact_gap_simple","p_max_contacts","p_max_debris_mass","p_max_entity_cells","p_max_LCPCG_contacts","p_max_LCPCG_fruitless_iters","p_max_LCPCG_iters","p_max_LCPCG_microiters","p_max_LCPCG_microiters_final","p_max_LCPCG_subiters","p_max_LCPCG_subiters_final","p_max_MC_iters","p_max_MC_mass_ratio","p_max_MC_vel","p_max_object_splashes","p_max_plane_contacts","p_max_plane_contacts_distress","p_max_player_velocity","p_max_substeps","p_max_substeps_large_group","p_max_unproj_vel","p_max_velocity","p_max_world_step","p_min_LCPCG_improvement","p_min_MC_iters","p_min_separation_speed","p_net_debugDraw","p_net_extrapmax","p_net_interp","p_net_sequencefrequency","p_num_bodies_large_group","p_num_startup_overload_checks","p_num_threads","p_penalty_scale","p_physics_library","p_players_can_break","p_profile","p_profile_entities","p_profile_functions","p_prohibit_unprojection","p_proxy_highlight_range","p_proxy_highlight_threshold","p_ray_fadeout","p_ray_peak_time","p_rope_collider_size_limit","p_single_step_mode","p_skip_redundant_colldet","p_splash_dist0","p_splash_dist1","p_splash_force0","p_splash_force1","p_splash_vel0","p_splash_vel1","p_tick_breakable","p_time_granularity","p_unproj_vel_scale","p_use_distance_contacts","p_use_unproj_vel","p_wireframe_distance","pp_LoadOnlineAttributes","pp_RichSaveGames","pp_RSFDebugWrite","pp_RSFDebugWriteOnLoad","profile","profile_additionalsub","profile_callstack","profile_col","profile_deep","profile_disk","profile_disk_budget","profile_disk_max_draw_items","profile_disk_max_items","profile_disk_timeframe","profile_disk_type_filter","profile_filter","profile_filter_thread","profile_graph","profile_graphScale","profile_log","profile_min_display_ms","profile_network","profile_pagefaults","profile_peak","profile_peak_display","profile_row","profile_sampler","profile_sampler_max_samples","profile_smooth","profile_weighting","profileStreaming","q_Renderer","q_ShaderFX","q_ShaderGeneral","q_ShaderGlass","q_ShaderHDR","q_ShaderIce","q_ShaderMetal","q_ShaderPostProcess","q_ShaderShadow","q_ShaderSky","q_ShaderTerrain","q_ShaderVegetation","q_ShaderWater","r_3MonHack","r_3MonHackHUDFOVX","r_3MonHackHUDFOVY","r_3MonHackLeftCGFOffsetX","r_3MonHackRightCGFOffsetX","r_AllowLiveMoCap","r_AntialiasingMode","r_AntialiasingModeDebug","r_AntialiasingModeEditor","r_AntialiasingModeSCull","r_AntialiasingTAAFalloffHiFreq","r_AntialiasingTAAFalloffLowFreq","r_AntialiasingTAAPattern","r_AntialiasingTAASharpening","r_AntialiasingTSAAMipBias","r_AntialiasingTSAASmoothness","r_AntialiasingTSAASubpixelDetection","r_ArmourPulseSpeedMultiplier","r_auxGeom","r_Batching","r_BatchType","r_BreakOnError","r_Brightness","r_buffer_banksize","r_buffer_enable_lockless_updates","r_buffer_pool_defrag_dynamic","r_buffer_pool_defrag_max_moves","r_buffer_pool_defrag_static","r_buffer_pool_max_allocs","r_buffer_sli_workaround","r_CBufferUseNativeDepth","r_Character_NoDeform","r_ChromaticAberration","r_CloakFadeByDist","r_CloakFadeLightScale","r_CloakFadeMaxDistSq","r_CloakFadeMinDistSq","r_CloakFadeMinValue","r_CloakHeatScale","r_cloakHighlightStrength","r_CloakInterferenceSparksAlpha","r_CloakLightScale","r_CloakMinAmbientIndoors","r_CloakMinAmbientOutdoors","r_CloakMinLightValue","r_CloakRefractionFadeByDist","r_CloakRefractionFadeMaxDistSq","r_CloakRefractionFadeMinDistSq","r_CloakRefractionFadeMinValue","r_CloakRenderInThermalVision","r_CloakSparksAlpha","r_CloakTransitionLightScale","r_ColorBits","r_ColorGrading","r_ColorGradingCharts","r_ColorGradingChartsCache","r_ColorGradingFilters","r_ColorGradingLevels","r_ColorGradingSelectiveColor","r_ColorRangeCompression","r_ComputeSkinning","r_ComputeSkinningDebugDraw","r_ComputeSkinningMorphs","r_ComputeSkinningTangents","r_ConditionalRendering","r_constantbuffer_banksize","r_constantbuffer_watermarm","r_Contrast","r_CustomResHeight","r_CustomResMaxSize","r_CustomResPreview","r_CustomResWidth","r_CustomVisions","r_D3D12AsynchronousCompute","r_D3D12BatchResourceBarriers","r_D3D12EarlyResourceBarriers","r_D3D12HardwareComputeQueue","r_D3D12HardwareCopyQueue","r_D3D12SubmissionThread","r_D3D12WaitableSwapChain","r_DebugFontRendering","r_DebugGBuffer","r_DebugLayerEffect","r_DebugLights","r_DebugLightVolumes","r_DebugRefraction","r_DebugRenderMode","r_DeferredDecals","r_deferredDecalsDebug","r_DeferredShadingAmbient","r_DeferredShadingAmbientLights","r_DeferredShadingAreaLights","r_DeferredShadingDBTstencil","r_DeferredShadingDepthBoundsTest","r_DeferredShadingEnvProbes","r_DeferredShadingFilterGBuffer","r_DeferredShadingLBuffersFmt","r_DeferredShadingLightLodRatio","r_DeferredShadingLights","r_DeferredShadingLightStencilRatio","r_DeferredShadingLightVolumes","r_DeferredShadingScissor","r_DeferredShadingSortLights","r_DeferredShadingSSS","r_DeferredShadingStencilPrepass","r_DeferredShadingTiled","r_DeferredShadingTiledDebug","r_DeferredShadingTiledHairQuality","r_DepthBits","r_DepthOfField","r_DepthOfFieldBokehQuality","r_DepthOfFieldDilation","r_DepthOfFieldMode","r_DetailDistance","r_DetailTextures","r_DisplayInfo","r_displayinfoTargetFPS","r_dofMinZ","r_dofMinZBlendMult","r_dofMinZScale","r_DrawNearFarPlane","r_DrawNearFoV","r_DrawNearShadows","r_DrawNearZRange","r_Driver","r_durango_async_dips","r_durango_async_dips_sync","r_DynTexAtlasCloudsMaxSize","r_DynTexAtlasDynTexSrcSize","r_DynTexAtlasSpritesMaxSize","r_DynTexAtlasVoxTerrainMaxSize","r_DynTexMaxSize","r_DynTexSourceSharedRTHeight","r_DynTexSourceSharedRTWidth","r_DynTexSourceUseSharedRT","r_enable_full_gpu_sync","r_enableAltTab","r_enableAuxGeom","r_EnableDebugLayer","r_EnvCMResolution","r_EnvTexResolution","r_EnvTexUpdateInterval","r_ExcludeMesh","r_ExcludeShader","r_FlareHqShafts","r_Flares","r_FlaresChromaShift","r_FlaresEnableColorGrading","r_FlaresIrisShaftMaxPolyNum","r_FlaresTessellationRatio","r_FlashMatTexResQuality","r_FogDepthTest","r_FogShadows","r_FogShadowsMode","r_FogShadowsWater","r_Fullscreen","r_FullscreenNativeRes","r_FullscreenPreemption","r_Gamma","r_GeomCacheInstanceThreshold","r_GeomInstancing","r_GeomInstancingDebug","r_GeomInstancingThreshold","r_GetScreenShot","r_GpuParticles","r_GpuParticlesConstantRadiusBoundingBoxes","r_GpuPhysicsFluidDynamicsDebug","r_GrainEnableExposureThreshold","r_GraphicsPipeline","r_GraphicsPipelineMobile","r_GraphicsPipelinePassScheduler","r_GraphStyle","r_HDRBloom","r_HDRBloomQuality","r_HDRDebug","r_HDREyeAdaptationMode","r_HDREyeAdaptationSpeed","r_HDRGrainAmount","r_HDRRangeAdapt","r_HDRRangeAdaptationSpeed","r_HDRRangeAdaptLBufferMax","r_HDRRangeAdaptLBufferMaxRange","r_HDRRangeAdaptMax","r_HDRRangeAdaptMaxRange","r_HDRRendering","r_HDRTexFormat","r_HDRVignetting","r_Height","r_HeightMapAO","r_HeightMapAOAmount","r_HeightMapAORange","r_HeightMapAOResolution","r_HideSunInCubemaps","r_LightsSinglePass","r_Log","r_LogShaders","r_LogTexStreaming","r_LogVBuffers","r_LogVidMem","r_MaterialsBatching","r_MaxSuitPulseSpeedMultiplier","r_MeasureOverdrawScale","r_MergeShadowDrawcalls","r_MeshInstancePoolSize","r_MeshPoolSize","r_MeshPrecache","r_minimizeLatency","r_MotionBlur","r_MotionBlurCameraMotionScale","r_MotionBlurGBufferVelocity","r_MotionBlurMaxViewDist","r_MotionBlurQuality","r_MotionBlurShutterSpeed","r_MotionBlurThreshold","r_MotionVectors","r_MouseCursorTexture","r_MultiGPU","r_MultiThreaded","r_MultiThreadedDrawing","r_MultiThreadedDrawingMinJobSize","r_NightVision","r_NightVisionBrightLevel","r_NightVisionCamMovNoiseAmount","r_NightVisionCamMovNoiseBlendSpeed","r_NightVisionFinalMul","r_NightVisionSonarLifetime","r_NightVisionSonarMultiplier","r_NightVisionSonarRadius","r_NoDraw","r_NoDrawNear","r_NoHWGamma","r_NormalsLength","r_overrideDXGIAdapter","r_overrideRefreshRate","r_overrideScanlineOrder","r_OverscanBorderScaleX","r_OverscanBorderScaleY","r_OverscanBordersDrawDebugView","r_ParticlesAmountGI","r_ParticlesDebug","r_ParticlesHalfRes","r_ParticlesHalfResAmount","r_ParticlesHalfResBlendMode","r_ParticlesInstanceVertices","r_ParticlesRefraction","r_ParticlesSoftIsec","r_ParticlesTessellation","r_ParticlesTessellationTriSize","r_ParticleVerticePoolSize","r_PostProcessEffects","r_PostProcessFilters","r_PostProcessGameFx","r_PostProcessHUD3D","r_PostProcessHUD3DCache","r_PostProcessHUD3DDebugView","r_PostProcessHUD3DGlowAmount","r_PostProcessHUD3DShadowAmount","r_PostProcessHUD3DStencilClear","r_PostProcessNanoGlassDebugView","r_PostProcessParamsBlending","r_PostprocessParamsBlendingTimeScale","r_PostProcessReset","r_PrintMemoryLeaks","r_profiler","r_profilerSmoothingWeight","r_profilerTargetFPS","r_Rain","r_RainAmount","r_RainDistMultiplier","r_RainDropsEffect","r_RainIgnoreNearest","r_RainMaxViewDist","r_RainMaxViewDist_Deferred","r_RainOccluderSizeTreshold","r_RC_AutoInvoke","r_ReadZBufferDirectlyFromVMEM","r_Reflections","r_ReflectionsOffset","r_ReflectionsQuality","r_ReflectTextureSlots","r_Refraction","r_RefractionPartialResolves","r_RefractionPartialResolvesDebug","r_ReleaseAllResourcesOnExit","r_ReloadShaders","r_RenderMeshHashGridUnitSize","r_RenderTargetPoolSize","r_ReprojectOnlyStaticObjects","r_ReverseDepth","r_Scissor","r_ShaderCompilerDontCache","r_ShaderCompilerFolderName","r_ShaderCompilerFolderSuffix","r_ShaderCompilerPort","r_ShaderCompilerServer","r_ShaderEmailCCs","r_ShaderEmailTags","r_ShadersAllowCompilation","r_ShadersAsyncActivation","r_ShadersAsyncCompiling","r_ShadersAsyncMaxThreads","r_ShadersCacheDeterministic","r_ShadersCacheInMemory","r_ShadersCompileAutoActivate","r_ShadersCompileCompatible","r_ShadersCompileStrict","r_ShadersDebug","r_ShadersEditing","r_ShadersExport","r_ShadersIgnoreIncludesChanging","r_ShadersImport","r_ShadersLazyUnload","r_ShadersLogCacheMisses","r_ShadersPrecacheAllLights","r_ShadersRemoteCompiler","r_ShadersSubmitRequestline","r_ShaderTarget","r_ShadowBluriness","r_ShadowCastingLightsMaxCount","r_ShadowGen","r_ShadowGenDepthClip","r_ShadowGenMode","r_ShadowJittering","r_ShadowMaskStencilPrepass","r_ShadowPass","r_ShadowPoolMaxFrames","r_ShadowPoolMaxTimeslicedUpdatesPerFrame","r_ShadowsAdaptionMin","r_ShadowsAdaptionRangeClamp","r_ShadowsAdaptionSize","r_ShadowsBias","r_ShadowsCache","r_ShadowsCacheFormat","r_ShadowsCacheResolutions","r_ShadowsDepthBoundNV","r_ShadowsGridAligned","r_ShadowsMaskDownScale","r_ShadowsMaskResolution","r_ShadowsNearestMapResolution","r_ShadowsParticleAnimJitterAmount","r_ShadowsParticleJitterAmount","r_ShadowsParticleKernelSize","r_ShadowsParticleNormalEffect","r_ShadowsPCFiltering","r_ShadowsScreenSpace","r_ShadowsScreenSpaceLength","r_ShadowsStencilPrePass","r_ShadowsUseClipVolume","r_ShadowTexFormat","r_Sharpening","r_ShowBufferUsage","r_ShowDynTextures","r_ShowDynTexturesFilter","r_ShowDynTexturesMaxCount","r_ShowLightBounds","r_ShowLines","r_ShowNormals","r_ShowTangents","r_ShowTexture","r_ShowTimeGraph","r_ShowVideoMemoryStats","r_SilhouettePOM","r_SkipAlphaTested","r_Snow","r_SnowDisplacement","r_SnowFlakeClusters","r_SnowHalfRes","r_SonarVision","r_ssdo","r_ssdoAmountAmbient","r_ssdoAmountDirect","r_ssdoAmountReflection","r_ssdoColorBleeding","r_ssdoHalfRes","r_ssdoRadius","r_ssdoRadiusMax","r_ssdoRadiusMin","r_SSReflections","r_SSReflHalfRes","r_Stats","r_statsMinDrawCalls","r_StencilBits","r_StereoDevice","r_StereoEnableMgpu","r_StereoEyeDist","r_StereoFlipEyes","r_StereoGammaAdjustment","r_StereoHudScreenDist","r_stereoMirrorProjection","r_StereoMode","r_StereoNearGeoScale","r_StereoOutput","r_stereoScaleCoefficient","r_StereoScreenDist","r_StereoStrength","r_sunshafts","r_Supersampling","r_SupersamplingFilter","r_SyncToFrameFence","r_TessellationDebug","r_TessellationTriangleSize","r_TexAtlasSize","r_TexBindMode","r_TexelsPerMeter","r_TexLog","r_TexMaxAnisotropy","r_TexMinAnisotropy","r_TexNoAnisoAlphaTest","r_TexNoLoad","r_TexPostponeLoading","r_TexPreallocateAtlases","r_TextureCompiling","r_TextureCompilingIndicator","r_TextureCompressor","r_TextureLodDistanceRatio","r_TexturesStreaming","r_TexturesStreamingDebug","r_TexturesStreamingDebugDumpIntoLog","r_TexturesStreamingDebugFilter","r_TexturesStreamingDebugMinMip","r_TexturesStreamingDebugMinSize","r_texturesstreamingDeferred","r_TexturesStreamingDisableNoStreamDuringLoad","r_texturesstreamingJobUpdate","r_TexturesStreamingMaxRequestedJobs","r_TexturesStreamingMaxRequestedMB","r_TexturesStreamingMinReadSizeKB","r_texturesstreamingMinUsableMips","r_TexturesStreamingMipBias","r_TexturesStreamingMipClampDVD","r_TexturesStreamingMipFading","r_TexturesStreamingNoUpload","r_TexturesStreamingOnlyVideo","r_TexturesStreamingPostponeMips","r_TexturesStreamingPostponeThresholdKB","r_texturesstreamingPostponeThresholdMip","r_TexturesStreamingPrecacheRounds","r_texturesstreamingSkipMips","r_TexturesStreamingSuppress","r_TexturesStreamingUpdateType","r_texturesstreampooldefragmentation","r_texturesstreampooldefragmentationmaxamount","r_texturesstreampooldefragmentationmaxmoves","r_TexturesStreamPoolSecondarySize","r_TexturesStreamPoolSize","r_ThermalVision","r_ThermalVisionViewCloakFlickerMaxIntensity","r_ThermalVisionViewCloakFlickerMinIntensity","r_ThermalVisionViewCloakFrequencyPrimary","r_ThermalVisionViewCloakFrequencySecondary","r_ThermalVisionViewDistance","r_transient_pool_size","r_TransparentPasses","r_TranspDepthFixup","r_Unlit","r_UpdateInstances","r_UseDisplacementFactor","r_UseESRAM","r_UseHWSkinning","r_UseMaterialLayers","r_UseMergedPosts","r_UsePersistentRTForModelHUD","r_UseShadowsPool","r_UseZPass","r_ValidateDraw","r_VegetationSpritesDebug","r_VegetationSpritesGenAlways","r_VegetationSpritesMaxLightingUpdates","r_VegetationSpritesNoGen","r_VegetationSpritesTexRes","r_VisAreaClipLightsPerPixel","r_VolumetricClouds","r_VolumetricCloudsPipeline","r_VolumetricCloudsRaymarchStepNum","r_VolumetricCloudsShadowResolution","r_VolumetricCloudsStereoReprojection","r_VolumetricCloudsTemporalReprojection","r_VolumetricFogDownscaledSunShadow","r_VolumetricFogDownscaledSunShadowRatio","r_VolumetricFogMinimumLightBulbSize","r_VolumetricFogReprojectionBlendFactor","r_VolumetricFogReprojectionMode","r_VolumetricFogSample","r_VolumetricFogShadow","r_VolumetricFogSunLightCorrection","r_VolumetricFogTexDepth","r_VolumetricFogTexScale","r_VrProjectionPreset","r_VrProjectionType","r_VSync","r_WaterCaustics","r_WaterCausticsDeferred","r_WaterCausticsDistance","r_WaterGodRays","r_WaterGodRaysDistortion","r_WaterReflections","r_WaterReflectionsMGPU","r_WaterReflectionsMinVisiblePixelsUpdate","r_WaterReflectionsMinVisUpdateDistanceMul","r_WaterReflectionsMinVisUpdateFactorMul","r_WaterReflectionsQuality","r_WaterReflectionsUseMinOffset","r_WaterTessellationHW","r_WaterUpdateDistance","r_WaterUpdateFactor","r_WaterUpdateThread","r_WaterVolumeCaustics","r_WaterVolumeCausticsDensity","r_WaterVolumeCausticsMaxDist","r_WaterVolumeCausticsRes","r_WaterVolumeCausticsSnapFactor","r_Width","r_WindowIconTexture","r_WindowType","r_wireframe","r_ZFightingDepthScale","r_ZFightingExtrude","r_ZPassDepthSorting","r_ZPassOnly","r_ZPrepassMaxDist","rc_debugVerboseLevel","rcon_password","s_AccumulateOcclusion","s_AudioEventPoolSize","s_AudioImplName","s_AudioObjectPoolSize","s_AudioObjectsRayType","s_AudioStandaloneFilePoolSize","s_DebugDistance","s_DebugFilter","s_DefaultStandaloneFilesAudioTrigger","s_DrawAudioDebug","s_FileCacheManagerDebugFilter","s_FileCacheManagerSize","s_FullObstructionMaxDistance","s_HideInactiveAudioObjects","s_IgnoreWindowFocus","s_ListenerOcclusionPlaneSize","s_LoggingOptions","s_OcclusionHighDistance","s_OcclusionMaxDistance","s_OcclusionMaxSyncDistance","s_OcclusionMediumDistance","s_OcclusionMinDistance","s_OcclusionRayLengthOffset","s_PositionUpdateThresholdMultiplier","s_SDLMixerStandaloneFileExtension","s_VelocityTrackingThreshold","sc_allowFlowGraphNodes","sc_DiscardOnSave","sc_DisplayCriticalErrors","sc_EnableScriptPartitioning","sc_EntityDebugConfig","sc_EntityDebugFilter","sc_EntityDebugTextPos","sc_ExperimentalFeatures","sc_FileFormat","sc_FunctionTimeLimit","sc_IgnorePAKFiles","sc_IgnoreUnderscoredFolders","sc_LogFileMessageTypes","sc_LogFileStreams","sc_LogToFile","sc_MaxRecursionDepth","sc_RelevanceGridCellSize","sc_RelevanceGridDebugStatic","sc_RootFolder","sc_RunUnitTests","sc_Update","sc_UseNewGraphPipeline","sensor_Debug","sensor_DebugRange","STAP_DEBUG","STAP_DISABLE","STAP_LOCK_EFFECTOR","STAP_OVERRIDE_TRACK_FACTOR","STAP_TRANSLATION_FEATHER","STAP_TRANSLATION_FUDGE","stats_FpsBuckets","stats_PakFile","stats_Particles","stats_RenderBatchStats","stats_RenderSummary","stats_Warnings","sv_AISystem","sv_autoconfigurl","sv_bandwidth","sv_bind","sv_DedicatedCPUPercent","sv_DedicatedCPUVariance","sv_DedicatedMaxRate","sv_dumpstats","sv_dumpstatsperiod","sv_gamerules","sv_gamerulesdefault","sv_lanonly","sv_levelrotation","sv_LoadAllLayersForResList","sv_map","sv_maxmemoryusage","sv_maxplayers","sv_maxspectators","sv_packetRate","sv_password","sv_port","sv_ranked","sv_requireinputdevice","sv_servername","sv_timeofdayenable","sv_timeofdaylength","sv_timeofdaystart","sv_timeout_disconnect","sys_AI","sys_archive_host_xml_version","sys_asserts","sys_audio_disable","sys_bp_enabled","sys_bp_format","sys_bp_frames","sys_bp_frames_sample_period","sys_bp_frames_sample_period_rnd","sys_bp_frames_threshold","sys_bp_frames_worker_thread","sys_bp_level_load","sys_bp_time_threshold","sys_budget_frametime","sys_budget_numdrawcalls","sys_budget_numpolys","sys_budget_soundchannels","sys_budget_soundCPU","sys_budget_soundmem","sys_budget_streamingthroughput","sys_budget_sysmem","sys_budget_videomem","sys_build_folder","sys_crashrpt","sys_crashrpt_appname","sys_crashrpt_appversion","sys_crashrpt_email","sys_crashrpt_privacypolicy","sys_crashrpt_server","sys_DeactivateConsole","sys_debugger_adjustments","sys_deferAudioUpdateOptim","sys_display_threads","sys_dll_ai","sys_dll_game","sys_dll_response_system","sys_dump_aux_threads","sys_dump_type","sys_enable_budgetmonitoring","sys_enable_crash_handler","sys_entities","sys_error_debugbreak","sys_filesystemCaseSensitivity","sys_firstlaunch","sys_flash","sys_flash_address_space","sys_flash_allow_reset_mesh_cache","sys_flash_check_filemodtime","sys_flash_curve_tess_error","sys_flash_debugdraw","sys_flash_debugdraw_depth","sys_flash_debuglog","sys_flash_edgeaa","sys_flash_info","sys_flash_info_histo_scale","sys_flash_info_peak_exclude","sys_flash_info_peak_tolerance","sys_flash_log_options","sys_flash_reset_mesh_cache","sys_flash_static_pool_size","sys_flash_stereo_maxparallax","sys_flash_use_arenas","sys_flash_video_soundvolume","sys_flash_video_subaudiovolume","sys_flash_warning_level","sys_float_exceptions","sys_force_installtohdd_mode","sys_game_folder","sys_game_name","sys_highrestimer","sys_ime","sys_initpreloadpacks","sys_intromoviesduringinit","sys_job_system_enable","sys_job_system_filter","sys_job_system_max_worker","sys_job_system_profiler","sys_keyboard","sys_keyboard_break","sys_limit_phys_thread_count","sys_livecreate","sys_LoadFrontendShaderCache","sys_localization_debug","sys_localization_encode","sys_localization_folder","sys_LocalMemoryDiagramAlpha","sys_LocalMemoryDiagramDistance","sys_LocalMemoryDiagramRadius","sys_LocalMemoryDiagramStreamingSpeedDistance","sys_LocalMemoryDiagramStreamingSpeedRadius","sys_LocalMemoryDiagramWidth","sys_LocalMemoryDrawText","sys_LocalMemoryGeometryLimit","sys_LocalMemoryGeometryStreamingSpeedLimit","sys_LocalMemoryInnerViewDistance","sys_LocalMemoryLogText","sys_LocalMemoryMaxMSecBetweenCalls","sys_LocalMemoryObjectAlpha","sys_LocalMemoryObjectHeight","sys_LocalMemoryObjectWidth","sys_LocalMemoryOptimalMSecPerSec","sys_LocalMemoryOuterViewDistance","sys_LocalMemoryStreamingSpeedObjectLength","sys_LocalMemoryStreamingSpeedObjectWidth","sys_LocalMemoryTextureLimit","sys_LocalMemoryTextureStreamingSpeedLimit","sys_LocalMemoryWarningRatio","sys_log_asserts","sys_logallocations","sys_max_step","sys_MaxFPS","sys_maxTimeStepForMovieSystem","sys_memory_debug","sys_MemoryDeadListSize","sys_menupreloadpacks","sys_min_step","sys_no_crash_dialog","sys_noupdate","sys_PakDisableNonLevelRelatedPaks","sys_PakInMemorySizeLimit","sys_PakLoadCache","sys_PakLoadModePaks","sys_PakLogAllFileAccess","sys_PakLogInvalidFileAccess","sys_PakLogMissingFiles","sys_PakMessageInvalidFileAccess","sys_PakPriority","sys_PakReadSlice","sys_PakSaveFastLoadResourceList","sys_PakSaveLevelResourceList","sys_PakSaveMenuCommonResourceList","sys_PakSaveTotalResourceList","sys_PakStreamCache","sys_PakTotalInMemorySizeLimit","sys_PakValidateFileHash","sys_perfhud","sys_perfhud_fpsBucketsExclusive","sys_perfhud_pause","sys_physics","sys_physics_enable_MT","sys_preload","sys_ProfileLevelLoading","sys_ProfileLevelLoadingDump","sys_project","sys_resource_cache_folder","sys_root","sys_scale3DMouseTranslation","sys_Scale3DMouseYPR","sys_SchematycPlugin","sys_screensaver_allowed","sys_simple_http_base_port","sys_SimulateTask","sys_spec","sys_spec_full","sys_spec_gameeffects","sys_spec_light","sys_spec_objectdetail","sys_spec_particles","sys_spec_physics","sys_spec_postprocessing","sys_spec_quality","sys_spec_shading","sys_spec_shadows","sys_spec_sound","sys_spec_texture","sys_spec_textureresolution","sys_spec_volumetriceffects","sys_spec_water","sys_splashscreen","sys_SSInfo","sys_streaming_debug","sys_streaming_debug_filter","sys_streaming_debug_filter_file_name","sys_streaming_debug_filter_min_time","sys_streaming_in_blocks","sys_streaming_max_bandwidth","sys_streaming_max_finalize_per_frame","sys_streaming_memory_budget","sys_streaming_requests_grouping_time_period","sys_streaming_resetstats","sys_streaming_use_optical_drive_thread","sys_system_timer_resolution","sys_target_platforms","sys_trackview","sys_UncachedStreamReads","sys_update_profile_time","sys_use_mono","sys_usePlatformSavingAPI","sys_usePlatformSavingAPIEncryption","sys_user_folder","sys_UserAnalyticsCollect","sys_UserAnalyticsLogging","sys_UserAnalyticsServerAddress","sys_version","sys_vr_support","sys_vtune","sys_warnings","sys_WER","t_Debug","t_FixedStep","t_MaxStep","t_Scale","t_Smoothing","v_autoDisable","v_clientPredict","v_clientPredictAdditionalTime","v_clientPredictMaxTime","v_clientPredictSmoothing","v_clientPredictSmoothingConst","v_debug_flip_over","v_debug_mem","v_debug_reorient","v_debugCollisionDamage","v_debugdraw","v_debugSuspensionIK","v_debugVehicle","v_debugViewAbove","v_debugViewAboveH","v_debugViewDetach","v_disable_hull","v_disableEntry","v_draw_components","v_draw_helpers","v_draw_passengers","v_draw_seats","v_draw_tm","v_driverControlledMountedGuns","v_enableMannequin","v_FlippedExplosionPlayerMinDistance","v_FlippedExplosionRetryTimeMS","v_FlippedExplosionTimeToExplode","v_goliathMode","v_independentMountedGuns","v_lights","v_lights_enable_always","v_playerTransitions","v_ragdollPassengers","v_serverControlled","v_set_passenger_tm","v_show_all","v_slipFrictionModFront","v_slipFrictionModRear","v_slipSlopeFront","v_slipSlopeRear","v_staticTreadDeform","v_testClientPredict","v_transitionAnimations","v_vehicle_quality","watchdog"]},"commands":{"type":"string","title":"Command name","description":"Console command name","default":"","enum":["_TestFormatMessage","ai_CheckGoalpipes","ai_commTest","ai_commTestStop","ai_DebugAgent","ai_debugMNMAgentType","ai_MNMCalculateAccessibility","ai_MNMComputeConnectedIslands","ai_NavigationReloadConfig","ai_Recorder_Start","ai_Recorder_Stop","ai_reload","ai_resetCommStats","ai_writeCommStats","audit_cvars","ban","ban_remove","ban_status","Bind","ca_DebugText","ca_DefaultTransitionInterpolationType","connect","connect_repeatedly","ConsoleHide","ConsoleShow","demo","demo_StartDemoChain","demo_StartDemoLevel","disconnect","disconnectchannel","drs_sendSignal","ds_Dump","ds_DumpSessions","ds_Reload","dump_action_maps","dump_maps","dump_stats","DumpCommandsVars","DumpVars","e_DebugDrawListCMD","e_ParticleListEffects","e_ParticleListEmitters","e_ParticleMemory","e_ReloadSurfaces","e_StatoscopeAddUserMarker","ed_disable_game_mode","ed_GenerateBillboardTextures","ed_goto","ed_killmemory","ed_randomize_variations","eqp_DumpPacks","es_compile_area_grid","es_debugAnim","es_dump_entities","es_dump_entity_classes_in_use","es_togglelayer","exec","ffs_PlayEffect","ffs_Reload","ffs_StopAllEffects","fg_InspectAction","fg_InspectEntity","fg_Inspector","fg_reloadClasses","fg_writeDocumentation","g_dump_stats","g_dumpClassRegistry","g_saveLoadDumpEntity","gamedata_playback","gamedata_record","gamedata_stop_record_or_playback","gfx_reload_all","gt_AddToDebugList","gt_RemoveFromDebugList","hmd_recenter_pose","http_startserver","http_stopserver","i_dropitem","i_giveallitems","i_giveammo","i_givedebugitems","i_giveitem","i_listitems","i_reloadActionMaps","i_saveweaponposition","kick","kickid","load","LoadConfig","LocalizationDumpLoadedInfo","log_flush","lua_debugger_show","lua_dump_coverage","lua_dump_state","lua_garbagecollect","lua_reload_script","map","memDumpAllocs","memReplayAddSizerTree","memReplayDumpSymbols","memReplayInfo","memReplayLabel","memReplayPause","memReplayResume","memReplayStop","memResetAllocs","mfx_Reload","mfx_ReloadFGEffects","mn_DebugAI","mn_listAssets","mn_reload","mono_reload","mov_goToFrameEditor","net_dump_object_state","net_DumpMessageApproximations","net_getChannelPerformanceMetrics","net_netMsgDispatcherClearStats","net_pb_cl_enable","net_pb_sv_enable","net_set_cdkey","net_setChannelPerformanceMetrics","open_url","osm_setFBScale","play","py","q_Quality","r_ColorGradingChartImage","r_DumpFontNames","r_DumpFontTexture","r_getposteffectparamf","r_OptimiseShaders","r_OverscanBorders","r_PrecacheShaderList","r_setposteffectparamf","r_ShowRenderTarget","r_StatsShaderList","rcon_command","rcon_connect","rcon_disconnect","rcon_startserver","rcon_stopserver","readabilityReload","record","RecordClip","ReloadDialogData","RunUnitTests","s_ExecuteTrigger","s_SetParameter","s_SetSwitchState","s_StopTrigger","save","save_genstrings","SaveLevelStats","sc_CriticalError","sc_FatalError","sc_rpcShow","sc_SaveAllScriptFiles","Screenshot","sensor_SetOctreeBounds","sensor_SetOctreeDepth","status","stopdemo","stoprecording","sys_crashrpt_generate","sys_crashtest","sys_crashtest_thread","sys_dump_cvars","sys_ignore_asserts_from_module","sys_job_system_dump_job_list","sys_LvlRes_finalstep","sys_LvlRes_findunused","sys_RestoreSpec","sys_StroboscopeDumpResults","sys_StroboscopeStart","sys_StroboscopeStop","sys_threads_dump_thread_config_list","test_delegate","test_playersBounds","test_profile","test_reset","unload","v_dump_classes","v_exit_player","v_reload_system","version","VisRegTest","voice_mute","wait_frames","wait_seconds"]}},"id":"https://json.schemastore.org/cryproj","properties":{"console_variables":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"$ref":"#/definitions/cvars"},"value":{"type":"string","title":"Value of the CVar","description":"The default value of the CVar","default":"pc,ps4,xboxone,linux"}},"required":["name","value"]}},"content":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"string","title":"Assets folder","description":"This indicates where the assets are stored","default":"Assets","examples":["Assets"]}},"code":{"type":"array","items":{"type":"string","title":"Code folder","description":"This indicates where the code is stored","default":"Code","examples":["Code"]}},"libs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"Lib's name","default":"","examples":["Blank"]},"shared":{"type":"object","properties":{"any":{"type":"string","title":"Lib's name to import for all the supported platforms","default":"","examples":["CryGameSDK"]},"win_x64":{"type":"string","title":"Lib's name to import for the win_x64 platform","default":"","examples":["bin/win_x64/Game.dll"]},"win_x86":{"type":"string","title":"Lib's name to import for the win_x86 platform","default":"","examples":["bin/win_x86/Game.dll"]}}}}}}},"required":["code"]},"info":{"type":"object","properties":{"name":{"type":"string","title":"Project name","description":"This indicates the project name","default":"","examples":["MyFancyProject"]},"guid":{"type":"string","title":"Project GUID","default":"","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"}},"required":["name"]},"require":{"type":"object","properties":{"engine":{"type":"string","title":"Engine version","description":"This indicates which engine version will be used","default":"","examples":["engine-5.4"],"enum":["engine-5.2","engine-5.3","engine-5.4","engine-5.5","engine-dev"]},"plugins":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","title":"Plugin name","description":"Required plugin's name","examples":["CryDefaultEntities","CrySensorSystem","CryPerceptionSystem","CryUserAnalytics","CryOSVR","CryOculusVR","CryOpenVR","CryLobby"]},"type":{"type":"string","title":"Plugin type","description":"EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one","default":"","examples":["EPluginType::Native","EPluginType::Managed"],"enum":["EPluginType::Native","EPluginType::Managed"]},"platforms":{"type":"array","items":{"type":"string","title":"This plugin will be used only by these platforms","default":"","examples":["PS4"],"enum":["pc","ps4","xboxone","linux"]}}},"required":["path","type"]}}},"required":["engine"]},"type":{"type":"string","title":"","default":"","examples":[""]},"version":{"type":"integer","title":"Project version","default":1,"examples":[1]},"console_commands":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"$ref":"#/definitions/commands"},"value":{"type":"string","title":"Value of the command","description":"Arguments that has to be passed to the command. Leave empty if it has not parameters","default":""}},"required":["name","value"]}}},"required":["content","info","require","version"],"title":"CryProj schema","type":"object"}
|
Provide a JSON object that satisfies the schema "CryProj schema". Here are the required top‑level fields: content, info, require, version. Return only the valid JSON object.
|
CryProj schema
|
schema-store
|
schema_store_223
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"additionalProperties\":false,\"allowTrailingCommas\":true,\"definitions\":{\"CacheFormat\":{\"enum\":[\"legacy\",\"universal\"],\"type\":\"string\"},\"CacheSettings\":{\"additionalProperties\":false,\"properties\":{\"cacheFormat\":{\"$ref\":\"#/definitions/CacheFormat\",\"default\":\"universal\",\"description\":\"Format of the cache file.\\n- `legacy` - use absolute paths in the cache file\\n- `universal` - use a sharable format.\",\"markdownDescription\":\"Format of the cache file.\\n- `legacy` - use absolute paths in the cache file\\n- `universal` - use a sharable format.\"},\"cacheLocation\":{\"$ref\":\"#/definitions/FSPathResolvable\",\"description\":\"Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\\n\\nA prefix of `${cwd}` is replaced with the current working directory.\",\"markdownDescription\":\"Path to the cache location. Can be a file or a directory.\\nIf none specified `.cspellcache` will be used.\\nRelative paths are relative to the config file in which it\\nis defined.\\n\\nA prefix of `${cwd}` is replaced with the current working directory.\"},\"cacheStrategy\":{\"$ref\":\"#/definitions/CacheStrategy\",\"default\":\"metadata\",\"description\":\"Strategy to use for detecting changed files, default: metadata\",\"markdownDescription\":\"Strategy to use for detecting changed files, default: metadata\"},\"useCache\":{\"default\":false,\"description\":\"Store the results of processed files in order to only operate on the changed ones.\",\"markdownDescription\":\"Store the results of processed files in order to only operate on the changed ones.\",\"type\":\"boolean\"}},\"type\":\"object\"},\"CacheStrategy\":{\"default\":\"content\",\"description\":\"The Strategy to use to detect if a file has changed.\\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).\\n- `metadata` - uses the file system timestamp and size to detect changes (fastest, may not work in CI).\",\"enum\":[\"content\",\"metadata\"],\"markdownDescription\":\"The Strategy to use to detect if a file has changed.\\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).\\n- `metadata` - uses the file system timestamp and size to detect changes (fastest, may not work in CI).\",\"type\":\"string\"},\"CharacterSet\":{\"description\":\"This is a set of characters that can include `-` or `|`\\n- `-` - indicates a range of characters: `a-c` => `abc`\\n- `|` - is a group separator, indicating that the characters on either side are not related.\",\"markdownDescription\":\"This is a set of characters that can include `-` or `|`\\n- `-` - indicates a range of characters: `a-c` => `abc`\\n- `|` - is a group separator, indicating that the characters on either side\\n are not related.\",\"type\":\"string\"},\"CharacterSetCosts\":{\"additionalProperties\":false,\"properties\":{\"characters\":{\"$ref\":\"#/definitions/CharacterSet\",\"description\":\"This is a set of characters that can include `-` or `|`\\n- `-` - indicates a range of characters: `a-c` => `abc`\\n- `|` - is a group separator, indicating that the characters on either side are not related.\",\"markdownDescription\":\"This is a set of characters that can include `-` or `|`\\n- `-` - indicates a range of characters: `a-c` => `abc`\\n- `|` - is a group separator, indicating that the characters on either side\\n are not related.\"},\"cost\":{\"description\":\"the cost to insert / delete / replace / swap the characters in a group\",\"markdownDescription\":\"the cost to insert / delete / replace / swap the characters in a group\",\"type\":\"number\"},\"penalty\":{\"description\":\"The penalty cost to apply if the accent is used. This is used to discourage\",\"markdownDescription\":\"The penalty cost to apply if the accent is used.\\nThis is used to discourage\",\"type\":\"number\"}},\"required\":[\"characters\",\"cost\"],\"type\":\"object\"},\"CostMapDefInsDel\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"A description to describe the purpose of the map.\",\"markdownDescription\":\"A description to describe the purpose of the map.\",\"type\":\"string\"},\"insDel\":{\"description\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"markdownDescription\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"type\":\"number\"},\"map\":{\"description\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"markdownDescription\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"type\":\"string\"},\"penalty\":{\"description\":\"Add a penalty to the final cost. This is used to discourage certain suggestions.\\n\\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \\\"$(-$)\\\" replace: 50 penalty: 100 ```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"markdownDescription\":\"Add a penalty to the final cost.\\nThis is used to discourage certain suggestions.\\n\\nExample:\\n```yaml\\n# Match adding/removing `-` to the end of a word.\\nmap: \\\"$(-$)\\\"\\nreplace: 50\\npenalty: 100\\n```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"type\":\"number\"},\"replace\":{\"description\":\"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"markdownDescription\":\"The cost to replace of of the substrings in the map with another substring in the map.\\nExample: Map['a', 'i']\\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"type\":\"number\"},\"swap\":{\"description\":\"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.\",\"markdownDescription\":\"The cost to swap two adjacent substrings found in the map.\\nExample: Map['e', 'i']\\nThis represents the cost to change `ei` to `ie` or the reverse.\",\"type\":\"number\"}},\"required\":[\"insDel\",\"map\"],\"type\":\"object\"},\"CostMapDefReplace\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"A description to describe the purpose of the map.\",\"markdownDescription\":\"A description to describe the purpose of the map.\",\"type\":\"string\"},\"insDel\":{\"description\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"markdownDescription\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"type\":\"number\"},\"map\":{\"description\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"markdownDescription\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"type\":\"string\"},\"penalty\":{\"description\":\"Add a penalty to the final cost. This is used to discourage certain suggestions.\\n\\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \\\"$(-$)\\\" replace: 50 penalty: 100 ```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"markdownDescription\":\"Add a penalty to the final cost.\\nThis is used to discourage certain suggestions.\\n\\nExample:\\n```yaml\\n# Match adding/removing `-` to the end of a word.\\nmap: \\\"$(-$)\\\"\\nreplace: 50\\npenalty: 100\\n```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"type\":\"number\"},\"replace\":{\"description\":\"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"markdownDescription\":\"The cost to replace of of the substrings in the map with another substring in the map.\\nExample: Map['a', 'i']\\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"type\":\"number\"},\"swap\":{\"description\":\"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.\",\"markdownDescription\":\"The cost to swap two adjacent substrings found in the map.\\nExample: Map['e', 'i']\\nThis represents the cost to change `ei` to `ie` or the reverse.\",\"type\":\"number\"}},\"required\":[\"map\",\"replace\"],\"type\":\"object\"},\"CostMapDefSwap\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"A description to describe the purpose of the map.\",\"markdownDescription\":\"A description to describe the purpose of the map.\",\"type\":\"string\"},\"insDel\":{\"description\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"markdownDescription\":\"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.\",\"type\":\"number\"},\"map\":{\"description\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"markdownDescription\":\"The set of substrings to map, these are generally single character strings.\\n\\nMultiple sets can be defined by using a `|` to separate them.\\n\\nExample: `\\\"e\\u00e9\\u00ea|a\\u00e5\\u00e1\\\"` contains two different sets.\\n\\nTo add a multi-character substring use `()`.\\n\\nExample: `\\\"f(ph)(gh)\\\"` results in the following set: `f`, `ph`, `gh`.\\n\\n- To match the beginning of a word, use `^`: `\\\"(^I)\\\"\\\"`.\\n- To match the end of a word, use `$`: `\\\"(e$)(ing$)\\\"`.\",\"type\":\"string\"},\"penalty\":{\"description\":\"Add a penalty to the final cost. This is used to discourage certain suggestions.\\n\\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \\\"$(-$)\\\" replace: 50 penalty: 100 ```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"markdownDescription\":\"Add a penalty to the final cost.\\nThis is used to discourage certain suggestions.\\n\\nExample:\\n```yaml\\n# Match adding/removing `-` to the end of a word.\\nmap: \\\"$(-$)\\\"\\nreplace: 50\\npenalty: 100\\n```\\n\\nThis makes adding a `-` to the end of a word more expensive.\\n\\nThink of it as taking the toll way for speed but getting the bill later.\",\"type\":\"number\"},\"replace\":{\"description\":\"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"markdownDescription\":\"The cost to replace of of the substrings in the map with another substring in the map.\\nExample: Map['a', 'i']\\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.\",\"type\":\"number\"},\"swap\":{\"description\":\"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.\",\"markdownDescription\":\"The cost to swap two adjacent substrings found in the map.\\nExample: Map['e', 'i']\\nThis represents the cost to change `ei` to `ie` or the reverse.\",\"type\":\"number\"}},\"required\":[\"map\",\"swap\"],\"type\":\"object\"},\"CustomDictionaryPath\":{\"$ref\":\"#/definitions/FsDictionaryPath\",\"description\":\"A File System Path to a dictionary file.\",\"markdownDescription\":\"A File System Path to a dictionary file.\"},\"CustomDictionaryScope\":{\"description\":\"Specifies the scope of a dictionary.\",\"enum\":[\"user\",\"workspace\",\"folder\"],\"markdownDescription\":\"Specifies the scope of a dictionary.\",\"type\":\"string\"},\"DictionaryDefinition\":{\"anyOf\":[{\"$ref\":\"#/definitions/DictionaryDefinitionPreferred\"},{\"$ref\":\"#/definitions/DictionaryDefinitionCustom\"},{\"$ref\":\"#/definitions/DictionaryDefinitionAugmented\"},{\"$ref\":\"#/definitions/DictionaryDefinitionInline\"},{\"$ref\":\"#/definitions/DictionaryDefinitionSimple\"},{\"$ref\":\"#/definitions/DictionaryDefinitionAlternate\"}]},\"DictionaryDefinitionAlternate\":{\"additionalProperties\":false,\"deprecated\":true,\"deprecationMessage\":\"Use {@link DictionaryDefinitionPreferred } instead.\",\"description\":\"Only for legacy dictionary definitions.\",\"markdownDescription\":\"Only for legacy dictionary definitions.\",\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"file\":{\"$ref\":\"#/definitions/DictionaryPath\",\"deprecated\":true,\"deprecationMessage\":\"Use `path` instead.\",\"description\":\"Path to the file, only for legacy dictionary definitions.\",\"markdownDescription\":\"Path to the file, only for legacy dictionary definitions.\"},\"ignoreForbiddenWords\":{\"description\":\"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.\",\"markdownDescription\":\"Some dictionaries may contain forbidden words to prevent compounding from generating\\nwords that are not valid in the language. These are often\\nwords that are used in other languages or might be generated through compounding.\\nThis setting allows flagged words to be ignored when checking the dictionary.\\nThe effect is similar to the word not being in the dictionary.\",\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"noSuggest\":{\"description\":\"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.\",\"markdownDescription\":\"Indicate that suggestions should not come from this dictionary.\\nWords in this dictionary are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\nthis dictionary, it will be removed from the set of\\npossible suggestions.\",\"type\":\"boolean\"},\"repMap\":{\"$ref\":\"#/definitions/ReplaceMap\",\"description\":\"Replacement pairs.\",\"markdownDescription\":\"Replacement pairs.\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/DictionaryFileTypes\",\"default\":\"S\",\"description\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\",\"markdownDescription\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\"},\"useCompounds\":{\"description\":\"Use Compounds.\",\"markdownDescription\":\"Use Compounds.\",\"type\":\"boolean\"}},\"required\":[\"file\",\"name\"],\"type\":\"object\"},\"DictionaryDefinitionAugmented\":{\"additionalProperties\":false,\"description\":\"Used to provide extra data related to the dictionary\",\"markdownDescription\":\"Used to provide extra data related to the dictionary\",\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"dictionaryInformation\":{\"$ref\":\"#/definitions/DictionaryInformation\"},\"ignoreForbiddenWords\":{\"description\":\"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.\",\"markdownDescription\":\"Some dictionaries may contain forbidden words to prevent compounding from generating\\nwords that are not valid in the language. These are often\\nwords that are used in other languages or might be generated through compounding.\\nThis setting allows flagged words to be ignored when checking the dictionary.\\nThe effect is similar to the word not being in the dictionary.\",\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"noSuggest\":{\"description\":\"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.\",\"markdownDescription\":\"Indicate that suggestions should not come from this dictionary.\\nWords in this dictionary are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\nthis dictionary, it will be removed from the set of\\npossible suggestions.\",\"type\":\"boolean\"},\"path\":{\"$ref\":\"#/definitions/DictionaryPath\",\"description\":\"Path to the file.\",\"markdownDescription\":\"Path to the file.\"},\"repMap\":{\"$ref\":\"#/definitions/ReplaceMap\",\"description\":\"Replacement pairs.\",\"markdownDescription\":\"Replacement pairs.\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/DictionaryFileTypes\",\"default\":\"S\",\"description\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\",\"markdownDescription\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\"},\"useCompounds\":{\"description\":\"Use Compounds.\",\"markdownDescription\":\"Use Compounds.\",\"type\":\"boolean\"}},\"required\":[\"name\",\"path\"],\"type\":\"object\"},\"DictionaryDefinitionCustom\":{\"additionalProperties\":false,\"description\":\"For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file.\\n\\nNote: only plain text files with one word per line are supported at this moment.\",\"markdownDescription\":\"For Defining Custom dictionaries. They are generally scoped to a\\n`user`, `workspace`, or `folder`.\\nWhen `addWords` is true, indicates that the spell checker can add words\\nto the file.\\n\\nNote: only plain text files with one word per line are supported at this moment.\",\"properties\":{\"addWords\":{\"description\":\"When `true`, let's the spell checker know that words can be added to this dictionary.\",\"markdownDescription\":\"When `true`, let's the spell checker know that words can be added to this dictionary.\",\"type\":\"boolean\"},\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"ignoreForbiddenWords\":{\"description\":\"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.\",\"markdownDescription\":\"Some dictionaries may contain forbidden words to prevent compounding from generating\\nwords that are not valid in the language. These are often\\nwords that are used in other languages or might be generated through compounding.\\nThis setting allows flagged words to be ignored when checking the dictionary.\\nThe effect is similar to the word not being in the dictionary.\",\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"noSuggest\":{\"description\":\"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.\",\"markdownDescription\":\"Indicate that suggestions should not come from this dictionary.\\nWords in this dictionary are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\nthis dictionary, it will be removed from the set of\\npossible suggestions.\",\"type\":\"boolean\"},\"path\":{\"$ref\":\"#/definitions/CustomDictionaryPath\",\"description\":\"Path to custom dictionary text file.\",\"markdownDescription\":\"Path to custom dictionary text file.\"},\"repMap\":{\"$ref\":\"#/definitions/ReplaceMap\",\"description\":\"Replacement pairs.\",\"markdownDescription\":\"Replacement pairs.\"},\"scope\":{\"anyOf\":[{\"$ref\":\"#/definitions/CustomDictionaryScope\"},{\"items\":{\"$ref\":\"#/definitions/CustomDictionaryScope\"},\"type\":\"array\"}],\"description\":\"Defines the scope for when words will be added to the dictionary.\\n\\nScope values: `user`, `workspace`, `folder`.\",\"markdownDescription\":\"Defines the scope for when words will be added to the dictionary.\\n\\nScope values: `user`, `workspace`, `folder`.\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/DictionaryFileTypes\",\"default\":\"S\",\"description\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\",\"markdownDescription\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\"},\"useCompounds\":{\"description\":\"Use Compounds.\",\"markdownDescription\":\"Use Compounds.\",\"type\":\"boolean\"}},\"required\":[\"addWords\",\"name\",\"path\"],\"type\":\"object\"},\"DictionaryDefinitionInline\":{\"anyOf\":[{\"$ref\":\"#/definitions/DictionaryDefinitionInlineWords\"},{\"$ref\":\"#/definitions/DictionaryDefinitionInlineIgnoreWords\"},{\"$ref\":\"#/definitions/DictionaryDefinitionInlineFlagWords\"},{\"$ref\":\"#/definitions/DictionaryDefinitionInlineSuggestWords\"}],\"description\":\"Inline Dictionary Definitions\",\"markdownDescription\":\"Inline Dictionary Definitions\",\"since\":\"6.23.0\"},\"DictionaryDefinitionInlineFlagWords\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"flagWords\",\"name\"],\"type\":\"object\"},\"DictionaryDefinitionInlineIgnoreWords\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"ignoreWords\",\"name\"],\"type\":\"object\"},\"DictionaryDefinitionInlineSuggestWords\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"name\",\"suggestWords\"],\"type\":\"object\"},\"DictionaryDefinitionInlineWords\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"name\",\"words\"],\"type\":\"object\"},\"DictionaryDefinitionPreferred\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"ignoreForbiddenWords\":{\"description\":\"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.\",\"markdownDescription\":\"Some dictionaries may contain forbidden words to prevent compounding from generating\\nwords that are not valid in the language. These are often\\nwords that are used in other languages or might be generated through compounding.\\nThis setting allows flagged words to be ignored when checking the dictionary.\\nThe effect is similar to the word not being in the dictionary.\",\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"noSuggest\":{\"description\":\"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.\",\"markdownDescription\":\"Indicate that suggestions should not come from this dictionary.\\nWords in this dictionary are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\nthis dictionary, it will be removed from the set of\\npossible suggestions.\",\"type\":\"boolean\"},\"path\":{\"$ref\":\"#/definitions/DictionaryPath\",\"description\":\"Path to the file.\",\"markdownDescription\":\"Path to the file.\"},\"repMap\":{\"$ref\":\"#/definitions/ReplaceMap\",\"description\":\"Replacement pairs.\",\"markdownDescription\":\"Replacement pairs.\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/DictionaryFileTypes\",\"default\":\"S\",\"description\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\",\"markdownDescription\":\"Type of file:\\n- S - single word per line,\\n- W - each line can contain one or more words separated by space,\\n- C - each line is treated like code (Camel Case is allowed).\\n\\nDefault is S.\\n\\nC is the slowest to load due to the need to split each line based upon code splitting rules.\\n\\nNote: this settings does not apply to inline dictionaries or `.trie` files.\"},\"useCompounds\":{\"description\":\"Use Compounds.\",\"markdownDescription\":\"Use Compounds.\",\"type\":\"boolean\"}},\"required\":[\"name\",\"path\"],\"type\":\"object\"},\"DictionaryDefinitionSimple\":{\"additionalProperties\":false,\"description\":\"An Empty Dictionary Definition\",\"markdownDescription\":\"An Empty Dictionary Definition\",\"properties\":{\"description\":{\"description\":\"Optional description of the contents / purpose of the dictionary.\",\"markdownDescription\":\"Optional description of the contents / purpose of the dictionary.\",\"type\":\"string\"},\"name\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\"},\"supportNonStrictSearches\":{\"default\":true,\"description\":\"Strip case and accents to allow for case insensitive searches and words without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.\",\"markdownDescription\":\"Strip case and accents to allow for case insensitive searches and\\nwords without accents.\\n\\nNote: this setting only applies to word lists. It has no-impact on trie\\ndictionaries.\",\"type\":\"boolean\"}},\"required\":[\"name\"],\"type\":\"object\"},\"DictionaryFileTypes\":{\"enum\":[\"S\",\"W\",\"C\",\"T\"],\"type\":\"string\"},\"DictionaryId\":{\"description\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"markdownDescription\":\"This is the name of a dictionary.\\n\\nName Format:\\n- Must contain at least 1 number or letter.\\n- Spaces are allowed.\\n- Leading and trailing space will be removed.\\n- Names ARE case-sensitive.\\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.\",\"pattern\":\"^(?=[^!*,;{}[\\\\]~\\\\n]+$)(?=(.*\\\\w)).+$\",\"type\":\"string\"},\"DictionaryInformation\":{\"additionalProperties\":false,\"description\":\"Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\\n\\nAdded with `v5.16.0`.\",\"markdownDescription\":\"Use by dictionary authors to help improve the quality of suggestions\\ngiven from the dictionary.\\n\\nAdded with `v5.16.0`.\",\"properties\":{\"accents\":{\"anyOf\":[{\"$ref\":\"#/definitions/CharacterSet\"},{\"items\":{\"$ref\":\"#/definitions/CharacterSetCosts\"},\"type\":\"array\"}],\"description\":\"The accent characters.\\n\\nDefault: `\\\"\\\\u0300-\\\\u0341\\\"`\",\"markdownDescription\":\"The accent characters.\\n\\nDefault: `\\\"\\\\u0300-\\\\u0341\\\"`\"},\"adjustments\":{\"description\":\"A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.\",\"items\":{\"$ref\":\"#/definitions/PatternAdjustment\"},\"markdownDescription\":\"A collection of patterns to test against the suggested words.\\nIf the word matches the pattern, then the penalty is applied.\",\"type\":\"array\"},\"alphabet\":{\"anyOf\":[{\"$ref\":\"#/definitions/CharacterSet\"},{\"items\":{\"$ref\":\"#/definitions/CharacterSetCosts\"},\"type\":\"array\"}],\"default\":\"a-zA-Z\",\"description\":\"The alphabet to use.\",\"markdownDescription\":\"The alphabet to use.\"},\"costs\":{\"$ref\":\"#/definitions/EditCosts\",\"description\":\"Define edit costs.\",\"markdownDescription\":\"Define edit costs.\"},\"hunspellInformation\":{\"$ref\":\"#/definitions/HunspellInformation\",\"description\":\"Used by dictionary authors\",\"markdownDescription\":\"Used by dictionary authors\"},\"ignore\":{\"$ref\":\"#/definitions/CharacterSet\",\"description\":\"An optional set of characters that can possibly be removed from a word before checking it.\\n\\nThis is useful in languages like Arabic where Harakat accents are optional.\\n\\nNote: All matching characters are removed or none. Partial removal is not supported.\",\"markdownDescription\":\"An optional set of characters that can possibly be removed from a word before\\nchecking it.\\n\\nThis is useful in languages like Arabic where Harakat accents are optional.\\n\\nNote: All matching characters are removed or none. Partial removal is not supported.\"},\"locale\":{\"description\":\"The locale of the dictionary. Example: `nl,nl-be`\",\"markdownDescription\":\"The locale of the dictionary.\\nExample: `nl,nl-be`\",\"type\":\"string\"},\"suggestionEditCosts\":{\"$ref\":\"#/definitions/SuggestionCostsDefs\",\"description\":\"Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\",\"markdownDescription\":\"Used in making suggestions. The lower the value, the more likely the suggestion\\nwill be near the top of the suggestion list.\"}},\"type\":\"object\"},\"DictionaryNegRef\":{\"description\":\"This a negative reference to a named dictionary.\\n\\nIt is used to exclude or include a dictionary by name.\\n\\nThe reference starts with 1 or more `!`.\\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`. Overrides `!<dictionary_name>`.\\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`. Overrides `!!<dictionary_name>`.\",\"markdownDescription\":\"This a negative reference to a named dictionary.\\n\\nIt is used to exclude or include a dictionary by name.\\n\\nThe reference starts with 1 or more `!`.\\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.\\n Overrides `!<dictionary_name>`.\\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\\n Overrides `!!<dictionary_name>`.\",\"pattern\":\"^(?=!+[^!*,;{}[\\\\]~\\\\n]+$)(?=(.*\\\\w)).+$\",\"type\":\"string\"},\"DictionaryPath\":{\"description\":\"A File System Path to a dictionary file. Pattern: `^.*\\\\.(?:txt|trie|dic)(?:\\\\.gz)?$`\",\"markdownDescription\":\"A File System Path to a dictionary file.\\nPattern: `^.*\\\\.(?:txt|trie|dic)(?:\\\\.gz)?$`\",\"type\":\"string\"},\"DictionaryRef\":{\"$ref\":\"#/definitions/DictionaryId\",\"description\":\"This a reference to a named dictionary. It is expected to match the name of a dictionary.\",\"markdownDescription\":\"This a reference to a named dictionary.\\nIt is expected to match the name of a dictionary.\"},\"DictionaryReference\":{\"anyOf\":[{\"$ref\":\"#/definitions/DictionaryRef\"},{\"$ref\":\"#/definitions/DictionaryNegRef\"}],\"description\":\"Reference to a dictionary by name. One of:\\n- {@link DictionaryRef } \\n- {@link DictionaryNegRef }\",\"markdownDescription\":\"Reference to a dictionary by name.\\nOne of:\\n- {@link DictionaryRef } \\n- {@link DictionaryNegRef }\"},\"EditCosts\":{\"additionalProperties\":false,\"properties\":{\"accentCosts\":{\"default\":1,\"description\":\"The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.\",\"markdownDescription\":\"The cost to add / remove an accent\\nThis should be very cheap, it helps with fixing accent issues.\",\"type\":\"number\"},\"baseCost\":{\"default\":100,\"description\":\"This is the base cost for making an edit.\",\"markdownDescription\":\"This is the base cost for making an edit.\",\"type\":\"number\"},\"capsCosts\":{\"default\":1,\"description\":\"The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.\",\"markdownDescription\":\"The cost to change capitalization.\\nThis should be very cheap, it helps with fixing capitalization issues.\",\"type\":\"number\"},\"firstLetterPenalty\":{\"default\":4,\"description\":\"The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.\",\"markdownDescription\":\"The extra cost incurred for changing the first letter of a word.\\nThis value should be less than `100 - baseCost`.\",\"type\":\"number\"},\"nonAlphabetCosts\":{\"default\":110,\"description\":\"This is the cost for characters not in the alphabet.\",\"markdownDescription\":\"This is the cost for characters not in the alphabet.\",\"type\":\"number\"}},\"type\":\"object\"},\"FSPathResolvable\":{\"$ref\":\"#/definitions/FsPath\",\"description\":\"A File System Path.\\n\\nSpecial Properties:\\n- `${cwd}` prefix - will be replaced with the current working directory.\\n- Relative paths are relative to the configuration file.\",\"markdownDescription\":\"A File System Path.\\n\\nSpecial Properties:\\n- `${cwd}` prefix - will be replaced with the current working directory.\\n- Relative paths are relative to the configuration file.\"},\"FeatureEnableOnly\":{\"type\":\"boolean\"},\"Features\":{\"additionalProperties\":false,\"description\":\"Features are behaviors or settings that can be explicitly configured.\",\"markdownDescription\":\"Features are behaviors or settings that can be explicitly configured.\",\"properties\":{\"weighted-suggestions\":{\"$ref\":\"#/definitions/FeatureEnableOnly\",\"description\":\"Enable/disable using weighted suggestions.\",\"markdownDescription\":\"Enable/disable using weighted suggestions.\"}},\"type\":\"object\"},\"FsDictionaryPath\":{\"description\":\"A File System Path. Relative paths are relative to the configuration file.\",\"markdownDescription\":\"A File System Path. Relative paths are relative to the configuration file.\",\"type\":\"string\"},\"FsPath\":{\"description\":\"A File System Path. Relative paths are relative to the configuration file.\",\"markdownDescription\":\"A File System Path. Relative paths are relative to the configuration file.\",\"type\":\"string\"},\"Glob\":{\"$ref\":\"#/definitions/SimpleGlob\",\"description\":\"These are glob expressions.\",\"markdownDescription\":\"These are glob expressions.\"},\"HunspellInformation\":{\"additionalProperties\":false,\"properties\":{\"aff\":{\"description\":\"Selected Hunspell AFF content. The content must be UTF-8\\n\\nSections:\\n- TRY\\n- MAP\\n- REP\\n- KEY\\n- ICONV\\n- OCONV\\n\\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjh\\u00e4\\u00f5b\\u00fco\\u00f6fcwzx\\u00f0q\\u00fe` MAP a\\u00e0\\u00e2\\u00e4A\\u00c0\\u00c2\\u00c4 MAP e\\u00e9\\u00e8\\u00ea\\u00ebE\\u00c9\\u00c8\\u00ca\\u00cb MAP i\\u00ee\\u00efyI\\u00ce\\u00cfY MAP o\\u00f4\\u00f6O\\u00d4\\u00d6 MAP (IJ)(\\u0132) ```\",\"markdownDescription\":\"Selected Hunspell AFF content.\\nThe content must be UTF-8\\n\\nSections:\\n- TRY\\n- MAP\\n- REP\\n- KEY\\n- ICONV\\n- OCONV\\n\\nExample:\\n```hunspell\\n# Comment\\nTRY aeistlunkodmrvpgjh\\u00e4\\u00f5b\\u00fco\\u00f6fcwzx\\u00f0q\\u00fe`\\nMAP a\\u00e0\\u00e2\\u00e4A\\u00c0\\u00c2\\u00c4\\nMAP e\\u00e9\\u00e8\\u00ea\\u00ebE\\u00c9\\u00c8\\u00ca\\u00cb\\nMAP i\\u00ee\\u00efyI\\u00ce\\u00cfY\\nMAP o\\u00f4\\u00f6O\\u00d4\\u00d6\\nMAP (IJ)(\\u0132)\\n```\",\"type\":\"string\"},\"costs\":{\"additionalProperties\":false,\"description\":\"The costs to apply when using the hunspell settings\",\"markdownDescription\":\"The costs to apply when using the hunspell settings\",\"properties\":{\"accentCosts\":{\"default\":1,\"description\":\"The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.\",\"markdownDescription\":\"The cost to add / remove an accent\\nThis should be very cheap, it helps with fixing accent issues.\",\"type\":\"number\"},\"baseCost\":{\"default\":100,\"description\":\"This is the base cost for making an edit.\",\"markdownDescription\":\"This is the base cost for making an edit.\",\"type\":\"number\"},\"capsCosts\":{\"default\":1,\"description\":\"The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.\",\"markdownDescription\":\"The cost to change capitalization.\\nThis should be very cheap, it helps with fixing capitalization issues.\",\"type\":\"number\"},\"firstLetterPenalty\":{\"default\":4,\"description\":\"The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.\",\"markdownDescription\":\"The extra cost incurred for changing the first letter of a word.\\nThis value should be less than `100 - baseCost`.\",\"type\":\"number\"},\"ioConvertCost\":{\"default\":30,\"description\":\"The cost to convert between convert pairs.\\n\\nThe value should be slightly higher than the mapCost.\",\"markdownDescription\":\"The cost to convert between convert pairs.\\n\\nThe value should be slightly higher than the mapCost.\",\"type\":\"number\"},\"keyboardCost\":{\"default\":99,\"description\":\"The cost of replacing or swapping any adjacent keyboard characters.\\n\\nThis should be slightly cheaper than `tryCharCost`.\",\"markdownDescription\":\"The cost of replacing or swapping any adjacent keyboard characters.\\n\\nThis should be slightly cheaper than `tryCharCost`.\",\"type\":\"number\"},\"mapCost\":{\"default\":25,\"description\":\"mapSet replacement cost is the cost to substitute one character with another from the same set.\\n\\nMap characters are considered very similar to each other and are often the cause of simple mistakes.\",\"markdownDescription\":\"mapSet replacement cost is the cost to substitute one character with another from\\nthe same set.\\n\\nMap characters are considered very similar to each other and are often\\nthe cause of simple mistakes.\",\"type\":\"number\"},\"nonAlphabetCosts\":{\"default\":110,\"description\":\"This is the cost for characters not in the alphabet.\",\"markdownDescription\":\"This is the cost for characters not in the alphabet.\",\"type\":\"number\"},\"replaceCosts\":{\"default\":75,\"description\":\"The cost to substitute pairs found in the replace settings.\",\"markdownDescription\":\"The cost to substitute pairs found in the replace settings.\",\"type\":\"number\"},\"tryCharCost\":{\"description\":\"The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`\",\"markdownDescription\":\"The cost of inserting / deleting / or swapping any `tryChars`\\nDefaults to `baseCosts`\",\"type\":\"number\"}},\"type\":\"object\"}},\"required\":[\"aff\"],\"type\":\"object\"},\"LanguageId\":{\"anyOf\":[{\"$ref\":\"#/definitions/LanguageIdSingle\"},{\"$ref\":\"#/definitions/LanguageIdMultiple\"},{\"$ref\":\"#/definitions/LanguageIdMultipleNeg\"}]},\"LanguageIdMultiple\":{\"description\":\"A single string with a comma separated list of file types:\\n- `typescript,cpp`\\n- `json,jsonc,yaml`\\n- etc.\",\"markdownDescription\":\"A single string with a comma separated list of file types:\\n- `typescript,cpp`\\n- `json,jsonc,yaml`\\n- etc.\",\"pattern\":\"^([-\\\\w_\\\\s]+)(,[-\\\\w_\\\\s]+)*$\",\"type\":\"string\"},\"LanguageIdMultipleNeg\":{\"description\":\"A Negative File Type used to exclude files of that type.\\n- `!typescript` - will exclude typescript files.\\n- `!cpp,!json` - will exclude cpp and json files.\\n- `!typescript,javascript` - will exclude typescript files and include javascript files.\",\"markdownDescription\":\"A Negative File Type used to exclude files of that type.\\n- `!typescript` - will exclude typescript files.\\n- `!cpp,!json` - will exclude cpp and json files.\\n- `!typescript,javascript` - will exclude typescript files and include javascript files.\",\"pattern\":\"^(![-\\\\w_\\\\s]+)(,!?[-\\\\w_\\\\s]+)*$\",\"type\":\"string\"},\"LanguageIdSingle\":{\"description\":\"A file type:\\n- `*` - will match ALL file types.\\n- `typescript`, `cpp`, `json`, etc.\",\"markdownDescription\":\"A file type:\\n- `*` - will match ALL file types.\\n- `typescript`, `cpp`, `json`, etc.\",\"pattern\":\"^(!?[-\\\\w_\\\\s]+)|(\\\\*)$\",\"type\":\"string\"},\"LanguageSetting\":{\"additionalProperties\":false,\"properties\":{\"allowCompoundWords\":{\"default\":false,\"description\":\"True to enable compound word checking.\",\"markdownDescription\":\"True to enable compound word checking.\",\"type\":\"boolean\"},\"caseSensitive\":{\"default\":false,\"description\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"markdownDescription\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word.\\n Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"type\":\"boolean\"},\"description\":{\"description\":\"Optional description of configuration.\",\"markdownDescription\":\"Optional description of configuration.\",\"type\":\"string\"},\"dictionaries\":{\"description\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"type\":\"array\"},\"dictionaryDefinitions\":{\"description\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json \\\"dictionaryDefinitions\\\": [ { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"} ], \\\"dictionaries\\\": [\\\"custom-words\\\"] ```\",\"items\":{\"$ref\":\"#/definitions/DictionaryDefinition\"},\"markdownDescription\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json\\n\\\"dictionaryDefinitions\\\": [\\n { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"}\\n],\\n\\\"dictionaries\\\": [\\\"custom-words\\\"]\\n```\",\"type\":\"array\"},\"enabled\":{\"default\":true,\"description\":\"Is the spell checker enabled.\",\"markdownDescription\":\"Is the spell checker enabled.\",\"type\":\"boolean\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"id\":{\"description\":\"Optional identifier.\",\"markdownDescription\":\"Optional identifier.\",\"type\":\"string\"},\"ignoreRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON ```json \\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"] ```\\n\\nYAML ```yaml ignoreRegExpList: - >- /\\\\b[A-Z]+\\\\b/g ```\\n\\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON\\n```json\\n\\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"]\\n```\\n\\nYAML\\n```yaml\\nignoreRegExpList:\\n - >-\\n /\\\\b[A-Z]+\\\\b/g\\n```\\n\\nBy default, several patterns are excluded. See\\n[Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"includeRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"languageId\":{\"$ref\":\"#/definitions/MatchingFileType\",\"description\":\"The language id. Ex: `typescript`, `html`, or `php`. `*` -- will match all languages.\",\"markdownDescription\":\"The language id. Ex: `typescript`, `html`, or `php`. `*` -- will match all languages.\"},\"local\":{\"anyOf\":[{\"$ref\":\"#/definitions/LocaleId\"},{\"items\":{\"$ref\":\"#/definitions/LocaleId\"},\"type\":\"array\"}],\"deprecated\":true,\"deprecationMessage\":\"Use `locale` instead.\",\"description\":\"Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.\",\"markdownDescription\":\"Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.\"},\"locale\":{\"anyOf\":[{\"$ref\":\"#/definitions/LocaleId\"},{\"items\":{\"$ref\":\"#/definitions/LocaleId\"},\"type\":\"array\"}],\"description\":\"The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.\",\"markdownDescription\":\"The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.\"},\"name\":{\"description\":\"Optional name of configuration.\",\"markdownDescription\":\"Optional name of configuration.\",\"type\":\"string\"},\"noSuggestDictionaries\":{\"description\":\"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries that will not be used for suggestions.\\nWords in these dictionaries are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\none of these dictionaries, it will be removed from the set of\\npossible suggestions.\",\"type\":\"array\"},\"patterns\":{\"description\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript \\\"ignoreRegExpList\\\": [\\\"comments\\\"], \\\"patterns\\\": [ { \\\"name\\\": \\\"comment-single-line\\\", \\\"pattern\\\": \\\"/#.*/g\\\" }, { \\\"name\\\": \\\"comment-multi-line\\\", \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\" }, // You can also combine multiple named patterns into one single named pattern { \\\"name\\\": \\\"comments\\\", \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"] } ] ```\",\"items\":{\"$ref\":\"#/definitions/RegExpPatternDefinition\"},\"markdownDescription\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\\n {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript\\n\\\"ignoreRegExpList\\\": [\\\"comments\\\"],\\n\\\"patterns\\\": [\\n {\\n \\\"name\\\": \\\"comment-single-line\\\",\\n \\\"pattern\\\": \\\"/#.*/g\\\"\\n },\\n {\\n \\\"name\\\": \\\"comment-multi-line\\\",\\n \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\"\\n },\\n // You can also combine multiple named patterns into one single named pattern\\n {\\n \\\"name\\\": \\\"comments\\\",\\n \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"]\\n }\\n]\\n```\",\"type\":\"array\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"unknownWords\":{\"$ref\":\"#/definitions/UnknownWordsChoices\",\"default\":\"report-all\",\"description\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"markdownDescription\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"since\":\"9.1.0\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"languageId\"],\"type\":\"object\"},\"LocaleId\":{\"description\":\"This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,fr` for both English and French\",\"markdownDescription\":\"This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,fr` for both English and French\",\"type\":\"string\"},\"MatchingFileType\":{\"anyOf\":[{\"$ref\":\"#/definitions/LanguageId\"},{\"items\":{\"$ref\":\"#/definitions/LanguageId\"},\"type\":\"array\"}]},\"OverrideSettings\":{\"additionalProperties\":false,\"properties\":{\"allowCompoundWords\":{\"default\":false,\"description\":\"True to enable compound word checking.\",\"markdownDescription\":\"True to enable compound word checking.\",\"type\":\"boolean\"},\"caseSensitive\":{\"default\":false,\"description\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"markdownDescription\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word.\\n Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"type\":\"boolean\"},\"description\":{\"description\":\"Optional description of configuration.\",\"markdownDescription\":\"Optional description of configuration.\",\"type\":\"string\"},\"dictionaries\":{\"description\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"type\":\"array\"},\"dictionaryDefinitions\":{\"description\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json \\\"dictionaryDefinitions\\\": [ { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"} ], \\\"dictionaries\\\": [\\\"custom-words\\\"] ```\",\"items\":{\"$ref\":\"#/definitions/DictionaryDefinition\"},\"markdownDescription\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json\\n\\\"dictionaryDefinitions\\\": [\\n { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"}\\n],\\n\\\"dictionaries\\\": [\\\"custom-words\\\"]\\n```\",\"type\":\"array\"},\"enableFiletypes\":{\"description\":\"Enable / Disable checking file types (languageIds).\\n\\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\\n\\n\\n**Example: individual file types**\\n\\n``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```\\n\\n**Example: enable all file types**\\n\\n```\\n* // enable checking for all file types !json // except for json ```\",\"items\":{\"$ref\":\"#/definitions/LanguageIdSingle\"},\"markdownDescription\":\"Enable / Disable checking file types (languageIds).\\n\\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } .\\nTo disable a language, prefix with `!` as in `!json`,\\n\\n\\n**Example: individual file types**\\n\\n```\\njsonc // enable checking for jsonc\\n!json // disable checking for json\\nkotlin // enable checking for kotlin\\n```\\n\\n**Example: enable all file types**\\n\\n```\\n* // enable checking for all file types\\n!json // except for json\\n```\",\"scope\":\"resource\",\"title\":\"Enable File Types\",\"type\":\"array\",\"uniqueItems\":true},\"enabled\":{\"default\":true,\"description\":\"Is the spell checker enabled.\",\"markdownDescription\":\"Is the spell checker enabled.\",\"type\":\"boolean\"},\"enabledFileTypes\":{\"additionalProperties\":{\"type\":\"boolean\"},\"description\":\"Enable / Disable checking file types (languageIds).\\n\\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\\n\\nA Value of:\\n- `true` - enable checking for the file type\\n- `false` - disable checking for the file type\\n\\nA file type of `*` is a wildcard that enables all file types.\\n\\n**Example: enable all file types**\\n\\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |\",\"markdownDescription\":\"Enable / Disable checking file types (languageIds).\\n\\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\\n\\nA Value of:\\n- `true` - enable checking for the file type\\n- `false` - disable checking for the file type\\n\\nA file type of `*` is a wildcard that enables all file types.\\n\\n**Example: enable all file types**\\n\\n| File Type | Enabled | Comment |\\n| --------- | ------- | ------- |\\n| `*` | `true` | Enable all file types. |\\n| `json` | `false` | Disable checking for json files. |\",\"since\":\"8.8.1\",\"title\":\"Enabled File Types to Check\",\"type\":\"object\"},\"enabledLanguageIds\":{\"description\":\"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.\",\"items\":{\"$ref\":\"#/definitions/LanguageIdSingle\"},\"markdownDescription\":\"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.\",\"title\":\"Enabled Language Ids\",\"type\":\"array\",\"uniqueItems\":true},\"filename\":{\"anyOf\":[{\"$ref\":\"#/definitions/Glob\"},{\"items\":{\"$ref\":\"#/definitions/Glob\"},\"type\":\"array\"}],\"description\":\"Glob pattern or patterns to match against.\",\"markdownDescription\":\"Glob pattern or patterns to match against.\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"id\":{\"description\":\"Optional identifier.\",\"markdownDescription\":\"Optional identifier.\",\"type\":\"string\"},\"ignoreRandomStrings\":{\"default\":true,\"description\":\"Ignore sequences of characters that look like random strings.\",\"markdownDescription\":\"Ignore sequences of characters that look like random strings.\",\"type\":\"boolean\"},\"ignoreRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON ```json \\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"] ```\\n\\nYAML ```yaml ignoreRegExpList: - >- /\\\\b[A-Z]+\\\\b/g ```\\n\\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON\\n```json\\n\\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"]\\n```\\n\\nYAML\\n```yaml\\nignoreRegExpList:\\n - >-\\n /\\\\b[A-Z]+\\\\b/g\\n```\\n\\nBy default, several patterns are excluded. See\\n[Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"includeRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"language\":{\"$ref\":\"#/definitions/LocaleId\",\"description\":\"Sets the locale.\",\"markdownDescription\":\"Sets the locale.\"},\"languageId\":{\"$ref\":\"#/definitions/MatchingFileType\",\"description\":\"Sets the programming language id to match file type.\",\"markdownDescription\":\"Sets the programming language id to match file type.\"},\"languageSettings\":{\"description\":\"Additional settings for individual languages.\\n\\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.\",\"items\":{\"$ref\":\"#/definitions/LanguageSetting\"},\"markdownDescription\":\"Additional settings for individual languages.\\n\\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.\",\"type\":\"array\"},\"loadDefaultConfiguration\":{\"default\":true,\"description\":\"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.\",\"markdownDescription\":\"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\\nwill prevent ALL default configuration from being loaded.\",\"type\":\"boolean\"},\"maxDuplicateProblems\":{\"default\":5,\"description\":\"The maximum number of times the same word can be flagged as an error in a file.\",\"markdownDescription\":\"The maximum number of times the same word can be flagged as an error in a file.\",\"type\":\"number\"},\"maxNumberOfProblems\":{\"default\":10000,\"description\":\"The maximum number of problems to report in a file.\",\"markdownDescription\":\"The maximum number of problems to report in a file.\",\"type\":\"number\"},\"minRandomLength\":{\"default\":40,\"description\":\"The minimum length of a random string to be ignored.\",\"markdownDescription\":\"The minimum length of a random string to be ignored.\",\"type\":\"number\"},\"minWordLength\":{\"default\":4,\"description\":\"The minimum length of a word before checking it against a dictionary.\",\"markdownDescription\":\"The minimum length of a word before checking it against a dictionary.\",\"type\":\"number\"},\"name\":{\"description\":\"Optional name of configuration.\",\"markdownDescription\":\"Optional name of configuration.\",\"type\":\"string\"},\"noSuggestDictionaries\":{\"description\":\"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries that will not be used for suggestions.\\nWords in these dictionaries are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\none of these dictionaries, it will be removed from the set of\\npossible suggestions.\",\"type\":\"array\"},\"numSuggestions\":{\"default\":10,\"description\":\"Number of suggestions to make.\",\"markdownDescription\":\"Number of suggestions to make.\",\"type\":\"number\"},\"patterns\":{\"description\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript \\\"ignoreRegExpList\\\": [\\\"comments\\\"], \\\"patterns\\\": [ { \\\"name\\\": \\\"comment-single-line\\\", \\\"pattern\\\": \\\"/#.*/g\\\" }, { \\\"name\\\": \\\"comment-multi-line\\\", \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\" }, // You can also combine multiple named patterns into one single named pattern { \\\"name\\\": \\\"comments\\\", \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"] } ] ```\",\"items\":{\"$ref\":\"#/definitions/RegExpPatternDefinition\"},\"markdownDescription\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\\n {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript\\n\\\"ignoreRegExpList\\\": [\\\"comments\\\"],\\n\\\"patterns\\\": [\\n {\\n \\\"name\\\": \\\"comment-single-line\\\",\\n \\\"pattern\\\": \\\"/#.*/g\\\"\\n },\\n {\\n \\\"name\\\": \\\"comment-multi-line\\\",\\n \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\"\\n },\\n // You can also combine multiple named patterns into one single named pattern\\n {\\n \\\"name\\\": \\\"comments\\\",\\n \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"]\\n }\\n]\\n```\",\"type\":\"array\"},\"pnpFiles\":{\"default\":[\".pnp.js\",\".pnp.cjs\"],\"description\":\"The PnP files to search for. Note: `.mjs` files are not currently supported.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"The PnP files to search for. Note: `.mjs` files are not currently supported.\",\"type\":\"array\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"suggestionNumChanges\":{\"default\":3,\"description\":\"The maximum number of changes allowed on a word to be considered a suggestions.\\n\\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\\n\\nRange: between 1 and 5.\",\"markdownDescription\":\"The maximum number of changes allowed on a word to be considered a suggestions.\\n\\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\\n\\nRange: between 1 and 5.\",\"type\":\"number\"},\"suggestionsTimeout\":{\"default\":500,\"description\":\"The maximum amount of time in milliseconds to generate suggestions for a word.\",\"markdownDescription\":\"The maximum amount of time in milliseconds to generate suggestions for a word.\",\"type\":\"number\"},\"unknownWords\":{\"$ref\":\"#/definitions/UnknownWordsChoices\",\"default\":\"report-all\",\"description\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"markdownDescription\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"since\":\"9.1.0\"},\"usePnP\":{\"default\":false,\"description\":\"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\\n\\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.\",\"markdownDescription\":\"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\\npackages stored in the repository.\\n\\nWhen true, the spell checker will search up the directory structure for the existence\\nof a PnP file and load it.\",\"type\":\"boolean\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"required\":[\"filename\"],\"type\":\"object\"},\"Pattern\":{\"type\":\"string\"},\"PatternAdjustment\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"description\":\"Id of the Adjustment, i.e. `short-compound`\",\"markdownDescription\":\"Id of the Adjustment, i.e. `short-compound`\",\"type\":\"string\"},\"penalty\":{\"description\":\"The amount of penalty to apply.\",\"markdownDescription\":\"The amount of penalty to apply.\",\"type\":\"number\"},\"regexp\":{\"description\":\"RegExp pattern to match\",\"markdownDescription\":\"RegExp pattern to match\",\"type\":\"string\"}},\"required\":[\"id\",\"regexp\",\"penalty\"],\"type\":\"object\"},\"PatternId\":{\"description\":\"This matches the name in a pattern definition.\",\"markdownDescription\":\"This matches the name in a pattern definition.\",\"type\":\"string\"},\"PatternRef\":{\"anyOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"$ref\":\"#/definitions/PatternId\"},{\"$ref\":\"#/definitions/PredefinedPatterns\"}],\"description\":\"A PatternRef is a Pattern or PatternId.\",\"markdownDescription\":\"A PatternRef is a Pattern or PatternId.\"},\"PredefinedPatterns\":{\"enum\":[\"Base64\",\"Base64MultiLine\",\"Base64SingleLine\",\"CStyleComment\",\"CStyleHexValue\",\"CSSHexValue\",\"CommitHash\",\"CommitHashLink\",\"Email\",\"EscapeCharacters\",\"HexValues\",\"href\",\"PhpHereDoc\",\"PublicKey\",\"RsaCert\",\"SshRsa\",\"SHA\",\"HashStrings\",\"SpellCheckerDisable\",\"SpellCheckerDisableBlock\",\"SpellCheckerDisableLine\",\"SpellCheckerDisableNext\",\"SpellCheckerIgnoreInDocSetting\",\"string\",\"UnicodeRef\",\"Urls\",\"UUID\",\"Everything\"],\"type\":\"string\"},\"RegExpPatternDefinition\":{\"additionalProperties\":false,\"properties\":{\"description\":{\"description\":\"Description of the pattern.\",\"markdownDescription\":\"Description of the pattern.\",\"type\":\"string\"},\"name\":{\"$ref\":\"#/definitions/PatternId\",\"description\":\"Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.\",\"markdownDescription\":\"Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.\\nIt is possible to redefine one of the predefined patterns to override its value.\"},\"pattern\":{\"anyOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"items\":{\"$ref\":\"#/definitions/Pattern\"},\"type\":\"array\"}],\"description\":\"RegExp pattern or array of RegExp patterns.\",\"markdownDescription\":\"RegExp pattern or array of RegExp patterns.\"}},\"required\":[\"name\",\"pattern\"],\"type\":\"object\"},\"RegExpPatternList\":{\"description\":\"A list of pattern names or regular expressions.\",\"items\":{\"$ref\":\"#/definitions/PatternRef\"},\"markdownDescription\":\"A list of pattern names or regular expressions.\",\"type\":\"array\"},\"ReplaceEntry\":{\"items\":{\"type\":\"string\"},\"maxItems\":2,\"minItems\":2,\"type\":\"array\"},\"ReplaceMap\":{\"items\":{\"$ref\":\"#/definitions/ReplaceEntry\"},\"type\":\"array\"},\"ReporterModuleName\":{\"description\":\"The module or path to the the reporter to load.\",\"markdownDescription\":\"The module or path to the the reporter to load.\",\"type\":\"string\"},\"ReporterOptions\":{\"$ref\":\"#/definitions/Serializable\",\"description\":\"Options to send to the reporter. These are defined by the reporter.\",\"markdownDescription\":\"Options to send to the reporter. These are defined by the reporter.\"},\"ReporterSettings\":{\"anyOf\":[{\"$ref\":\"#/definitions/ReporterModuleName\"},{\"items\":{\"$ref\":\"#/definitions/ReporterModuleName\",\"title\":\"name\"},\"maxItems\":1,\"minItems\":1,\"type\":\"array\"},{\"items\":[{\"$ref\":\"#/definitions/ReporterModuleName\",\"title\":\"name\"},{\"$ref\":\"#/definitions/ReporterOptions\",\"title\":\"options\"}],\"maxItems\":2,\"minItems\":2,\"type\":\"array\"}],\"description\":\"Declare a reporter to use.\\n\\n`default` - is a special name for the default cli reporter.\\n\\nExamples:\\n- `\\\"default\\\"` - to use the default reporter\\n- `\\\"@cspell/cspell-json-reporter\\\"` - use the cspell JSON reporter.\\n- `[\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]`\",\"markdownDescription\":\"Declare a reporter to use.\\n\\n`default` - is a special name for the default cli reporter.\\n\\nExamples:\\n- `\\\"default\\\"` - to use the default reporter\\n- `\\\"@cspell/cspell-json-reporter\\\"` - use the cspell JSON reporter.\\n- `[\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]`\"},\"Serializable\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"object\"}]},\"SimpleGlob\":{\"description\":\"Simple Glob string, the root will be globRoot.\",\"markdownDescription\":\"Simple Glob string, the root will be globRoot.\",\"type\":\"string\"},\"SuggestionCostMapDef\":{\"anyOf\":[{\"$ref\":\"#/definitions/CostMapDefReplace\"},{\"$ref\":\"#/definitions/CostMapDefInsDel\"},{\"$ref\":\"#/definitions/CostMapDefSwap\"}],\"description\":\"A WeightedMapDef enables setting weights for edits between related characters and substrings.\\n\\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\\n\\nFor example, in some languages, some letters sound alike.\\n\\n```yaml map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```\\n\\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml map: 'aeiouy' insDel: 50 # Make it is cheaper to insert or delete a vowel. replace: 45 # It is even cheaper to replace one with another. ```\\n\\nNote: the default edit distance is 100.\",\"markdownDescription\":\"A WeightedMapDef enables setting weights for edits between related characters and substrings.\\n\\nMultiple groups can be defined using a `|`.\\nA multi-character substring is defined using `()`.\\n\\nFor example, in some languages, some letters sound alike.\\n\\n```yaml\\n map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.\\n replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`.\\n```\\n\\nThe following could be used to make inserting, removing, or replacing vowels cheaper.\\n```yaml\\n map: 'aeiouy'\\n insDel: 50 # Make it is cheaper to insert or delete a vowel.\\n replace: 45 # It is even cheaper to replace one with another.\\n```\\n\\nNote: the default edit distance is 100.\"},\"SuggestionCostsDefs\":{\"items\":{\"$ref\":\"#/definitions/SuggestionCostMapDef\"},\"type\":\"array\"},\"UnknownWordsChoices\":{\"description\":\"Possible choices for how to handle unknown words.\",\"enum\":[\"report-all\",\"report-simple\",\"report-common-typos\",\"report-flagged\"],\"markdownDescription\":\"Possible choices for how to handle unknown words.\",\"type\":\"string\"},\"Version\":{\"anyOf\":[{\"$ref\":\"#/definitions/VersionLatest\"},{\"$ref\":\"#/definitions/VersionLegacy\"}]},\"VersionLatest\":{\"const\":\"0.2\",\"description\":\"Configuration File Version.\",\"markdownDescription\":\"Configuration File Version.\",\"type\":\"string\"},\"VersionLegacy\":{\"const\":\"0.1\",\"deprecated\":true,\"deprecationMessage\":\"Use `0.2` instead.\",\"description\":\"Legacy Configuration File Versions.\",\"markdownDescription\":\"Legacy Configuration File Versions.\",\"type\":\"string\"}},\"properties\":{\"$schema\":{\"default\":\"https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json\",\"description\":\"Url to JSON Schema\",\"markdownDescription\":\"Url to JSON Schema\",\"type\":\"string\"},\"allowCompoundWords\":{\"default\":false,\"description\":\"True to enable compound word checking.\",\"markdownDescription\":\"True to enable compound word checking.\",\"type\":\"boolean\"},\"cache\":{\"$ref\":\"#/definitions/CacheSettings\",\"description\":\"Define cache settings.\",\"markdownDescription\":\"Define cache settings.\"},\"caseSensitive\":{\"default\":false,\"description\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"markdownDescription\":\"Determines if words must match case and accent rules.\\n\\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\\n\\n- `false` - Case is ignored and accents can be missing on the entire word.\\n Incorrect accents or partially missing accents will be marked as incorrect.\\n- `true` - Case and accents are enforced.\",\"type\":\"boolean\"},\"description\":{\"description\":\"Optional description of configuration.\",\"markdownDescription\":\"Optional description of configuration.\",\"type\":\"string\"},\"dictionaries\":{\"description\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\\n\\nTo remove a dictionary from the list, add `!` before the name.\\n\\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\\n\\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.\",\"type\":\"array\"},\"dictionaryDefinitions\":{\"description\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json \\\"dictionaryDefinitions\\\": [ { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"} ], \\\"dictionaries\\\": [\\\"custom-words\\\"] ```\",\"items\":{\"$ref\":\"#/definitions/DictionaryDefinition\"},\"markdownDescription\":\"Define additional available dictionaries.\\n\\nFor example, you can use the following to add a custom dictionary:\\n\\n```json\\n\\\"dictionaryDefinitions\\\": [\\n { \\\"name\\\": \\\"custom-words\\\", \\\"path\\\": \\\"./custom-words.txt\\\"}\\n],\\n\\\"dictionaries\\\": [\\\"custom-words\\\"]\\n```\",\"type\":\"array\"},\"enableFiletypes\":{\"description\":\"Enable / Disable checking file types (languageIds).\\n\\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\\n\\n\\n**Example: individual file types**\\n\\n``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```\\n\\n**Example: enable all file types**\\n\\n```\\n* // enable checking for all file types !json // except for json ```\",\"items\":{\"$ref\":\"#/definitions/LanguageIdSingle\"},\"markdownDescription\":\"Enable / Disable checking file types (languageIds).\\n\\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } .\\nTo disable a language, prefix with `!` as in `!json`,\\n\\n\\n**Example: individual file types**\\n\\n```\\njsonc // enable checking for jsonc\\n!json // disable checking for json\\nkotlin // enable checking for kotlin\\n```\\n\\n**Example: enable all file types**\\n\\n```\\n* // enable checking for all file types\\n!json // except for json\\n```\",\"scope\":\"resource\",\"title\":\"Enable File Types\",\"type\":\"array\",\"uniqueItems\":true},\"enableGlobDot\":{\"default\":false,\"description\":\"Enable scanning files and directories beginning with `.` (period).\\n\\nBy default, CSpell does not scan `hidden` files.\",\"markdownDescription\":\"Enable scanning files and directories beginning with `.` (period).\\n\\nBy default, CSpell does not scan `hidden` files.\",\"type\":\"boolean\"},\"enabled\":{\"default\":true,\"description\":\"Is the spell checker enabled.\",\"markdownDescription\":\"Is the spell checker enabled.\",\"type\":\"boolean\"},\"enabledFileTypes\":{\"additionalProperties\":{\"type\":\"boolean\"},\"description\":\"Enable / Disable checking file types (languageIds).\\n\\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\\n\\nA Value of:\\n- `true` - enable checking for the file type\\n- `false` - disable checking for the file type\\n\\nA file type of `*` is a wildcard that enables all file types.\\n\\n**Example: enable all file types**\\n\\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |\",\"markdownDescription\":\"Enable / Disable checking file types (languageIds).\\n\\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\\n\\nA Value of:\\n- `true` - enable checking for the file type\\n- `false` - disable checking for the file type\\n\\nA file type of `*` is a wildcard that enables all file types.\\n\\n**Example: enable all file types**\\n\\n| File Type | Enabled | Comment |\\n| --------- | ------- | ------- |\\n| `*` | `true` | Enable all file types. |\\n| `json` | `false` | Disable checking for json files. |\",\"since\":\"8.8.1\",\"title\":\"Enabled File Types to Check\",\"type\":\"object\"},\"enabledLanguageIds\":{\"description\":\"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.\",\"items\":{\"$ref\":\"#/definitions/LanguageIdSingle\"},\"markdownDescription\":\"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.\",\"title\":\"Enabled Language Ids\",\"type\":\"array\",\"uniqueItems\":true},\"failFast\":{\"default\":false,\"description\":\"Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)\",\"markdownDescription\":\"Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)\",\"type\":\"boolean\"},\"features\":{\"$ref\":\"#/definitions/Features\",\"description\":\"Configure CSpell features.\",\"markdownDescription\":\"Configure CSpell features.\",\"since\":\"5.16.0\"},\"files\":{\"description\":\"Glob patterns of files to be checked.\\n\\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.\",\"items\":{\"$ref\":\"#/definitions/Glob\"},\"markdownDescription\":\"Glob patterns of files to be checked.\\n\\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.\",\"type\":\"array\"},\"flagWords\":{\"description\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample: ```ts \\\"flagWords\\\": [ \\\"color: colour\\\", \\\"incase: in case, encase\\\", \\\"canot->cannot\\\", \\\"cancelled->canceled\\\" ] ```\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\\n\\nFormat of `flagWords`\\n- single word entry - `word`\\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\\n\\nExample:\\n```ts\\n\\\"flagWords\\\": [\\n \\\"color: colour\\\",\\n \\\"incase: in case, encase\\\",\\n \\\"canot->cannot\\\",\\n \\\"cancelled->canceled\\\"\\n]\\n```\",\"type\":\"array\"},\"gitignoreRoot\":{\"anyOf\":[{\"$ref\":\"#/definitions/FsPath\"},{\"items\":{\"$ref\":\"#/definitions/FsPath\"},\"type\":\"array\"}],\"description\":\"Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root.\",\"markdownDescription\":\"Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root.\"},\"globRoot\":{\"$ref\":\"#/definitions/FSPathResolvable\",\"description\":\"The root to use for glob patterns found in this configuration. Default: location of the configuration file. For compatibility reasons, config files with version 0.1, the glob root will default to be `${cwd}`.\\n\\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\\n\\nSpecial Values:\\n- `${cwd}` - will be replaced with the current working directory.\\n- `.` - will be the location of the containing configuration file.\",\"markdownDescription\":\"The root to use for glob patterns found in this configuration.\\nDefault: location of the configuration file.\\n For compatibility reasons, config files with version 0.1, the glob root will\\n default to be `${cwd}`.\\n\\nUse `globRoot` to define a different location.\\n`globRoot` can be relative to the location of this configuration file.\\nDefining globRoot, does not impact imported configurations.\\n\\nSpecial Values:\\n- `${cwd}` - will be replaced with the current working directory.\\n- `.` - will be the location of the containing configuration file.\"},\"id\":{\"description\":\"Optional identifier.\",\"markdownDescription\":\"Optional identifier.\",\"type\":\"string\"},\"ignorePaths\":{\"description\":\"Glob patterns of files to be ignored.\\n\\nGlob patterns are relative to the {@link globRoot } of the configuration file that defines them.\",\"items\":{\"$ref\":\"#/definitions/Glob\"},\"markdownDescription\":\"Glob patterns of files to be ignored.\\n\\nGlob patterns are relative to the {@link globRoot } of the configuration file that defines them.\",\"type\":\"array\"},\"ignoreRandomStrings\":{\"default\":true,\"description\":\"Ignore sequences of characters that look like random strings.\",\"markdownDescription\":\"Ignore sequences of characters that look like random strings.\",\"type\":\"boolean\"},\"ignoreRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON ```json \\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"] ```\\n\\nYAML ```yaml ignoreRegExpList: - >- /\\\\b[A-Z]+\\\\b/g ```\\n\\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or pattern names to exclude from spell checking.\\n\\nExample: `[\\\"href\\\"]` - to exclude html href pattern.\\n\\nRegular expressions use JavaScript regular expression syntax.\\n\\nExample: to ignore ALL-CAPS words\\n\\nJSON\\n```json\\n\\\"ignoreRegExpList\\\": [\\\"/\\\\\\\\b[A-Z]+\\\\\\\\b/g\\\"]\\n```\\n\\nYAML\\n```yaml\\nignoreRegExpList:\\n - >-\\n /\\\\b[A-Z]+\\\\b/g\\n```\\n\\nBy default, several patterns are excluded. See\\n[Configuration](https://cspell.org/configuration/patterns) for more details.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"ignoreWords\":{\"description\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be ignored. An ignored word will not show up as an error, even if it is\\nalso in the `flagWords`.\",\"type\":\"array\"},\"import\":{\"anyOf\":[{\"$ref\":\"#/definitions/FsPath\"},{\"items\":{\"$ref\":\"#/definitions/FsPath\"},\"type\":\"array\"}],\"description\":\"Allows this configuration to inherit configuration for one or more other files.\\n\\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.\",\"markdownDescription\":\"Allows this configuration to inherit configuration for one or more other files.\\n\\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.\"},\"includeRegExpList\":{\"$ref\":\"#/definitions/RegExpPatternList\",\"description\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\",\"markdownDescription\":\"List of regular expression patterns or defined pattern names to match for spell checking.\\n\\nIf this property is defined, only text matching the included patterns will be checked.\\n\\nWhile you can create your own patterns, you can also leverage several patterns that are\\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).\"},\"language\":{\"$ref\":\"#/definitions/LocaleId\",\"default\":\"en\",\"description\":\"Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\\n\\nFor example:\\n\\n- \\\"en-GB\\\" for British English.\\n- \\\"en,nl\\\" to enable both English and Dutch.\",\"markdownDescription\":\"Current active spelling language. This specifies the language locale to use in choosing the\\ngeneral dictionary.\\n\\nFor example:\\n\\n- \\\"en-GB\\\" for British English.\\n- \\\"en,nl\\\" to enable both English and Dutch.\"},\"languageId\":{\"$ref\":\"#/definitions/MatchingFileType\",\"description\":\"Forces the spell checker to assume a give language id. Used mainly as an Override.\",\"markdownDescription\":\"Forces the spell checker to assume a give language id. Used mainly as an Override.\"},\"languageSettings\":{\"description\":\"Additional settings for individual languages.\\n\\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.\",\"items\":{\"$ref\":\"#/definitions/LanguageSetting\"},\"markdownDescription\":\"Additional settings for individual languages.\\n\\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.\",\"type\":\"array\"},\"loadDefaultConfiguration\":{\"default\":true,\"description\":\"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.\",\"markdownDescription\":\"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\\nwill prevent ALL default configuration from being loaded.\",\"type\":\"boolean\"},\"maxDuplicateProblems\":{\"default\":5,\"description\":\"The maximum number of times the same word can be flagged as an error in a file.\",\"markdownDescription\":\"The maximum number of times the same word can be flagged as an error in a file.\",\"type\":\"number\"},\"maxNumberOfProblems\":{\"default\":10000,\"description\":\"The maximum number of problems to report in a file.\",\"markdownDescription\":\"The maximum number of problems to report in a file.\",\"type\":\"number\"},\"minRandomLength\":{\"default\":40,\"description\":\"The minimum length of a random string to be ignored.\",\"markdownDescription\":\"The minimum length of a random string to be ignored.\",\"type\":\"number\"},\"minWordLength\":{\"default\":4,\"description\":\"The minimum length of a word before checking it against a dictionary.\",\"markdownDescription\":\"The minimum length of a word before checking it against a dictionary.\",\"type\":\"number\"},\"name\":{\"description\":\"Optional name of configuration.\",\"markdownDescription\":\"Optional name of configuration.\",\"type\":\"string\"},\"noConfigSearch\":{\"default\":false,\"description\":\"Prevents searching for local configuration when checking individual documents.\",\"markdownDescription\":\"Prevents searching for local configuration when checking individual documents.\",\"type\":\"boolean\"},\"noSuggestDictionaries\":{\"description\":\"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.\",\"items\":{\"$ref\":\"#/definitions/DictionaryReference\"},\"markdownDescription\":\"Optional list of dictionaries that will not be used for suggestions.\\nWords in these dictionaries are considered correct, but will not be\\nused when making spell correction suggestions.\\n\\nNote: if a word is suggested by another dictionary, but found in\\none of these dictionaries, it will be removed from the set of\\npossible suggestions.\",\"type\":\"array\"},\"numSuggestions\":{\"default\":10,\"description\":\"Number of suggestions to make.\",\"markdownDescription\":\"Number of suggestions to make.\",\"type\":\"number\"},\"overrides\":{\"description\":\"Overrides are used to apply settings for specific files in your project.\\n\\nFor example:\\n\\n```javascript \\\"overrides\\\": [ // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: { \\\"filename\\\": \\\"**/{*.hrr,*.crr}\\\", \\\"languageId\\\": \\\"cpp\\\" }, // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately): { \\\"language\\\": \\\"nl\\\", \\\"filename\\\": \\\"**/dutch/**/*.txt\\\" } ] ```\",\"items\":{\"$ref\":\"#/definitions/OverrideSettings\"},\"markdownDescription\":\"Overrides are used to apply settings for specific files in your project.\\n\\nFor example:\\n\\n```javascript\\n\\\"overrides\\\": [\\n // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:\\n {\\n \\\"filename\\\": \\\"**/{*.hrr,*.crr}\\\",\\n \\\"languageId\\\": \\\"cpp\\\"\\n },\\n // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):\\n {\\n \\\"language\\\": \\\"nl\\\",\\n \\\"filename\\\": \\\"**/dutch/**/*.txt\\\"\\n }\\n]\\n```\",\"type\":\"array\"},\"patterns\":{\"description\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript \\\"ignoreRegExpList\\\": [\\\"comments\\\"], \\\"patterns\\\": [ { \\\"name\\\": \\\"comment-single-line\\\", \\\"pattern\\\": \\\"/#.*/g\\\" }, { \\\"name\\\": \\\"comment-multi-line\\\", \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\" }, // You can also combine multiple named patterns into one single named pattern { \\\"name\\\": \\\"comments\\\", \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"] } ] ```\",\"items\":{\"$ref\":\"#/definitions/RegExpPatternDefinition\"},\"markdownDescription\":\"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\\n {@link includeRegExpList } options.\\n\\nFor example:\\n\\n```javascript\\n\\\"ignoreRegExpList\\\": [\\\"comments\\\"],\\n\\\"patterns\\\": [\\n {\\n \\\"name\\\": \\\"comment-single-line\\\",\\n \\\"pattern\\\": \\\"/#.*/g\\\"\\n },\\n {\\n \\\"name\\\": \\\"comment-multi-line\\\",\\n \\\"pattern\\\": \\\"/(?:\\\\\\\\/\\\\\\\\*[\\\\\\\\s\\\\\\\\S]*?\\\\\\\\*\\\\\\\\/)/g\\\"\\n },\\n // You can also combine multiple named patterns into one single named pattern\\n {\\n \\\"name\\\": \\\"comments\\\",\\n \\\"pattern\\\": [\\\"comment-single-line\\\", \\\"comment-multi-line\\\"]\\n }\\n]\\n```\",\"type\":\"array\"},\"pnpFiles\":{\"default\":[\".pnp.js\",\".pnp.cjs\"],\"description\":\"The PnP files to search for. Note: `.mjs` files are not currently supported.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"The PnP files to search for. Note: `.mjs` files are not currently supported.\",\"type\":\"array\"},\"readonly\":{\"default\":false,\"description\":\"Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.\",\"markdownDescription\":\"Indicate that the configuration file should not be modified.\\nThis is used to prevent tools like the VS Code Spell Checker from\\nmodifying the file to add words and other configuration.\",\"type\":\"boolean\"},\"reporters\":{\"default\":[\"default\"],\"description\":\"Define which reports to use. `default` - is a special name for the default cli reporter.\\n\\nExamples:\\n- `[\\\"default\\\"]` - to use the default reporter\\n- `[\\\"@cspell/cspell-json-reporter\\\"]` - use the cspell JSON reporter.\\n- `[[\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]]`\\n- `[ \\\"default\\\", [\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]]` - Use both the default reporter and the cspell-json-reporter.\",\"items\":{\"$ref\":\"#/definitions/ReporterSettings\"},\"markdownDescription\":\"Define which reports to use.\\n`default` - is a special name for the default cli reporter.\\n\\nExamples:\\n- `[\\\"default\\\"]` - to use the default reporter\\n- `[\\\"@cspell/cspell-json-reporter\\\"]` - use the cspell JSON reporter.\\n- `[[\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]]`\\n- `[ \\\"default\\\", [\\\"@cspell/cspell-json-reporter\\\", { \\\"outFile\\\": \\\"out.json\\\" }]]` - Use both the default reporter and the cspell-json-reporter.\",\"type\":\"array\"},\"showStatus\":{\"deprecated\":true,\"description\":\"Show status.\",\"markdownDescription\":\"Show status.\",\"type\":\"boolean\"},\"spellCheckDelayMs\":{\"deprecated\":true,\"description\":\"Delay in ms after a document has changed before checking it for spelling errors.\",\"markdownDescription\":\"Delay in ms after a document has changed before checking it for spelling errors.\",\"type\":\"number\"},\"suggestWords\":{\"description\":\"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"A list of suggested replacements for words.\\nSuggested words provide a way to make preferred suggestions on word replacements.\\nTo hint at a preferred change, but not to require it.\\n\\nFormat of `suggestWords`\\n- Single suggestion (possible auto fix)\\n - `word: suggestion`\\n - `word->suggestion`\\n- Multiple suggestions (not auto fixable)\\n - `word: first, second, third`\\n - `word->first, second, third`\",\"type\":\"array\"},\"suggestionNumChanges\":{\"default\":3,\"description\":\"The maximum number of changes allowed on a word to be considered a suggestions.\\n\\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\\n\\nRange: between 1 and 5.\",\"markdownDescription\":\"The maximum number of changes allowed on a word to be considered a suggestions.\\n\\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\\n\\nRange: between 1 and 5.\",\"type\":\"number\"},\"suggestionsTimeout\":{\"default\":500,\"description\":\"The maximum amount of time in milliseconds to generate suggestions for a word.\",\"markdownDescription\":\"The maximum amount of time in milliseconds to generate suggestions for a word.\",\"type\":\"number\"},\"unknownWords\":{\"$ref\":\"#/definitions/UnknownWordsChoices\",\"default\":\"report-all\",\"description\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"markdownDescription\":\"Controls how unknown words are handled.\\n\\n- `report-all` - Report all unknown words (default behavior)\\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\\n- `report-flagged` - Report unknown words that are flagged.\",\"since\":\"9.1.0\"},\"useGitignore\":{\"default\":false,\"description\":\"Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.\",\"markdownDescription\":\"Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.\",\"type\":\"boolean\"},\"usePnP\":{\"default\":false,\"description\":\"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\\n\\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.\",\"markdownDescription\":\"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\\npackages stored in the repository.\\n\\nWhen true, the spell checker will search up the directory structure for the existence\\nof a PnP file and load it.\",\"type\":\"boolean\"},\"userWords\":{\"description\":\"Words to add to global dictionary -- should only be in the user config file.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"Words to add to global dictionary -- should only be in the user config file.\",\"type\":\"array\"},\"validateDirectives\":{\"description\":\"Verify that the in-document directives are correct.\",\"markdownDescription\":\"Verify that the in-document directives are correct.\",\"type\":\"boolean\"},\"version\":{\"$ref\":\"#/definitions/Version\",\"default\":\"0.2\",\"description\":\"Configuration format version of the settings file.\\n\\nThis controls how the settings in the configuration file behave.\",\"markdownDescription\":\"Configuration format version of the settings file.\\n\\nThis controls how the settings in the configuration file behave.\"},\"words\":{\"description\":\"List of words to be considered correct.\",\"items\":{\"type\":\"string\"},\"markdownDescription\":\"List of words to be considered correct.\",\"type\":\"array\"}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"cspell.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"allowTrailingCommas":true,"definitions":{"CacheFormat":{"enum":["legacy","universal"],"type":"string"},"CacheSettings":{"additionalProperties":false,"properties":{"cacheFormat":{"$ref":"#/definitions/CacheFormat","default":"universal","description":"Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format.","markdownDescription":"Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format."},"cacheLocation":{"$ref":"#/definitions/FSPathResolvable","description":"Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory.","markdownDescription":"Path to the cache location. Can be a file or a directory.\nIf none specified `.cspellcache` will be used.\nRelative paths are relative to the config file in which it\nis defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."},"cacheStrategy":{"$ref":"#/definitions/CacheStrategy","default":"metadata","description":"Strategy to use for detecting changed files, default: metadata","markdownDescription":"Strategy to use for detecting changed files, default: metadata"},"useCache":{"default":false,"description":"Store the results of processed files in order to only operate on the changed ones.","markdownDescription":"Store the results of processed files in order to only operate on the changed ones.","type":"boolean"}},"type":"object"},"CacheStrategy":{"default":"content","description":"The Strategy to use to detect if a file has changed.\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).\n- `metadata` - uses the file system timestamp and size to detect changes (fastest, may not work in CI).","enum":["content","metadata"],"markdownDescription":"The Strategy to use to detect if a file has changed.\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).\n- `metadata` - uses the file system timestamp and size to detect changes (fastest, may not work in CI).","type":"string"},"CharacterSet":{"description":"This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.","markdownDescription":"This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related.","type":"string"},"CharacterSetCosts":{"additionalProperties":false,"properties":{"characters":{"$ref":"#/definitions/CharacterSet","description":"This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.","markdownDescription":"This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related."},"cost":{"description":"the cost to insert / delete / replace / swap the characters in a group","markdownDescription":"the cost to insert / delete / replace / swap the characters in a group","type":"number"},"penalty":{"description":"The penalty cost to apply if the accent is used. This is used to discourage","markdownDescription":"The penalty cost to apply if the accent is used.\nThis is used to discourage","type":"number"}},"required":["characters","cost"],"type":"object"},"CostMapDefInsDel":{"additionalProperties":false,"properties":{"description":{"description":"A description to describe the purpose of the map.","markdownDescription":"A description to describe the purpose of the map.","type":"string"},"insDel":{"description":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","markdownDescription":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","type":"number"},"map":{"description":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","markdownDescription":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","type":"string"},"penalty":{"description":"Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","markdownDescription":"Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","type":"number"},"replace":{"description":"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","markdownDescription":"The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","type":"number"},"swap":{"description":"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.","markdownDescription":"The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.","type":"number"}},"required":["insDel","map"],"type":"object"},"CostMapDefReplace":{"additionalProperties":false,"properties":{"description":{"description":"A description to describe the purpose of the map.","markdownDescription":"A description to describe the purpose of the map.","type":"string"},"insDel":{"description":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","markdownDescription":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","type":"number"},"map":{"description":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","markdownDescription":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","type":"string"},"penalty":{"description":"Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","markdownDescription":"Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","type":"number"},"replace":{"description":"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","markdownDescription":"The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","type":"number"},"swap":{"description":"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.","markdownDescription":"The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.","type":"number"}},"required":["map","replace"],"type":"object"},"CostMapDefSwap":{"additionalProperties":false,"properties":{"description":{"description":"A description to describe the purpose of the map.","markdownDescription":"A description to describe the purpose of the map.","type":"string"},"insDel":{"description":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","markdownDescription":"The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.","type":"number"},"map":{"description":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","markdownDescription":"The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"e\u00e9\u00ea|a\u00e5\u00e1\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.","type":"string"},"penalty":{"description":"Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","markdownDescription":"Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.","type":"number"},"replace":{"description":"The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","markdownDescription":"The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.","type":"number"},"swap":{"description":"The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.","markdownDescription":"The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.","type":"number"}},"required":["map","swap"],"type":"object"},"CustomDictionaryPath":{"$ref":"#/definitions/FsDictionaryPath","description":"A File System Path to a dictionary file.","markdownDescription":"A File System Path to a dictionary file."},"CustomDictionaryScope":{"description":"Specifies the scope of a dictionary.","enum":["user","workspace","folder"],"markdownDescription":"Specifies the scope of a dictionary.","type":"string"},"DictionaryDefinition":{"anyOf":[{"$ref":"#/definitions/DictionaryDefinitionPreferred"},{"$ref":"#/definitions/DictionaryDefinitionCustom"},{"$ref":"#/definitions/DictionaryDefinitionAugmented"},{"$ref":"#/definitions/DictionaryDefinitionInline"},{"$ref":"#/definitions/DictionaryDefinitionSimple"},{"$ref":"#/definitions/DictionaryDefinitionAlternate"}]},"DictionaryDefinitionAlternate":{"additionalProperties":false,"deprecated":true,"deprecationMessage":"Use {@link DictionaryDefinitionPreferred } instead.","description":"Only for legacy dictionary definitions.","markdownDescription":"Only for legacy dictionary definitions.","properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"file":{"$ref":"#/definitions/DictionaryPath","deprecated":true,"deprecationMessage":"Use `path` instead.","description":"Path to the file, only for legacy dictionary definitions.","markdownDescription":"Path to the file, only for legacy dictionary definitions."},"ignoreForbiddenWords":{"description":"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.","markdownDescription":"Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.","type":"boolean"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"noSuggest":{"description":"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.","markdownDescription":"Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.","type":"boolean"},"repMap":{"$ref":"#/definitions/ReplaceMap","description":"Replacement pairs.","markdownDescription":"Replacement pairs."},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"type":{"$ref":"#/definitions/DictionaryFileTypes","default":"S","description":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.","markdownDescription":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."},"useCompounds":{"description":"Use Compounds.","markdownDescription":"Use Compounds.","type":"boolean"}},"required":["file","name"],"type":"object"},"DictionaryDefinitionAugmented":{"additionalProperties":false,"description":"Used to provide extra data related to the dictionary","markdownDescription":"Used to provide extra data related to the dictionary","properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"dictionaryInformation":{"$ref":"#/definitions/DictionaryInformation"},"ignoreForbiddenWords":{"description":"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.","markdownDescription":"Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.","type":"boolean"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"noSuggest":{"description":"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.","markdownDescription":"Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.","type":"boolean"},"path":{"$ref":"#/definitions/DictionaryPath","description":"Path to the file.","markdownDescription":"Path to the file."},"repMap":{"$ref":"#/definitions/ReplaceMap","description":"Replacement pairs.","markdownDescription":"Replacement pairs."},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"type":{"$ref":"#/definitions/DictionaryFileTypes","default":"S","description":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.","markdownDescription":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."},"useCompounds":{"description":"Use Compounds.","markdownDescription":"Use Compounds.","type":"boolean"}},"required":["name","path"],"type":"object"},"DictionaryDefinitionCustom":{"additionalProperties":false,"description":"For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file.\n\nNote: only plain text files with one word per line are supported at this moment.","markdownDescription":"For Defining Custom dictionaries. They are generally scoped to a\n`user`, `workspace`, or `folder`.\nWhen `addWords` is true, indicates that the spell checker can add words\nto the file.\n\nNote: only plain text files with one word per line are supported at this moment.","properties":{"addWords":{"description":"When `true`, let's the spell checker know that words can be added to this dictionary.","markdownDescription":"When `true`, let's the spell checker know that words can be added to this dictionary.","type":"boolean"},"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"ignoreForbiddenWords":{"description":"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.","markdownDescription":"Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.","type":"boolean"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"noSuggest":{"description":"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.","markdownDescription":"Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.","type":"boolean"},"path":{"$ref":"#/definitions/CustomDictionaryPath","description":"Path to custom dictionary text file.","markdownDescription":"Path to custom dictionary text file."},"repMap":{"$ref":"#/definitions/ReplaceMap","description":"Replacement pairs.","markdownDescription":"Replacement pairs."},"scope":{"anyOf":[{"$ref":"#/definitions/CustomDictionaryScope"},{"items":{"$ref":"#/definitions/CustomDictionaryScope"},"type":"array"}],"description":"Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`.","markdownDescription":"Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"type":{"$ref":"#/definitions/DictionaryFileTypes","default":"S","description":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.","markdownDescription":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."},"useCompounds":{"description":"Use Compounds.","markdownDescription":"Use Compounds.","type":"boolean"}},"required":["addWords","name","path"],"type":"object"},"DictionaryDefinitionInline":{"anyOf":[{"$ref":"#/definitions/DictionaryDefinitionInlineWords"},{"$ref":"#/definitions/DictionaryDefinitionInlineIgnoreWords"},{"$ref":"#/definitions/DictionaryDefinitionInlineFlagWords"},{"$ref":"#/definitions/DictionaryDefinitionInlineSuggestWords"}],"description":"Inline Dictionary Definitions","markdownDescription":"Inline Dictionary Definitions","since":"6.23.0"},"DictionaryDefinitionInlineFlagWords":{"additionalProperties":false,"properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["flagWords","name"],"type":"object"},"DictionaryDefinitionInlineIgnoreWords":{"additionalProperties":false,"properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["ignoreWords","name"],"type":"object"},"DictionaryDefinitionInlineSuggestWords":{"additionalProperties":false,"properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["name","suggestWords"],"type":"object"},"DictionaryDefinitionInlineWords":{"additionalProperties":false,"properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["name","words"],"type":"object"},"DictionaryDefinitionPreferred":{"additionalProperties":false,"properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"ignoreForbiddenWords":{"description":"Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.","markdownDescription":"Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.","type":"boolean"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"noSuggest":{"description":"Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.","markdownDescription":"Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.","type":"boolean"},"path":{"$ref":"#/definitions/DictionaryPath","description":"Path to the file.","markdownDescription":"Path to the file."},"repMap":{"$ref":"#/definitions/ReplaceMap","description":"Replacement pairs.","markdownDescription":"Replacement pairs."},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"},"type":{"$ref":"#/definitions/DictionaryFileTypes","default":"S","description":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.","markdownDescription":"Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files."},"useCompounds":{"description":"Use Compounds.","markdownDescription":"Use Compounds.","type":"boolean"}},"required":["name","path"],"type":"object"},"DictionaryDefinitionSimple":{"additionalProperties":false,"description":"An Empty Dictionary Definition","markdownDescription":"An Empty Dictionary Definition","properties":{"description":{"description":"Optional description of the contents / purpose of the dictionary.","markdownDescription":"Optional description of the contents / purpose of the dictionary.","type":"string"},"name":{"$ref":"#/definitions/DictionaryId","description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."},"supportNonStrictSearches":{"default":true,"description":"Strip case and accents to allow for case insensitive searches and words without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie dictionaries.","markdownDescription":"Strip case and accents to allow for case insensitive searches and\nwords without accents.\n\nNote: this setting only applies to word lists. It has no-impact on trie\ndictionaries.","type":"boolean"}},"required":["name"],"type":"object"},"DictionaryFileTypes":{"enum":["S","W","C","T"],"type":"string"},"DictionaryId":{"description":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","markdownDescription":"This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.","pattern":"^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$","type":"string"},"DictionaryInformation":{"additionalProperties":false,"description":"Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\n\nAdded with `v5.16.0`.","markdownDescription":"Use by dictionary authors to help improve the quality of suggestions\ngiven from the dictionary.\n\nAdded with `v5.16.0`.","properties":{"accents":{"anyOf":[{"$ref":"#/definitions/CharacterSet"},{"items":{"$ref":"#/definitions/CharacterSetCosts"},"type":"array"}],"description":"The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`","markdownDescription":"The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"},"adjustments":{"description":"A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.","items":{"$ref":"#/definitions/PatternAdjustment"},"markdownDescription":"A collection of patterns to test against the suggested words.\nIf the word matches the pattern, then the penalty is applied.","type":"array"},"alphabet":{"anyOf":[{"$ref":"#/definitions/CharacterSet"},{"items":{"$ref":"#/definitions/CharacterSetCosts"},"type":"array"}],"default":"a-zA-Z","description":"The alphabet to use.","markdownDescription":"The alphabet to use."},"costs":{"$ref":"#/definitions/EditCosts","description":"Define edit costs.","markdownDescription":"Define edit costs."},"hunspellInformation":{"$ref":"#/definitions/HunspellInformation","description":"Used by dictionary authors","markdownDescription":"Used by dictionary authors"},"ignore":{"$ref":"#/definitions/CharacterSet","description":"An optional set of characters that can possibly be removed from a word before checking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported.","markdownDescription":"An optional set of characters that can possibly be removed from a word before\nchecking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported."},"locale":{"description":"The locale of the dictionary. Example: `nl,nl-be`","markdownDescription":"The locale of the dictionary.\nExample: `nl,nl-be`","type":"string"},"suggestionEditCosts":{"$ref":"#/definitions/SuggestionCostsDefs","description":"Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.","markdownDescription":"Used in making suggestions. The lower the value, the more likely the suggestion\nwill be near the top of the suggestion list."}},"type":"object"},"DictionaryNegRef":{"description":"This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`. Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`. Overrides `!!<dictionary_name>`.","markdownDescription":"This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.\n Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\n Overrides `!!<dictionary_name>`.","pattern":"^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$","type":"string"},"DictionaryPath":{"description":"A File System Path to a dictionary file. Pattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`","markdownDescription":"A File System Path to a dictionary file.\nPattern: `^.*\\.(?:txt|trie|dic)(?:\\.gz)?$`","type":"string"},"DictionaryRef":{"$ref":"#/definitions/DictionaryId","description":"This a reference to a named dictionary. It is expected to match the name of a dictionary.","markdownDescription":"This a reference to a named dictionary.\nIt is expected to match the name of a dictionary."},"DictionaryReference":{"anyOf":[{"$ref":"#/definitions/DictionaryRef"},{"$ref":"#/definitions/DictionaryNegRef"}],"description":"Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }","markdownDescription":"Reference to a dictionary by name.\nOne of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }"},"EditCosts":{"additionalProperties":false,"properties":{"accentCosts":{"default":1,"description":"The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.","markdownDescription":"The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.","type":"number"},"baseCost":{"default":100,"description":"This is the base cost for making an edit.","markdownDescription":"This is the base cost for making an edit.","type":"number"},"capsCosts":{"default":1,"description":"The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.","markdownDescription":"The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.","type":"number"},"firstLetterPenalty":{"default":4,"description":"The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.","markdownDescription":"The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.","type":"number"},"nonAlphabetCosts":{"default":110,"description":"This is the cost for characters not in the alphabet.","markdownDescription":"This is the cost for characters not in the alphabet.","type":"number"}},"type":"object"},"FSPathResolvable":{"$ref":"#/definitions/FsPath","description":"A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file.","markdownDescription":"A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."},"FeatureEnableOnly":{"type":"boolean"},"Features":{"additionalProperties":false,"description":"Features are behaviors or settings that can be explicitly configured.","markdownDescription":"Features are behaviors or settings that can be explicitly configured.","properties":{"weighted-suggestions":{"$ref":"#/definitions/FeatureEnableOnly","description":"Enable/disable using weighted suggestions.","markdownDescription":"Enable/disable using weighted suggestions."}},"type":"object"},"FsDictionaryPath":{"description":"A File System Path. Relative paths are relative to the configuration file.","markdownDescription":"A File System Path. Relative paths are relative to the configuration file.","type":"string"},"FsPath":{"description":"A File System Path. Relative paths are relative to the configuration file.","markdownDescription":"A File System Path. Relative paths are relative to the configuration file.","type":"string"},"Glob":{"$ref":"#/definitions/SimpleGlob","description":"These are glob expressions.","markdownDescription":"These are glob expressions."},"HunspellInformation":{"additionalProperties":false,"properties":{"aff":{"description":"Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjh\u00e4\u00f5b\u00fco\u00f6fcwzx\u00f0q\u00fe` MAP a\u00e0\u00e2\u00e4A\u00c0\u00c2\u00c4 MAP e\u00e9\u00e8\u00ea\u00ebE\u00c9\u00c8\u00ca\u00cb MAP i\u00ee\u00efyI\u00ce\u00cfY MAP o\u00f4\u00f6O\u00d4\u00d6 MAP (IJ)(\u0132) ```","markdownDescription":"Selected Hunspell AFF content.\nThe content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample:\n```hunspell\n# Comment\nTRY aeistlunkodmrvpgjh\u00e4\u00f5b\u00fco\u00f6fcwzx\u00f0q\u00fe`\nMAP a\u00e0\u00e2\u00e4A\u00c0\u00c2\u00c4\nMAP e\u00e9\u00e8\u00ea\u00ebE\u00c9\u00c8\u00ca\u00cb\nMAP i\u00ee\u00efyI\u00ce\u00cfY\nMAP o\u00f4\u00f6O\u00d4\u00d6\nMAP (IJ)(\u0132)\n```","type":"string"},"costs":{"additionalProperties":false,"description":"The costs to apply when using the hunspell settings","markdownDescription":"The costs to apply when using the hunspell settings","properties":{"accentCosts":{"default":1,"description":"The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.","markdownDescription":"The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.","type":"number"},"baseCost":{"default":100,"description":"This is the base cost for making an edit.","markdownDescription":"This is the base cost for making an edit.","type":"number"},"capsCosts":{"default":1,"description":"The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.","markdownDescription":"The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.","type":"number"},"firstLetterPenalty":{"default":4,"description":"The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.","markdownDescription":"The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.","type":"number"},"ioConvertCost":{"default":30,"description":"The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.","markdownDescription":"The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.","type":"number"},"keyboardCost":{"default":99,"description":"The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.","markdownDescription":"The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.","type":"number"},"mapCost":{"default":25,"description":"mapSet replacement cost is the cost to substitute one character with another from the same set.\n\nMap characters are considered very similar to each other and are often the cause of simple mistakes.","markdownDescription":"mapSet replacement cost is the cost to substitute one character with another from\nthe same set.\n\nMap characters are considered very similar to each other and are often\nthe cause of simple mistakes.","type":"number"},"nonAlphabetCosts":{"default":110,"description":"This is the cost for characters not in the alphabet.","markdownDescription":"This is the cost for characters not in the alphabet.","type":"number"},"replaceCosts":{"default":75,"description":"The cost to substitute pairs found in the replace settings.","markdownDescription":"The cost to substitute pairs found in the replace settings.","type":"number"},"tryCharCost":{"description":"The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`","markdownDescription":"The cost of inserting / deleting / or swapping any `tryChars`\nDefaults to `baseCosts`","type":"number"}},"type":"object"}},"required":["aff"],"type":"object"},"LanguageId":{"anyOf":[{"$ref":"#/definitions/LanguageIdSingle"},{"$ref":"#/definitions/LanguageIdMultiple"},{"$ref":"#/definitions/LanguageIdMultipleNeg"}]},"LanguageIdMultiple":{"description":"A single string with a comma separated list of file types:\n- `typescript,cpp`\n- `json,jsonc,yaml`\n- etc.","markdownDescription":"A single string with a comma separated list of file types:\n- `typescript,cpp`\n- `json,jsonc,yaml`\n- etc.","pattern":"^([-\\w_\\s]+)(,[-\\w_\\s]+)*$","type":"string"},"LanguageIdMultipleNeg":{"description":"A Negative File Type used to exclude files of that type.\n- `!typescript` - will exclude typescript files.\n- `!cpp,!json` - will exclude cpp and json files.\n- `!typescript,javascript` - will exclude typescript files and include javascript files.","markdownDescription":"A Negative File Type used to exclude files of that type.\n- `!typescript` - will exclude typescript files.\n- `!cpp,!json` - will exclude cpp and json files.\n- `!typescript,javascript` - will exclude typescript files and include javascript files.","pattern":"^(![-\\w_\\s]+)(,!?[-\\w_\\s]+)*$","type":"string"},"LanguageIdSingle":{"description":"A file type:\n- `*` - will match ALL file types.\n- `typescript`, `cpp`, `json`, etc.","markdownDescription":"A file type:\n- `*` - will match ALL file types.\n- `typescript`, `cpp`, `json`, etc.","pattern":"^(!?[-\\w_\\s]+)|(\\*)$","type":"string"},"LanguageSetting":{"additionalProperties":false,"properties":{"allowCompoundWords":{"default":false,"description":"True to enable compound word checking.","markdownDescription":"True to enable compound word checking.","type":"boolean"},"caseSensitive":{"default":false,"description":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","markdownDescription":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","type":"boolean"},"description":{"description":"Optional description of configuration.","markdownDescription":"Optional description of configuration.","type":"string"},"dictionaries":{"description":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","type":"array"},"dictionaryDefinitions":{"description":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json \"dictionaryDefinitions\": [ { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"} ], \"dictionaries\": [\"custom-words\"] ```","items":{"$ref":"#/definitions/DictionaryDefinition"},"markdownDescription":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```","type":"array"},"enabled":{"default":true,"description":"Is the spell checker enabled.","markdownDescription":"Is the spell checker enabled.","type":"boolean"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"id":{"description":"Optional identifier.","markdownDescription":"Optional identifier.","type":"string"},"ignoreRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"includeRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"languageId":{"$ref":"#/definitions/MatchingFileType","description":"The language id. Ex: `typescript`, `html`, or `php`. `*` -- will match all languages.","markdownDescription":"The language id. Ex: `typescript`, `html`, or `php`. `*` -- will match all languages."},"local":{"anyOf":[{"$ref":"#/definitions/LocaleId"},{"items":{"$ref":"#/definitions/LocaleId"},"type":"array"}],"deprecated":true,"deprecationMessage":"Use `locale` instead.","description":"Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.","markdownDescription":"Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales."},"locale":{"anyOf":[{"$ref":"#/definitions/LocaleId"},{"items":{"$ref":"#/definitions/LocaleId"},"type":"array"}],"description":"The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.","markdownDescription":"The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales."},"name":{"description":"Optional name of configuration.","markdownDescription":"Optional name of configuration.","type":"string"},"noSuggestDictionaries":{"description":"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.","type":"array"},"patterns":{"description":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ```","items":{"$ref":"#/definitions/RegExpPatternDefinition"},"markdownDescription":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\n {@link includeRegExpList } options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```","type":"array"},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"unknownWords":{"$ref":"#/definitions/UnknownWordsChoices","default":"report-all","description":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","markdownDescription":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","since":"9.1.0"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["languageId"],"type":"object"},"LocaleId":{"description":"This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,fr` for both English and French","markdownDescription":"This is a written language locale like: `en`, `en-GB`, `fr`, `es`, `de` or `en,fr` for both English and French","type":"string"},"MatchingFileType":{"anyOf":[{"$ref":"#/definitions/LanguageId"},{"items":{"$ref":"#/definitions/LanguageId"},"type":"array"}]},"OverrideSettings":{"additionalProperties":false,"properties":{"allowCompoundWords":{"default":false,"description":"True to enable compound word checking.","markdownDescription":"True to enable compound word checking.","type":"boolean"},"caseSensitive":{"default":false,"description":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","markdownDescription":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","type":"boolean"},"description":{"description":"Optional description of configuration.","markdownDescription":"Optional description of configuration.","type":"string"},"dictionaries":{"description":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","type":"array"},"dictionaryDefinitions":{"description":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json \"dictionaryDefinitions\": [ { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"} ], \"dictionaries\": [\"custom-words\"] ```","items":{"$ref":"#/definitions/DictionaryDefinition"},"markdownDescription":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```","type":"array"},"enableFiletypes":{"description":"Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n* // enable checking for all file types !json // except for json ```","items":{"$ref":"#/definitions/LanguageIdSingle"},"markdownDescription":"Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n* // enable checking for all file types\n!json // except for json\n```","scope":"resource","title":"Enable File Types","type":"array","uniqueItems":true},"enabled":{"default":true,"description":"Is the spell checker enabled.","markdownDescription":"Is the spell checker enabled.","type":"boolean"},"enabledFileTypes":{"additionalProperties":{"type":"boolean"},"description":"Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |","markdownDescription":"Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*` | `true` | Enable all file types. |\n| `json` | `false` | Disable checking for json files. |","since":"8.8.1","title":"Enabled File Types to Check","type":"object"},"enabledLanguageIds":{"description":"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.","items":{"$ref":"#/definitions/LanguageIdSingle"},"markdownDescription":"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.","title":"Enabled Language Ids","type":"array","uniqueItems":true},"filename":{"anyOf":[{"$ref":"#/definitions/Glob"},{"items":{"$ref":"#/definitions/Glob"},"type":"array"}],"description":"Glob pattern or patterns to match against.","markdownDescription":"Glob pattern or patterns to match against."},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"id":{"description":"Optional identifier.","markdownDescription":"Optional identifier.","type":"string"},"ignoreRandomStrings":{"default":true,"description":"Ignore sequences of characters that look like random strings.","markdownDescription":"Ignore sequences of characters that look like random strings.","type":"boolean"},"ignoreRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"includeRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"language":{"$ref":"#/definitions/LocaleId","description":"Sets the locale.","markdownDescription":"Sets the locale."},"languageId":{"$ref":"#/definitions/MatchingFileType","description":"Sets the programming language id to match file type.","markdownDescription":"Sets the programming language id to match file type."},"languageSettings":{"description":"Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.","items":{"$ref":"#/definitions/LanguageSetting"},"markdownDescription":"Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.","type":"array"},"loadDefaultConfiguration":{"default":true,"description":"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.","markdownDescription":"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\nwill prevent ALL default configuration from being loaded.","type":"boolean"},"maxDuplicateProblems":{"default":5,"description":"The maximum number of times the same word can be flagged as an error in a file.","markdownDescription":"The maximum number of times the same word can be flagged as an error in a file.","type":"number"},"maxNumberOfProblems":{"default":10000,"description":"The maximum number of problems to report in a file.","markdownDescription":"The maximum number of problems to report in a file.","type":"number"},"minRandomLength":{"default":40,"description":"The minimum length of a random string to be ignored.","markdownDescription":"The minimum length of a random string to be ignored.","type":"number"},"minWordLength":{"default":4,"description":"The minimum length of a word before checking it against a dictionary.","markdownDescription":"The minimum length of a word before checking it against a dictionary.","type":"number"},"name":{"description":"Optional name of configuration.","markdownDescription":"Optional name of configuration.","type":"string"},"noSuggestDictionaries":{"description":"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.","type":"array"},"numSuggestions":{"default":10,"description":"Number of suggestions to make.","markdownDescription":"Number of suggestions to make.","type":"number"},"patterns":{"description":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ```","items":{"$ref":"#/definitions/RegExpPatternDefinition"},"markdownDescription":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\n {@link includeRegExpList } options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```","type":"array"},"pnpFiles":{"default":[".pnp.js",".pnp.cjs"],"description":"The PnP files to search for. Note: `.mjs` files are not currently supported.","items":{"type":"string"},"markdownDescription":"The PnP files to search for. Note: `.mjs` files are not currently supported.","type":"array"},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"suggestionNumChanges":{"default":3,"description":"The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.","markdownDescription":"The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.","type":"number"},"suggestionsTimeout":{"default":500,"description":"The maximum amount of time in milliseconds to generate suggestions for a word.","markdownDescription":"The maximum amount of time in milliseconds to generate suggestions for a word.","type":"number"},"unknownWords":{"$ref":"#/definitions/UnknownWordsChoices","default":"report-all","description":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","markdownDescription":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","since":"9.1.0"},"usePnP":{"default":false,"description":"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.","markdownDescription":"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\npackages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence\nof a PnP file and load it.","type":"boolean"},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"required":["filename"],"type":"object"},"Pattern":{"type":"string"},"PatternAdjustment":{"additionalProperties":false,"properties":{"id":{"description":"Id of the Adjustment, i.e. `short-compound`","markdownDescription":"Id of the Adjustment, i.e. `short-compound`","type":"string"},"penalty":{"description":"The amount of penalty to apply.","markdownDescription":"The amount of penalty to apply.","type":"number"},"regexp":{"description":"RegExp pattern to match","markdownDescription":"RegExp pattern to match","type":"string"}},"required":["id","regexp","penalty"],"type":"object"},"PatternId":{"description":"This matches the name in a pattern definition.","markdownDescription":"This matches the name in a pattern definition.","type":"string"},"PatternRef":{"anyOf":[{"$ref":"#/definitions/Pattern"},{"$ref":"#/definitions/PatternId"},{"$ref":"#/definitions/PredefinedPatterns"}],"description":"A PatternRef is a Pattern or PatternId.","markdownDescription":"A PatternRef is a Pattern or PatternId."},"PredefinedPatterns":{"enum":["Base64","Base64MultiLine","Base64SingleLine","CStyleComment","CStyleHexValue","CSSHexValue","CommitHash","CommitHashLink","Email","EscapeCharacters","HexValues","href","PhpHereDoc","PublicKey","RsaCert","SshRsa","SHA","HashStrings","SpellCheckerDisable","SpellCheckerDisableBlock","SpellCheckerDisableLine","SpellCheckerDisableNext","SpellCheckerIgnoreInDocSetting","string","UnicodeRef","Urls","UUID","Everything"],"type":"string"},"RegExpPatternDefinition":{"additionalProperties":false,"properties":{"description":{"description":"Description of the pattern.","markdownDescription":"Description of the pattern.","type":"string"},"name":{"$ref":"#/definitions/PatternId","description":"Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.","markdownDescription":"Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.\nIt is possible to redefine one of the predefined patterns to override its value."},"pattern":{"anyOf":[{"$ref":"#/definitions/Pattern"},{"items":{"$ref":"#/definitions/Pattern"},"type":"array"}],"description":"RegExp pattern or array of RegExp patterns.","markdownDescription":"RegExp pattern or array of RegExp patterns."}},"required":["name","pattern"],"type":"object"},"RegExpPatternList":{"description":"A list of pattern names or regular expressions.","items":{"$ref":"#/definitions/PatternRef"},"markdownDescription":"A list of pattern names or regular expressions.","type":"array"},"ReplaceEntry":{"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"},"ReplaceMap":{"items":{"$ref":"#/definitions/ReplaceEntry"},"type":"array"},"ReporterModuleName":{"description":"The module or path to the the reporter to load.","markdownDescription":"The module or path to the the reporter to load.","type":"string"},"ReporterOptions":{"$ref":"#/definitions/Serializable","description":"Options to send to the reporter. These are defined by the reporter.","markdownDescription":"Options to send to the reporter. These are defined by the reporter."},"ReporterSettings":{"anyOf":[{"$ref":"#/definitions/ReporterModuleName"},{"items":{"$ref":"#/definitions/ReporterModuleName","title":"name"},"maxItems":1,"minItems":1,"type":"array"},{"items":[{"$ref":"#/definitions/ReporterModuleName","title":"name"},{"$ref":"#/definitions/ReporterOptions","title":"options"}],"maxItems":2,"minItems":2,"type":"array"}],"description":"Declare a reporter to use.\n\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `\"default\"` - to use the default reporter\n- `\"@cspell/cspell-json-reporter\"` - use the cspell JSON reporter.\n- `[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]`","markdownDescription":"Declare a reporter to use.\n\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `\"default\"` - to use the default reporter\n- `\"@cspell/cspell-json-reporter\"` - use the cspell JSON reporter.\n- `[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]`"},"Serializable":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"null"},{"type":"object"}]},"SimpleGlob":{"description":"Simple Glob string, the root will be globRoot.","markdownDescription":"Simple Glob string, the root will be globRoot.","type":"string"},"SuggestionCostMapDef":{"anyOf":[{"$ref":"#/definitions/CostMapDefReplace"},{"$ref":"#/definitions/CostMapDefInsDel"},{"$ref":"#/definitions/CostMapDefSwap"}],"description":"A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml map: 'aeiouy' insDel: 50 # Make it is cheaper to insert or delete a vowel. replace: 45 # It is even cheaper to replace one with another. ```\n\nNote: the default edit distance is 100.","markdownDescription":"A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`.\nA multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml\n map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.\n replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`.\n```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper.\n```yaml\n map: 'aeiouy'\n insDel: 50 # Make it is cheaper to insert or delete a vowel.\n replace: 45 # It is even cheaper to replace one with another.\n```\n\nNote: the default edit distance is 100."},"SuggestionCostsDefs":{"items":{"$ref":"#/definitions/SuggestionCostMapDef"},"type":"array"},"UnknownWordsChoices":{"description":"Possible choices for how to handle unknown words.","enum":["report-all","report-simple","report-common-typos","report-flagged"],"markdownDescription":"Possible choices for how to handle unknown words.","type":"string"},"Version":{"anyOf":[{"$ref":"#/definitions/VersionLatest"},{"$ref":"#/definitions/VersionLegacy"}]},"VersionLatest":{"const":"0.2","description":"Configuration File Version.","markdownDescription":"Configuration File Version.","type":"string"},"VersionLegacy":{"const":"0.1","deprecated":true,"deprecationMessage":"Use `0.2` instead.","description":"Legacy Configuration File Versions.","markdownDescription":"Legacy Configuration File Versions.","type":"string"}},"properties":{"$schema":{"default":"https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json","description":"Url to JSON Schema","markdownDescription":"Url to JSON Schema","type":"string"},"allowCompoundWords":{"default":false,"description":"True to enable compound word checking.","markdownDescription":"True to enable compound word checking.","type":"boolean"},"cache":{"$ref":"#/definitions/CacheSettings","description":"Define cache settings.","markdownDescription":"Define cache settings."},"caseSensitive":{"default":false,"description":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","markdownDescription":"Determines if words must match case and accent rules.\n\nSee [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.","type":"boolean"},"description":{"description":"Optional description of configuration.","markdownDescription":"Optional description of configuration.","type":"string"},"dictionaries":{"description":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.","type":"array"},"dictionaryDefinitions":{"description":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json \"dictionaryDefinitions\": [ { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"} ], \"dictionaries\": [\"custom-words\"] ```","items":{"$ref":"#/definitions/DictionaryDefinition"},"markdownDescription":"Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```","type":"array"},"enableFiletypes":{"description":"Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } . To disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```\n\n**Example: enable all file types**\n\n```\n* // enable checking for all file types !json // except for json ```","items":{"$ref":"#/definitions/LanguageIdSingle"},"markdownDescription":"Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by {@link Settings.enabledLanguageIds } .\nTo disable a language, prefix with `!` as in `!json`,\n\n\n**Example: individual file types**\n\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```\n\n**Example: enable all file types**\n\n```\n* // enable checking for all file types\n!json // except for json\n```","scope":"resource","title":"Enable File Types","type":"array","uniqueItems":true},"enableGlobDot":{"default":false,"description":"Enable scanning files and directories beginning with `.` (period).\n\nBy default, CSpell does not scan `hidden` files.","markdownDescription":"Enable scanning files and directories beginning with `.` (period).\n\nBy default, CSpell does not scan `hidden` files.","type":"boolean"},"enabled":{"default":true,"description":"Is the spell checker enabled.","markdownDescription":"Is the spell checker enabled.","type":"boolean"},"enabledFileTypes":{"additionalProperties":{"type":"boolean"},"description":"Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment | | --------- | ------- | ------- | | `*` | `true` | Enable all file types. | | `json` | `false` | Disable checking for json files. |","markdownDescription":"Enable / Disable checking file types (languageIds).\n\nThis setting replaces: {@link Settings.enabledLanguageIds } and {@link Settings.enableFiletypes } .\n\nA Value of:\n- `true` - enable checking for the file type\n- `false` - disable checking for the file type\n\nA file type of `*` is a wildcard that enables all file types.\n\n**Example: enable all file types**\n\n| File Type | Enabled | Comment |\n| --------- | ------- | ------- |\n| `*` | `true` | Enable all file types. |\n| `json` | `false` | Disable checking for json files. |","since":"8.8.1","title":"Enabled File Types to Check","type":"object"},"enabledLanguageIds":{"description":"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.","items":{"$ref":"#/definitions/LanguageIdSingle"},"markdownDescription":"Specify a list of file types to spell check. It is better to use {@link Settings.enabledFileTypes } to Enable / Disable checking files types.","title":"Enabled Language Ids","type":"array","uniqueItems":true},"failFast":{"default":false,"description":"Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)","markdownDescription":"Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)","type":"boolean"},"features":{"$ref":"#/definitions/Features","description":"Configure CSpell features.","markdownDescription":"Configure CSpell features.","since":"5.16.0"},"files":{"description":"Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.","items":{"$ref":"#/definitions/Glob"},"markdownDescription":"Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.","type":"array"},"flagWords":{"description":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```","items":{"type":"string"},"markdownDescription":"List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```","type":"array"},"gitignoreRoot":{"anyOf":[{"$ref":"#/definitions/FsPath"},{"items":{"$ref":"#/definitions/FsPath"},"type":"array"}],"description":"Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root.","markdownDescription":"Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root."},"globRoot":{"$ref":"#/definitions/FSPathResolvable","description":"The root to use for glob patterns found in this configuration. Default: location of the configuration file. For compatibility reasons, config files with version 0.1, the glob root will default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file.","markdownDescription":"The root to use for glob patterns found in this configuration.\nDefault: location of the configuration file.\n For compatibility reasons, config files with version 0.1, the glob root will\n default to be `${cwd}`.\n\nUse `globRoot` to define a different location.\n`globRoot` can be relative to the location of this configuration file.\nDefining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."},"id":{"description":"Optional identifier.","markdownDescription":"Optional identifier.","type":"string"},"ignorePaths":{"description":"Glob patterns of files to be ignored.\n\nGlob patterns are relative to the {@link globRoot } of the configuration file that defines them.","items":{"$ref":"#/definitions/Glob"},"markdownDescription":"Glob patterns of files to be ignored.\n\nGlob patterns are relative to the {@link globRoot } of the configuration file that defines them.","type":"array"},"ignoreRandomStrings":{"default":true,"description":"Ignore sequences of characters that look like random strings.","markdownDescription":"Ignore sequences of characters that look like random strings.","type":"boolean"},"ignoreRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"ignoreWords":{"description":"List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.","items":{"type":"string"},"markdownDescription":"List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.","type":"array"},"import":{"anyOf":[{"$ref":"#/definitions/FsPath"},{"items":{"$ref":"#/definitions/FsPath"},"type":"array"}],"description":"Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.","markdownDescription":"Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."},"includeRegExpList":{"$ref":"#/definitions/RegExpPatternList","description":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).","markdownDescription":"List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."},"language":{"$ref":"#/definitions/LocaleId","default":"en","description":"Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch.","markdownDescription":"Current active spelling language. This specifies the language locale to use in choosing the\ngeneral dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch."},"languageId":{"$ref":"#/definitions/MatchingFileType","description":"Forces the spell checker to assume a give language id. Used mainly as an Override.","markdownDescription":"Forces the spell checker to assume a give language id. Used mainly as an Override."},"languageSettings":{"description":"Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.","items":{"$ref":"#/definitions/LanguageSetting"},"markdownDescription":"Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.","type":"array"},"loadDefaultConfiguration":{"default":true,"description":"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.","markdownDescription":"By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\nwill prevent ALL default configuration from being loaded.","type":"boolean"},"maxDuplicateProblems":{"default":5,"description":"The maximum number of times the same word can be flagged as an error in a file.","markdownDescription":"The maximum number of times the same word can be flagged as an error in a file.","type":"number"},"maxNumberOfProblems":{"default":10000,"description":"The maximum number of problems to report in a file.","markdownDescription":"The maximum number of problems to report in a file.","type":"number"},"minRandomLength":{"default":40,"description":"The minimum length of a random string to be ignored.","markdownDescription":"The minimum length of a random string to be ignored.","type":"number"},"minWordLength":{"default":4,"description":"The minimum length of a word before checking it against a dictionary.","markdownDescription":"The minimum length of a word before checking it against a dictionary.","type":"number"},"name":{"description":"Optional name of configuration.","markdownDescription":"Optional name of configuration.","type":"string"},"noConfigSearch":{"default":false,"description":"Prevents searching for local configuration when checking individual documents.","markdownDescription":"Prevents searching for local configuration when checking individual documents.","type":"boolean"},"noSuggestDictionaries":{"description":"Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in one of these dictionaries, it will be removed from the set of possible suggestions.","items":{"$ref":"#/definitions/DictionaryReference"},"markdownDescription":"Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.","type":"array"},"numSuggestions":{"default":10,"description":"Number of suggestions to make.","markdownDescription":"Number of suggestions to make.","type":"number"},"overrides":{"description":"Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript \"overrides\": [ // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: { \"filename\": \"**/{*.hrr,*.crr}\", \"languageId\": \"cpp\" }, // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately): { \"language\": \"nl\", \"filename\": \"**/dutch/**/*.txt\" } ] ```","items":{"$ref":"#/definitions/OverrideSettings"},"markdownDescription":"Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript\n\"overrides\": [\n // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:\n {\n \"filename\": \"**/{*.hrr,*.crr}\",\n \"languageId\": \"cpp\"\n },\n // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):\n {\n \"language\": \"nl\",\n \"filename\": \"**/dutch/**/*.txt\"\n }\n]\n```","type":"array"},"patterns":{"description":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and {@link includeRegExpList } options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ```","items":{"$ref":"#/definitions/RegExpPatternDefinition"},"markdownDescription":"Defines a list of patterns that can be used with the {@link ignoreRegExpList } and\n {@link includeRegExpList } options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```","type":"array"},"pnpFiles":{"default":[".pnp.js",".pnp.cjs"],"description":"The PnP files to search for. Note: `.mjs` files are not currently supported.","items":{"type":"string"},"markdownDescription":"The PnP files to search for. Note: `.mjs` files are not currently supported.","type":"array"},"readonly":{"default":false,"description":"Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.","markdownDescription":"Indicate that the configuration file should not be modified.\nThis is used to prevent tools like the VS Code Spell Checker from\nmodifying the file to add words and other configuration.","type":"boolean"},"reporters":{"default":["default"],"description":"Define which reports to use. `default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.","items":{"$ref":"#/definitions/ReporterSettings"},"markdownDescription":"Define which reports to use.\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.","type":"array"},"showStatus":{"deprecated":true,"description":"Show status.","markdownDescription":"Show status.","type":"boolean"},"spellCheckDelayMs":{"deprecated":true,"description":"Delay in ms after a document has changed before checking it for spelling errors.","markdownDescription":"Delay in ms after a document has changed before checking it for spelling errors.","type":"number"},"suggestWords":{"description":"A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`","items":{"type":"string"},"markdownDescription":"A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`","type":"array"},"suggestionNumChanges":{"default":3,"description":"The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.","markdownDescription":"The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.","type":"number"},"suggestionsTimeout":{"default":500,"description":"The maximum amount of time in milliseconds to generate suggestions for a word.","markdownDescription":"The maximum amount of time in milliseconds to generate suggestions for a word.","type":"number"},"unknownWords":{"$ref":"#/definitions/UnknownWordsChoices","default":"report-all","description":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","markdownDescription":"Controls how unknown words are handled.\n\n- `report-all` - Report all unknown words (default behavior)\n- `report-simple` - Report unknown words that have simple spelling errors, typos, and flagged words.\n- `report-common-typos` - Report unknown words that are common typos and flagged words.\n- `report-flagged` - Report unknown words that are flagged.","since":"9.1.0"},"useGitignore":{"default":false,"description":"Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.","markdownDescription":"Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.","type":"boolean"},"usePnP":{"default":false,"description":"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.","markdownDescription":"Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\npackages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence\nof a PnP file and load it.","type":"boolean"},"userWords":{"description":"Words to add to global dictionary -- should only be in the user config file.","items":{"type":"string"},"markdownDescription":"Words to add to global dictionary -- should only be in the user config file.","type":"array"},"validateDirectives":{"description":"Verify that the in-document directives are correct.","markdownDescription":"Verify that the in-document directives are correct.","type":"boolean"},"version":{"$ref":"#/definitions/Version","default":"0.2","description":"Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave.","markdownDescription":"Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave."},"words":{"description":"List of words to be considered correct.","items":{"type":"string"},"markdownDescription":"List of words to be considered correct.","type":"array"}},"type":"object"}
|
Provide a JSON object that satisfies the schema "cspell.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
cspell.schema
|
schema-store
|
schema_store_224
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"id\":\"https://json.schemastore.org/csscomb.json\",\"properties\":{\"exclude\":{\"description\":\"A list of files to ignore in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}},\"verbose\":{\"type\":\"boolean\"},\"always-semicolon\":{\"description\":\"Whether to add missing semicolon in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"block-indent\":{\"description\":\"A block indent style in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"color-case\":{\"description\":\"A hexadecimal color style in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\",\"enum\":[\"lower\",\"upper\"]},\"color-shorthand\":{\"description\":\"Whether to expand hexadecimal color or use shorthand in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"element-case\":{\"description\":\"Whether to unify case of element selector in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\",\"enum\":[\"lower\",\"upper\"]},\"eof-newline\":{\"description\":\"Whether to add a trailing line break in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"leading-zero\":{\"description\":\"Whether to add leading zero in a dimension in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"quotes\":{\"description\":\"A quote style in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\",\"enum\":[\"single\",\"double\"]},\"remove-empty-rulesets\":{\"description\":\"Whether to remove empty rulesets\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"space-after-colon\":{\"description\":\"A space style after a colon in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-after-combinator\":{\"description\":\"A space style after a combinator in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-after-opening-brace\":{\"description\":\"A space style after an opening brace in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-after-selector-delimiter\":{\"description\":\"A space style after a selector delimiter in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-after-closing-brace\":{\"description\":\"A space style after a closing brace in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-before-colon\":{\"description\":\"A space style before a colon in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-before-combinator\":{\"description\":\"A space style before a combinator in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-before-opening-brace\":{\"description\":\"A space style before an opening brace in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-before-selector-delimiter\":{\"description\":\"A space style before a selector delimiter in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"space-between-declarations\":{\"description\":\"A space style between declarations in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"},\"strip-spaces\":{\"description\":\"Whether to trim trailing space in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"unitless-zero\":{\"description\":\"Whether to remove unit in zero-valued dimension in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"vendor-prefix-align\":{\"description\":\"Whether to align prefix in property and value in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"boolean\"},\"sort-order\":{\"description\":\"A sort order in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"tab-size\":{\"type\":\"boolean\"},\"sort-order-fallback\":{\"description\":\"A sort style of unknown properties in the current project\\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config\",\"type\":\"string\"}},\"title\":\"A CSS Comb config schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"A CSS Comb config schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","id":"https://json.schemastore.org/csscomb.json","properties":{"exclude":{"description":"A list of files to ignore in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"verbose":{"type":"boolean"},"always-semicolon":{"description":"Whether to add missing semicolon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"block-indent":{"description":"A block indent style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"color-case":{"description":"A hexadecimal color style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string","enum":["lower","upper"]},"color-shorthand":{"description":"Whether to expand hexadecimal color or use shorthand in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"element-case":{"description":"Whether to unify case of element selector in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string","enum":["lower","upper"]},"eof-newline":{"description":"Whether to add a trailing line break in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"leading-zero":{"description":"Whether to add leading zero in a dimension in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"quotes":{"description":"A quote style in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string","enum":["single","double"]},"remove-empty-rulesets":{"description":"Whether to remove empty rulesets\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"space-after-colon":{"description":"A space style after a colon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-after-combinator":{"description":"A space style after a combinator in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-after-opening-brace":{"description":"A space style after an opening brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-after-selector-delimiter":{"description":"A space style after a selector delimiter in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-after-closing-brace":{"description":"A space style after a closing brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-before-colon":{"description":"A space style before a colon in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-before-combinator":{"description":"A space style before a combinator in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-before-opening-brace":{"description":"A space style before an opening brace in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-before-selector-delimiter":{"description":"A space style before a selector delimiter in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"space-between-declarations":{"description":"A space style between declarations in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"},"strip-spaces":{"description":"Whether to trim trailing space in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"unitless-zero":{"description":"Whether to remove unit in zero-valued dimension in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"vendor-prefix-align":{"description":"Whether to align prefix in property and value in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"boolean"},"sort-order":{"description":"A sort order in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"array","items":{"type":"array","items":{"type":"string"}}},"tab-size":{"type":"boolean"},"sort-order-fallback":{"description":"A sort style of unknown properties in the current project\nhttps://github.com/csscomb/csscomb.js/blob/dev/doc/configuration.md#create-custom-config","type":"string"}},"title":"A CSS Comb config schema","type":"object"}
|
Provide a JSON object that satisfies the schema "A CSS Comb config schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
A CSS Comb config schema
|
schema-store
|
schema_store_225
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"rule\":{\"description\":\"CSS Lint rule\\n\\n'false' means rule is off\\n'true' means it is a warning\\n'2' means the rule is an error\",\"enum\":[2,true,false]}},\"id\":\"https://json.schemastore.org/csslintrc.json\",\"properties\":{\"adjoining-classes\":{\"$ref\":\"#/definitions/rule\"},\"box-model\":{\"$ref\":\"#/definitions/rule\"},\"box-sizing\":{\"$ref\":\"#/definitions/rule\"},\"bulletproof-font-face\":{\"$ref\":\"#/definitions/rule\"},\"compatible-vendor-prefixes\":{\"$ref\":\"#/definitions/rule\"},\"display-property-grouping\":{\"$ref\":\"#/definitions/rule\"},\"duplicate-background-images\":{\"$ref\":\"#/definitions/rule\"},\"duplicate-properties\":{\"$ref\":\"#/definitions/rule\"},\"empty-rules\":{\"$ref\":\"#/definitions/rule\"},\"fallback-colors\":{\"$ref\":\"#/definitions/rule\"},\"floats\":{\"$ref\":\"#/definitions/rule\"},\"font-faces\":{\"$ref\":\"#/definitions/rule\"},\"font-sizes\":{\"$ref\":\"#/definitions/rule\"},\"gradients\":{\"$ref\":\"#/definitions/rule\"},\"ids\":{\"$ref\":\"#/definitions/rule\"},\"import\":{\"$ref\":\"#/definitions/rule\"},\"important\":{\"$ref\":\"#/definitions/rule\"},\"known-properties\":{\"$ref\":\"#/definitions/rule\"},\"outline-none\":{\"$ref\":\"#/definitions/rule\"},\"overqualified-elements\":{\"$ref\":\"#/definitions/rule\"},\"qualified-headings\":{\"$ref\":\"#/definitions/rule\"},\"regex-selectors\":{\"$ref\":\"#/definitions/rule\"},\"shorthand\":{\"$ref\":\"#/definitions/rule\"},\"star-property-hack\":{\"$ref\":\"#/definitions/rule\"},\"text-indent\":{\"$ref\":\"#/definitions/rule\"},\"underscore-property-hack\":{\"$ref\":\"#/definitions/rule\"},\"unique-headings\":{\"$ref\":\"#/definitions/rule\"},\"universal-selector\":{\"$ref\":\"#/definitions/rule\"},\"unqualified-attributes\":{\"$ref\":\"#/definitions/rule\"},\"vendor-prefix\":{\"$ref\":\"#/definitions/rule\"},\"zero-units\":{\"$ref\":\"#/definitions/rule\"}},\"title\":\"JSON schema for CSS Lint configuration files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for CSS Lint configuration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"rule":{"description":"CSS Lint rule\n\n'false' means rule is off\n'true' means it is a warning\n'2' means the rule is an error","enum":[2,true,false]}},"id":"https://json.schemastore.org/csslintrc.json","properties":{"adjoining-classes":{"$ref":"#/definitions/rule"},"box-model":{"$ref":"#/definitions/rule"},"box-sizing":{"$ref":"#/definitions/rule"},"bulletproof-font-face":{"$ref":"#/definitions/rule"},"compatible-vendor-prefixes":{"$ref":"#/definitions/rule"},"display-property-grouping":{"$ref":"#/definitions/rule"},"duplicate-background-images":{"$ref":"#/definitions/rule"},"duplicate-properties":{"$ref":"#/definitions/rule"},"empty-rules":{"$ref":"#/definitions/rule"},"fallback-colors":{"$ref":"#/definitions/rule"},"floats":{"$ref":"#/definitions/rule"},"font-faces":{"$ref":"#/definitions/rule"},"font-sizes":{"$ref":"#/definitions/rule"},"gradients":{"$ref":"#/definitions/rule"},"ids":{"$ref":"#/definitions/rule"},"import":{"$ref":"#/definitions/rule"},"important":{"$ref":"#/definitions/rule"},"known-properties":{"$ref":"#/definitions/rule"},"outline-none":{"$ref":"#/definitions/rule"},"overqualified-elements":{"$ref":"#/definitions/rule"},"qualified-headings":{"$ref":"#/definitions/rule"},"regex-selectors":{"$ref":"#/definitions/rule"},"shorthand":{"$ref":"#/definitions/rule"},"star-property-hack":{"$ref":"#/definitions/rule"},"text-indent":{"$ref":"#/definitions/rule"},"underscore-property-hack":{"$ref":"#/definitions/rule"},"unique-headings":{"$ref":"#/definitions/rule"},"universal-selector":{"$ref":"#/definitions/rule"},"unqualified-attributes":{"$ref":"#/definitions/rule"},"vendor-prefix":{"$ref":"#/definitions/rule"},"zero-units":{"$ref":"#/definitions/rule"}},"title":"JSON schema for CSS Lint configuration files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for CSS Lint configuration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for CSS Lint configuration files
|
schema-store
|
schema_store_226
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://json.schemastore.org/ctfd.json\",\"$ref\":\"#/$defs/Config\",\"$defs\":{\"Accounts\":{\"properties\":{\"domain_whitelist\":{\"type\":\"string\",\"description\":\"The domain whitelist (a list separated by colons) to allow users to have email addresses from.\"},\"domain_blacklist\":{\"type\":\"string\",\"description\":\"The domain blacklist (a list separated by colons) to blocks users to have email addresses from.\"},\"verify_emails\":{\"type\":\"boolean\",\"description\":\"Whether to verify emails once a user register or not.\"},\"team_creation\":{\"type\":\"boolean\",\"description\":\"Whether to allow team creation by players or not.\"},\"team_size\":{\"type\":\"integer\",\"description\":\"Maximum size (number of players) in a team.\"},\"num_teams\":{\"type\":\"integer\",\"description\":\"The total number of teams allowed.\"},\"num_users\":{\"type\":\"integer\",\"description\":\"The total number of users allowed.\"},\"team_disbanding\":{\"type\":\"string\",\"description\":\"Whether to allow teams to be disbanded or not. Could be inactive_only or disabled.\"},\"incorrect_submissions_per_minutes\":{\"type\":\"integer\",\"description\":\"Maximum number of invalid submissions per minute (per user/team). We suggest you use it as part of an anti-brute-force strategy (rate limiting).\"},\"name_changes\":{\"type\":\"boolean\",\"description\":\"Whether a user can change its name or not.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Accounts parameters, like rate limiting or default permissions.\"},\"Admin\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The administrator name. Immutable, or need the administrator to change the CTFd data AND the configuration file.\"},\"email\":{\"type\":\"string\",\"description\":\"The administrator email address. Immutable, or need the administrator to change the CTFd data AND the configuration file.\"},\"password\":{\"$ref\":\"#/$defs/FromEnv\",\"description\":\"The administrator password, recommended to use the varenvs. Immutable, or need the administrator to change the CTFd data AND the configuration file.\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"name\",\"email\",\"password\"],\"description\":\"Admin accesses.\"},\"Appearance\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of your CTF, displayed as is.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of your CTF, displayed as is.\"},\"default_locale\":{\"type\":\"string\",\"description\":\"The default language for the users.\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"name\",\"description\"],\"description\":\"Appearance of the CTFd.\"},\"Config\":{\"properties\":{\"appearance\":{\"$ref\":\"#/$defs/Appearance\"},\"theme\":{\"$ref\":\"#/$defs/Theme\"},\"accounts\":{\"$ref\":\"#/$defs/Accounts\"},\"pages\":{\"$ref\":\"#/$defs/Pages\"},\"major_league_cyber\":{\"$ref\":\"#/$defs/MajorLeagueCyber\"},\"settings\":{\"$ref\":\"#/$defs/Settings\"},\"security\":{\"$ref\":\"#/$defs/Security\"},\"email\":{\"$ref\":\"#/$defs/Email\"},\"time\":{\"$ref\":\"#/$defs/Time\"},\"social\":{\"$ref\":\"#/$defs/Social\"},\"legal\":{\"$ref\":\"#/$defs/Legal\"},\"admin\":{\"$ref\":\"#/$defs/Admin\"},\"mode\":{\"type\":\"string\",\"enum\":[\"users\",\"teams\"],\"description\":\"The mode of your CTFd, either users or teams.\",\"default\":\"users\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"appearance\",\"admin\"]},\"Email\":{\"properties\":{\"registration\":{\"$ref\":\"#/$defs/EmailContent\",\"description\":\"The registration email.\"},\"confirmation\":{\"$ref\":\"#/$defs/EmailContent\",\"description\":\"The confirmation email.\"},\"new_account\":{\"$ref\":\"#/$defs/EmailContent\",\"description\":\"The new account email.\"},\"password_reset\":{\"$ref\":\"#/$defs/EmailContent\",\"description\":\"The password reset email.\"},\"password_reset_confirmation\":{\"$ref\":\"#/$defs/EmailContent\",\"description\":\"The password reset confirmation email.\"},\"from\":{\"type\":\"string\",\"description\":\"The 'From:' to sent to mail with.\"},\"server\":{\"type\":\"string\",\"description\":\"The mail server to use.\"},\"port\":{\"type\":\"string\",\"description\":\"The mail server port to reach.\"},\"username\":{\"type\":\"string\",\"description\":\"The username to log in to the mail server.\"},\"password\":{\"type\":\"string\",\"description\":\"The password to log in to the mail server.\"},\"tls_ssl\":{\"type\":\"boolean\",\"description\":\"Whether to turn on TLS/SSL or not.\"},\"starttls\":{\"type\":\"boolean\",\"description\":\"Whether to turn on STARTTLS or not.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Email rules and server credentials.\"},\"EmailContent\":{\"properties\":{\"subject\":{\"type\":\"string\",\"description\":\"Subject of the email.\"},\"body\":{\"type\":\"string\",\"description\":\"Body (or content) or the email.\"}},\"additionalProperties\":false,\"type\":\"object\"},\"ExternalReference\":{\"properties\":{\"url\":{\"type\":\"string\",\"description\":\"The URL to access the content.\"},\"content\":{\"$ref\":\"#/$defs/File\",\"description\":\"The content of the reference.\"}},\"additionalProperties\":false,\"type\":\"object\"},\"File\":{\"oneOf\":[{\"properties\":{\"from_file\":{\"type\":\"string\",\"description\":\"The file to import content from.\"}},\"type\":\"object\"},{\"type\":\"string\"}]},\"FromEnv\":{\"oneOf\":[{\"properties\":{\"from_env\":{\"type\":\"string\",\"description\":\"The environment variable to look at.\"}},\"type\":\"object\"},{\"type\":\"string\"}]},\"Legal\":{\"properties\":{\"tos\":{\"$ref\":\"#/$defs/ExternalReference\",\"description\":\"The Terms of Services.\"},\"privacy_policy\":{\"$ref\":\"#/$defs/ExternalReference\",\"description\":\"The Privacy Policy.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Legal contents for players.\"},\"MajorLeagueCyber\":{\"properties\":{\"client_id\":{\"type\":\"string\",\"description\":\"The MajorLeagueCyber OAuth ClientID.\"},\"client_secret\":{\"type\":\"string\",\"description\":\"The MajorLeagueCyber OAuth Client Secret.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"MajorLeagueCyber credentials to register the CTF.\"},\"Page\":{\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"Title of the page.\"},\"route\":{\"type\":\"string\",\"description\":\"Route to serve.\"},\"format\":{\"type\":\"string\",\"enum\":[\"markdown\",\"html\"],\"description\":\"Format to consume the content.\",\"default\":\"markdown\"},\"content\":{\"$ref\":\"#/$defs/File\",\"description\":\"The page content. If you need to use images, please use an external CDN to make sure the content is replicable.\"},\"draft\":{\"type\":\"boolean\",\"description\":\"Set the page as a draft.\",\"default\":false},\"hidden\":{\"type\":\"boolean\",\"description\":\"Hide or show the page to users.\",\"default\":false},\"auth_required\":{\"type\":\"boolean\",\"description\":\"Configure whether the page require authentication or not.\",\"default\":false}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"title\",\"route\",\"content\"],\"description\":\"Page to configure and display on the CTFd.\"},\"Pages\":{\"properties\":{\"robots_txt\":{\"$ref\":\"#/$defs/File\",\"description\":\"Define the /robots.txt file content, for web crawlers indexing.\"},\"additional\":{\"items\":{\"$ref\":\"#/$defs/Page\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Pages global configuration.\"},\"Security\":{\"properties\":{\"html_sanitization\":{\"type\":\"boolean\",\"description\":\"Whether to turn on HTML sanitization or not.\"},\"registration_code\":{\"type\":\"string\",\"description\":\"The registration code (secret) to join the CTF.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Security of contents and accesses.\"},\"Settings\":{\"properties\":{\"challenge_visibility\":{\"type\":\"string\",\"enum\":[\"public\",\"private\",\"admins\"],\"description\":\"The visibility for the challenges. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).\",\"default\":\"private\"},\"account_visibility\":{\"type\":\"string\",\"enum\":[\"public\",\"private\",\"admins\"],\"description\":\"The visibility for the accounts. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).\",\"default\":\"public\"},\"score_visibility\":{\"type\":\"string\",\"enum\":[\"public\",\"private\",\"admins\"],\"description\":\"The visibility for the scoreboard. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).\",\"default\":\"public\"},\"registration_visibility\":{\"type\":\"string\",\"enum\":[\"public\",\"private\",\"admins\"],\"description\":\"The visibility for the registration. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).\",\"default\":\"public\"},\"paused\":{\"type\":\"boolean\",\"description\":\"Whether the CTFd is paused or not.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Settings for resources visibility.\"},\"Social\":{\"properties\":{\"shares\":{\"type\":\"boolean\",\"description\":\"Whether to enable users share they solved a challenge or not.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Social network configuration.\"},\"Theme\":{\"properties\":{\"logo\":{\"$ref\":\"#/$defs/File\",\"description\":\"The frontend logo.\"},\"small_icon\":{\"$ref\":\"#/$defs/File\",\"description\":\"The frontend small icon.\"},\"name\":{\"type\":\"string\",\"description\":\"The frontend theme name.\",\"default\":\"core-beta\"},\"color\":{\"type\":\"string\",\"description\":\"The frontend theme color.\"},\"header\":{\"$ref\":\"#/$defs/File\",\"description\":\"The frontend header.\"},\"footer\":{\"$ref\":\"#/$defs/File\",\"description\":\"The frontend footer.\"},\"settings\":{\"$ref\":\"#/$defs/File\",\"description\":\"The frontend settings (JSON).\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Theme displayed to end-users.\"},\"Time\":{\"properties\":{\"start\":{\"type\":\"string\",\"description\":\"The start timestamp at which the CTFd will open.\"},\"end\":{\"type\":\"string\",\"description\":\"The end timestamp at which the CTFd will close.\"},\"freeze\":{\"type\":\"string\",\"description\":\"The freeze timestamp at which the CTFd will remain open but won't accept any further submissions.\"},\"view_after\":{\"type\":\"boolean\",\"description\":\"Whether allows users to view challenges after end or not.\"}},\"additionalProperties\":false,\"type\":\"object\",\"description\":\"Time settings of the CTF.\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ctfd\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://json.schemastore.org/ctfd.json","$ref":"#/$defs/Config","$defs":{"Accounts":{"properties":{"domain_whitelist":{"type":"string","description":"The domain whitelist (a list separated by colons) to allow users to have email addresses from."},"domain_blacklist":{"type":"string","description":"The domain blacklist (a list separated by colons) to blocks users to have email addresses from."},"verify_emails":{"type":"boolean","description":"Whether to verify emails once a user register or not."},"team_creation":{"type":"boolean","description":"Whether to allow team creation by players or not."},"team_size":{"type":"integer","description":"Maximum size (number of players) in a team."},"num_teams":{"type":"integer","description":"The total number of teams allowed."},"num_users":{"type":"integer","description":"The total number of users allowed."},"team_disbanding":{"type":"string","description":"Whether to allow teams to be disbanded or not. Could be inactive_only or disabled."},"incorrect_submissions_per_minutes":{"type":"integer","description":"Maximum number of invalid submissions per minute (per user/team). We suggest you use it as part of an anti-brute-force strategy (rate limiting)."},"name_changes":{"type":"boolean","description":"Whether a user can change its name or not."}},"additionalProperties":false,"type":"object","description":"Accounts parameters, like rate limiting or default permissions."},"Admin":{"properties":{"name":{"type":"string","description":"The administrator name. Immutable, or need the administrator to change the CTFd data AND the configuration file."},"email":{"type":"string","description":"The administrator email address. Immutable, or need the administrator to change the CTFd data AND the configuration file."},"password":{"$ref":"#/$defs/FromEnv","description":"The administrator password, recommended to use the varenvs. Immutable, or need the administrator to change the CTFd data AND the configuration file."}},"additionalProperties":false,"type":"object","required":["name","email","password"],"description":"Admin accesses."},"Appearance":{"properties":{"name":{"type":"string","description":"The name of your CTF, displayed as is."},"description":{"type":"string","description":"The description of your CTF, displayed as is."},"default_locale":{"type":"string","description":"The default language for the users."}},"additionalProperties":false,"type":"object","required":["name","description"],"description":"Appearance of the CTFd."},"Config":{"properties":{"appearance":{"$ref":"#/$defs/Appearance"},"theme":{"$ref":"#/$defs/Theme"},"accounts":{"$ref":"#/$defs/Accounts"},"pages":{"$ref":"#/$defs/Pages"},"major_league_cyber":{"$ref":"#/$defs/MajorLeagueCyber"},"settings":{"$ref":"#/$defs/Settings"},"security":{"$ref":"#/$defs/Security"},"email":{"$ref":"#/$defs/Email"},"time":{"$ref":"#/$defs/Time"},"social":{"$ref":"#/$defs/Social"},"legal":{"$ref":"#/$defs/Legal"},"admin":{"$ref":"#/$defs/Admin"},"mode":{"type":"string","enum":["users","teams"],"description":"The mode of your CTFd, either users or teams.","default":"users"}},"additionalProperties":false,"type":"object","required":["appearance","admin"]},"Email":{"properties":{"registration":{"$ref":"#/$defs/EmailContent","description":"The registration email."},"confirmation":{"$ref":"#/$defs/EmailContent","description":"The confirmation email."},"new_account":{"$ref":"#/$defs/EmailContent","description":"The new account email."},"password_reset":{"$ref":"#/$defs/EmailContent","description":"The password reset email."},"password_reset_confirmation":{"$ref":"#/$defs/EmailContent","description":"The password reset confirmation email."},"from":{"type":"string","description":"The 'From:' to sent to mail with."},"server":{"type":"string","description":"The mail server to use."},"port":{"type":"string","description":"The mail server port to reach."},"username":{"type":"string","description":"The username to log in to the mail server."},"password":{"type":"string","description":"The password to log in to the mail server."},"tls_ssl":{"type":"boolean","description":"Whether to turn on TLS/SSL or not."},"starttls":{"type":"boolean","description":"Whether to turn on STARTTLS or not."}},"additionalProperties":false,"type":"object","description":"Email rules and server credentials."},"EmailContent":{"properties":{"subject":{"type":"string","description":"Subject of the email."},"body":{"type":"string","description":"Body (or content) or the email."}},"additionalProperties":false,"type":"object"},"ExternalReference":{"properties":{"url":{"type":"string","description":"The URL to access the content."},"content":{"$ref":"#/$defs/File","description":"The content of the reference."}},"additionalProperties":false,"type":"object"},"File":{"oneOf":[{"properties":{"from_file":{"type":"string","description":"The file to import content from."}},"type":"object"},{"type":"string"}]},"FromEnv":{"oneOf":[{"properties":{"from_env":{"type":"string","description":"The environment variable to look at."}},"type":"object"},{"type":"string"}]},"Legal":{"properties":{"tos":{"$ref":"#/$defs/ExternalReference","description":"The Terms of Services."},"privacy_policy":{"$ref":"#/$defs/ExternalReference","description":"The Privacy Policy."}},"additionalProperties":false,"type":"object","description":"Legal contents for players."},"MajorLeagueCyber":{"properties":{"client_id":{"type":"string","description":"The MajorLeagueCyber OAuth ClientID."},"client_secret":{"type":"string","description":"The MajorLeagueCyber OAuth Client Secret."}},"additionalProperties":false,"type":"object","description":"MajorLeagueCyber credentials to register the CTF."},"Page":{"properties":{"title":{"type":"string","description":"Title of the page."},"route":{"type":"string","description":"Route to serve."},"format":{"type":"string","enum":["markdown","html"],"description":"Format to consume the content.","default":"markdown"},"content":{"$ref":"#/$defs/File","description":"The page content. If you need to use images, please use an external CDN to make sure the content is replicable."},"draft":{"type":"boolean","description":"Set the page as a draft.","default":false},"hidden":{"type":"boolean","description":"Hide or show the page to users.","default":false},"auth_required":{"type":"boolean","description":"Configure whether the page require authentication or not.","default":false}},"additionalProperties":false,"type":"object","required":["title","route","content"],"description":"Page to configure and display on the CTFd."},"Pages":{"properties":{"robots_txt":{"$ref":"#/$defs/File","description":"Define the /robots.txt file content, for web crawlers indexing."},"additional":{"items":{"$ref":"#/$defs/Page"},"type":"array"}},"additionalProperties":false,"type":"object","description":"Pages global configuration."},"Security":{"properties":{"html_sanitization":{"type":"boolean","description":"Whether to turn on HTML sanitization or not."},"registration_code":{"type":"string","description":"The registration code (secret) to join the CTF."}},"additionalProperties":false,"type":"object","description":"Security of contents and accesses."},"Settings":{"properties":{"challenge_visibility":{"type":"string","enum":["public","private","admins"],"description":"The visibility for the challenges. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).","default":"private"},"account_visibility":{"type":"string","enum":["public","private","admins"],"description":"The visibility for the accounts. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).","default":"public"},"score_visibility":{"type":"string","enum":["public","private","admins"],"description":"The visibility for the scoreboard. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).","default":"public"},"registration_visibility":{"type":"string","enum":["public","private","admins"],"description":"The visibility for the registration. Please refer to CTFd documentation (https://docs.ctfd.io/docs/settings/visibility-settings/).","default":"public"},"paused":{"type":"boolean","description":"Whether the CTFd is paused or not."}},"additionalProperties":false,"type":"object","description":"Settings for resources visibility."},"Social":{"properties":{"shares":{"type":"boolean","description":"Whether to enable users share they solved a challenge or not."}},"additionalProperties":false,"type":"object","description":"Social network configuration."},"Theme":{"properties":{"logo":{"$ref":"#/$defs/File","description":"The frontend logo."},"small_icon":{"$ref":"#/$defs/File","description":"The frontend small icon."},"name":{"type":"string","description":"The frontend theme name.","default":"core-beta"},"color":{"type":"string","description":"The frontend theme color."},"header":{"$ref":"#/$defs/File","description":"The frontend header."},"footer":{"$ref":"#/$defs/File","description":"The frontend footer."},"settings":{"$ref":"#/$defs/File","description":"The frontend settings (JSON)."}},"additionalProperties":false,"type":"object","description":"Theme displayed to end-users."},"Time":{"properties":{"start":{"type":"string","description":"The start timestamp at which the CTFd will open."},"end":{"type":"string","description":"The end timestamp at which the CTFd will close."},"freeze":{"type":"string","description":"The freeze timestamp at which the CTFd will remain open but won't accept any further submissions."},"view_after":{"type":"boolean","description":"Whether allows users to view challenges after end or not."}},"additionalProperties":false,"type":"object","description":"Time settings of the CTF."}}}
|
Provide a JSON object that satisfies the schema "ctfd". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
ctfd
|
schema-store
|
schema_store_227
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"CumulusCIRoot\",\"type\":\"object\",\"properties\":{\"tasks\":{\"title\":\"Tasks\",\"default\":{},\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Task\"}},\"flows\":{\"title\":\"Flows\",\"default\":{},\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Flow\"}},\"project\":{\"title\":\"Project\",\"default\":{},\"allOf\":[{\"$ref\":\"#/definitions/Project\"}]},\"orgs\":{\"title\":\"Orgs\",\"default\":{},\"allOf\":[{\"$ref\":\"#/definitions/Orgs\"}]},\"services\":{\"title\":\"Services\",\"default\":{},\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Service\"}},\"cumulusci\":{\"$ref\":\"#/definitions/CumulusCIConfig\"},\"plans\":{\"title\":\"Plans\",\"default\":{},\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Plan\"}},\"minimum_cumulusci_version\":{\"title\":\"Minimum Cumulusci Version\",\"type\":\"string\"},\"sources\":{\"title\":\"Sources\",\"default\":{},\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/definitions/LocalFolderSourceModel\"},{\"$ref\":\"#/definitions/GitHubSourceModel\"}]}},\"cli\":{\"$ref\":\"#/definitions/CumulusCLIConfig\"}},\"additionalProperties\":false,\"definitions\":{\"Task\":{\"title\":\"Task\",\"type\":\"object\",\"properties\":{\"class_path\":{\"title\":\"Class Path\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"group\":{\"title\":\"Group\",\"type\":\"string\"},\"options\":{\"title\":\"Options\",\"default\":{},\"additionalProperties\":true,\"type\":\"object\"},\"ui_options\":{\"title\":\"Ui Options\",\"default\":{},\"additionalProperties\":true,\"type\":\"object\"},\"name\":{\"title\":\"Name\",\"type\":\"string\"}},\"additionalProperties\":false},\"PreflightCheck\":{\"title\":\"PreflightCheck\",\"type\":\"object\",\"properties\":{\"when\":{\"title\":\"When\",\"type\":\"string\"},\"action\":{\"title\":\"Action\",\"type\":\"string\"},\"message\":{\"title\":\"Message\",\"type\":\"string\"}},\"additionalProperties\":false},\"Step\":{\"title\":\"Step\",\"type\":\"object\",\"properties\":{\"task\":{\"title\":\"Task\",\"type\":\"string\"},\"flow\":{\"title\":\"Flow\",\"type\":\"string\"},\"ignore_failure\":{\"title\":\"Ignore Failure\",\"default\":false,\"type\":\"boolean\"},\"when\":{\"title\":\"When\",\"type\":\"string\"},\"options\":{\"title\":\"Options\",\"default\":{},\"additionalProperties\":true,\"type\":\"object\"},\"ui_options\":{\"title\":\"Ui Options\",\"default\":{},\"additionalProperties\":true,\"type\":\"object\"},\"checks\":{\"title\":\"Checks\",\"default\":[],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PreflightCheck\"}},\"description\":{\"title\":\"Description\",\"type\":\"string\"}},\"additionalProperties\":false},\"Flow\":{\"title\":\"Flow\",\"type\":\"object\",\"properties\":{\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"steps\":{\"title\":\"Steps\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Step\"}},\"group\":{\"title\":\"Group\",\"type\":\"string\"}},\"additionalProperties\":false},\"Package\":{\"title\":\"Package\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"Name\",\"type\":\"string\"},\"name_managed\":{\"title\":\"Name Managed\",\"type\":\"string\"},\"namespace\":{\"title\":\"Namespace\",\"type\":\"string\"},\"install_class\":{\"title\":\"Install Class\",\"type\":\"string\"},\"uninstall_class\":{\"title\":\"Uninstall Class\",\"type\":\"string\"},\"api_version\":{\"title\":\"Api Version\",\"type\":\"string\"},\"metadata_package_id\":{\"title\":\"Metadata Package Id\",\"type\":\"string\"}},\"additionalProperties\":false},\"Test\":{\"title\":\"Test\",\"type\":\"object\",\"properties\":{\"name_match\":{\"title\":\"Name Match\",\"type\":\"string\"}},\"required\":[\"name_match\"],\"additionalProperties\":false},\"ReleaseNotesParser\":{\"title\":\"ReleaseNotesParser\",\"type\":\"object\",\"properties\":{\"class_path\":{\"title\":\"Class Path\",\"type\":\"string\"},\"title\":{\"title\":\"Title\",\"type\":\"string\"}},\"required\":[\"class_path\",\"title\"],\"additionalProperties\":false},\"ReleaseNotes\":{\"title\":\"ReleaseNotes\",\"type\":\"object\",\"properties\":{\"parsers\":{\"title\":\"Parsers\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/ReleaseNotesParser\"}}},\"required\":[\"parsers\"],\"additionalProperties\":false},\"Git\":{\"title\":\"Git\",\"type\":\"object\",\"properties\":{\"repo_url\":{\"title\":\"Repo Url\",\"type\":\"string\"},\"default_branch\":{\"title\":\"Default Branch\",\"type\":\"string\"},\"prefix_feature\":{\"title\":\"Prefix Feature\",\"type\":\"string\"},\"prefix_beta\":{\"title\":\"Prefix Beta\",\"type\":\"string\"},\"prefix_release\":{\"title\":\"Prefix Release\",\"type\":\"string\"},\"push_prefix_sandbox\":{\"title\":\"Push Prefix Sandbox\",\"type\":\"string\"},\"push_prefix_production\":{\"title\":\"Push Prefix Production\",\"type\":\"string\"},\"release_notes\":{\"$ref\":\"#/definitions/ReleaseNotes\"},\"2gp_context\":{\"title\":\"2Gp Context\",\"type\":\"string\"},\"unlocked_context\":{\"title\":\"Unlocked Context\",\"type\":\"string\"}},\"additionalProperties\":false},\"DependencyResolutions\":{\"title\":\"DependencyResolutions\",\"type\":\"object\",\"properties\":{\"production\":{\"title\":\"Production\",\"type\":\"string\"},\"preproduction\":{\"title\":\"Preproduction\",\"type\":\"string\"},\"resolution_strategies\":{\"title\":\"Resolution Strategies\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"additionalProperties\":false},\"Project\":{\"title\":\"Project\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"Name\",\"type\":\"string\"},\"package\":{\"$ref\":\"#/definitions/Package\"},\"test\":{\"$ref\":\"#/definitions/Test\"},\"git\":{\"$ref\":\"#/definitions/Git\"},\"dependencies\":{\"title\":\"Dependencies\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"dependency_resolutions\":{\"$ref\":\"#/definitions/DependencyResolutions\"},\"dependency_pins\":{\"title\":\"Dependency Pins\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"source_format\":{\"title\":\"Source Format\",\"default\":\"mdapi\",\"enum\":[\"sfdx\",\"mdapi\"],\"type\":\"string\"},\"custom\":{\"title\":\"Custom\",\"type\":\"object\"}},\"additionalProperties\":false},\"ScratchOrg\":{\"title\":\"ScratchOrg\",\"type\":\"object\",\"properties\":{\"config_file\":{\"title\":\"Config File\",\"type\":\"string\",\"format\":\"path\"},\"days\":{\"title\":\"Days\",\"type\":\"integer\"},\"namespaced\":{\"title\":\"Namespaced\",\"type\":\"string\"},\"setup_flow\":{\"title\":\"Setup Flow\",\"type\":\"string\"},\"noancestors\":{\"title\":\"Noancestors\",\"type\":\"boolean\"},\"release\":{\"title\":\"Release\",\"enum\":[\"preview\",\"previous\"],\"type\":\"string\"}},\"additionalProperties\":false},\"Orgs\":{\"title\":\"Orgs\",\"type\":\"object\",\"properties\":{\"scratch\":{\"title\":\"Scratch\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/ScratchOrg\"}}},\"additionalProperties\":false},\"ServiceAttribute\":{\"title\":\"ServiceAttribute\",\"type\":\"object\",\"properties\":{\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"required\":{\"title\":\"Required\",\"type\":\"boolean\"},\"default_factory\":{\"title\":\"Default Factory\",\"type\":\"string\"},\"default\":{\"title\":\"Default\",\"type\":\"string\"},\"sensitive\":{\"title\":\"Sensitive\",\"default\":false,\"type\":\"boolean\"}},\"additionalProperties\":false},\"Service\":{\"title\":\"Service\",\"type\":\"object\",\"properties\":{\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"class_path\":{\"title\":\"Class Path\",\"type\":\"string\"},\"attributes\":{\"title\":\"Attributes\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/ServiceAttribute\"}},\"validator\":{\"title\":\"Validator\",\"type\":\"string\"}},\"additionalProperties\":false},\"CumulusCIConfig\":{\"title\":\"CumulusCIConfig\",\"type\":\"object\",\"properties\":{\"keychain\":{\"title\":\"Keychain\",\"type\":\"string\"}},\"required\":[\"keychain\"],\"additionalProperties\":false},\"Plan\":{\"title\":\"Plan\",\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"Title\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"tier\":{\"title\":\"Tier\",\"default\":\"primary\",\"enum\":[\"primary\",\"secondary\",\"additional\"],\"type\":\"string\"},\"slug\":{\"title\":\"Slug\",\"type\":\"string\"},\"is_listed\":{\"title\":\"Is Listed\",\"default\":true,\"type\":\"boolean\"},\"steps\":{\"title\":\"Steps\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Step\"}},\"checks\":{\"title\":\"Checks\",\"default\":[],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PreflightCheck\"}},\"error_message\":{\"title\":\"Error Message\",\"type\":\"string\"},\"post_install_message\":{\"title\":\"Post Install Message\",\"type\":\"string\"},\"preflight_message\":{\"title\":\"Preflight Message\",\"type\":\"string\"},\"allowed_org_providers\":{\"title\":\"Allowed Org Providers\",\"default\":[\"user\"],\"type\":\"array\",\"items\":{\"enum\":[\"devhub\",\"user\"],\"type\":\"string\"}}},\"additionalProperties\":false},\"LocalFolderSourceModel\":{\"title\":\"LocalFolderSourceModel\",\"type\":\"object\",\"properties\":{\"path\":{\"title\":\"Path\",\"format\":\"directory-path\",\"type\":\"string\"},\"allow_remote_code\":{\"title\":\"Allow Remote Code\",\"default\":false,\"type\":\"boolean\"}},\"required\":[\"path\"],\"additionalProperties\":false},\"GitHubSourceRelease\":{\"title\":\"GitHubSourceRelease\",\"description\":\"An enumeration.\",\"enum\":[\"latest\",\"previous\",\"latest_beta\"],\"type\":\"string\"},\"GitHubSourceModel\":{\"title\":\"GitHubSourceModel\",\"type\":\"object\",\"properties\":{\"github\":{\"title\":\"Github\",\"type\":\"string\"},\"resolution_strategy\":{\"title\":\"Resolution Strategy\",\"type\":\"string\"},\"commit\":{\"title\":\"Commit\",\"type\":\"string\"},\"ref\":{\"title\":\"Ref\",\"type\":\"string\"},\"branch\":{\"title\":\"Branch\",\"type\":\"string\"},\"tag\":{\"title\":\"Tag\",\"type\":\"string\"},\"release\":{\"$ref\":\"#/definitions/GitHubSourceRelease\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"allow_remote_code\":{\"title\":\"Allow Remote Code\",\"default\":false,\"type\":\"boolean\"}},\"required\":[\"github\"],\"additionalProperties\":false},\"CumulusCLIConfig\":{\"title\":\"CumulusCLIConfig\",\"type\":\"object\",\"properties\":{\"show_stacktraces\":{\"title\":\"Show Stacktraces\",\"default\":false,\"type\":\"boolean\"},\"plain_output\":{\"title\":\"Plain Output\",\"type\":\"boolean\"}},\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CumulusCIRoot\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"CumulusCIRoot","type":"object","properties":{"tasks":{"title":"Tasks","default":{},"type":"object","additionalProperties":{"$ref":"#/definitions/Task"}},"flows":{"title":"Flows","default":{},"type":"object","additionalProperties":{"$ref":"#/definitions/Flow"}},"project":{"title":"Project","default":{},"allOf":[{"$ref":"#/definitions/Project"}]},"orgs":{"title":"Orgs","default":{},"allOf":[{"$ref":"#/definitions/Orgs"}]},"services":{"title":"Services","default":{},"type":"object","additionalProperties":{"$ref":"#/definitions/Service"}},"cumulusci":{"$ref":"#/definitions/CumulusCIConfig"},"plans":{"title":"Plans","default":{},"type":"object","additionalProperties":{"$ref":"#/definitions/Plan"}},"minimum_cumulusci_version":{"title":"Minimum Cumulusci Version","type":"string"},"sources":{"title":"Sources","default":{},"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/definitions/LocalFolderSourceModel"},{"$ref":"#/definitions/GitHubSourceModel"}]}},"cli":{"$ref":"#/definitions/CumulusCLIConfig"}},"additionalProperties":false,"definitions":{"Task":{"title":"Task","type":"object","properties":{"class_path":{"title":"Class Path","type":"string"},"description":{"title":"Description","type":"string"},"group":{"title":"Group","type":"string"},"options":{"title":"Options","default":{},"additionalProperties":true,"type":"object"},"ui_options":{"title":"Ui Options","default":{},"additionalProperties":true,"type":"object"},"name":{"title":"Name","type":"string"}},"additionalProperties":false},"PreflightCheck":{"title":"PreflightCheck","type":"object","properties":{"when":{"title":"When","type":"string"},"action":{"title":"Action","type":"string"},"message":{"title":"Message","type":"string"}},"additionalProperties":false},"Step":{"title":"Step","type":"object","properties":{"task":{"title":"Task","type":"string"},"flow":{"title":"Flow","type":"string"},"ignore_failure":{"title":"Ignore Failure","default":false,"type":"boolean"},"when":{"title":"When","type":"string"},"options":{"title":"Options","default":{},"additionalProperties":true,"type":"object"},"ui_options":{"title":"Ui Options","default":{},"additionalProperties":true,"type":"object"},"checks":{"title":"Checks","default":[],"type":"array","items":{"$ref":"#/definitions/PreflightCheck"}},"description":{"title":"Description","type":"string"}},"additionalProperties":false},"Flow":{"title":"Flow","type":"object","properties":{"description":{"title":"Description","type":"string"},"steps":{"title":"Steps","type":"object","additionalProperties":{"$ref":"#/definitions/Step"}},"group":{"title":"Group","type":"string"}},"additionalProperties":false},"Package":{"title":"Package","type":"object","properties":{"name":{"title":"Name","type":"string"},"name_managed":{"title":"Name Managed","type":"string"},"namespace":{"title":"Namespace","type":"string"},"install_class":{"title":"Install Class","type":"string"},"uninstall_class":{"title":"Uninstall Class","type":"string"},"api_version":{"title":"Api Version","type":"string"},"metadata_package_id":{"title":"Metadata Package Id","type":"string"}},"additionalProperties":false},"Test":{"title":"Test","type":"object","properties":{"name_match":{"title":"Name Match","type":"string"}},"required":["name_match"],"additionalProperties":false},"ReleaseNotesParser":{"title":"ReleaseNotesParser","type":"object","properties":{"class_path":{"title":"Class Path","type":"string"},"title":{"title":"Title","type":"string"}},"required":["class_path","title"],"additionalProperties":false},"ReleaseNotes":{"title":"ReleaseNotes","type":"object","properties":{"parsers":{"title":"Parsers","type":"object","additionalProperties":{"$ref":"#/definitions/ReleaseNotesParser"}}},"required":["parsers"],"additionalProperties":false},"Git":{"title":"Git","type":"object","properties":{"repo_url":{"title":"Repo Url","type":"string"},"default_branch":{"title":"Default Branch","type":"string"},"prefix_feature":{"title":"Prefix Feature","type":"string"},"prefix_beta":{"title":"Prefix Beta","type":"string"},"prefix_release":{"title":"Prefix Release","type":"string"},"push_prefix_sandbox":{"title":"Push Prefix Sandbox","type":"string"},"push_prefix_production":{"title":"Push Prefix Production","type":"string"},"release_notes":{"$ref":"#/definitions/ReleaseNotes"},"2gp_context":{"title":"2Gp Context","type":"string"},"unlocked_context":{"title":"Unlocked Context","type":"string"}},"additionalProperties":false},"DependencyResolutions":{"title":"DependencyResolutions","type":"object","properties":{"production":{"title":"Production","type":"string"},"preproduction":{"title":"Preproduction","type":"string"},"resolution_strategies":{"title":"Resolution Strategies","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":false},"Project":{"title":"Project","type":"object","properties":{"name":{"title":"Name","type":"string"},"package":{"$ref":"#/definitions/Package"},"test":{"$ref":"#/definitions/Test"},"git":{"$ref":"#/definitions/Git"},"dependencies":{"title":"Dependencies","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"dependency_resolutions":{"$ref":"#/definitions/DependencyResolutions"},"dependency_pins":{"title":"Dependency Pins","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"source_format":{"title":"Source Format","default":"mdapi","enum":["sfdx","mdapi"],"type":"string"},"custom":{"title":"Custom","type":"object"}},"additionalProperties":false},"ScratchOrg":{"title":"ScratchOrg","type":"object","properties":{"config_file":{"title":"Config File","type":"string","format":"path"},"days":{"title":"Days","type":"integer"},"namespaced":{"title":"Namespaced","type":"string"},"setup_flow":{"title":"Setup Flow","type":"string"},"noancestors":{"title":"Noancestors","type":"boolean"},"release":{"title":"Release","enum":["preview","previous"],"type":"string"}},"additionalProperties":false},"Orgs":{"title":"Orgs","type":"object","properties":{"scratch":{"title":"Scratch","type":"object","additionalProperties":{"$ref":"#/definitions/ScratchOrg"}}},"additionalProperties":false},"ServiceAttribute":{"title":"ServiceAttribute","type":"object","properties":{"description":{"title":"Description","type":"string"},"required":{"title":"Required","type":"boolean"},"default_factory":{"title":"Default Factory","type":"string"},"default":{"title":"Default","type":"string"},"sensitive":{"title":"Sensitive","default":false,"type":"boolean"}},"additionalProperties":false},"Service":{"title":"Service","type":"object","properties":{"description":{"title":"Description","type":"string"},"class_path":{"title":"Class Path","type":"string"},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"$ref":"#/definitions/ServiceAttribute"}},"validator":{"title":"Validator","type":"string"}},"additionalProperties":false},"CumulusCIConfig":{"title":"CumulusCIConfig","type":"object","properties":{"keychain":{"title":"Keychain","type":"string"}},"required":["keychain"],"additionalProperties":false},"Plan":{"title":"Plan","type":"object","properties":{"title":{"title":"Title","type":"string"},"description":{"title":"Description","type":"string"},"tier":{"title":"Tier","default":"primary","enum":["primary","secondary","additional"],"type":"string"},"slug":{"title":"Slug","type":"string"},"is_listed":{"title":"Is Listed","default":true,"type":"boolean"},"steps":{"title":"Steps","type":"object","additionalProperties":{"$ref":"#/definitions/Step"}},"checks":{"title":"Checks","default":[],"type":"array","items":{"$ref":"#/definitions/PreflightCheck"}},"error_message":{"title":"Error Message","type":"string"},"post_install_message":{"title":"Post Install Message","type":"string"},"preflight_message":{"title":"Preflight Message","type":"string"},"allowed_org_providers":{"title":"Allowed Org Providers","default":["user"],"type":"array","items":{"enum":["devhub","user"],"type":"string"}}},"additionalProperties":false},"LocalFolderSourceModel":{"title":"LocalFolderSourceModel","type":"object","properties":{"path":{"title":"Path","format":"directory-path","type":"string"},"allow_remote_code":{"title":"Allow Remote Code","default":false,"type":"boolean"}},"required":["path"],"additionalProperties":false},"GitHubSourceRelease":{"title":"GitHubSourceRelease","description":"An enumeration.","enum":["latest","previous","latest_beta"],"type":"string"},"GitHubSourceModel":{"title":"GitHubSourceModel","type":"object","properties":{"github":{"title":"Github","type":"string"},"resolution_strategy":{"title":"Resolution Strategy","type":"string"},"commit":{"title":"Commit","type":"string"},"ref":{"title":"Ref","type":"string"},"branch":{"title":"Branch","type":"string"},"tag":{"title":"Tag","type":"string"},"release":{"$ref":"#/definitions/GitHubSourceRelease"},"description":{"title":"Description","type":"string"},"allow_remote_code":{"title":"Allow Remote Code","default":false,"type":"boolean"}},"required":["github"],"additionalProperties":false},"CumulusCLIConfig":{"title":"CumulusCLIConfig","type":"object","properties":{"show_stacktraces":{"title":"Show Stacktraces","default":false,"type":"boolean"},"plain_output":{"title":"Plain Output","type":"boolean"}},"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "CumulusCIRoot". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
CumulusCIRoot
|
schema-store
|
schema_store_228
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://oss-review-toolkit.org/curations.yml\",\"title\":\"ORT curations\",\"description\":\"The OSS-Review-Toolkit (ORT) provides a possibility to correct metadata and set the concluded license for a specific packages (dependencies) in curation files. A full list of all available options can be found at https://oss-review-toolkit.org/ort/docs/configuration/package-curations.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"curations\":{\"type\":\"object\",\"properties\":{\"comment\":{\"type\":\"string\"},\"authors\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"concluded_license\":{\"type\":\"string\"},\"cpe\":{\"type\":\"string\"},\"declared_license_mapping\":{\"type\":\"object\"},\"description\":{\"type\":\"string\"},\"homepage_url\":{\"type\":\"string\"},\"purl\":{\"type\":\"string\"},\"binary_artifact\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"},\"hash\":{\"$ref\":\"#/definitions/hash\"}},\"required\":[\"hash\",\"url\"]},\"source_artifact\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"},\"hash\":{\"$ref\":\"#/definitions/hash\"}},\"required\":[\"hash\",\"url\"]},\"vcs\":{\"$ref\":\"#/definitions/vcsMatcher\"},\"is_metadata_only\":{\"type\":\"boolean\"},\"is_modified\":{\"type\":\"boolean\"}}}},\"required\":[\"id\",\"curations\"]},\"definitions\":{\"vcsMatcher\":{\"anyOf\":[{\"required\":[\"type\"]},{\"required\":[\"url\"]},{\"required\":[\"revision\"]},{\"required\":[\"path\"]}],\"properties\":{\"path\":{\"type\":\"string\"},\"revision\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}},\"type\":\"object\"},\"hash\":{\"type\":[\"object\"],\"properties\":{\"value\":{\"type\":\"string\"},\"algorithm\":{\"type\":\"string\"}},\"required\":[\"value\",\"algorithm\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ORT curations\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://oss-review-toolkit.org/curations.yml","title":"ORT curations","description":"The OSS-Review-Toolkit (ORT) provides a possibility to correct metadata and set the concluded license for a specific packages (dependencies) in curation files. A full list of all available options can be found at https://oss-review-toolkit.org/ort/docs/configuration/package-curations.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"curations":{"type":"object","properties":{"comment":{"type":"string"},"authors":{"type":"array","items":[{"type":"string"}]},"concluded_license":{"type":"string"},"cpe":{"type":"string"},"declared_license_mapping":{"type":"object"},"description":{"type":"string"},"homepage_url":{"type":"string"},"purl":{"type":"string"},"binary_artifact":{"type":"object","properties":{"url":{"type":"string"},"hash":{"$ref":"#/definitions/hash"}},"required":["hash","url"]},"source_artifact":{"type":"object","properties":{"url":{"type":"string"},"hash":{"$ref":"#/definitions/hash"}},"required":["hash","url"]},"vcs":{"$ref":"#/definitions/vcsMatcher"},"is_metadata_only":{"type":"boolean"},"is_modified":{"type":"boolean"}}}},"required":["id","curations"]},"definitions":{"vcsMatcher":{"anyOf":[{"required":["type"]},{"required":["url"]},{"required":["revision"]},{"required":["path"]}],"properties":{"path":{"type":"string"},"revision":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"hash":{"type":["object"],"properties":{"value":{"type":"string"},"algorithm":{"type":"string"}},"required":["value","algorithm"]}}}
|
Provide a JSON object that satisfies the schema "ORT curations". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
ORT curations
|
schema-store
|
schema_store_229
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$ref\":\"#/$defs/Configuration\",\"$defs\":{\"Configuration\":{\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"golangci-lint version.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the binary.\"},\"destination\":{\"type\":\"string\",\"description\":\"Destination is the path to a directory to store the binary.\"},\"plugins\":{\"items\":{\"$ref\":\"#/$defs/Plugin\"},\"type\":\"array\",\"description\":\"Plugins information.\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"version\"],\"description\":\"Configuration represents the configuration file.\"},\"Plugin\":{\"oneOf\":[{\"required\":[\"version\"],\"title\":\"version\"},{\"required\":[\"path\"],\"title\":\"path\"}],\"properties\":{\"module\":{\"type\":\"string\",\"description\":\"Module name.\"},\"import\":{\"type\":\"string\",\"description\":\"Import to use.\"},\"version\":{\"type\":\"string\",\"description\":\"Version of the module.\\nOnly for module available through a Go proxy.\"},\"path\":{\"type\":\"string\",\"description\":\"Path to the local module.\\nOnly for local module.\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"module\"],\"description\":\"Plugin represents information about a plugin.\"}},\"description\":\"mygcl configuration definition file\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"custom-gcl.jsonschema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$ref":"#/$defs/Configuration","$defs":{"Configuration":{"properties":{"version":{"type":"string","description":"golangci-lint version."},"name":{"type":"string","description":"Name of the binary."},"destination":{"type":"string","description":"Destination is the path to a directory to store the binary."},"plugins":{"items":{"$ref":"#/$defs/Plugin"},"type":"array","description":"Plugins information."}},"additionalProperties":false,"type":"object","required":["version"],"description":"Configuration represents the configuration file."},"Plugin":{"oneOf":[{"required":["version"],"title":"version"},{"required":["path"],"title":"path"}],"properties":{"module":{"type":"string","description":"Module name."},"import":{"type":"string","description":"Import to use."},"version":{"type":"string","description":"Version of the module.\nOnly for module available through a Go proxy."},"path":{"type":"string","description":"Path to the local module.\nOnly for local module."}},"additionalProperties":false,"type":"object","required":["module"],"description":"Plugin represents information about a plugin."}},"description":"mygcl configuration definition file"}
|
Provide a JSON object that satisfies the schema "custom-gcl.jsonschema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
custom-gcl.jsonschema
|
schema-store
|
schema_store_230
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/custom_machinery_machine.json\",\"allOf\":[{\"if\":{\"required\":[\"name\"]},\"then\":{\"$ref\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/machine.json\"}},{\"if\":{\"required\":[\"parent\"]},\"then\":{\"$ref\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/upgraded_machine.json\"}}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"custom_machinery_machine\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/custom_machinery_machine.json","allOf":[{"if":{"required":["name"]},"then":{"$ref":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/machine.json"}},{"if":{"required":["parent"]},"then":{"$ref":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/upgraded_machine.json"}}]}
|
Provide a JSON object that satisfies the schema "custom_machinery_machine". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
custom_machinery_machine
|
schema-store
|
schema_store_231
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/custom_machinery_recipe.json\",\"allOf\":[{\"if\":{\"required\":[\"output\"]},\"then\":{\"$ref\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/craft_recipe.json\"}},{\"if\":{\"required\":[\"time\"]},\"then\":{\"$ref\":\"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/machine_recipe.json\"}}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"custom_machinery_recipe\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/custom_machinery_recipe.json","allOf":[{"if":{"required":["output"]},"then":{"$ref":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/craft_recipe.json"}},{"if":{"required":["time"]},"then":{"$ref":"https://alec016.github.io/Custom-Machinery/Json%20Schema/src/main/resources/schemas/machine_recipe.json"}}]}
|
Provide a JSON object that satisfies the schema "custom_machinery_recipe". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
custom_machinery_recipe
|
schema-store
|
schema_store_232
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$ref\":\"#/definitions/ICustomizationsConfig\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"AlbListenerProtocolEnum\":{\"enum\":[\"HTTP\",\"HTTPS\"],\"type\":\"string\"},\"AlbListenerTypeEnum\":{\"enum\":[\"fixed-response\",\"forward\",\"redirect\"],\"type\":\"string\"},\"AlbRoutingHttpConfigMitigationModeEnum\":{\"enum\":[\"monitor\",\"defensive\",\"strictest\"],\"type\":\"string\"},\"AlbSchemeEnum\":{\"enum\":[\"internet-facing\",\"internal\"],\"type\":\"string\"},\"AlpnPolicyEnum\":{\"enum\":[\"HTTP1Only\",\"HTTP2Only\",\"HTTP2Optional\",\"HTTP2Preferred\",\"None\"],\"type\":\"string\"},\"AutoScalingHealthCheckTypeEnum\":{\"enum\":[\"EC2\",\"ELB\"],\"type\":\"string\"},\"IAlbAttributesConfig\":{\"additionalProperties\":false,\"description\":\"Application Load Balancer attributes config.\",\"properties\":{\"deletionProtection\":{\"description\":\"Enable or disable deletion protection.\",\"type\":\"boolean\"},\"http2Enabled\":{\"description\":\"Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.\",\"type\":\"boolean\"},\"idleTimeout\":{\"description\":\"The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\",\"type\":\"number\"},\"routingHttpDesyncMitigationMode\":{\"$ref\":\"#/definitions/AlbRoutingHttpConfigMitigationModeEnum\",\"description\":\"Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are `monitor` , `defensive` , and `strictest` . The default is `defensive`.\"},\"routingHttpDropInvalidHeader\":{\"description\":\"Indicates whether HTTP headers with invalid header fields are removed by the load balancer ( true ) or routed to targets ( false ). The default is false.\",\"type\":\"boolean\"},\"routingHttpXAmznTlsCipherEnable\":{\"description\":\"Indicates whether the two headers ( x-amzn-tls-version and x-amzn-tls-cipher-suite ), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false . The default is false.\",\"type\":\"boolean\"},\"routingHttpXffClientPort\":{\"description\":\"Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false . The default is false.\",\"type\":\"boolean\"},\"routingHttpXffHeaderProcessingMode\":{\"$ref\":\"#/definitions/RoutingHttpXffHeaderProcessingModeEnum\",\"description\":\"Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.\"},\"wafFailOpen\":{\"description\":\"Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false.\",\"type\":\"boolean\"}},\"type\":\"object\"},\"IAlbListenerConfig\":{\"additionalProperties\":false,\"description\":\"Application Load Balancer listener config. Currently only action type of `forward`, `redirect` and `fixed-response` is allowed.\",\"properties\":{\"certificate\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Applies to HTTPS listeners. The default certificate for the listener. You must provide exactly one certificate arn or a certificate name which was created by LZA\"},\"fixedResponseConfig\":{\"$ref\":\"#/definitions/IAlbListenerFixedResponseConfig\",\"description\":\"Information for creating an action that returns a custom HTTP response. Specify only when type is `fixed-response`.\"},\"forwardConfig\":{\"$ref\":\"#/definitions/IAlbListenerForwardConfig\",\"description\":\"Information for creating an action that distributes requests to targetGroup. Stickiness for targetGroup can be set here.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the application load balancer listener\"},\"order\":{\"description\":\"The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first\",\"type\":\"number\"},\"port\":{\"description\":\"Port of the application load balancer listener\",\"type\":\"number\"},\"protocol\":{\"$ref\":\"#/definitions/AlbListenerProtocolEnum\",\"description\":\"Protocol of the application load balancer listener. The supported protocols are HTTP and HTTPS\"},\"redirectConfig\":{\"$ref\":\"#/definitions/IAlbListenerRedirectConfig\",\"description\":\"Information for creating a redirect action. Specify only when type is `redirect`.\"},\"sslPolicy\":{\"$ref\":\"#/definitions/SslPolicyAlbEnum\",\"description\":\"The security policy that defines which protocols and ciphers are supported.\"},\"targetGroup\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Target Group name to which traffic will be forwarded to. This name should be same as {@link ApplicationLoadBalancerTargetGroupConfig targetGroup } name.\"},\"type\":{\"$ref\":\"#/definitions/AlbListenerTypeEnum\",\"description\":\"Type of the application load balancer listener\"}},\"required\":[\"name\",\"port\",\"protocol\",\"type\",\"targetGroup\"],\"type\":\"object\"},\"IAlbListenerFixedResponseConfig\":{\"additionalProperties\":false,\"description\":\"Application load balancer listener fixed response config\\nIt returns a custom HTTP response.\\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `fixed-response`.\",\"properties\":{\"contentType\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The message to send back.\"},\"messageBody\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The HTTP response code (2XX, 4XX, or 5XX).\"},\"statusCode\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json\"}},\"required\":[\"statusCode\"],\"type\":\"object\"},\"IAlbListenerForwardConfig\":{\"additionalProperties\":false,\"description\":\"Application Load balancer listener forward config. Used to define forward action.\\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `forward`.\",\"properties\":{\"targetGroupStickinessConfig\":{\"$ref\":\"#/definitions/IAlbListenerTargetGroupStickinessConfig\"}},\"type\":\"object\"},\"IAlbListenerRedirectConfig\":{\"additionalProperties\":false,\"description\":\"Application Load balancer listener redirect config. Used to define redirect action.\\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `redirect`.\",\"properties\":{\"host\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"path\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"port\":{\"type\":\"number\"},\"protocol\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"query\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"statusCode\":{\"$ref\":\"#/definitions/NonEmptyString\"}},\"type\":\"object\"},\"IAlbListenerTargetGroupStickinessConfig\":{\"additionalProperties\":false,\"description\":\"Application Load balancer listener forward config target group stickiness config\\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `forward`.\",\"properties\":{\"durationSeconds\":{\"description\":\"The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).\",\"type\":\"number\"},\"enabled\":{\"description\":\"Indicates whether target group stickiness is enabled.\",\"type\":\"boolean\"}},\"type\":\"object\"},\"IAppConfigItem\":{\"additionalProperties\":false,\"description\":\"Application configuration.\\nUsed to define two tier application configurations for the accelerator.\",\"properties\":{\"applicationLoadBalancer\":{\"$ref\":\"#/definitions/IApplicationLoadBalancerConfig\",\"description\":\"Application Load Balancer for the application\"},\"autoscaling\":{\"$ref\":\"#/definitions/IAutoScalingConfig\",\"description\":\"AutoScalingGroup for the application\"},\"deploymentTargets\":{\"$ref\":\"#/definitions/IDeploymentTargets\",\"description\":\"The location where the application will be deployed.\"},\"launchTemplate\":{\"$ref\":\"#/definitions/ILaunchTemplateConfig\",\"description\":\"Launch Template for the application\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the application. This should be unique per application.\"},\"networkLoadBalancer\":{\"$ref\":\"#/definitions/INetworkLoadBalancerConfig\",\"description\":\"Network Load Balancer for the application\"},\"targetGroups\":{\"description\":\"Target groups for the application\",\"items\":{\"$ref\":\"#/definitions/ITargetGroupItem\"},\"type\":\"array\"},\"vpc\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"VPC where the application will be deployed. The value should be a reference to the vpc in the network config under `vpcs:`.\"}},\"required\":[\"name\",\"vpc\",\"deploymentTargets\"],\"type\":\"object\"},\"IApplicationLoadBalancerConfig\":{\"additionalProperties\":false,\"description\":\"Used to define Application Load Balancer configurations for the accelerator.\",\"properties\":{\"attributes\":{\"$ref\":\"#/definitions/IAlbAttributesConfig\",\"description\":\"Attributes for Application Load Balancer.\"},\"listeners\":{\"description\":\"Listeners for Application Load Balancer.\",\"items\":{\"$ref\":\"#/definitions/IAlbListenerConfig\"},\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the application load balancer\"},\"scheme\":{\"$ref\":\"#/definitions/AlbSchemeEnum\",\"description\":\"Internal or internet facing scheme for Application Load Balancer.\"},\"securityGroups\":{\"description\":\"Security Groups to attach to the Application Load Balancer.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"},\"shareTargets\":{\"$ref\":\"#/definitions/IShareTargets\",\"description\":\"The location where the Application Load Balancer(s) will be deployed to.\\n*\"},\"subnets\":{\"description\":\"Subnets to launch the Application Load Balancer in.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"}},\"required\":[\"name\",\"subnets\",\"securityGroups\"],\"type\":\"object\"},\"IAutoScalingConfig\":{\"additionalProperties\":false,\"description\":\"Autoscaling group configuration for the application.\",\"properties\":{\"desiredSize\":{\"description\":\"The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.\",\"type\":\"number\"},\"healthCheckGracePeriod\":{\"description\":\"The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the `InService` state. Defaults to 0 if unspecified.\",\"type\":\"number\"},\"healthCheckType\":{\"$ref\":\"#/definitions/AutoScalingHealthCheckTypeEnum\",\"description\":\"The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.\"},\"launchTemplate\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Information used to specify the launch template and version to use to launch instances.\"},\"maxInstanceLifetime\":{\"description\":\"The maximum instance lifetime specifies the maximum amount of time (in seconds) that an instance can be in service before it is terminated and replaced. A common use case might be a requirement to replace your instances on a schedule because of internal security policies or external compliance controls. You must specify a value of at least 86,400 seconds (one day). To clear a previously set value, specify a new value of 0. This setting applies to all current and future instances in your Auto Scaling group\",\"type\":\"number\"},\"maxSize\":{\"description\":\"The maximum size of the group.\",\"type\":\"number\"},\"minSize\":{\"description\":\"The minimum size of the group.\",\"type\":\"number\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\\n*Note* You cannot use a colon (:) in the name.\"},\"subnets\":{\"description\":\"List of subnet names for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. These subnets should be created under the VPC in network-config.yaml.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"},\"targetGroups\":{\"description\":\"Target group name array to associate with the Auto Scaling group. These names are from the {@link TargetGroupItemConfig target group } set in the application. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"}},\"required\":[\"name\",\"minSize\",\"maxSize\",\"desiredSize\",\"launchTemplate\",\"subnets\"],\"type\":\"object\"},\"IBlockDeviceMappingItem\":{\"additionalProperties\":false,\"description\":\"The parameters for a block device mapping in launch template.\",\"properties\":{\"deviceName\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The device name (for example, /dev/sdh or xvdh).\"},\"ebs\":{\"$ref\":\"#/definitions/IEbsItem\",\"description\":\"Parameters used to automatically set up EBS volumes when the instance is launched.\"}},\"required\":[\"deviceName\"],\"type\":\"object\"},\"ICfnParameter\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"required\":[\"name\",\"value\"],\"type\":\"object\"},\"ICloudFormationStack\":{\"additionalProperties\":false,\"description\":\"Defines a custom CloudFormation Stack to be deployed to the environment.\",\"properties\":{\"deploymentTargets\":{\"$ref\":\"#/definitions/IDeploymentTargets\",\"description\":\"CloudFormation Stack deployment targets\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The description is to used to provide more information about the stack.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name that will be used as a base for the created CloudFormation Stack Name. The name should not contain any spaces as this isn't supported by the Accelerator.\"},\"parameters\":{\"description\":\"The parameters to pass to the stack.\",\"items\":{\"$ref\":\"#/definitions/ICfnParameter\"},\"type\":\"array\"},\"regions\":{\"description\":\"A list of AWS regions to deploy the stack to.\",\"items\":{\"$ref\":\"#/definitions/Region\"},\"type\":\"array\"},\"runOrder\":{\"description\":\"The order to deploy the stack relative to the other stacks. Must be a positive integer. To deploy stacks in parallel, set runOrder of each stack to 1.\",\"type\":\"number\"},\"template\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The file path to the template file defining the stack.\"},\"terminationProtection\":{\"description\":\"This determines whether to enable termination protection for the stack.\",\"type\":\"boolean\"}},\"required\":[\"deploymentTargets\",\"name\",\"regions\",\"runOrder\",\"template\",\"terminationProtection\"],\"type\":\"object\"},\"ICloudFormationStackSet\":{\"additionalProperties\":false,\"description\":\"Defines a custom CloudFormation StackSet to be deployed to the environment.\",\"properties\":{\"administrationRoleArn\":{\"description\":\"The Amazon Resource Name (ARN) of the IAM role to use when creating this stack set. This field is optional. If specified, it allows you to set a custom IAM role for stack set operations. If left blank, the default permissions associated with your account will be used.\",\"type\":\"string\"},\"capabilities\":{\"description\":\"The CloudFormation capabilities enabled to deploy the stackset.\",\"items\":{\"enum\":[\"CAPABILITY_IAM\",\"CAPABILITY_NAMED_IAM\",\"CAPABILITY_AUTO_EXPAND\"],\"type\":\"string\"},\"type\":\"array\"},\"dependsOn\":{\"description\":\"The other StackSets this StackSet depends on. For stackset names you define here, a CloudFormation DependsOn attribute will be added between the resources. Please note this does not guarantee the deployment order of the stack instances within the StackSet.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"deploymentTargets\":{\"$ref\":\"#/definitions/IDeploymentTargets\",\"description\":\"CloudFormation StackSet deployment targets\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The description is to used to provide more information about the stackset.\"},\"executionRoleName\":{\"description\":\"The name of the IAM execution role to use when creating the stack set. This field is optional. If provided, it allows you to specify a custom execution role for stack set operations. If omitted, the default execution role associated with your account will be used.\",\"type\":\"string\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name that will be used as a base for the created CloudFormation StackSet Name. The name should not contain any spaces as this isn't supported by the Accelerator.\"},\"operationPreferences\":{\"$ref\":\"#/definitions/IOperationPreferences\",\"description\":\"The operational preferences of current stackset\"},\"parameters\":{\"description\":\"The parameters to be passed to the stackset.\",\"items\":{\"$ref\":\"#/definitions/ICfnParameter\"},\"type\":\"array\"},\"regions\":{\"description\":\"A list of regions to deploy the stackset.\",\"items\":{\"$ref\":\"#/definitions/Region\"},\"type\":\"array\"},\"template\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The file path to the template file used for deployment.\"}},\"required\":[\"deploymentTargets\",\"name\",\"regions\",\"template\"],\"type\":\"object\"},\"ICustomizationConfig\":{\"additionalProperties\":false,\"description\":\"Defines CloudFormation Stacks and StackSets to be deployed to the environment.\\nThis feature supports the deployment of customer-provided CloudFormation templates to AWS\\naccounts and/or organizational units. These deployments can leverage independent CloudFormation stacks\\nor CloudFormation StackSets depending on the customer's deployment preference.\",\"properties\":{\"cloudFormationStackSets\":{\"items\":{\"$ref\":\"#/definitions/ICloudFormationStackSet\"},\"type\":\"array\"},\"cloudFormationStacks\":{\"items\":{\"$ref\":\"#/definitions/ICloudFormationStack\"},\"type\":\"array\"},\"createCfnStackSetExecutionRole\":{\"type\":\"boolean\"},\"serviceCatalogPortfolios\":{\"items\":{\"$ref\":\"#/definitions/IPortfolioConfig\"},\"type\":\"array\"}},\"type\":\"object\"},\"ICustomizationsConfig\":{\"additionalProperties\":false,\"description\":\"Defines custom CloudFormation and external web and application tier resources. We recommend creating resources\\nwith native LZA features where possible.\",\"properties\":{\"applications\":{\"items\":{\"$ref\":\"#/definitions/IAppConfigItem\"},\"type\":\"array\"},\"createCfnStackSetExecutionRole\":{\"description\":\"Defines whether or not the StackSetExecution role is created in all workload accounts and if the StackSetAdmin role is created in the management account. If you are using stacksets and set the value to false, you will need to ensure that the roles are created.\\n\\nDefault value is true.\",\"type\":\"boolean\"},\"customizations\":{\"$ref\":\"#/definitions/ICustomizationConfig\"},\"firewalls\":{\"$ref\":\"#/definitions/IEc2FirewallConfig\"}},\"type\":\"object\"},\"IDeploymentTargets\":{\"additionalProperties\":false,\"properties\":{\"accounts\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"excludedAccounts\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"excludedRegions\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"organizationalUnits\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"},\"IEbsItem\":{\"additionalProperties\":false,\"description\":\"The parameters for a block device for an EBS volume.\",\"properties\":{\"deleteOnTermination\":{\"description\":\"Indicates whether the EBS volume is deleted on instance termination.\",\"type\":\"boolean\"},\"encrypted\":{\"description\":\"Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. If encrypted is `true` and kmsKeyId is not provided, then accelerator checks for {@link EbsDefaultVolumeEncryptionConfig default ebs encryption } in the config.\",\"type\":\"boolean\"},\"iops\":{\"description\":\"The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.\",\"type\":\"number\"},\"kmsKeyId\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.\"},\"snapshotId\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The ID of the snapshot.\"},\"throughput\":{\"description\":\"The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 1000.\",\"type\":\"number\"},\"volumeSize\":{\"description\":\"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\\n- gp2 and gp3: 1-16,384\\n- io1 and io2: 4-16,384\\n- st1 and sc1: 125-16,384\\n- standard: 1-1,024\",\"type\":\"number\"},\"volumeType\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The volume type. Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`\"}},\"type\":\"object\"},\"IEc2FirewallAutoScalingGroupConfig\":{\"additionalProperties\":false,\"description\":\"EC2 firewall autoscaling group configuration.\\nUsed to define EC2-based firewall instances to be deployed in an autoscaling group.\\n\\n```\\n- name: accelerator-firewall-asg\\n autoscaling:\\n name: firewall-asg\\n maxSize: 4\\n minSize: 1\\n desiredSize: 2\\n launchTemplate: firewall-lt\\n healthCheckGracePeriod: 300\\n healthCheckType: ELB\\n targetGroups:\\n - firewall-gwlb-tg\\n subnets:\\n - firewall-subnet-a\\n - firewall-subnet-b\\n maxInstanceLifetime: 86400\\n launchTemplate:\\n name: firewall-lt\\n blockDeviceMappings:\\n - deviceName: /dev/xvda\\n ebs:\\n deleteOnTermination: true\\n encrypted: true\\n volumeSize: 20\\n enforceImdsv2: true\\n iamInstanceProfile: firewall-profile\\n imageId: ami-123xyz\\n instanceType: c6i.xlarge\\n networkInterfaces:\\n - deleteOnTermination: true\\n description: Primary interface\\n deviceIndex: 0\\n groups:\\n - firewall-data-sg\\n - deleteOnTermination: true\\n description: Management interface\\n deviceIndex: 1\\n groups:\\n - firewall-mgmt-sg\\n userData: path/to/userdata.txt\\n vpc: Network-Inspection\\n tags: []\\n```\",\"properties\":{\"account\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) The logical name of the account to deploy the firewall autoscaling group to\"},\"autoscaling\":{\"$ref\":\"#/definitions/IAutoScalingConfig\",\"description\":\"An AutoScaling Group configuration\"},\"configDir\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 directory path to pull a firewall configuration directory.\\n\\nEither configFile or configDir can be set but not both.\\n\\nFor example, if your S3 folder path is `s3://path/to/config`, specify `path/to/config` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration directory.\"},\"configFile\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 object path to pull a firewall configuration file from.\\n\\nFor example, if your S3 object path is `s3://path/to/config.txt`, specify `path/to/config.txt` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration file.\"},\"launchTemplate\":{\"$ref\":\"#/definitions/ILaunchTemplateConfig\",\"description\":\"The launch template for the firewall instance\"},\"licenseFile\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 object path to pull a firewall license file from.\\n\\nFor example, if your S3 object path is `s3://path/to/license.lic`, specify `path/to/license.lic` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the license file.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name of the firewall instance\"},\"staticReplacements\":{\"description\":\"(OPTIONAL) Static firewall configuration replacements definition.\",\"items\":{\"$ref\":\"#/definitions/IFirewallStaticReplacementsConfig\"},\"type\":\"array\"},\"tags\":{\"description\":\"(OPTIONAL) An array of tags\",\"items\":{\"$ref\":\"#/definitions/ITag\"},\"type\":\"array\"},\"vpc\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name of the VPC to deploy the firewall instance to\"}},\"required\":[\"name\",\"autoscaling\",\"launchTemplate\",\"vpc\"],\"type\":\"object\"},\"IEc2FirewallConfig\":{\"additionalProperties\":false,\"description\":\"EC2 firewall configuration.\\nUsed to define EC2-based firewall and management appliances\",\"properties\":{\"autoscalingGroups\":{\"description\":\"Define EC2-based firewall instances in autoscaling groups\",\"items\":{\"$ref\":\"#/definitions/IEc2FirewallAutoScalingGroupConfig\"},\"type\":\"array\"},\"instances\":{\"description\":\"Define EC2-based firewall standalone instances\",\"items\":{\"$ref\":\"#/definitions/IEc2FirewallInstanceConfig\"},\"type\":\"array\"},\"managerInstances\":{\"description\":\"Define EC2-based firewall management instances\",\"items\":{\"$ref\":\"#/definitions/IEc2FirewallInstanceConfig\"},\"type\":\"array\"},\"targetGroups\":{\"description\":\"Define target groups for EC2-based firewalls\",\"items\":{\"$ref\":\"#/definitions/ITargetGroupItem\"},\"type\":\"array\"}},\"type\":\"object\"},\"IEc2FirewallInstanceConfig\":{\"additionalProperties\":false,\"description\":\"EC2 firewall instance configuration.\\nUse to define an array of standalone firewall instances\",\"properties\":{\"account\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) The logical name of the account to deploy the firewall instance to\"},\"configDir\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 directory path to pull a firewall configuration directory.\\n\\nEither configFile or configDir can be set but not both.\\n\\nFor example, if your S3 folder path is `s3://path/to/config`, specify `path/to/config` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration directory.\"},\"configFile\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 object path to pull a firewall configuration file from.\\n\\nFor example, if your S3 object path is `s3://path/to/config.txt`, specify `path/to/config.txt` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration file.\"},\"detailedMonitoring\":{\"description\":\"(OPTIONAL) Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.\",\"type\":\"boolean\"},\"launchTemplate\":{\"$ref\":\"#/definitions/ILaunchTemplateConfig\",\"description\":\"The launch template for the firewall instance\"},\"licenseFile\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"(OPTIONAL) Specify a relative S3 object path to pull a firewall license file from.\\n\\nFor example, if your S3 object path is `s3://path/to/license.lic`, specify `path/to/license.lic` for this property.\\n\\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the license file.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name of the firewall instance\"},\"staticReplacements\":{\"description\":\"(OPTIONAL) Static firewall configuration replacements definition.\",\"items\":{\"$ref\":\"#/definitions/IFirewallStaticReplacementsConfig\"},\"type\":\"array\"},\"tags\":{\"description\":\"(OPTIONAL) An array of tags\",\"items\":{\"$ref\":\"#/definitions/ITag\"},\"type\":\"array\"},\"terminationProtection\":{\"description\":\"(OPTIONAL) If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API.\\n\\nMore information: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination\",\"type\":\"boolean\"},\"vpc\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name of the VPC to deploy the firewall instance to\"}},\"required\":[\"name\",\"launchTemplate\",\"vpc\"],\"type\":\"object\"},\"IFirewallStaticReplacementsConfig\":{\"additionalProperties\":false,\"description\":\"Firewall Static Replacements Config\",\"properties\":{\"key\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The key name for the static replacement\"},\"value\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The value of the static replacement\"}},\"required\":[\"key\",\"value\"],\"type\":\"object\"},\"ILaunchTemplateConfig\":{\"additionalProperties\":false,\"description\":\"Configure a launch template for the application.\",\"properties\":{\"blockDeviceMappings\":{\"items\":{\"$ref\":\"#/definitions/IBlockDeviceMappingItem\"},\"type\":\"array\"},\"enforceImdsv2\":{\"description\":\"By default, {@link https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html IMDSv2 } is enabled. Disable it by setting this to false.\",\"type\":\"boolean\"},\"iamInstanceProfile\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Name of the instance profile created by accelerator in iam-config.yaml under roleSets\"},\"imageId\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Valid AMI ID or a reference to ssm parameter store to get AMI ID. If ssm parameter is referenced it should follow the pattern ${ACCEL_LOOKUP::ImageId:/path/to/ssm/parameter/for/ami}\\n\\nFor example to get the latest x86_64 amazon linux 2 ami, the value would be `${ACCEL_LOOKUP::ImageId:/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2}`\"},\"instanceType\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Valid instance type which can be launched in the target account and region.\"},\"keyPair\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the key pair. LZA does not create keypair. This should exist in the account/region or else deployment will fail.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"networkInterfaces\":{\"description\":\"One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.\",\"items\":{\"$ref\":\"#/definitions/INetworkInterfaceItem\"},\"type\":\"array\"},\"securityGroups\":{\"description\":\"One or more security group names. These should be created under the VPC in network-config.yaml\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"},\"userData\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Path to user data. The path is relative to the config repository and the content should be in regular text. It is encoded in base64 before passing in to Launch Template\"}},\"required\":[\"name\",\"imageId\",\"instanceType\"],\"type\":\"object\"},\"INetworkInterfaceItem\":{\"additionalProperties\":false,\"description\":\"The parameters for a network interface.\",\"properties\":{\"associateCarrierIpAddress\":{\"description\":\"Associates a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface.\",\"type\":\"boolean\"},\"associateElasticIp\":{\"description\":\"Associate an elastic IP with the interface\",\"type\":\"boolean\"},\"associatePublicIpAddress\":{\"description\":\"Associates a public IPv4 address with eth0 for a new network interface.\",\"type\":\"boolean\"},\"deleteOnTermination\":{\"description\":\"Indicates whether the network interface is deleted when the instance is terminated.\",\"type\":\"boolean\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"A description for the network interface.\"},\"deviceIndex\":{\"description\":\"The device index for the network interface attachment.\",\"type\":\"number\"},\"groups\":{\"description\":\"Security group names to associate with this network interface.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"},\"interfaceType\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. If you are not creating an EFA, specify interface or omit this parameter. Valid values: `interface | efa`\"},\"networkCardIndex\":{\"description\":\"The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.\",\"type\":\"number\"},\"networkInterfaceId\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The ID of the network interface.\"},\"privateIpAddress\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The primary private IPv4 address of the network interface.\"},\"privateIpAddresses\":{\"description\":\"One or more private IPv4 addresses.\",\"items\":{\"$ref\":\"#/definitions/IPrivateIpAddressItem\"},\"type\":\"array\"},\"secondaryPrivateIpAddressCount\":{\"description\":\"The number of secondary private IPv4 addresses to assign to a network interface.\",\"type\":\"number\"},\"sourceDestCheck\":{\"description\":\"If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.\",\"type\":\"boolean\"},\"subnetId\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Valid subnet name from network-config.yaml under the same vpc\"}},\"type\":\"object\"},\"INetworkLoadBalancerConfig\":{\"additionalProperties\":false,\"description\":\"Network Load Balancer configuration.\",\"properties\":{\"crossZoneLoadBalancing\":{\"description\":\"Cross Zone load balancing for Network Load Balancer.\",\"type\":\"boolean\"},\"deletionProtection\":{\"description\":\"Deletion protection for Network Load Balancer.\",\"type\":\"boolean\"},\"listeners\":{\"description\":\"Listeners for Network Load Balancer.\",\"items\":{\"$ref\":\"#/definitions/INlbListenerConfig\"},\"type\":\"array\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Name for Network Load Balancer.\"},\"scheme\":{\"$ref\":\"#/definitions/LoadBalancerSchemeEnum\",\"description\":\"Load Balancer scheme. If undefined, the default of {@link https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateLoadBalancer.html ELBv2 CreateLoadBalancer API } is used.\"},\"subnets\":{\"description\":\"Subnets to launch the Network Load Balancer in.\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"}},\"required\":[\"subnets\",\"name\"],\"type\":\"object\"},\"INlbListenerConfig\":{\"additionalProperties\":false,\"description\":\"Application Load Balancer listener config. Currently only action type of `forward`, `redirect` and `fixed-response` is allowed.\",\"properties\":{\"alpnPolicy\":{\"$ref\":\"#/definitions/AlpnPolicyEnum\",\"description\":\"Application-Layer Protocol Negotiation (ALPN) policy} for TLS encrypted traffic\"},\"certificate\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"ACM ARN of the certificate to be associated with the listener.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Name for Listener.\"},\"port\":{\"description\":\"Port where the traffic is directed to.\",\"type\":\"number\"},\"protocol\":{\"$ref\":\"#/definitions/NlbProtocolEnum\",\"description\":\"Protocol used for the traffic. The supported protocols are TCP, TLS, UDP, or TCP_UDP.\"},\"sslPolicy\":{\"$ref\":\"#/definitions/SslPolicyNlbEnum\",\"description\":\"SSL policy for TLS encrypted traffic\"},\"targetGroup\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Target Group to direct the traffic to.\"}},\"required\":[\"name\",\"targetGroup\"],\"type\":\"object\"},\"INlbTargetType\":{\"additionalProperties\":false,\"description\":\"The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.\",\"properties\":{\"account\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Friendly Account Name where the NLB is deployed\"},\"nlbName\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Friendly name of the NLB\"},\"region\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Region where the NLB is deployed\"}},\"required\":[\"account\",\"region\",\"nlbName\"],\"type\":\"object\"},\"IOperationPreferences\":{\"additionalProperties\":false,\"properties\":{\"failureToleranceCount\":{\"type\":\"number\"},\"failureTolerancePercentage\":{\"type\":\"number\"},\"maxConcurrentCount\":{\"type\":\"number\"},\"maxConcurrentPercentage\":{\"type\":\"number\"},\"regionConcurrencyType\":{\"type\":\"string\"},\"regionOrder\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"},\"IPortfolioAssociatoinConfig\":{\"additionalProperties\":false,\"description\":\"Portfolio Associations configuration\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Indicates the name of the principal to associate the portfolio with.\"},\"propagateAssociation\":{\"description\":\"Indicates whether the principal association should be created in accounts the portfolio is shared with. Verify the IAM principal exists in all accounts the portfolio is shared with before enabling.\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/PortfolioAssociationType\",\"description\":\"Indicates the type of portfolio association, valid values are: Group, User, and Role.\"}},\"required\":[\"type\",\"name\"],\"type\":\"object\"},\"IPortfolioConfig\":{\"additionalProperties\":false,\"description\":\"Service Catalog Portfolios configuration\",\"properties\":{\"account\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the account to deploy the portfolio.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the portfolio\"},\"portfolioAssociations\":{\"description\":\"Configuration of portfolio associations to give access to IAM principals.\",\"items\":{\"$ref\":\"#/definitions/IPortfolioAssociatoinConfig\"},\"type\":\"array\"},\"products\":{\"description\":\"Product Configuration\",\"items\":{\"$ref\":\"#/definitions/IProductConfig\"},\"type\":\"array\"},\"provider\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The provider of the portfolio\"},\"regions\":{\"description\":\"The region names to deploy the portfolio.\",\"items\":{\"$ref\":\"#/definitions/Region\"},\"type\":\"array\"},\"shareTagOptions\":{\"description\":\"Whether or not to share TagOptions with other account(s)/OU(s)\",\"type\":\"boolean\"},\"shareTargets\":{\"$ref\":\"#/definitions/IShareTargets\",\"description\":\"Portfolio share target. Sharing portfolios to Organizational Units is only supported for portfolios in the Management account.\"},\"tagOptions\":{\"description\":\"Portfolio TagOptions configuration\",\"items\":{\"$ref\":\"#/definitions/ITagOptionsConfig\"},\"type\":\"array\"}},\"required\":[\"name\",\"account\",\"regions\",\"provider\"],\"type\":\"object\"},\"IPrivateIpAddressItem\":{\"additionalProperties\":false,\"description\":\"Configure a secondary private IPv4 address for a network interface.\",\"properties\":{\"primary\":{\"description\":\"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.\",\"type\":\"boolean\"},\"privateIpAddress\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The private IPv4 address.\"}},\"type\":\"object\"},\"IProductConfig\":{\"additionalProperties\":false,\"description\":\"Service Catalog Products configuration\",\"properties\":{\"constraints\":{\"$ref\":\"#/definitions/IProductConstraintConfig\",\"description\":\"Product Constraint configuration\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Product description\"},\"distributor\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the product's publisher.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the product\"},\"owner\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The owner of the product\"},\"support\":{\"$ref\":\"#/definitions/IProductSupportConfig\",\"description\":\"Product support details.\"},\"tagOptions\":{\"description\":\"Product TagOptions configuration\",\"items\":{\"$ref\":\"#/definitions/ITagOptionsConfig\"},\"type\":\"array\"},\"versions\":{\"description\":\"Product version configuration\",\"items\":{\"$ref\":\"#/definitions/IProductVersionConfig\"},\"type\":\"array\"}},\"required\":[\"name\",\"owner\",\"versions\"],\"type\":\"object\"},\"IProductConstraintConfig\":{\"additionalProperties\":false,\"description\":\"Service Catalog Product Constraint configuration. For more information see https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html\",\"properties\":{\"launch\":{\"$ref\":\"#/definitions/IProductLaunchConstraintConfig\",\"description\":\"Launch constraint role name and type, supports LocalRole or Role.\"},\"notifications\":{\"description\":\"A list of SNS topic names to stream product notifications to\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"},\"tagUpdate\":{\"description\":\"Determines if Service Catalog Tag Update constraint is enabled\",\"type\":\"boolean\"}},\"type\":\"object\"},\"IProductLaunchConstraintConfig\":{\"additionalProperties\":false,\"description\":\"Service Catalog Product Constraint configuration. For more information see https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html\",\"properties\":{\"role\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the IAM Role.\"},\"type\":{\"$ref\":\"#/definitions/ProductLaunchConstraintType\",\"description\":\"The type of launch constraint, either Role or LocalRole. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html\"}},\"required\":[\"type\",\"role\"],\"type\":\"object\"},\"IProductSupportConfig\":{\"additionalProperties\":false,\"description\":\"Product Support configuration\",\"properties\":{\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Support description of how users should use email contact and support link.\"},\"email\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The email address to report issues with the product\"},\"url\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The url to the site where users can find support information or file tickets.\"}},\"type\":\"object\"},\"IProductVersionConfig\":{\"additionalProperties\":false,\"description\":\"Product Versions configuration\",\"properties\":{\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The version description\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Name of the version of the product\"},\"template\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The product template.\"}},\"required\":[\"name\",\"template\"],\"type\":\"object\"},\"IShareTargets\":{\"additionalProperties\":false,\"properties\":{\"accounts\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"organizationalUnits\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"},\"ITag\":{\"additionalProperties\":false,\"properties\":{\"key\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"required\":[\"key\",\"value\"],\"type\":\"object\"},\"ITagOptionsConfig\":{\"additionalProperties\":false,\"description\":\"Service Catalog TagOptions configuration.\",\"properties\":{\"key\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The tag key\"},\"values\":{\"description\":\"An array of values that can be used for the tag key\",\"items\":{\"$ref\":\"#/definitions/NonEmptyString\"},\"type\":\"array\"}},\"required\":[\"key\",\"values\"],\"type\":\"object\"},\"ITargetGroupAttributeTypes\":{\"additionalProperties\":false,\"description\":\"Set attributes for target group.\",\"properties\":{\"algorithm\":{\"$ref\":\"#/definitions/TargetGroupAttributeAlgorithm\",\"description\":\"The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin. The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.\"},\"appCookieDuration\":{\"description\":\"The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.\",\"type\":\"number\"},\"appCookieName\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer. The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.\"},\"connectionTermination\":{\"description\":\"Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.\",\"type\":\"boolean\"},\"deregistrationDelay\":{\"description\":\"The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.\",\"type\":\"number\"},\"lbCookieDuration\":{\"description\":\"The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.\",\"type\":\"number\"},\"preserveClientIp\":{\"description\":\"Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. The following attribute is supported only by Network Load Balancers.\",\"type\":\"boolean\"},\"proxyProtocolV2\":{\"description\":\"Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.\",\"type\":\"boolean\"},\"slowStart\":{\"description\":\"The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.\",\"type\":\"number\"},\"stickiness\":{\"description\":\"Indicates whether target stickiness is enabled. The value is true or false. The default is false.\",\"type\":\"boolean\"},\"stickinessType\":{\"$ref\":\"#/definitions/TargetGroupAttributeStickinessType\",\"description\":\"Indicates the type of stickiness. The possible values are: - lb_cookie and app_cookie for Application Load Balancers. - source_ip for Network Load Balancers. - source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers\"},\"targetFailover\":{\"$ref\":\"#/definitions/TargetGroupTargetFailoverType\",\"description\":\"Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered or becomes unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance\"}},\"type\":\"object\"},\"ITargetGroupHealthCheckType\":{\"additionalProperties\":false,\"description\":\"Configure health check for target group.\",\"properties\":{\"interval\":{\"description\":\"The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds.\",\"type\":\"number\"},\"path\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.\"},\"port\":{\"description\":\"The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is `traffic-port`, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.\",\"type\":\"number\"},\"protocol\":{\"$ref\":\"#/definitions/TargetGroupHealthCheckProtocolType\",\"description\":\"The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.\"},\"timeout\":{\"description\":\"The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2\\u2013120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds.\",\"type\":\"number\"}},\"type\":\"object\"},\"ITargetGroupItem\":{\"additionalProperties\":false,\"description\":\"Target Group Configuration\",\"properties\":{\"attributes\":{\"$ref\":\"#/definitions/ITargetGroupAttributeTypes\",\"description\":\"Target Group Attributes.\"},\"healthCheck\":{\"$ref\":\"#/definitions/ITargetGroupHealthCheckType\",\"description\":\"Target Group HealthCheck.\"},\"matcher\":{\"$ref\":\"#/definitions/ITargetGroupMatcherType\",\"description\":\"The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499.\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The name of the target group. This value is used in {@link ApplicationLoadBalancerListenerConfig Application Load Balancer listeners } , {@link NetworkLoadBalancerListenerConfig Network Load Balancer listeners } , and {@link AutoScalingConfig Autoscaling config } .\"},\"port\":{\"description\":\"The port on which the targets receive traffic.\",\"type\":\"number\"},\"protocol\":{\"$ref\":\"#/definitions/TargetGroupProtocolType\",\"description\":\"Target group protocol version. Should be one of HTTP, HTTPS, GENEVE, TCP, UDP, TCP_UDP or TLS The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. For Gateway Load Balancers, the supported protocol is GENEVE.\"},\"protocolVersion\":{\"$ref\":\"#/definitions/TargetGroupProtocolVersionType\",\"description\":\"The protocol version. Should be one of 'GRPC', 'HTTP1', 'HTTP2'. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.\"},\"shareTargets\":{\"$ref\":\"#/definitions/IShareTargets\",\"description\":\"The accounts/OUs location where the Target Group will be deployed to.\"},\"targets\":{\"description\":\"Target group targets. These targets should be the friendly names assigned to firewall instances.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/NonEmptyString\"},{\"$ref\":\"#/definitions/INlbTargetType\"}]},\"type\":\"array\"},\"threshold\":{\"$ref\":\"#/definitions/ITargetGroupThresholdType\",\"description\":\"Target Group Threshold.\"},\"type\":{\"$ref\":\"#/definitions/TargetGroupType\",\"description\":\"The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.\\n- `instance` - Register targets by instance ID. This is the default value.\\n- `ip` - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. `alb` - Register a single Application Load Balancer as a target.\"}},\"required\":[\"name\",\"port\",\"protocol\",\"type\"],\"type\":\"object\"},\"ITargetGroupMatcherType\":{\"additionalProperties\":false,\"description\":\"Add the ability to target an NLB created by the Landing Zone Accelerator\",\"properties\":{\"grpcCode\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"You can specify values between 0 and 99. You can specify multiple values (for example, \\\"0,1\\\") or a range of values (for example, \\\"0-5\\\"). The default value is 12.\"},\"httpCode\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, \\\"200,202\\\") or a range of values (for example, \\\"200-299\\\"). For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, \\\"200,202\\\") or a range of values (for example, \\\"200-299\\\"). Note that when using shorthand syntax, some values such as commas need to be escaped.\"}},\"type\":\"object\"},\"ITargetGroupThresholdType\":{\"additionalProperties\":false,\"description\":\"Configure health check threshold for target group.\",\"properties\":{\"healthy\":{\"description\":\"The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 3.\",\"type\":\"number\"},\"unhealthy\":{\"description\":\"The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 3.\",\"type\":\"number\"}},\"type\":\"object\"},\"LoadBalancerSchemeEnum\":{\"enum\":[\"internet-facing\",\"internal\"],\"type\":\"string\"},\"NlbProtocolEnum\":{\"enum\":[\"TCP\",\"UDP\",\"TLS\",\"TCP_UDP\"],\"type\":\"string\"},\"NonEmptyString\":{\"description\":\"A string that has at least 1 character\",\"minLength\":1,\"type\":\"string\"},\"PortfolioAssociationType\":{\"enum\":[\"User\",\"Group\",\"Role\",\"PermissionSet\"],\"type\":\"string\"},\"ProductLaunchConstraintType\":{\"enum\":[\"Role\",\"LocalRole\"],\"type\":\"string\"},\"Region\":{\"description\":\"AWS Region\",\"enum\":[\"af-south-1\",\"ap-east-1\",\"ap-northeast-1\",\"ap-northeast-2\",\"ap-northeast-3\",\"ap-south-1\",\"ap-south-2\",\"ap-southeast-1\",\"ap-southeast-2\",\"ap-southeast-3\",\"ap-southeast-4\",\"ap-southeast-5\",\"ca-central-1\",\"ca-west-1\",\"cn-north-1\",\"cn-northwest-1\",\"eu-central-1\",\"eu-central-2\",\"eu-north-1\",\"eu-south-1\",\"eu-south-2\",\"eu-west-1\",\"eu-west-2\",\"eu-west-3\",\"eu-isoe-west-1\",\"il-central-1\",\"me-central-1\",\"me-south-1\",\"sa-east-1\",\"us-east-1\",\"us-east-2\",\"us-gov-west-1\",\"us-gov-east-1\",\"us-iso-east-1\",\"us-isob-east-1\",\"us-iso-west-1\",\"us-isof-south-1\",\"us-isof-east-1\",\"us-west-1\",\"us-west-2\"],\"type\":\"string\"},\"RoutingHttpXffHeaderProcessingModeEnum\":{\"enum\":[\"append\",\"preserve\",\"remove\"],\"type\":\"string\"},\"SslPolicyAlbEnum\":{\"enum\":[\"ELBSecurityPolicy-TLS13-1-2-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Res-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06\",\"ELBSecurityPolicy-TLS13-1-1-2021-06\",\"ELBSecurityPolicy-TLS13-1-0-2021-06\",\"ELBSecurityPolicy-TLS13-1-3-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Res-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext0-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext1-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext2-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-1-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-0-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-3-FIPS-2023-04\",\"ELBSecurityPolicy-TLS-1-0-2015-04\",\"ELBSecurityPolicy-TLS-1-1-2017-01\",\"ELBSecurityPolicy-TLS-1-2-2017-01\",\"ELBSecurityPolicy-TLS-1-2-Ext-2018-06\",\"ELBSecurityPolicy-FS-2018-06\",\"ELBSecurityPolicy-FS-1-1-2019-08\",\"ELBSecurityPolicy-FS-1-2-2019-08\",\"ELBSecurityPolicy-FS-1-2-Res-2019-08\",\"ELBSecurityPolicy-2015-05\",\"ELBSecurityPolicy-FS-1-2-Res-2020-10\",\"ELBSecurityPolicy-2016-08\"],\"type\":\"string\"},\"SslPolicyNlbEnum\":{\"enum\":[\"ELBSecurityPolicy-TLS13-1-2-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Res-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06\",\"ELBSecurityPolicy-TLS13-1-1-2021-06\",\"ELBSecurityPolicy-TLS13-1-0-2021-06\",\"ELBSecurityPolicy-TLS13-1-3-2021-06\",\"ELBSecurityPolicy-TLS13-1-2-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Res-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext0-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext1-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-2-Ext2-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-1-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-0-FIPS-2023-04\",\"ELBSecurityPolicy-TLS13-1-3-FIPS-2023-04\",\"ELBSecurityPolicy-TLS-1-0-2015-04\",\"ELBSecurityPolicy-TLS-1-1-2017-01\",\"ELBSecurityPolicy-TLS-1-2-2017-01\",\"ELBSecurityPolicy-TLS-1-2-Ext-2018-06\",\"ELBSecurityPolicy-FS-2018-06\",\"ELBSecurityPolicy-FS-1-1-2019-08\",\"ELBSecurityPolicy-FS-1-2-2019-08\",\"ELBSecurityPolicy-FS-1-2-Res-2019-08\",\"ELBSecurityPolicy-2015-05\",\"ELBSecurityPolicy-FS-1-2-Res-2020-10\",\"ELBSecurityPolicy-2016-08\"],\"type\":\"string\"},\"TargetGroupAttributeAlgorithm\":{\"enum\":[\"round_robin\",\"least_outstanding_requests\"],\"type\":\"string\"},\"TargetGroupAttributeStickinessType\":{\"enum\":[\"lb_cookie\",\"app_cookie\",\"source_ip\",\"source_ip_dest_ip\",\"source_ip_dest_ip_proto\"],\"type\":\"string\"},\"TargetGroupHealthCheckProtocolType\":{\"enum\":[\"HTTP\",\"HTTPS\",\"TCP\"],\"type\":\"string\"},\"TargetGroupProtocolType\":{\"enum\":[\"TCP\",\"TLS\",\"UDP\",\"TCP_UDP\",\"HTTP\",\"HTTPS\",\"GENEVE\"],\"type\":\"string\"},\"TargetGroupProtocolVersionType\":{\"enum\":[\"GRPC\",\"HTTP1\",\"HTTP2\"],\"type\":\"string\"},\"TargetGroupTargetFailoverType\":{\"enum\":[\"no_rebalance\",\"rebalance\"],\"type\":\"string\"},\"TargetGroupType\":{\"enum\":[\"instance\",\"ip\",\"alb\",\"lambda\"],\"type\":\"string\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"customizations-config\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$ref":"#/definitions/ICustomizationsConfig","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"AlbListenerProtocolEnum":{"enum":["HTTP","HTTPS"],"type":"string"},"AlbListenerTypeEnum":{"enum":["fixed-response","forward","redirect"],"type":"string"},"AlbRoutingHttpConfigMitigationModeEnum":{"enum":["monitor","defensive","strictest"],"type":"string"},"AlbSchemeEnum":{"enum":["internet-facing","internal"],"type":"string"},"AlpnPolicyEnum":{"enum":["HTTP1Only","HTTP2Only","HTTP2Optional","HTTP2Preferred","None"],"type":"string"},"AutoScalingHealthCheckTypeEnum":{"enum":["EC2","ELB"],"type":"string"},"IAlbAttributesConfig":{"additionalProperties":false,"description":"Application Load Balancer attributes config.","properties":{"deletionProtection":{"description":"Enable or disable deletion protection.","type":"boolean"},"http2Enabled":{"description":"Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.","type":"boolean"},"idleTimeout":{"description":"The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.","type":"number"},"routingHttpDesyncMitigationMode":{"$ref":"#/definitions/AlbRoutingHttpConfigMitigationModeEnum","description":"Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are `monitor` , `defensive` , and `strictest` . The default is `defensive`."},"routingHttpDropInvalidHeader":{"description":"Indicates whether HTTP headers with invalid header fields are removed by the load balancer ( true ) or routed to targets ( false ). The default is false.","type":"boolean"},"routingHttpXAmznTlsCipherEnable":{"description":"Indicates whether the two headers ( x-amzn-tls-version and x-amzn-tls-cipher-suite ), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false . The default is false.","type":"boolean"},"routingHttpXffClientPort":{"description":"Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false . The default is false.","type":"boolean"},"routingHttpXffHeaderProcessingMode":{"$ref":"#/definitions/RoutingHttpXffHeaderProcessingModeEnum","description":"Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append."},"wafFailOpen":{"description":"Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are true and false. The default is false.","type":"boolean"}},"type":"object"},"IAlbListenerConfig":{"additionalProperties":false,"description":"Application Load Balancer listener config. Currently only action type of `forward`, `redirect` and `fixed-response` is allowed.","properties":{"certificate":{"$ref":"#/definitions/NonEmptyString","description":"Applies to HTTPS listeners. The default certificate for the listener. You must provide exactly one certificate arn or a certificate name which was created by LZA"},"fixedResponseConfig":{"$ref":"#/definitions/IAlbListenerFixedResponseConfig","description":"Information for creating an action that returns a custom HTTP response. Specify only when type is `fixed-response`."},"forwardConfig":{"$ref":"#/definitions/IAlbListenerForwardConfig","description":"Information for creating an action that distributes requests to targetGroup. Stickiness for targetGroup can be set here."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the application load balancer listener"},"order":{"description":"The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first","type":"number"},"port":{"description":"Port of the application load balancer listener","type":"number"},"protocol":{"$ref":"#/definitions/AlbListenerProtocolEnum","description":"Protocol of the application load balancer listener. The supported protocols are HTTP and HTTPS"},"redirectConfig":{"$ref":"#/definitions/IAlbListenerRedirectConfig","description":"Information for creating a redirect action. Specify only when type is `redirect`."},"sslPolicy":{"$ref":"#/definitions/SslPolicyAlbEnum","description":"The security policy that defines which protocols and ciphers are supported."},"targetGroup":{"$ref":"#/definitions/NonEmptyString","description":"Target Group name to which traffic will be forwarded to. This name should be same as {@link ApplicationLoadBalancerTargetGroupConfig targetGroup } name."},"type":{"$ref":"#/definitions/AlbListenerTypeEnum","description":"Type of the application load balancer listener"}},"required":["name","port","protocol","type","targetGroup"],"type":"object"},"IAlbListenerFixedResponseConfig":{"additionalProperties":false,"description":"Application load balancer listener fixed response config\nIt returns a custom HTTP response.\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `fixed-response`.","properties":{"contentType":{"$ref":"#/definitions/NonEmptyString","description":"The message to send back."},"messageBody":{"$ref":"#/definitions/NonEmptyString","description":"The HTTP response code (2XX, 4XX, or 5XX)."},"statusCode":{"$ref":"#/definitions/NonEmptyString","description":"The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json"}},"required":["statusCode"],"type":"object"},"IAlbListenerForwardConfig":{"additionalProperties":false,"description":"Application Load balancer listener forward config. Used to define forward action.\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `forward`.","properties":{"targetGroupStickinessConfig":{"$ref":"#/definitions/IAlbListenerTargetGroupStickinessConfig"}},"type":"object"},"IAlbListenerRedirectConfig":{"additionalProperties":false,"description":"Application Load balancer listener redirect config. Used to define redirect action.\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `redirect`.","properties":{"host":{"$ref":"#/definitions/NonEmptyString"},"path":{"$ref":"#/definitions/NonEmptyString"},"port":{"type":"number"},"protocol":{"$ref":"#/definitions/NonEmptyString"},"query":{"$ref":"#/definitions/NonEmptyString"},"statusCode":{"$ref":"#/definitions/NonEmptyString"}},"type":"object"},"IAlbListenerTargetGroupStickinessConfig":{"additionalProperties":false,"description":"Application Load balancer listener forward config target group stickiness config\nApplicable only when `type` under {@link ApplicationLoadBalancerListenerConfig listener} is `forward`.","properties":{"durationSeconds":{"description":"The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).","type":"number"},"enabled":{"description":"Indicates whether target group stickiness is enabled.","type":"boolean"}},"type":"object"},"IAppConfigItem":{"additionalProperties":false,"description":"Application configuration.\nUsed to define two tier application configurations for the accelerator.","properties":{"applicationLoadBalancer":{"$ref":"#/definitions/IApplicationLoadBalancerConfig","description":"Application Load Balancer for the application"},"autoscaling":{"$ref":"#/definitions/IAutoScalingConfig","description":"AutoScalingGroup for the application"},"deploymentTargets":{"$ref":"#/definitions/IDeploymentTargets","description":"The location where the application will be deployed."},"launchTemplate":{"$ref":"#/definitions/ILaunchTemplateConfig","description":"Launch Template for the application"},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the application. This should be unique per application."},"networkLoadBalancer":{"$ref":"#/definitions/INetworkLoadBalancerConfig","description":"Network Load Balancer for the application"},"targetGroups":{"description":"Target groups for the application","items":{"$ref":"#/definitions/ITargetGroupItem"},"type":"array"},"vpc":{"$ref":"#/definitions/NonEmptyString","description":"VPC where the application will be deployed. The value should be a reference to the vpc in the network config under `vpcs:`."}},"required":["name","vpc","deploymentTargets"],"type":"object"},"IApplicationLoadBalancerConfig":{"additionalProperties":false,"description":"Used to define Application Load Balancer configurations for the accelerator.","properties":{"attributes":{"$ref":"#/definitions/IAlbAttributesConfig","description":"Attributes for Application Load Balancer."},"listeners":{"description":"Listeners for Application Load Balancer.","items":{"$ref":"#/definitions/IAlbListenerConfig"},"type":"array"},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the application load balancer"},"scheme":{"$ref":"#/definitions/AlbSchemeEnum","description":"Internal or internet facing scheme for Application Load Balancer."},"securityGroups":{"description":"Security Groups to attach to the Application Load Balancer.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"},"shareTargets":{"$ref":"#/definitions/IShareTargets","description":"The location where the Application Load Balancer(s) will be deployed to.\n*"},"subnets":{"description":"Subnets to launch the Application Load Balancer in.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"}},"required":["name","subnets","securityGroups"],"type":"object"},"IAutoScalingConfig":{"additionalProperties":false,"description":"Autoscaling group configuration for the application.","properties":{"desiredSize":{"description":"The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.","type":"number"},"healthCheckGracePeriod":{"description":"The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the `InService` state. Defaults to 0 if unspecified.","type":"number"},"healthCheckType":{"$ref":"#/definitions/AutoScalingHealthCheckTypeEnum","description":"The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks."},"launchTemplate":{"$ref":"#/definitions/NonEmptyString","description":"Information used to specify the launch template and version to use to launch instances."},"maxInstanceLifetime":{"description":"The maximum instance lifetime specifies the maximum amount of time (in seconds) that an instance can be in service before it is terminated and replaced. A common use case might be a requirement to replace your instances on a schedule because of internal security policies or external compliance controls. You must specify a value of at least 86,400 seconds (one day). To clear a previously set value, specify a new value of 0. This setting applies to all current and future instances in your Auto Scaling group","type":"number"},"maxSize":{"description":"The maximum size of the group.","type":"number"},"minSize":{"description":"The minimum size of the group.","type":"number"},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\n*Note* You cannot use a colon (:) in the name."},"subnets":{"description":"List of subnet names for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. These subnets should be created under the VPC in network-config.yaml.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"},"targetGroups":{"description":"Target group name array to associate with the Auto Scaling group. These names are from the {@link TargetGroupItemConfig target group } set in the application. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"}},"required":["name","minSize","maxSize","desiredSize","launchTemplate","subnets"],"type":"object"},"IBlockDeviceMappingItem":{"additionalProperties":false,"description":"The parameters for a block device mapping in launch template.","properties":{"deviceName":{"$ref":"#/definitions/NonEmptyString","description":"The device name (for example, /dev/sdh or xvdh)."},"ebs":{"$ref":"#/definitions/IEbsItem","description":"Parameters used to automatically set up EBS volumes when the instance is launched."}},"required":["deviceName"],"type":"object"},"ICfnParameter":{"additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"ICloudFormationStack":{"additionalProperties":false,"description":"Defines a custom CloudFormation Stack to be deployed to the environment.","properties":{"deploymentTargets":{"$ref":"#/definitions/IDeploymentTargets","description":"CloudFormation Stack deployment targets"},"description":{"$ref":"#/definitions/NonEmptyString","description":"The description is to used to provide more information about the stack."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name that will be used as a base for the created CloudFormation Stack Name. The name should not contain any spaces as this isn't supported by the Accelerator."},"parameters":{"description":"The parameters to pass to the stack.","items":{"$ref":"#/definitions/ICfnParameter"},"type":"array"},"regions":{"description":"A list of AWS regions to deploy the stack to.","items":{"$ref":"#/definitions/Region"},"type":"array"},"runOrder":{"description":"The order to deploy the stack relative to the other stacks. Must be a positive integer. To deploy stacks in parallel, set runOrder of each stack to 1.","type":"number"},"template":{"$ref":"#/definitions/NonEmptyString","description":"The file path to the template file defining the stack."},"terminationProtection":{"description":"This determines whether to enable termination protection for the stack.","type":"boolean"}},"required":["deploymentTargets","name","regions","runOrder","template","terminationProtection"],"type":"object"},"ICloudFormationStackSet":{"additionalProperties":false,"description":"Defines a custom CloudFormation StackSet to be deployed to the environment.","properties":{"administrationRoleArn":{"description":"The Amazon Resource Name (ARN) of the IAM role to use when creating this stack set. This field is optional. If specified, it allows you to set a custom IAM role for stack set operations. If left blank, the default permissions associated with your account will be used.","type":"string"},"capabilities":{"description":"The CloudFormation capabilities enabled to deploy the stackset.","items":{"enum":["CAPABILITY_IAM","CAPABILITY_NAMED_IAM","CAPABILITY_AUTO_EXPAND"],"type":"string"},"type":"array"},"dependsOn":{"description":"The other StackSets this StackSet depends on. For stackset names you define here, a CloudFormation DependsOn attribute will be added between the resources. Please note this does not guarantee the deployment order of the stack instances within the StackSet.","items":{"type":"string"},"type":"array"},"deploymentTargets":{"$ref":"#/definitions/IDeploymentTargets","description":"CloudFormation StackSet deployment targets"},"description":{"$ref":"#/definitions/NonEmptyString","description":"The description is to used to provide more information about the stackset."},"executionRoleName":{"description":"The name of the IAM execution role to use when creating the stack set. This field is optional. If provided, it allows you to specify a custom execution role for stack set operations. If omitted, the default execution role associated with your account will be used.","type":"string"},"name":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name that will be used as a base for the created CloudFormation StackSet Name. The name should not contain any spaces as this isn't supported by the Accelerator."},"operationPreferences":{"$ref":"#/definitions/IOperationPreferences","description":"The operational preferences of current stackset"},"parameters":{"description":"The parameters to be passed to the stackset.","items":{"$ref":"#/definitions/ICfnParameter"},"type":"array"},"regions":{"description":"A list of regions to deploy the stackset.","items":{"$ref":"#/definitions/Region"},"type":"array"},"template":{"$ref":"#/definitions/NonEmptyString","description":"The file path to the template file used for deployment."}},"required":["deploymentTargets","name","regions","template"],"type":"object"},"ICustomizationConfig":{"additionalProperties":false,"description":"Defines CloudFormation Stacks and StackSets to be deployed to the environment.\nThis feature supports the deployment of customer-provided CloudFormation templates to AWS\naccounts and/or organizational units. These deployments can leverage independent CloudFormation stacks\nor CloudFormation StackSets depending on the customer's deployment preference.","properties":{"cloudFormationStackSets":{"items":{"$ref":"#/definitions/ICloudFormationStackSet"},"type":"array"},"cloudFormationStacks":{"items":{"$ref":"#/definitions/ICloudFormationStack"},"type":"array"},"createCfnStackSetExecutionRole":{"type":"boolean"},"serviceCatalogPortfolios":{"items":{"$ref":"#/definitions/IPortfolioConfig"},"type":"array"}},"type":"object"},"ICustomizationsConfig":{"additionalProperties":false,"description":"Defines custom CloudFormation and external web and application tier resources. We recommend creating resources\nwith native LZA features where possible.","properties":{"applications":{"items":{"$ref":"#/definitions/IAppConfigItem"},"type":"array"},"createCfnStackSetExecutionRole":{"description":"Defines whether or not the StackSetExecution role is created in all workload accounts and if the StackSetAdmin role is created in the management account. If you are using stacksets and set the value to false, you will need to ensure that the roles are created.\n\nDefault value is true.","type":"boolean"},"customizations":{"$ref":"#/definitions/ICustomizationConfig"},"firewalls":{"$ref":"#/definitions/IEc2FirewallConfig"}},"type":"object"},"IDeploymentTargets":{"additionalProperties":false,"properties":{"accounts":{"items":{"type":"string"},"type":"array"},"excludedAccounts":{"items":{"type":"string"},"type":"array"},"excludedRegions":{"items":{"type":"string"},"type":"array"},"organizationalUnits":{"items":{"type":"string"},"type":"array"}},"type":"object"},"IEbsItem":{"additionalProperties":false,"description":"The parameters for a block device for an EBS volume.","properties":{"deleteOnTermination":{"description":"Indicates whether the EBS volume is deleted on instance termination.","type":"boolean"},"encrypted":{"description":"Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. If encrypted is `true` and kmsKeyId is not provided, then accelerator checks for {@link EbsDefaultVolumeEncryptionConfig default ebs encryption } in the config.","type":"boolean"},"iops":{"description":"The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.","type":"number"},"kmsKeyId":{"$ref":"#/definitions/NonEmptyString","description":"The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption."},"snapshotId":{"$ref":"#/definitions/NonEmptyString","description":"The ID of the snapshot."},"throughput":{"description":"The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 1000.","type":"number"},"volumeSize":{"description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n- gp2 and gp3: 1-16,384\n- io1 and io2: 4-16,384\n- st1 and sc1: 125-16,384\n- standard: 1-1,024","type":"number"},"volumeType":{"$ref":"#/definitions/NonEmptyString","description":"The volume type. Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`"}},"type":"object"},"IEc2FirewallAutoScalingGroupConfig":{"additionalProperties":false,"description":"EC2 firewall autoscaling group configuration.\nUsed to define EC2-based firewall instances to be deployed in an autoscaling group.\n\n```\n- name: accelerator-firewall-asg\n autoscaling:\n name: firewall-asg\n maxSize: 4\n minSize: 1\n desiredSize: 2\n launchTemplate: firewall-lt\n healthCheckGracePeriod: 300\n healthCheckType: ELB\n targetGroups:\n - firewall-gwlb-tg\n subnets:\n - firewall-subnet-a\n - firewall-subnet-b\n maxInstanceLifetime: 86400\n launchTemplate:\n name: firewall-lt\n blockDeviceMappings:\n - deviceName: /dev/xvda\n ebs:\n deleteOnTermination: true\n encrypted: true\n volumeSize: 20\n enforceImdsv2: true\n iamInstanceProfile: firewall-profile\n imageId: ami-123xyz\n instanceType: c6i.xlarge\n networkInterfaces:\n - deleteOnTermination: true\n description: Primary interface\n deviceIndex: 0\n groups:\n - firewall-data-sg\n - deleteOnTermination: true\n description: Management interface\n deviceIndex: 1\n groups:\n - firewall-mgmt-sg\n userData: path/to/userdata.txt\n vpc: Network-Inspection\n tags: []\n```","properties":{"account":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) The logical name of the account to deploy the firewall autoscaling group to"},"autoscaling":{"$ref":"#/definitions/IAutoScalingConfig","description":"An AutoScaling Group configuration"},"configDir":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 directory path to pull a firewall configuration directory.\n\nEither configFile or configDir can be set but not both.\n\nFor example, if your S3 folder path is `s3://path/to/config`, specify `path/to/config` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration directory."},"configFile":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 object path to pull a firewall configuration file from.\n\nFor example, if your S3 object path is `s3://path/to/config.txt`, specify `path/to/config.txt` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration file."},"launchTemplate":{"$ref":"#/definitions/ILaunchTemplateConfig","description":"The launch template for the firewall instance"},"licenseFile":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 object path to pull a firewall license file from.\n\nFor example, if your S3 object path is `s3://path/to/license.lic`, specify `path/to/license.lic` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the license file."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name of the firewall instance"},"staticReplacements":{"description":"(OPTIONAL) Static firewall configuration replacements definition.","items":{"$ref":"#/definitions/IFirewallStaticReplacementsConfig"},"type":"array"},"tags":{"description":"(OPTIONAL) An array of tags","items":{"$ref":"#/definitions/ITag"},"type":"array"},"vpc":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name of the VPC to deploy the firewall instance to"}},"required":["name","autoscaling","launchTemplate","vpc"],"type":"object"},"IEc2FirewallConfig":{"additionalProperties":false,"description":"EC2 firewall configuration.\nUsed to define EC2-based firewall and management appliances","properties":{"autoscalingGroups":{"description":"Define EC2-based firewall instances in autoscaling groups","items":{"$ref":"#/definitions/IEc2FirewallAutoScalingGroupConfig"},"type":"array"},"instances":{"description":"Define EC2-based firewall standalone instances","items":{"$ref":"#/definitions/IEc2FirewallInstanceConfig"},"type":"array"},"managerInstances":{"description":"Define EC2-based firewall management instances","items":{"$ref":"#/definitions/IEc2FirewallInstanceConfig"},"type":"array"},"targetGroups":{"description":"Define target groups for EC2-based firewalls","items":{"$ref":"#/definitions/ITargetGroupItem"},"type":"array"}},"type":"object"},"IEc2FirewallInstanceConfig":{"additionalProperties":false,"description":"EC2 firewall instance configuration.\nUse to define an array of standalone firewall instances","properties":{"account":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) The logical name of the account to deploy the firewall instance to"},"configDir":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 directory path to pull a firewall configuration directory.\n\nEither configFile or configDir can be set but not both.\n\nFor example, if your S3 folder path is `s3://path/to/config`, specify `path/to/config` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration directory."},"configFile":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 object path to pull a firewall configuration file from.\n\nFor example, if your S3 object path is `s3://path/to/config.txt`, specify `path/to/config.txt` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the configuration file."},"detailedMonitoring":{"description":"(OPTIONAL) Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.","type":"boolean"},"launchTemplate":{"$ref":"#/definitions/ILaunchTemplateConfig","description":"The launch template for the firewall instance"},"licenseFile":{"$ref":"#/definitions/NonEmptyString","description":"(OPTIONAL) Specify a relative S3 object path to pull a firewall license file from.\n\nFor example, if your S3 object path is `s3://path/to/license.lic`, specify `path/to/license.lic` for this property.\n\n**NOTE:** The custom resource backing this feature does not force update on every core pipeline run. To update the resource, update the name of the license file."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name of the firewall instance"},"staticReplacements":{"description":"(OPTIONAL) Static firewall configuration replacements definition.","items":{"$ref":"#/definitions/IFirewallStaticReplacementsConfig"},"type":"array"},"tags":{"description":"(OPTIONAL) An array of tags","items":{"$ref":"#/definitions/ITag"},"type":"array"},"terminationProtection":{"description":"(OPTIONAL) If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API.\n\nMore information: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination","type":"boolean"},"vpc":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name of the VPC to deploy the firewall instance to"}},"required":["name","launchTemplate","vpc"],"type":"object"},"IFirewallStaticReplacementsConfig":{"additionalProperties":false,"description":"Firewall Static Replacements Config","properties":{"key":{"$ref":"#/definitions/NonEmptyString","description":"The key name for the static replacement"},"value":{"$ref":"#/definitions/NonEmptyString","description":"The value of the static replacement"}},"required":["key","value"],"type":"object"},"ILaunchTemplateConfig":{"additionalProperties":false,"description":"Configure a launch template for the application.","properties":{"blockDeviceMappings":{"items":{"$ref":"#/definitions/IBlockDeviceMappingItem"},"type":"array"},"enforceImdsv2":{"description":"By default, {@link https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html IMDSv2 } is enabled. Disable it by setting this to false.","type":"boolean"},"iamInstanceProfile":{"$ref":"#/definitions/NonEmptyString","description":"Name of the instance profile created by accelerator in iam-config.yaml under roleSets"},"imageId":{"$ref":"#/definitions/NonEmptyString","description":"Valid AMI ID or a reference to ssm parameter store to get AMI ID. If ssm parameter is referenced it should follow the pattern ${ACCEL_LOOKUP::ImageId:/path/to/ssm/parameter/for/ami}\n\nFor example to get the latest x86_64 amazon linux 2 ami, the value would be `${ACCEL_LOOKUP::ImageId:/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2}`"},"instanceType":{"$ref":"#/definitions/NonEmptyString","description":"Valid instance type which can be launched in the target account and region."},"keyPair":{"$ref":"#/definitions/NonEmptyString","description":"The name of the key pair. LZA does not create keypair. This should exist in the account/region or else deployment will fail."},"name":{"$ref":"#/definitions/NonEmptyString"},"networkInterfaces":{"description":"One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.","items":{"$ref":"#/definitions/INetworkInterfaceItem"},"type":"array"},"securityGroups":{"description":"One or more security group names. These should be created under the VPC in network-config.yaml","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"},"userData":{"$ref":"#/definitions/NonEmptyString","description":"Path to user data. The path is relative to the config repository and the content should be in regular text. It is encoded in base64 before passing in to Launch Template"}},"required":["name","imageId","instanceType"],"type":"object"},"INetworkInterfaceItem":{"additionalProperties":false,"description":"The parameters for a network interface.","properties":{"associateCarrierIpAddress":{"description":"Associates a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface.","type":"boolean"},"associateElasticIp":{"description":"Associate an elastic IP with the interface","type":"boolean"},"associatePublicIpAddress":{"description":"Associates a public IPv4 address with eth0 for a new network interface.","type":"boolean"},"deleteOnTermination":{"description":"Indicates whether the network interface is deleted when the instance is terminated.","type":"boolean"},"description":{"$ref":"#/definitions/NonEmptyString","description":"A description for the network interface."},"deviceIndex":{"description":"The device index for the network interface attachment.","type":"number"},"groups":{"description":"Security group names to associate with this network interface.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"},"interfaceType":{"$ref":"#/definitions/NonEmptyString","description":"The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. If you are not creating an EFA, specify interface or omit this parameter. Valid values: `interface | efa`"},"networkCardIndex":{"description":"The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.","type":"number"},"networkInterfaceId":{"$ref":"#/definitions/NonEmptyString","description":"The ID of the network interface."},"privateIpAddress":{"$ref":"#/definitions/NonEmptyString","description":"The primary private IPv4 address of the network interface."},"privateIpAddresses":{"description":"One or more private IPv4 addresses.","items":{"$ref":"#/definitions/IPrivateIpAddressItem"},"type":"array"},"secondaryPrivateIpAddressCount":{"description":"The number of secondary private IPv4 addresses to assign to a network interface.","type":"number"},"sourceDestCheck":{"description":"If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.","type":"boolean"},"subnetId":{"$ref":"#/definitions/NonEmptyString","description":"Valid subnet name from network-config.yaml under the same vpc"}},"type":"object"},"INetworkLoadBalancerConfig":{"additionalProperties":false,"description":"Network Load Balancer configuration.","properties":{"crossZoneLoadBalancing":{"description":"Cross Zone load balancing for Network Load Balancer.","type":"boolean"},"deletionProtection":{"description":"Deletion protection for Network Load Balancer.","type":"boolean"},"listeners":{"description":"Listeners for Network Load Balancer.","items":{"$ref":"#/definitions/INlbListenerConfig"},"type":"array"},"name":{"$ref":"#/definitions/NonEmptyString","description":"Name for Network Load Balancer."},"scheme":{"$ref":"#/definitions/LoadBalancerSchemeEnum","description":"Load Balancer scheme. If undefined, the default of {@link https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateLoadBalancer.html ELBv2 CreateLoadBalancer API } is used."},"subnets":{"description":"Subnets to launch the Network Load Balancer in.","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"}},"required":["subnets","name"],"type":"object"},"INlbListenerConfig":{"additionalProperties":false,"description":"Application Load Balancer listener config. Currently only action type of `forward`, `redirect` and `fixed-response` is allowed.","properties":{"alpnPolicy":{"$ref":"#/definitions/AlpnPolicyEnum","description":"Application-Layer Protocol Negotiation (ALPN) policy} for TLS encrypted traffic"},"certificate":{"$ref":"#/definitions/NonEmptyString","description":"ACM ARN of the certificate to be associated with the listener."},"name":{"$ref":"#/definitions/NonEmptyString","description":"Name for Listener."},"port":{"description":"Port where the traffic is directed to.","type":"number"},"protocol":{"$ref":"#/definitions/NlbProtocolEnum","description":"Protocol used for the traffic. The supported protocols are TCP, TLS, UDP, or TCP_UDP."},"sslPolicy":{"$ref":"#/definitions/SslPolicyNlbEnum","description":"SSL policy for TLS encrypted traffic"},"targetGroup":{"$ref":"#/definitions/NonEmptyString","description":"Target Group to direct the traffic to."}},"required":["name","targetGroup"],"type":"object"},"INlbTargetType":{"additionalProperties":false,"description":"The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.","properties":{"account":{"$ref":"#/definitions/NonEmptyString","description":"Friendly Account Name where the NLB is deployed"},"nlbName":{"$ref":"#/definitions/NonEmptyString","description":"Friendly name of the NLB"},"region":{"$ref":"#/definitions/NonEmptyString","description":"Region where the NLB is deployed"}},"required":["account","region","nlbName"],"type":"object"},"IOperationPreferences":{"additionalProperties":false,"properties":{"failureToleranceCount":{"type":"number"},"failureTolerancePercentage":{"type":"number"},"maxConcurrentCount":{"type":"number"},"maxConcurrentPercentage":{"type":"number"},"regionConcurrencyType":{"type":"string"},"regionOrder":{"items":{"type":"string"},"type":"array"}},"type":"object"},"IPortfolioAssociatoinConfig":{"additionalProperties":false,"description":"Portfolio Associations configuration","properties":{"name":{"$ref":"#/definitions/NonEmptyString","description":"Indicates the name of the principal to associate the portfolio with."},"propagateAssociation":{"description":"Indicates whether the principal association should be created in accounts the portfolio is shared with. Verify the IAM principal exists in all accounts the portfolio is shared with before enabling.","type":"boolean"},"type":{"$ref":"#/definitions/PortfolioAssociationType","description":"Indicates the type of portfolio association, valid values are: Group, User, and Role."}},"required":["type","name"],"type":"object"},"IPortfolioConfig":{"additionalProperties":false,"description":"Service Catalog Portfolios configuration","properties":{"account":{"$ref":"#/definitions/NonEmptyString","description":"The name of the account to deploy the portfolio."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the portfolio"},"portfolioAssociations":{"description":"Configuration of portfolio associations to give access to IAM principals.","items":{"$ref":"#/definitions/IPortfolioAssociatoinConfig"},"type":"array"},"products":{"description":"Product Configuration","items":{"$ref":"#/definitions/IProductConfig"},"type":"array"},"provider":{"$ref":"#/definitions/NonEmptyString","description":"The provider of the portfolio"},"regions":{"description":"The region names to deploy the portfolio.","items":{"$ref":"#/definitions/Region"},"type":"array"},"shareTagOptions":{"description":"Whether or not to share TagOptions with other account(s)/OU(s)","type":"boolean"},"shareTargets":{"$ref":"#/definitions/IShareTargets","description":"Portfolio share target. Sharing portfolios to Organizational Units is only supported for portfolios in the Management account."},"tagOptions":{"description":"Portfolio TagOptions configuration","items":{"$ref":"#/definitions/ITagOptionsConfig"},"type":"array"}},"required":["name","account","regions","provider"],"type":"object"},"IPrivateIpAddressItem":{"additionalProperties":false,"description":"Configure a secondary private IPv4 address for a network interface.","properties":{"primary":{"description":"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.","type":"boolean"},"privateIpAddress":{"$ref":"#/definitions/NonEmptyString","description":"The private IPv4 address."}},"type":"object"},"IProductConfig":{"additionalProperties":false,"description":"Service Catalog Products configuration","properties":{"constraints":{"$ref":"#/definitions/IProductConstraintConfig","description":"Product Constraint configuration"},"description":{"$ref":"#/definitions/NonEmptyString","description":"Product description"},"distributor":{"$ref":"#/definitions/NonEmptyString","description":"The name of the product's publisher."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the product"},"owner":{"$ref":"#/definitions/NonEmptyString","description":"The owner of the product"},"support":{"$ref":"#/definitions/IProductSupportConfig","description":"Product support details."},"tagOptions":{"description":"Product TagOptions configuration","items":{"$ref":"#/definitions/ITagOptionsConfig"},"type":"array"},"versions":{"description":"Product version configuration","items":{"$ref":"#/definitions/IProductVersionConfig"},"type":"array"}},"required":["name","owner","versions"],"type":"object"},"IProductConstraintConfig":{"additionalProperties":false,"description":"Service Catalog Product Constraint configuration. For more information see https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html","properties":{"launch":{"$ref":"#/definitions/IProductLaunchConstraintConfig","description":"Launch constraint role name and type, supports LocalRole or Role."},"notifications":{"description":"A list of SNS topic names to stream product notifications to","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"},"tagUpdate":{"description":"Determines if Service Catalog Tag Update constraint is enabled","type":"boolean"}},"type":"object"},"IProductLaunchConstraintConfig":{"additionalProperties":false,"description":"Service Catalog Product Constraint configuration. For more information see https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html","properties":{"role":{"$ref":"#/definitions/NonEmptyString","description":"The name of the IAM Role."},"type":{"$ref":"#/definitions/ProductLaunchConstraintType","description":"The type of launch constraint, either Role or LocalRole. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html"}},"required":["type","role"],"type":"object"},"IProductSupportConfig":{"additionalProperties":false,"description":"Product Support configuration","properties":{"description":{"$ref":"#/definitions/NonEmptyString","description":"Support description of how users should use email contact and support link."},"email":{"$ref":"#/definitions/NonEmptyString","description":"The email address to report issues with the product"},"url":{"$ref":"#/definitions/NonEmptyString","description":"The url to the site where users can find support information or file tickets."}},"type":"object"},"IProductVersionConfig":{"additionalProperties":false,"description":"Product Versions configuration","properties":{"description":{"$ref":"#/definitions/NonEmptyString","description":"The version description"},"name":{"$ref":"#/definitions/NonEmptyString","description":"Name of the version of the product"},"template":{"$ref":"#/definitions/NonEmptyString","description":"The product template."}},"required":["name","template"],"type":"object"},"IShareTargets":{"additionalProperties":false,"properties":{"accounts":{"items":{"type":"string"},"type":"array"},"organizationalUnits":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ITag":{"additionalProperties":false,"properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"type":"object"},"ITagOptionsConfig":{"additionalProperties":false,"description":"Service Catalog TagOptions configuration.","properties":{"key":{"$ref":"#/definitions/NonEmptyString","description":"The tag key"},"values":{"description":"An array of values that can be used for the tag key","items":{"$ref":"#/definitions/NonEmptyString"},"type":"array"}},"required":["key","values"],"type":"object"},"ITargetGroupAttributeTypes":{"additionalProperties":false,"description":"Set attributes for target group.","properties":{"algorithm":{"$ref":"#/definitions/TargetGroupAttributeAlgorithm","description":"The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin. The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address."},"appCookieDuration":{"description":"The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.","type":"number"},"appCookieName":{"$ref":"#/definitions/NonEmptyString","description":"Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer. The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address."},"connectionTermination":{"description":"Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.","type":"boolean"},"deregistrationDelay":{"description":"The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.","type":"number"},"lbCookieDuration":{"description":"The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.","type":"number"},"preserveClientIp":{"description":"Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. The following attribute is supported only by Network Load Balancers.","type":"boolean"},"proxyProtocolV2":{"description":"Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. The following attribute is supported only by Network Load Balancers.","type":"boolean"},"slowStart":{"description":"The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address.","type":"number"},"stickiness":{"description":"Indicates whether target stickiness is enabled. The value is true or false. The default is false.","type":"boolean"},"stickinessType":{"$ref":"#/definitions/TargetGroupAttributeStickinessType","description":"Indicates the type of stickiness. The possible values are: - lb_cookie and app_cookie for Application Load Balancers. - source_ip for Network Load Balancers. - source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers"},"targetFailover":{"$ref":"#/definitions/TargetGroupTargetFailoverType","description":"Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered or becomes unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance"}},"type":"object"},"ITargetGroupHealthCheckType":{"additionalProperties":false,"description":"Configure health check for target group.","properties":{"interval":{"description":"The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds.","type":"number"},"path":{"$ref":"#/definitions/NonEmptyString","description":"[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck."},"port":{"description":"The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is `traffic-port`, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.","type":"number"},"protocol":{"$ref":"#/definitions/TargetGroupHealthCheckProtocolType","description":"The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks."},"timeout":{"description":"The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2\u2013120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds.","type":"number"}},"type":"object"},"ITargetGroupItem":{"additionalProperties":false,"description":"Target Group Configuration","properties":{"attributes":{"$ref":"#/definitions/ITargetGroupAttributeTypes","description":"Target Group Attributes."},"healthCheck":{"$ref":"#/definitions/ITargetGroupHealthCheckType","description":"Target Group HealthCheck."},"matcher":{"$ref":"#/definitions/ITargetGroupMatcherType","description":"The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499."},"name":{"$ref":"#/definitions/NonEmptyString","description":"The name of the target group. This value is used in {@link ApplicationLoadBalancerListenerConfig Application Load Balancer listeners } , {@link NetworkLoadBalancerListenerConfig Network Load Balancer listeners } , and {@link AutoScalingConfig Autoscaling config } ."},"port":{"description":"The port on which the targets receive traffic.","type":"number"},"protocol":{"$ref":"#/definitions/TargetGroupProtocolType","description":"Target group protocol version. Should be one of HTTP, HTTPS, GENEVE, TCP, UDP, TCP_UDP or TLS The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. For Gateway Load Balancers, the supported protocol is GENEVE."},"protocolVersion":{"$ref":"#/definitions/TargetGroupProtocolVersionType","description":"The protocol version. Should be one of 'GRPC', 'HTTP1', 'HTTP2'. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1."},"shareTargets":{"$ref":"#/definitions/IShareTargets","description":"The accounts/OUs location where the Target Group will be deployed to."},"targets":{"description":"Target group targets. These targets should be the friendly names assigned to firewall instances.","items":{"anyOf":[{"$ref":"#/definitions/NonEmptyString"},{"$ref":"#/definitions/INlbTargetType"}]},"type":"array"},"threshold":{"$ref":"#/definitions/ITargetGroupThresholdType","description":"Target Group Threshold."},"type":{"$ref":"#/definitions/TargetGroupType","description":"The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.\n- `instance` - Register targets by instance ID. This is the default value.\n- `ip` - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. `alb` - Register a single Application Load Balancer as a target."}},"required":["name","port","protocol","type"],"type":"object"},"ITargetGroupMatcherType":{"additionalProperties":false,"description":"Add the ability to target an NLB created by the Landing Zone Accelerator","properties":{"grpcCode":{"$ref":"#/definitions/NonEmptyString","description":"You can specify values between 0 and 99. You can specify multiple values (for example, \"0,1\") or a range of values (for example, \"0-5\"). The default value is 12."},"httpCode":{"$ref":"#/definitions/NonEmptyString","description":"For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\"). For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\"). Note that when using shorthand syntax, some values such as commas need to be escaped."}},"type":"object"},"ITargetGroupThresholdType":{"additionalProperties":false,"description":"Configure health check threshold for target group.","properties":{"healthy":{"description":"The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 3.","type":"number"},"unhealthy":{"description":"The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 3.","type":"number"}},"type":"object"},"LoadBalancerSchemeEnum":{"enum":["internet-facing","internal"],"type":"string"},"NlbProtocolEnum":{"enum":["TCP","UDP","TLS","TCP_UDP"],"type":"string"},"NonEmptyString":{"description":"A string that has at least 1 character","minLength":1,"type":"string"},"PortfolioAssociationType":{"enum":["User","Group","Role","PermissionSet"],"type":"string"},"ProductLaunchConstraintType":{"enum":["Role","LocalRole"],"type":"string"},"Region":{"description":"AWS Region","enum":["af-south-1","ap-east-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-south-1","ap-south-2","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ap-southeast-5","ca-central-1","ca-west-1","cn-north-1","cn-northwest-1","eu-central-1","eu-central-2","eu-north-1","eu-south-1","eu-south-2","eu-west-1","eu-west-2","eu-west-3","eu-isoe-west-1","il-central-1","me-central-1","me-south-1","sa-east-1","us-east-1","us-east-2","us-gov-west-1","us-gov-east-1","us-iso-east-1","us-isob-east-1","us-iso-west-1","us-isof-south-1","us-isof-east-1","us-west-1","us-west-2"],"type":"string"},"RoutingHttpXffHeaderProcessingModeEnum":{"enum":["append","preserve","remove"],"type":"string"},"SslPolicyAlbEnum":{"enum":["ELBSecurityPolicy-TLS13-1-2-2021-06","ELBSecurityPolicy-TLS13-1-2-Res-2021-06","ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06","ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06","ELBSecurityPolicy-TLS13-1-1-2021-06","ELBSecurityPolicy-TLS13-1-0-2021-06","ELBSecurityPolicy-TLS13-1-3-2021-06","ELBSecurityPolicy-TLS13-1-2-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Res-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext0-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext1-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext2-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-1-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-0-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-3-FIPS-2023-04","ELBSecurityPolicy-TLS-1-0-2015-04","ELBSecurityPolicy-TLS-1-1-2017-01","ELBSecurityPolicy-TLS-1-2-2017-01","ELBSecurityPolicy-TLS-1-2-Ext-2018-06","ELBSecurityPolicy-FS-2018-06","ELBSecurityPolicy-FS-1-1-2019-08","ELBSecurityPolicy-FS-1-2-2019-08","ELBSecurityPolicy-FS-1-2-Res-2019-08","ELBSecurityPolicy-2015-05","ELBSecurityPolicy-FS-1-2-Res-2020-10","ELBSecurityPolicy-2016-08"],"type":"string"},"SslPolicyNlbEnum":{"enum":["ELBSecurityPolicy-TLS13-1-2-2021-06","ELBSecurityPolicy-TLS13-1-2-Res-2021-06","ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06","ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06","ELBSecurityPolicy-TLS13-1-1-2021-06","ELBSecurityPolicy-TLS13-1-0-2021-06","ELBSecurityPolicy-TLS13-1-3-2021-06","ELBSecurityPolicy-TLS13-1-2-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Res-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext0-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext1-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-2-Ext2-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-1-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-0-FIPS-2023-04","ELBSecurityPolicy-TLS13-1-3-FIPS-2023-04","ELBSecurityPolicy-TLS-1-0-2015-04","ELBSecurityPolicy-TLS-1-1-2017-01","ELBSecurityPolicy-TLS-1-2-2017-01","ELBSecurityPolicy-TLS-1-2-Ext-2018-06","ELBSecurityPolicy-FS-2018-06","ELBSecurityPolicy-FS-1-1-2019-08","ELBSecurityPolicy-FS-1-2-2019-08","ELBSecurityPolicy-FS-1-2-Res-2019-08","ELBSecurityPolicy-2015-05","ELBSecurityPolicy-FS-1-2-Res-2020-10","ELBSecurityPolicy-2016-08"],"type":"string"},"TargetGroupAttributeAlgorithm":{"enum":["round_robin","least_outstanding_requests"],"type":"string"},"TargetGroupAttributeStickinessType":{"enum":["lb_cookie","app_cookie","source_ip","source_ip_dest_ip","source_ip_dest_ip_proto"],"type":"string"},"TargetGroupHealthCheckProtocolType":{"enum":["HTTP","HTTPS","TCP"],"type":"string"},"TargetGroupProtocolType":{"enum":["TCP","TLS","UDP","TCP_UDP","HTTP","HTTPS","GENEVE"],"type":"string"},"TargetGroupProtocolVersionType":{"enum":["GRPC","HTTP1","HTTP2"],"type":"string"},"TargetGroupTargetFailoverType":{"enum":["no_rebalance","rebalance"],"type":"string"},"TargetGroupType":{"enum":["instance","ip","alb","lambda"],"type":"string"}}}
|
Provide a JSON object that satisfies the schema "customizations-config". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
customizations-config
|
schema-store
|
schema_store_233
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft-04/schema\",\"$id\":\"https://raw.githubusercontent.com/hexagontk/codecv/master/cv.schema.json\",\"$ref\":\"#/$defs/Cv\",\"$defs\":{\"Language\":{\"type\":\"string\",\"pattern\":\"[a-z]{2}\"},\"Country\":{\"type\":\"string\",\"pattern\":\"[A-Z]{2}\"},\"NullableCountry\":{\"type\":[\"string\",\"null\"],\"pattern\":\"[A-Z]{2}\"},\"Disability\":{\"title\":\"Disability information\",\"type\":\"object\",\"required\":[\"Type\"],\"additionalProperties\":false,\"properties\":{\"Type\":{\"title\":\"Kind of disability\",\"type\":\"string\",\"enum\":[\"visual\",\"auditory\",\"movement\",\"mental\"]},\"Level\":{\"title\":\"Disability degree\",\"description\":\"Disability degree. Value must be between 1.0 (fully disabled) and 0\",\"$ref\":\"#/$defs/NullableNumber\"},\"Summary\":{\"title\":\"Text describing the disability\",\"$ref\":\"#/$defs/NullableString\"}}},\"DrivingLicense\":{\"title\":\"Driving license details\",\"type\":\"object\",\"required\":[\"Country\",\"License\"],\"additionalProperties\":false,\"properties\":{\"Country\":{\"title\":\"Country issuing the driver license\",\"$ref\":\"#/$defs/Country\"},\"License\":{\"title\":\"Kind of driver licence, i\",\"description\":\"Kind of driver licence, i.e.: A, B1, etc\",\"type\":\"string\"}}},\"IdDocument\":{\"title\":\"Identification document\",\"description\":\"Identification document, I.e.: passport\",\"type\":\"object\",\"required\":[\"Country\",\"Document\",\"Id\"],\"additionalProperties\":false,\"properties\":{\"Country\":{\"title\":\"Issuer of the document\",\"$ref\":\"#/$defs/Country\"},\"Document\":{\"title\":\"Document name\",\"description\":\"Document name. It could be a national document name, or passport\",\"type\":\"string\"},\"Id\":{\"title\":\"Code with the serial number of the document for the CV principal\",\"type\":\"string\"}}},\"Personal\":{\"title\":\"Personal information, not related with professional skills or qualifications\",\"type\":\"object\",\"required\":[\"Given Name\",\"Family Name\",\"Native Language\"],\"additionalProperties\":false,\"properties\":{\"Given Name\":{\"title\":\"Given name\",\"description\":\"Given name. It can be multiple words for compound names\",\"type\":\"string\"},\"Family Name\":{\"title\":\"Family name\",\"description\":\"Family name. Depending on cultures, this field can be very different\",\"type\":\"string\"},\"Native Language\":{\"title\":\"First learned language\",\"description\":\"First learned language. Or preferred language if you had many\",\"$ref\":\"#/$defs/Language\"},\"Pronoun\":{\"title\":\"Pronoun to state how do you like to be addressed\",\"type\":[\"null\",\"string\"],\"enum\":[\"feminine\",\"masculine\",\"neutral\"]},\"Gender\":{\"title\":\"Gender role\",\"type\":[\"null\",\"string\"],\"enum\":[\"woman\",\"man\",\"lesbian\",\"gay\",\"transgender woman\",\"transgender man\",\"bisexual\",\"intersexual\",\"queer\",\"agender\",\"other\"]},\"Birth\":{\"title\":\"Date of birth\",\"$ref\":\"#/$defs/NullableDate\"},\"Birth Country\":{\"title\":\"Country of birth\",\"$ref\":\"#/$defs/NullableCountry\"},\"Alias\":{\"title\":\"Short name you commonly use or nickname\",\"$ref\":\"#/$defs/NullableString\"},\"Photo\":{\"title\":\"Photo address\",\"$ref\":\"#/$defs/NullableUri\"},\"Avatar\":{\"title\":\"Avatar\",\"description\":\"Avatar. Image used to represent you without being an actual photo\",\"$ref\":\"#/$defs/NullableUri\"},\"Nationalities\":{\"title\":\"Set of nationalities\",\"description\":\"Set of nationalities. If none is supplied, the birth of country is used\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/Country\"}},\"Disabilities\":{\"title\":\"List of disabilities of a person\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Disability\"}},\"Driving Licenses\":{\"title\":\"List of driving permissions\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/DrivingLicense\"}},\"Own Vehicle\":{\"title\":\"True if the CV holder have his own vehicle\",\"type\":\"boolean\"},\"Ids\":{\"title\":\"Id documents owned by country\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/IdDocument\"}}}},\"Location\":{\"title\":\"Area that may have different degrees of precision, from a whole country, to a street address\",\"type\":\"object\",\"required\":[\"Country\"],\"additionalProperties\":false,\"properties\":{\"Country\":{\"title\":\"Location country\",\"$ref\":\"#/$defs/Country\"},\"Region\":{\"title\":\"Country region\",\"description\":\"Country region. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"City\":{\"title\":\"City\",\"description\":\"City. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Postcode\":{\"title\":\"Postcode\",\"description\":\"Postcode. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Address\":{\"title\":\"Street address\",\"description\":\"Street address. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"}}},\"NullableLocation\":{\"title\":\"Area that may have different degrees of precision, from a whole country, to a street address\",\"type\":[\"object\",\"null\"],\"required\":[\"Country\"],\"additionalProperties\":false,\"properties\":{\"Country\":{\"title\":\"Location country\",\"$ref\":\"#/$defs/Country\"},\"Region\":{\"title\":\"Country region\",\"description\":\"Country region. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"City\":{\"title\":\"City\",\"description\":\"City. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Postcode\":{\"title\":\"Postcode\",\"description\":\"Postcode. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Address\":{\"title\":\"Street address\",\"description\":\"Street address. If set, can not be blank\",\"$ref\":\"#/$defs/NullableString\"}}},\"Link\":{\"title\":\"Link to a resource identifier, it can be `tel:`, `mailto:`, or the usual WWW ones\",\"type\":\"object\",\"required\":[\"Address\"],\"additionalProperties\":false,\"properties\":{\"Address\":{\"title\":\"Link's URI\",\"$ref\":\"#/$defs/Uri\"},\"Title\":{\"title\":\"Description of the link's purpose\",\"$ref\":\"#/$defs/NullableString\"},\"Tags\":{\"title\":\"Set of tags that can be used to group a collection of links\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"Money\":{\"type\":\"object\",\"required\":[\"Amount\",\"Currency\"],\"additionalProperties\":false,\"properties\":{\"Amount\":{\"type\":\"number\"},\"Currency\":{\"type\":\"string\"}}},\"NullableSalary\":{\"type\":[\"object\",\"null\"],\"required\":[\"Money\"],\"additionalProperties\":false,\"properties\":{\"Money\":{\"$ref\":\"#/$defs/Money\"},\"Period\":{\"$ref\":\"#/$defs/Period\"},\"Gross\":{\"type\":\"boolean\"}}},\"Frequency\":{\"type\":\"object\",\"required\":[\"Times\",\"Interval\"],\"additionalProperties\":false,\"properties\":{\"Times\":{\"$ref\":\"#/$defs/Period\"},\"Interval\":{\"$ref\":\"#/$defs/Period\"}}},\"NullableFrequency\":{\"type\":[\"object\",\"null\"],\"required\":[\"Times\",\"Interval\"],\"additionalProperties\":false,\"properties\":{\"Times\":{\"$ref\":\"#/$defs/Period\"},\"Interval\":{\"$ref\":\"#/$defs/Period\"}}},\"NullableNoticePeriod\":{\"type\":[\"object\",\"null\"],\"required\":[\"Days\",\"Working Days\"],\"additionalProperties\":false,\"properties\":{\"Days\":{\"type\":\"number\"},\"Working Days\":{\"type\":\"boolean\"}}},\"NullableTravelAvailability\":{\"type\":[\"object\",\"null\"],\"required\":[\"Frequency\",\"Reach\"],\"additionalProperties\":false,\"properties\":{\"Frequency\":{\"$ref\":\"#/$defs/Frequency\"},\"Reach\":{\"type\":\"string\",\"enum\":[\"region\",\"country\",\"continent\",\"worldwide\"]}}},\"TargetJob\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"Salary\":{\"$ref\":\"#/$defs/NullableSalary\"},\"Remote\":{\"$ref\":\"#/$defs/NullableFrequency\"},\"Notice Period\":{\"$ref\":\"#/$defs/NullableNoticePeriod\"},\"Travel Availability\":{\"$ref\":\"#/$defs/NullableTravelAvailability\"},\"Roles\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Operating Systems\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"enum\":[\"linux\",\"macos\",\"windows\"]}},\"Features\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Desired Skills\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Excluded Skills\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Locations\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Location\"}}}},\"LanguageSkill\":{\"title\":\"Foreign language capabilities\",\"type\":\"object\",\"required\":[\"Language\",\"Listening\",\"Reading\",\"Spoken\",\"Written\"],\"additionalProperties\":false,\"properties\":{\"Language\":{\"title\":\"Foreign language\",\"$ref\":\"#/$defs/Language\"},\"Listening\":{\"title\":\"Listening level\",\"type\":\"string\",\"enum\":[\"a1\",\"a2\",\"b1\",\"b2\",\"c1\",\"c2\"]},\"Reading\":{\"title\":\"Reading level\",\"type\":\"string\",\"enum\":[\"a1\",\"a2\",\"b1\",\"b2\",\"c1\",\"c2\"]},\"Spoken\":{\"title\":\"Spoken level\",\"type\":\"string\",\"enum\":[\"a1\",\"a2\",\"b1\",\"b2\",\"c1\",\"c2\"]},\"Written\":{\"title\":\"Written level\",\"type\":\"string\",\"enum\":[\"a1\",\"a2\",\"b1\",\"b2\",\"c1\",\"c2\"]}}},\"Organization\":{\"title\":\"Organization data (can be used for companies, educational institutions, etc\",\"description\":\"Organization data (can be used for companies, educational institutions, etc.)\",\"type\":\"object\",\"required\":[\"Name\"],\"additionalProperties\":false,\"properties\":{\"Name\":{\"title\":\"Name of the organization\",\"description\":\"Name of the organization. If set can not be blank\",\"type\":\"string\"},\"Website\":{\"title\":\"URI of the organization's website\",\"$ref\":\"#/$defs/NullableUri\"},\"Type\":{\"title\":\"Organization's type (NGO, educational, government, etc\",\"description\":\"Organization's type (NGO, educational, government, etc.). If set can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Industry\":{\"title\":\"Industry (financial, industry, etc\",\"description\":\"Industry (financial, industry, etc.). If set can not be blank\",\"$ref\":\"#/$defs/NullableString\"}}},\"NullableOrganization\":{\"title\":\"Organization data (can be used for companies, educational institutions, etc\",\"description\":\"Organization data (can be used for companies, educational institutions, etc.)\",\"type\":[\"object\",\"null\"],\"required\":[\"Name\"],\"additionalProperties\":false,\"properties\":{\"Name\":{\"title\":\"Name of the organization\",\"description\":\"Name of the organization. If set can not be blank\",\"type\":\"string\"},\"Website\":{\"title\":\"URI of the organization's website\",\"$ref\":\"#/$defs/NullableUri\"},\"Type\":{\"title\":\"Organization's type (NGO, educational, government, etc\",\"description\":\"Organization's type (NGO, educational, government, etc.). If set can not be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Industry\":{\"title\":\"Industry (financial, industry, etc\",\"description\":\"Industry (financial, industry, etc.). If set can not be blank\",\"$ref\":\"#/$defs/NullableString\"}}},\"Project\":{\"title\":\"A span of time planned for achieving a goal or deliver a product\",\"type\":\"object\",\"required\":[\"Title\"],\"additionalProperties\":false,\"properties\":{\"Title\":{\"title\":\"Descriptive title of the professional experience\",\"description\":\"Descriptive title of the professional experience. Cannot be blank\",\"type\":\"string\"},\"Website\":{\"title\":\"URI with more information about the project\",\"$ref\":\"#/$defs/NullableUri\"},\"From\":{\"title\":\"Project start date\",\"description\":\"Project start date. It must be equals or before the end date\",\"$ref\":\"#/$defs/NullableYearMonth\"},\"Persons\":{\"title\":\"People involved in the project (without including yourself)\",\"description\":\"People involved in the project (without including yourself). Must be greater than zero\",\"type\":\"number\"},\"Type\":{\"title\":\"Project kind\",\"description\":\"Project kind, i.e.: Web Application, Mobile Application, REST service, CLI, etc\",\"$ref\":\"#/$defs/NullableString\"},\"To\":{\"title\":\"Finish date of the project\",\"description\":\"Finish date of the project. Should be set to a date equals or before today\",\"$ref\":\"#/$defs/NullableYearMonth\"},\"Summary\":{\"title\":\"Brief description of the project\",\"description\":\"Brief description of the project. If set, blank values aren't allowed\",\"$ref\":\"#/$defs/NullableString\"},\"Client\":{\"title\":\"Third party for which the project was developed\",\"description\":\"Third party for which the project was developed. If set can not be blank\",\"$ref\":\"#/$defs/NullableOrganization\"},\"Production\":{\"title\":\"True if the project was also maintained in production\",\"type\":[\"null\",\"boolean\"]},\"Highlights\":{\"title\":\"Remarkable items achieved on this project\",\"description\":\"Remarkable items achieved on this project. Empty text is not allowed\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Roles\":{\"title\":\"Set of roles played on the project\",\"description\":\"Set of roles played on the project. Blank items are not allowed\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Skills\":{\"title\":\"Skills used in the development of the project\",\"description\":\"Skills used in the development of the project. Empty texts are not allowed\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"Experience\":{\"title\":\"Professional experience executed for an employer or a client\",\"type\":\"object\",\"required\":[\"Position\"],\"additionalProperties\":false,\"properties\":{\"Position\":{\"title\":\"Main role for which the person was hired at this professional experience\",\"description\":\"Main role for which the person was hired at this professional experience. It can not be blank\",\"type\":\"string\"},\"Company\":{\"title\":\"Permanent role company\",\"description\":\"Permanent role company. If null, it means this is a contractor experience\",\"$ref\":\"#/$defs/NullableOrganization\"},\"From\":{\"title\":\"Start date of the professional experience\",\"description\":\"Start date of the professional experience. It must be before the end date\",\"$ref\":\"#/$defs/NullableYearMonth\"},\"To\":{\"title\":\"End date of the professional experience\",\"description\":\"End date of the professional experience. Should be set to a date before today\",\"$ref\":\"#/$defs/NullableYearMonth\"},\"Location\":{\"title\":\"Location where the profesional experience was done\",\"description\":\"Location where the profesional experience was done. If set, no blanks allowed\",\"$ref\":\"#/$defs/NullableLocation\"},\"Summary\":{\"title\":\"Brief description of the profesional experience\",\"description\":\"Brief description of the profesional experience. Blank values other than 'null' aren't allowed\",\"$ref\":\"#/$defs/NullableString\"},\"Quit Reason\":{\"title\":\"Reason that led to leave this professional experience\",\"$ref\":\"#/$defs/NullableString\"},\"Projects\":{\"title\":\"List of projects developed during this professional experience\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Project\"}}}},\"Education\":{\"title\":\"Formal education studies\",\"type\":\"object\",\"required\":[\"Title\",\"Type\",\"Institution\",\"From\"],\"additionalProperties\":false,\"properties\":{\"Title\":{\"title\":\"Descriptive title of the education\",\"description\":\"Descriptive title of the education. Cannot be blank\",\"type\":\"string\"},\"Type\":{\"title\":\"Education kind\",\"description\":\"Education kind, i.e.: professional education or college. Cannot be blank\",\"type\":\"string\"},\"Institution\":{\"title\":\"Organization in which the classes took place\",\"$ref\":\"#/$defs/Organization\"},\"From\":{\"title\":\"Start date of the classes\",\"description\":\"Start date of the classes. It must be equals or before the end date\",\"$ref\":\"#/$defs/YearMonth\"},\"Website\":{\"title\":\"URI with more information about the studies\",\"$ref\":\"#/$defs/NullableUri\"},\"To\":{\"title\":\"End date of the classes\",\"description\":\"End date of the classes. Should be set to a date equals or before today\",\"$ref\":\"#/$defs/NullableYearMonth\"},\"Area\":{\"title\":\"Studies subject\",\"description\":\"Studies subject, i.e.: Computer Science. If set, it cannot be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Location\":{\"title\":\"Location where the classes took place\",\"$ref\":\"#/$defs/NullableLocation\"},\"Summary\":{\"title\":\"Brief description of the studies\",\"description\":\"Brief description of the studies. If set, blank values aren't allowed\",\"$ref\":\"#/$defs/NullableString\"},\"Score\":{\"title\":\"Score of the studies (if any)\",\"$ref\":\"#/$defs/NullableString\"},\"Subjects\":{\"title\":\"Set of topics covered in the studies\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"Course\":{\"title\":\"Training course, as opposed to formal education\",\"type\":\"object\",\"required\":[\"Title\",\"Institution\",\"From\",\"To\"],\"additionalProperties\":false,\"properties\":{\"Title\":{\"title\":\"Course title\",\"description\":\"Course title. Can not be blank\",\"type\":\"string\"},\"Institution\":{\"title\":\"Organization which run the course and/or award its certificate\",\"$ref\":\"#/$defs/Organization\"},\"From\":{\"title\":\"Start date of the course\",\"description\":\"Start date of the course. It must be before the end date\",\"$ref\":\"#/$defs/Date\"},\"To\":{\"title\":\"End date of the course\",\"description\":\"End date of the course. Should be set to a date before today\",\"$ref\":\"#/$defs/Date\"},\"Website\":{\"title\":\"URI with more information about the course\",\"$ref\":\"#/$defs/NullableUri\"},\"Area\":{\"title\":\"Course subject\",\"description\":\"Course subject. If set, it cannot be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Location\":{\"title\":\"Location where the training took place\",\"description\":\"Location where the training took place. If set, no blanks allowed\",\"$ref\":\"#/$defs/NullableLocation\"},\"Summary\":{\"title\":\"Brief description of the course\",\"description\":\"Brief description of the course. Blank values other than 'null' aren't allowed\",\"$ref\":\"#/$defs/NullableString\"},\"Company\":{\"title\":\"Name of the company paying for the course\",\"$ref\":\"#/$defs/NullableString\"},\"Hours\":{\"title\":\"Number of effective hours of this course\",\"description\":\"Number of effective hours of this course. If set, should be greater than zero\",\"$ref\":\"#/$defs/NullableNumber\"},\"Score\":{\"title\":\"Score of the course (if any)\",\"$ref\":\"#/$defs/NullableString\"},\"Subjects\":{\"title\":\"Set of topics covered in the course\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"Achievement\":{\"title\":\"Professional achievement\",\"description\":\"Professional achievement. Achievement accomplished at a given date. Publications must be owned by external parties in order to be an achievement, posts on social networks or personal blogs are listed in other CV sections\",\"type\":\"object\",\"required\":[\"Type\",\"Title\",\"Date\"],\"additionalProperties\":false,\"properties\":{\"Type\":{\"title\":\"Type of achievement\",\"type\":\"string\",\"enum\":[\"certification\",\"award\",\"publication\",\"presentation\",\"conference\",\"workshop\",\"other\"]},\"Title\":{\"title\":\"Descriptive title of the achievement\",\"description\":\"Descriptive title of the achievement. Cannot be blank\",\"type\":\"string\"},\"Date\":{\"title\":\"Data in which the achievement was accomplished\",\"description\":\"Data in which the achievement was accomplished. Cannot be after today\",\"$ref\":\"#/$defs/Date\"},\"Website\":{\"title\":\"Link with further information of the achievement, I\",\"description\":\"Link with further information of the achievement, I.e.: the URI of a publication\",\"$ref\":\"#/$defs/NullableUri\"},\"Summary\":{\"title\":\"Detailed description of the achievement\",\"description\":\"Detailed description of the achievement. It cannot be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Issuer\":{\"title\":\"Organization that awarded this achievement\",\"$ref\":\"#/$defs/NullableOrganization\"}}},\"Reference\":{\"title\":\"Other person's reference\",\"type\":\"object\",\"required\":[\"Full Name\",\"Summary\"],\"additionalProperties\":false,\"properties\":{\"Full Name\":{\"title\":\"Referrer's name\",\"description\":\"Referrer's name. Can not be blank\",\"type\":\"string\"},\"Summary\":{\"title\":\"Reference details in plain text\",\"description\":\"Reference details in plain text. Can not be blank\",\"type\":\"string\"},\"Type\":{\"title\":\"Relation among CV principal and referrer\",\"type\":[\"null\",\"string\"],\"enum\":[\"colleague\",\"manager\",\"subordinate\",\"client\",\"provider\"]},\"Contact\":{\"title\":\"Contact data of the referrer person\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/Link\"}},\"Social Profiles\":{\"title\":\"Referrer's social networks\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/Uri\"}},\"Projects\":{\"title\":\"Projects in common with the referrer\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"SkillSet\":{\"type\":\"object\",\"required\":[\"Title\"],\"additionalProperties\":false,\"properties\":{\"Title\":{\"type\":\"string\"},\"Skills\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"Cv\":{\"title\":\"CV data grouped by topics\",\"description\":\"CV data grouped by topics. Most of the fields are optional. When the model is rendered, the fields are passed to the template context with the names in camel case. Read only properties are meant only for use in templates, and cannot be defined in the document\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"$schema\":{\"title\":\"Schema used for the document\",\"description\":\"Used to deal with different versions. It also eases the use on some editors\",\"type\":\"string\",\"format\":\"URI\"},\"Job Status\":{\"title\":\"Job search status\",\"type\":[\"null\",\"string\"],\"enum\":[\"active search\",\"open to challenges\",\"not moving\"]},\"Locale\":{\"title\":\"Locale representing the CV's content\",\"description\":\"Locale representing the CV's content. If not set, it will be `en`\",\"$ref\":\"#/$defs/Locale\"},\"Last Update\":{\"title\":\"Date of the CV's latest modification\",\"$ref\":\"#/$defs/NullableDate\"},\"Resources\":{\"title\":\"List of resources to be included in this CV\",\"description\":\"List of resources to be included in this CV. Allows CV modularization. Resources' content will be overwritten with the CV document content\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Templates\":{\"title\":\"Templates used to render this CV\",\"description\":\"Templates used to render this CV. Templates for different media types are supported using the template extension to select the appropriate one\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Variables\":{\"title\":\"Configuration added to the context when the CV is rendered\",\"description\":\"Configuration added to the context when the CV is rendered. Map keys must be in camel case\",\"type\":\"object\"},\"Personal\":{\"title\":\"Personal information\",\"$ref\":\"#/$defs/Personal\"},\"Residence\":{\"title\":\"Current residence information\",\"$ref\":\"#/$defs/Location\"},\"Contact\":{\"title\":\"Contact data\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/Link\"}},\"Target Job\":{\"title\":\"Searched job desired characteristics\",\"$ref\":\"#/$defs/TargetJob\"},\"Bio\":{\"title\":\"Bio, if set, cannot be blank\",\"$ref\":\"#/$defs/NullableString\"},\"Titles\":{\"title\":\"Titles\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Labels\":{\"title\":\"Labels\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Goals\":{\"title\":\"Professional goals\",\"description\":\"Professional goals. It cannot contain any blank item\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Top Skills\":{\"title\":\"Group of general skills to highlight\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"Links\":{\"title\":\"List of links pointing to another resources (like social networks profiles)\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/Link\"}},\"Languages\":{\"title\":\"List of languages aside of the birth language\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/$defs/LanguageSkill\"}},\"Personal Projects\":{\"title\":\"Personal projects developed outside a company\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Project\"}},\"Volunteering\":{\"title\":\"Experience on non govern organizations related with social or technical interests\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Experience\"}},\"Experience\":{\"title\":\"Professional projects developed for a company\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Experience\"}},\"Education\":{\"title\":\"Formal education\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Education\"}},\"Courses\":{\"title\":\"Specific courses on a given subject\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Course\"}},\"Achievements\":{\"title\":\"Professional achievements awarded by third parties\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Achievement\"}},\"References\":{\"title\":\"Personal references from previous experiences\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Reference\"}},\"Technical Skills\":{\"title\":\"Set of technical skills\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/SkillSet\"}},\"Common Skills\":{\"title\":\"Common (or soft) skills\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/SkillSet\"}},\"Other Facts\":{\"title\":\"Fun facts and/or interests\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"NullableYearMonth\":{\"type\":[\"null\",\"string\"],\"pattern\":\"\\\\d{4}-\\\\d{2}\"},\"YearMonth\":{\"type\":\"string\",\"pattern\":\"\\\\d{4}-\\\\d{2}\"},\"Period\":{\"type\":\"string\",\"pattern\":\"[pP]?\\\\s*(\\\\d+[yY])?\\\\s*(\\\\d+[wW])?\\\\s*(\\\\d+[dD])?\"},\"Locale\":{\"type\":\"string\",\"pattern\":\"[a-z]{2}(_[A-Z]{2})?\"},\"NullableDate\":{\"type\":[\"null\",\"string\"],\"format\":\"DATE\"},\"Date\":{\"type\":\"string\",\"format\":\"DATE\"},\"NullableUri\":{\"type\":[\"null\",\"string\"],\"format\":\"URI\"},\"Uri\":{\"type\":\"string\",\"format\":\"URI\"},\"NullableString\":{\"type\":[\"null\",\"string\"]},\"NullableNumber\":{\"type\":[\"null\",\"number\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"cv.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft-04/schema","$id":"https://raw.githubusercontent.com/hexagontk/codecv/master/cv.schema.json","$ref":"#/$defs/Cv","$defs":{"Language":{"type":"string","pattern":"[a-z]{2}"},"Country":{"type":"string","pattern":"[A-Z]{2}"},"NullableCountry":{"type":["string","null"],"pattern":"[A-Z]{2}"},"Disability":{"title":"Disability information","type":"object","required":["Type"],"additionalProperties":false,"properties":{"Type":{"title":"Kind of disability","type":"string","enum":["visual","auditory","movement","mental"]},"Level":{"title":"Disability degree","description":"Disability degree. Value must be between 1.0 (fully disabled) and 0","$ref":"#/$defs/NullableNumber"},"Summary":{"title":"Text describing the disability","$ref":"#/$defs/NullableString"}}},"DrivingLicense":{"title":"Driving license details","type":"object","required":["Country","License"],"additionalProperties":false,"properties":{"Country":{"title":"Country issuing the driver license","$ref":"#/$defs/Country"},"License":{"title":"Kind of driver licence, i","description":"Kind of driver licence, i.e.: A, B1, etc","type":"string"}}},"IdDocument":{"title":"Identification document","description":"Identification document, I.e.: passport","type":"object","required":["Country","Document","Id"],"additionalProperties":false,"properties":{"Country":{"title":"Issuer of the document","$ref":"#/$defs/Country"},"Document":{"title":"Document name","description":"Document name. It could be a national document name, or passport","type":"string"},"Id":{"title":"Code with the serial number of the document for the CV principal","type":"string"}}},"Personal":{"title":"Personal information, not related with professional skills or qualifications","type":"object","required":["Given Name","Family Name","Native Language"],"additionalProperties":false,"properties":{"Given Name":{"title":"Given name","description":"Given name. It can be multiple words for compound names","type":"string"},"Family Name":{"title":"Family name","description":"Family name. Depending on cultures, this field can be very different","type":"string"},"Native Language":{"title":"First learned language","description":"First learned language. Or preferred language if you had many","$ref":"#/$defs/Language"},"Pronoun":{"title":"Pronoun to state how do you like to be addressed","type":["null","string"],"enum":["feminine","masculine","neutral"]},"Gender":{"title":"Gender role","type":["null","string"],"enum":["woman","man","lesbian","gay","transgender woman","transgender man","bisexual","intersexual","queer","agender","other"]},"Birth":{"title":"Date of birth","$ref":"#/$defs/NullableDate"},"Birth Country":{"title":"Country of birth","$ref":"#/$defs/NullableCountry"},"Alias":{"title":"Short name you commonly use or nickname","$ref":"#/$defs/NullableString"},"Photo":{"title":"Photo address","$ref":"#/$defs/NullableUri"},"Avatar":{"title":"Avatar","description":"Avatar. Image used to represent you without being an actual photo","$ref":"#/$defs/NullableUri"},"Nationalities":{"title":"Set of nationalities","description":"Set of nationalities. If none is supplied, the birth of country is used","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/Country"}},"Disabilities":{"title":"List of disabilities of a person","type":"array","items":{"$ref":"#/$defs/Disability"}},"Driving Licenses":{"title":"List of driving permissions","type":"array","items":{"$ref":"#/$defs/DrivingLicense"}},"Own Vehicle":{"title":"True if the CV holder have his own vehicle","type":"boolean"},"Ids":{"title":"Id documents owned by country","type":"array","items":{"$ref":"#/$defs/IdDocument"}}}},"Location":{"title":"Area that may have different degrees of precision, from a whole country, to a street address","type":"object","required":["Country"],"additionalProperties":false,"properties":{"Country":{"title":"Location country","$ref":"#/$defs/Country"},"Region":{"title":"Country region","description":"Country region. If set, can not be blank","$ref":"#/$defs/NullableString"},"City":{"title":"City","description":"City. If set, can not be blank","$ref":"#/$defs/NullableString"},"Postcode":{"title":"Postcode","description":"Postcode. If set, can not be blank","$ref":"#/$defs/NullableString"},"Address":{"title":"Street address","description":"Street address. If set, can not be blank","$ref":"#/$defs/NullableString"}}},"NullableLocation":{"title":"Area that may have different degrees of precision, from a whole country, to a street address","type":["object","null"],"required":["Country"],"additionalProperties":false,"properties":{"Country":{"title":"Location country","$ref":"#/$defs/Country"},"Region":{"title":"Country region","description":"Country region. If set, can not be blank","$ref":"#/$defs/NullableString"},"City":{"title":"City","description":"City. If set, can not be blank","$ref":"#/$defs/NullableString"},"Postcode":{"title":"Postcode","description":"Postcode. If set, can not be blank","$ref":"#/$defs/NullableString"},"Address":{"title":"Street address","description":"Street address. If set, can not be blank","$ref":"#/$defs/NullableString"}}},"Link":{"title":"Link to a resource identifier, it can be `tel:`, `mailto:`, or the usual WWW ones","type":"object","required":["Address"],"additionalProperties":false,"properties":{"Address":{"title":"Link's URI","$ref":"#/$defs/Uri"},"Title":{"title":"Description of the link's purpose","$ref":"#/$defs/NullableString"},"Tags":{"title":"Set of tags that can be used to group a collection of links","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Money":{"type":"object","required":["Amount","Currency"],"additionalProperties":false,"properties":{"Amount":{"type":"number"},"Currency":{"type":"string"}}},"NullableSalary":{"type":["object","null"],"required":["Money"],"additionalProperties":false,"properties":{"Money":{"$ref":"#/$defs/Money"},"Period":{"$ref":"#/$defs/Period"},"Gross":{"type":"boolean"}}},"Frequency":{"type":"object","required":["Times","Interval"],"additionalProperties":false,"properties":{"Times":{"$ref":"#/$defs/Period"},"Interval":{"$ref":"#/$defs/Period"}}},"NullableFrequency":{"type":["object","null"],"required":["Times","Interval"],"additionalProperties":false,"properties":{"Times":{"$ref":"#/$defs/Period"},"Interval":{"$ref":"#/$defs/Period"}}},"NullableNoticePeriod":{"type":["object","null"],"required":["Days","Working Days"],"additionalProperties":false,"properties":{"Days":{"type":"number"},"Working Days":{"type":"boolean"}}},"NullableTravelAvailability":{"type":["object","null"],"required":["Frequency","Reach"],"additionalProperties":false,"properties":{"Frequency":{"$ref":"#/$defs/Frequency"},"Reach":{"type":"string","enum":["region","country","continent","worldwide"]}}},"TargetJob":{"type":"object","additionalProperties":false,"properties":{"Salary":{"$ref":"#/$defs/NullableSalary"},"Remote":{"$ref":"#/$defs/NullableFrequency"},"Notice Period":{"$ref":"#/$defs/NullableNoticePeriod"},"Travel Availability":{"$ref":"#/$defs/NullableTravelAvailability"},"Roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"Operating Systems":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["linux","macos","windows"]}},"Features":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"Desired Skills":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"Excluded Skills":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"Locations":{"type":"array","items":{"$ref":"#/$defs/Location"}}}},"LanguageSkill":{"title":"Foreign language capabilities","type":"object","required":["Language","Listening","Reading","Spoken","Written"],"additionalProperties":false,"properties":{"Language":{"title":"Foreign language","$ref":"#/$defs/Language"},"Listening":{"title":"Listening level","type":"string","enum":["a1","a2","b1","b2","c1","c2"]},"Reading":{"title":"Reading level","type":"string","enum":["a1","a2","b1","b2","c1","c2"]},"Spoken":{"title":"Spoken level","type":"string","enum":["a1","a2","b1","b2","c1","c2"]},"Written":{"title":"Written level","type":"string","enum":["a1","a2","b1","b2","c1","c2"]}}},"Organization":{"title":"Organization data (can be used for companies, educational institutions, etc","description":"Organization data (can be used for companies, educational institutions, etc.)","type":"object","required":["Name"],"additionalProperties":false,"properties":{"Name":{"title":"Name of the organization","description":"Name of the organization. If set can not be blank","type":"string"},"Website":{"title":"URI of the organization's website","$ref":"#/$defs/NullableUri"},"Type":{"title":"Organization's type (NGO, educational, government, etc","description":"Organization's type (NGO, educational, government, etc.). If set can not be blank","$ref":"#/$defs/NullableString"},"Industry":{"title":"Industry (financial, industry, etc","description":"Industry (financial, industry, etc.). If set can not be blank","$ref":"#/$defs/NullableString"}}},"NullableOrganization":{"title":"Organization data (can be used for companies, educational institutions, etc","description":"Organization data (can be used for companies, educational institutions, etc.)","type":["object","null"],"required":["Name"],"additionalProperties":false,"properties":{"Name":{"title":"Name of the organization","description":"Name of the organization. If set can not be blank","type":"string"},"Website":{"title":"URI of the organization's website","$ref":"#/$defs/NullableUri"},"Type":{"title":"Organization's type (NGO, educational, government, etc","description":"Organization's type (NGO, educational, government, etc.). If set can not be blank","$ref":"#/$defs/NullableString"},"Industry":{"title":"Industry (financial, industry, etc","description":"Industry (financial, industry, etc.). If set can not be blank","$ref":"#/$defs/NullableString"}}},"Project":{"title":"A span of time planned for achieving a goal or deliver a product","type":"object","required":["Title"],"additionalProperties":false,"properties":{"Title":{"title":"Descriptive title of the professional experience","description":"Descriptive title of the professional experience. Cannot be blank","type":"string"},"Website":{"title":"URI with more information about the project","$ref":"#/$defs/NullableUri"},"From":{"title":"Project start date","description":"Project start date. It must be equals or before the end date","$ref":"#/$defs/NullableYearMonth"},"Persons":{"title":"People involved in the project (without including yourself)","description":"People involved in the project (without including yourself). Must be greater than zero","type":"number"},"Type":{"title":"Project kind","description":"Project kind, i.e.: Web Application, Mobile Application, REST service, CLI, etc","$ref":"#/$defs/NullableString"},"To":{"title":"Finish date of the project","description":"Finish date of the project. Should be set to a date equals or before today","$ref":"#/$defs/NullableYearMonth"},"Summary":{"title":"Brief description of the project","description":"Brief description of the project. If set, blank values aren't allowed","$ref":"#/$defs/NullableString"},"Client":{"title":"Third party for which the project was developed","description":"Third party for which the project was developed. If set can not be blank","$ref":"#/$defs/NullableOrganization"},"Production":{"title":"True if the project was also maintained in production","type":["null","boolean"]},"Highlights":{"title":"Remarkable items achieved on this project","description":"Remarkable items achieved on this project. Empty text is not allowed","type":"array","uniqueItems":true,"items":{"type":"string"}},"Roles":{"title":"Set of roles played on the project","description":"Set of roles played on the project. Blank items are not allowed","type":"array","uniqueItems":true,"items":{"type":"string"}},"Skills":{"title":"Skills used in the development of the project","description":"Skills used in the development of the project. Empty texts are not allowed","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Experience":{"title":"Professional experience executed for an employer or a client","type":"object","required":["Position"],"additionalProperties":false,"properties":{"Position":{"title":"Main role for which the person was hired at this professional experience","description":"Main role for which the person was hired at this professional experience. It can not be blank","type":"string"},"Company":{"title":"Permanent role company","description":"Permanent role company. If null, it means this is a contractor experience","$ref":"#/$defs/NullableOrganization"},"From":{"title":"Start date of the professional experience","description":"Start date of the professional experience. It must be before the end date","$ref":"#/$defs/NullableYearMonth"},"To":{"title":"End date of the professional experience","description":"End date of the professional experience. Should be set to a date before today","$ref":"#/$defs/NullableYearMonth"},"Location":{"title":"Location where the profesional experience was done","description":"Location where the profesional experience was done. If set, no blanks allowed","$ref":"#/$defs/NullableLocation"},"Summary":{"title":"Brief description of the profesional experience","description":"Brief description of the profesional experience. Blank values other than 'null' aren't allowed","$ref":"#/$defs/NullableString"},"Quit Reason":{"title":"Reason that led to leave this professional experience","$ref":"#/$defs/NullableString"},"Projects":{"title":"List of projects developed during this professional experience","type":"array","items":{"$ref":"#/$defs/Project"}}}},"Education":{"title":"Formal education studies","type":"object","required":["Title","Type","Institution","From"],"additionalProperties":false,"properties":{"Title":{"title":"Descriptive title of the education","description":"Descriptive title of the education. Cannot be blank","type":"string"},"Type":{"title":"Education kind","description":"Education kind, i.e.: professional education or college. Cannot be blank","type":"string"},"Institution":{"title":"Organization in which the classes took place","$ref":"#/$defs/Organization"},"From":{"title":"Start date of the classes","description":"Start date of the classes. It must be equals or before the end date","$ref":"#/$defs/YearMonth"},"Website":{"title":"URI with more information about the studies","$ref":"#/$defs/NullableUri"},"To":{"title":"End date of the classes","description":"End date of the classes. Should be set to a date equals or before today","$ref":"#/$defs/NullableYearMonth"},"Area":{"title":"Studies subject","description":"Studies subject, i.e.: Computer Science. If set, it cannot be blank","$ref":"#/$defs/NullableString"},"Location":{"title":"Location where the classes took place","$ref":"#/$defs/NullableLocation"},"Summary":{"title":"Brief description of the studies","description":"Brief description of the studies. If set, blank values aren't allowed","$ref":"#/$defs/NullableString"},"Score":{"title":"Score of the studies (if any)","$ref":"#/$defs/NullableString"},"Subjects":{"title":"Set of topics covered in the studies","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Course":{"title":"Training course, as opposed to formal education","type":"object","required":["Title","Institution","From","To"],"additionalProperties":false,"properties":{"Title":{"title":"Course title","description":"Course title. Can not be blank","type":"string"},"Institution":{"title":"Organization which run the course and/or award its certificate","$ref":"#/$defs/Organization"},"From":{"title":"Start date of the course","description":"Start date of the course. It must be before the end date","$ref":"#/$defs/Date"},"To":{"title":"End date of the course","description":"End date of the course. Should be set to a date before today","$ref":"#/$defs/Date"},"Website":{"title":"URI with more information about the course","$ref":"#/$defs/NullableUri"},"Area":{"title":"Course subject","description":"Course subject. If set, it cannot be blank","$ref":"#/$defs/NullableString"},"Location":{"title":"Location where the training took place","description":"Location where the training took place. If set, no blanks allowed","$ref":"#/$defs/NullableLocation"},"Summary":{"title":"Brief description of the course","description":"Brief description of the course. Blank values other than 'null' aren't allowed","$ref":"#/$defs/NullableString"},"Company":{"title":"Name of the company paying for the course","$ref":"#/$defs/NullableString"},"Hours":{"title":"Number of effective hours of this course","description":"Number of effective hours of this course. If set, should be greater than zero","$ref":"#/$defs/NullableNumber"},"Score":{"title":"Score of the course (if any)","$ref":"#/$defs/NullableString"},"Subjects":{"title":"Set of topics covered in the course","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Achievement":{"title":"Professional achievement","description":"Professional achievement. Achievement accomplished at a given date. Publications must be owned by external parties in order to be an achievement, posts on social networks or personal blogs are listed in other CV sections","type":"object","required":["Type","Title","Date"],"additionalProperties":false,"properties":{"Type":{"title":"Type of achievement","type":"string","enum":["certification","award","publication","presentation","conference","workshop","other"]},"Title":{"title":"Descriptive title of the achievement","description":"Descriptive title of the achievement. Cannot be blank","type":"string"},"Date":{"title":"Data in which the achievement was accomplished","description":"Data in which the achievement was accomplished. Cannot be after today","$ref":"#/$defs/Date"},"Website":{"title":"Link with further information of the achievement, I","description":"Link with further information of the achievement, I.e.: the URI of a publication","$ref":"#/$defs/NullableUri"},"Summary":{"title":"Detailed description of the achievement","description":"Detailed description of the achievement. It cannot be blank","$ref":"#/$defs/NullableString"},"Issuer":{"title":"Organization that awarded this achievement","$ref":"#/$defs/NullableOrganization"}}},"Reference":{"title":"Other person's reference","type":"object","required":["Full Name","Summary"],"additionalProperties":false,"properties":{"Full Name":{"title":"Referrer's name","description":"Referrer's name. Can not be blank","type":"string"},"Summary":{"title":"Reference details in plain text","description":"Reference details in plain text. Can not be blank","type":"string"},"Type":{"title":"Relation among CV principal and referrer","type":["null","string"],"enum":["colleague","manager","subordinate","client","provider"]},"Contact":{"title":"Contact data of the referrer person","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/Link"}},"Social Profiles":{"title":"Referrer's social networks","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/Uri"}},"Projects":{"title":"Projects in common with the referrer","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"SkillSet":{"type":"object","required":["Title"],"additionalProperties":false,"properties":{"Title":{"type":"string"},"Skills":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Cv":{"title":"CV data grouped by topics","description":"CV data grouped by topics. Most of the fields are optional. When the model is rendered, the fields are passed to the template context with the names in camel case. Read only properties are meant only for use in templates, and cannot be defined in the document","type":"object","additionalProperties":false,"properties":{"$schema":{"title":"Schema used for the document","description":"Used to deal with different versions. It also eases the use on some editors","type":"string","format":"URI"},"Job Status":{"title":"Job search status","type":["null","string"],"enum":["active search","open to challenges","not moving"]},"Locale":{"title":"Locale representing the CV's content","description":"Locale representing the CV's content. If not set, it will be `en`","$ref":"#/$defs/Locale"},"Last Update":{"title":"Date of the CV's latest modification","$ref":"#/$defs/NullableDate"},"Resources":{"title":"List of resources to be included in this CV","description":"List of resources to be included in this CV. Allows CV modularization. Resources' content will be overwritten with the CV document content","type":"array","uniqueItems":true,"items":{"type":"string"}},"Templates":{"title":"Templates used to render this CV","description":"Templates used to render this CV. Templates for different media types are supported using the template extension to select the appropriate one","type":"array","uniqueItems":true,"items":{"type":"string"}},"Variables":{"title":"Configuration added to the context when the CV is rendered","description":"Configuration added to the context when the CV is rendered. Map keys must be in camel case","type":"object"},"Personal":{"title":"Personal information","$ref":"#/$defs/Personal"},"Residence":{"title":"Current residence information","$ref":"#/$defs/Location"},"Contact":{"title":"Contact data","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/Link"}},"Target Job":{"title":"Searched job desired characteristics","$ref":"#/$defs/TargetJob"},"Bio":{"title":"Bio, if set, cannot be blank","$ref":"#/$defs/NullableString"},"Titles":{"title":"Titles","type":"array","uniqueItems":true,"items":{"type":"string"}},"Labels":{"title":"Labels","type":"array","uniqueItems":true,"items":{"type":"string"}},"Goals":{"title":"Professional goals","description":"Professional goals. It cannot contain any blank item","type":"array","uniqueItems":true,"items":{"type":"string"}},"Top Skills":{"title":"Group of general skills to highlight","type":"array","uniqueItems":true,"items":{"type":"string"}},"Links":{"title":"List of links pointing to another resources (like social networks profiles)","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/Link"}},"Languages":{"title":"List of languages aside of the birth language","type":"array","uniqueItems":true,"items":{"$ref":"#/$defs/LanguageSkill"}},"Personal Projects":{"title":"Personal projects developed outside a company","type":"array","items":{"$ref":"#/$defs/Project"}},"Volunteering":{"title":"Experience on non govern organizations related with social or technical interests","type":"array","items":{"$ref":"#/$defs/Experience"}},"Experience":{"title":"Professional projects developed for a company","type":"array","items":{"$ref":"#/$defs/Experience"}},"Education":{"title":"Formal education","type":"array","items":{"$ref":"#/$defs/Education"}},"Courses":{"title":"Specific courses on a given subject","type":"array","items":{"$ref":"#/$defs/Course"}},"Achievements":{"title":"Professional achievements awarded by third parties","type":"array","items":{"$ref":"#/$defs/Achievement"}},"References":{"title":"Personal references from previous experiences","type":"array","items":{"$ref":"#/$defs/Reference"}},"Technical Skills":{"title":"Set of technical skills","type":"array","items":{"$ref":"#/$defs/SkillSet"}},"Common Skills":{"title":"Common (or soft) skills","type":"array","items":{"$ref":"#/$defs/SkillSet"}},"Other Facts":{"title":"Fun facts and/or interests","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"NullableYearMonth":{"type":["null","string"],"pattern":"\\d{4}-\\d{2}"},"YearMonth":{"type":"string","pattern":"\\d{4}-\\d{2}"},"Period":{"type":"string","pattern":"[pP]?\\s*(\\d+[yY])?\\s*(\\d+[wW])?\\s*(\\d+[dD])?"},"Locale":{"type":"string","pattern":"[a-z]{2}(_[A-Z]{2})?"},"NullableDate":{"type":["null","string"],"format":"DATE"},"Date":{"type":"string","format":"DATE"},"NullableUri":{"type":["null","string"],"format":"URI"},"Uri":{"type":"string","format":"URI"},"NullableString":{"type":["null","string"]},"NullableNumber":{"type":["null","number"]}}}
|
Provide a JSON object that satisfies the schema "cv.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
cv.schema
|
schema-store
|
schema_store_234
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$ref\":\"#/definitions/CWLGraphOrFile\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"CommandInputArraySchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputArraySchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn this object into command line arguments.\"},\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Defines the type of the array elements.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"array\",\"description\":\"Must be `array`\",\"type\":\"string\"}},\"required\":[\"items\",\"type\"],\"type\":\"object\"},\"CommandInputEnumSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputEnumSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn this object into command line arguments.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"symbols\":{\"description\":\"Defines the set of valid symbols.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type\":{\"const\":\"enum\",\"description\":\"Must be `enum`\",\"type\":\"string\"}},\"required\":[\"symbols\",\"type\"],\"type\":\"object\"},\"CommandInputParameter\":{\"additionalProperties\":false,\"description\":\"An input parameter for a CommandLineTool.\",\"properties\":{\"default\":{\"description\":\"The default value to use for this parameter if the parameter is missing\\nfrom the input object, or if the value of the parameter in the input\\nobject is `null`. Default values are applied before evaluating expressions\\n(e.g. dependent `valueFrom` fields).\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn the input parameters of a process into\\ncommand line arguments.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"CommandInputRecordField\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn this object into command line arguments.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"required\":[\"name\",\"type\"],\"type\":\"object\"},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}}]},\"CommandInputRecordSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"fields\":{\"description\":\"Defines the fields of the record.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/CommandInputRecordField\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"$ref\":\"#/definitions/CommandInputRecordFieldMap\"}},\"type\":\"object\"}]},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn this object into command line arguments.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"record\",\"description\":\"Must be `record`\",\"type\":\"string\"}},\"required\":[\"type\"],\"type\":\"object\"},\"CommandLineBinding\":{\"additionalProperties\":false,\"description\":\"\\nWhen listed under `inputBinding` in the input schema, the term\\n\\\"value\\\" refers to the corresponding value in the input object. For\\nbinding objects listed in `CommandLineTool.arguments`, the term \\\"value\\\"\\nrefers to the effective value after evaluating `valueFrom`.\\n\\nThe binding behavior when building the command line depends on the data\\ntype of the value. If there is a mismatch between the type described by\\nthe input schema and the effective value, such as resulting from an\\nexpression evaluation, an implementation must use the data type of the\\neffective value.\\n\\n - **string**: Add `prefix` and the string to the command line.\\n\\n - **number**: Add `prefix` and decimal representation to command line.\\n\\n - **boolean**: If true, add `prefix` to the command line. If false, add\\n nothing.\\n\\n - **File**: Add `prefix` and the value of\\n [`File.path`](#File) to the command line.\\n\\n - **Directory**: Add `prefix` and the value of\\n [`Directory.path`](#Directory) to the command line.\\n\\n - **array**: If `itemSeparator` is specified, add `prefix` and the join\\n the array into a single string with `itemSeparator` separating the\\n items. Otherwise, first add `prefix`, then recursively process\\n individual elements.\\n If the array is empty, it does not add anything to command line.\\n\\n - **object**: Add `prefix` only, and recursively add object fields for\\n which `inputBinding` is specified.\\n\\n - **null**: Add nothing.\",\"properties\":{\"itemSeparator\":{\"description\":\"Join the array elements into a single string with the elements\\nseparated by `itemSeparator`.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Use of `loadContents` in `InputBinding` is deprecated.\\nPreserved for v1.0 backwards compatibility. Will be removed in\\nCWL v2.0. Use `InputParameter.loadContents` instead.\",\"type\":\"boolean\"},\"position\":{\"description\":\"The sorting key. Default position is 0. If a [CWL Parameter Reference](#Parameter_references)\\nor [CWL Expression](#Expressions_(Optional)) is used and if the\\ninputBinding is associated with an input parameter, then the value of\\n`self` will be the value of the input parameter. Input parameter\\ndefaults (as specified by the `InputParameter.default` field) must be\\napplied before evaluating the expression. Expressions must return a\\nsingle value of type int or a null.\",\"type\":[\"string\",\"number\"]},\"prefix\":{\"description\":\"Command line prefix to add before the value.\",\"type\":\"string\"},\"separate\":{\"description\":\"If true (default), then the prefix and value must be added as separate\\ncommand line arguments; if false, prefix and value must be concatenated\\ninto a single command line argument.\",\"type\":\"boolean\"},\"shellQuote\":{\"description\":\"If `ShellCommandRequirement` is in the requirements for the current command,\\nthis controls whether the value is quoted on the command line (default is true).\\nUse `shellQuote: false` to inject metacharacters for operations such as pipes.\\n\\nIf `shellQuote` is true or not provided, the implementation must not\\npermit interpretation of any shell metacharacters or directives.\",\"type\":\"boolean\"},\"valueFrom\":{\"description\":\"If `valueFrom` is a constant string value, use this as the value and\\napply the binding rules above.\\n\\nIf `valueFrom` is an expression, evaluate the expression to yield the\\nactual value to use to build the command line and apply the binding\\nrules above. If the inputBinding is associated with an input\\nparameter, the value of `self` in the expression will be the value of\\nthe input parameter. Input parameter defaults (as specified by the\\n`InputParameter.default` field) must be applied before evaluating the\\nexpression.\\n\\nIf the value of the associated input parameter is `null`, `valueFrom` is\\nnot evaluated and nothing is added to the command line.\\n\\nWhen a binding is part of the `CommandLineTool.arguments` field,\\nthe `valueFrom` field is required.\",\"type\":\"string\"}},\"required\":[],\"type\":\"object\"},\"CommandLineTool\":{\"description\":\"This defines the schema of the CWL Command Line Tool Description document.\",\"properties\":{\"arguments\":{\"description\":\"Command line bindings which are not directly associated with input\\nparameters. If the value is a string, it is used as a string literal\\nargument. If it is an Expression, the result of the evaluation is used\\nas an argument.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandLineBinding\"},{\"type\":\"string\"}]},\"type\":\"array\"},\"baseCommand\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specifies the program to execute. If an array, the first element of\\nthe array is the command to execute, and subsequent elements are\\nmandatory command line arguments. The elements in `baseCommand` must\\nappear before any command line bindings from `inputBinding` or\\n`arguments`.\\n\\nIf `baseCommand` is not provided or is an empty array, the first\\nelement of the command line produced after processing `inputBinding` or\\n`arguments` must be used as the program to execute.\\n\\nIf the program includes a path separator character it must\\nbe an absolute path, otherwise it is an error. If the program does not\\ninclude a path separator, search the `$PATH` variable in the runtime\\nenvironment of the workflow runner find the absolute path of the\\nexecutable.\"},\"class\":{\"const\":\"CommandLineTool\",\"type\":\"string\"},\"cwlVersion\":{\"description\":\"CWL document version. Always required at the document root. Not\\nrequired for a Process embedded inside another Process.\",\"enum\":[\"draft-2\",\"draft-3\",\"draft-3.dev1\",\"draft-3.dev2\",\"draft-3.dev3\",\"draft-3.dev4\",\"draft-3.dev5\",\"draft-4.dev1\",\"draft-4.dev2\",\"draft-4.dev3\",\"v1.0\",\"v1.0.dev4\",\"v1.1\",\"v1.1.0-dev1\",\"v1.2\",\"v1.2.0-dev1\",\"v1.2.0-dev2\",\"v1.2.0-dev3\",\"v1.2.0-dev4\",\"v1.2.0-dev5\"],\"type\":\"string\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"hints\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"id\":{\"description\":\"The unique identifier for this object.\\n\\nOnly useful for `$graph` at `Process` level. Should not be exposed\\nto users in graphical or terminal user interfaces.\",\"type\":\"string\"},\"inputs\":{\"description\":\"Defines the input parameters of the process. The process is ready to\\nrun when all required input parameters are associated with concrete\\nvalues. Input parameters include a schema for each parameter which is\\nused to validate the input object. It may also be used to build a user\\ninterface for constructing the input object.\\n\\nWhen accepting an input object, all input parameters must have a value.\\nIf an input parameter is missing from the input object, it must be\\nassigned a value of `null` (or the value of `default` for that\\nparameter, if provided) for the purposes of validation and evaluation\\nof expressions.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/CommandInputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/CommandInputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/CommandInputParameter\"}]}}]}},\"type\":\"object\"}]},\"intent\":{\"description\":\"An identifier for the type of computational operation, of this Process.\\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\\n\\nIf provided, then this must be an IRI of a concept node that\\nrepresents the type of operation, preferably defined within an ontology.\\n\\nFor example, in the domain of bioinformatics, one can use an IRI from\\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\\nlike [Alignment](http://edamontology.org/operation_2928),\\nor [Clustering](http://edamontology.org/operation_3432); or a more\\nspecific Operation concept like\\n[Split read mapping](http://edamontology.org/operation_3199).\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"outputs\":{\"description\":\"Defines the parameters representing the output of the process. May be\\nused to generate and/or validate the output object.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/CommandOutputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/CommandOutputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/CommandOutputParameter\"}]}}]}},\"type\":\"object\"}]},\"permanentFailCodes\":{\"description\":\"Exit codes that indicate the process failed due to a permanent logic error, where executing the process with the same runtime environment and same inputs is expected to always fail.\\nIf not specified, all exit codes except 0 are considered permanent failure.\",\"items\":{\"type\":\"number\"},\"type\":\"array\"},\"requirements\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"stderr\":{\"description\":\"Capture the command's standard error stream to a file written to\\nthe designated output directory.\\n\\nIf `stderr` is a string, it specifies the file name to use.\\n\\nIf `stderr` is an expression, the expression is evaluated and must\\nreturn a string with the file name to use to capture stderr. If the\\nreturn value is not a string, or the resulting path contains illegal\\ncharacters (such as the path separator `/`) it is an error.\",\"type\":\"string\"},\"stdin\":{\"description\":\"A path to a file whose contents must be piped into the command's\\nstandard input stream.\",\"type\":\"string\"},\"stdout\":{\"description\":\"Capture the command's standard output stream to a file written to\\nthe designated output directory.\\n\\nIf the `CommandLineTool` contains logically chained commands\\n(e.g. `echo a && echo b`) `stdout` must include the output of\\nevery command.\\n\\nIf `stdout` is a string, it specifies the file name to use.\\n\\nIf `stdout` is an expression, the expression is evaluated and must\\nreturn a string with the file name to use to capture stdout. If the\\nreturn value is not a string, or the resulting path contains illegal\\ncharacters (such as the path separator `/`) it is an error.\",\"type\":\"string\"},\"successCodes\":{\"description\":\"Exit codes that indicate the process completed successfully.\\n\\nIf not specified, only exit code 0 is considered success.\",\"items\":{\"type\":\"number\"},\"type\":\"array\"},\"temporaryFailCodes\":{\"description\":\"Exit codes that indicate the process failed due to a possibly\\ntemporary condition, where executing the process with the same\\nruntime environment and inputs may produce different results.\\n\\nIf not specified, no exit codes are considered temporary failure.\",\"items\":{\"type\":\"number\"},\"type\":\"array\"}},\"required\":[\"class\",\"inputs\",\"outputs\"],\"type\":\"object\"},\"CommandOutputArraySchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputArraySchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Defines the type of the array elements.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"array\",\"description\":\"Must be `array`\",\"type\":\"string\"}},\"required\":[\"items\",\"type\"],\"type\":\"object\"},\"CommandOutputBinding\":{\"additionalProperties\":false,\"description\":\"Describes how to generate an output parameter based on the files produced\\nby a CommandLineTool.\\n\\nThe output parameter value is generated by applying these operations in the\\nfollowing order:\\n\\n - glob\\n - loadContents\\n - outputEval\\n - secondaryFiles\",\"properties\":{\"glob\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Find files or directories relative to the output directory, using POSIX\\nglob(3) pathname matching. If an array is provided, find files or\\ndirectories that match any pattern in the array. If an expression is\\nprovided, the expression must return a string or an array of strings,\\nwhich will then be evaluated as one or more glob patterns. Must only\\nmatch and return files/directories which actually exist.\\n\\nIf the value of glob is a relative path pattern (does not\\nbegin with a slash '/') then it is resolved relative to the\\noutput directory. If the value of the glob is an absolute\\npath pattern (it does begin with a slash '/') then it must\\nrefer to a path within the output directory. It is an error\\nif any glob resolves to a path outside the output directory.\\nSpecifically this means globs that resolve to paths outside the output\\ndirectory are illegal.\\n\\nA glob may match a path within the output directory which is\\nactually a symlink to another file. In this case, the\\nexpected behavior is for the resulting File/Directory object to take the\\n`basename` (and corresponding `nameroot` and `nameext`) of the\\nsymlink. The `location` of the File/Directory is implementation\\ndependent, but logically the File/Directory should have the same content\\nas the symlink target. Platforms may stage output files/directories to\\ncloud storage that lack the concept of a symlink. In\\nthis case file content and directories may be duplicated, or (to avoid\\nduplication) the File/Directory `location` may refer to the symlink\\ntarget.\\n\\nIt is an error if a symlink in the output directory (or any\\nsymlink in a chain of links) refers to any file or directory\\nthat is not under an input or output directory.\\n\\nImplementations may shut down a container before globbing\\noutput, so globs and expressions must not assume access to the\\ncontainer filesystem except for declared input and output.\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"outputEval\":{\"description\":\"Evaluate an expression to generate the output value. If\\n`glob` was specified, the value of `self` must be an array\\ncontaining file objects that were matched. If no files were\\nmatched, `self` must be a zero length array; if a single file\\nwas matched, the value of `self` is an array of a single\\nelement. The exit code of the process is\\navailable in the expression as `runtime.exitCode`.\\n\\nAdditionally, if `loadContents` is true, the file must be a\\nUTF-8 text file 64 KiB or smaller, and the implementation must\\nread the entire contents of the file (or file array) and place\\nit in the `contents` field of the File object for use in\\n`outputEval`. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\\n\\nIf a tool needs to return a large amount of structured data to\\nthe workflow, loading the output object from `cwl.output.json`\\nbypasses `outputEval` and is not subject to the 64 KiB\\n`loadContents` limit.\",\"type\":\"string\"}},\"required\":[],\"type\":\"object\"},\"CommandOutputEnumSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputEnumSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"symbols\":{\"description\":\"Defines the set of valid symbols.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type\":{\"const\":\"enum\",\"description\":\"Must be `enum`\",\"type\":\"string\"}},\"required\":[\"symbols\",\"type\"],\"type\":\"object\"},\"CommandOutputParameter\":{\"additionalProperties\":false,\"description\":\"An output parameter for a CommandLineTool.\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"outputBinding\":{\"$ref\":\"#/definitions/CommandOutputBinding\",\"description\":\"Describes how to generate this output object based on the files produced by a CommandLineTool\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"CommandOutputRecordField\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"outputBinding\":{\"$ref\":\"#/definitions/CommandOutputBinding\",\"description\":\"Describes how to generate this output object based on the files\\nproduced by a CommandLineTool\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"required\":[\"name\",\"type\"],\"type\":\"object\"},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}}]},\"CommandOutputRecordSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"fields\":{\"description\":\"Defines the fields of the record.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/CommandOutputRecordField\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"$ref\":\"#/definitions/CommandOutputRecordFieldMap\"}},\"type\":\"object\"}]},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"record\",\"description\":\"Must be `record`\",\"type\":\"string\"}},\"required\":[\"type\"],\"type\":\"object\"},\"DefaultFetcher\":{\"additionalProperties\":false,\"type\":\"object\"},\"Dictionary<any>\":{\"additionalProperties\":{\"$ref\":\"#/definitions/T\"},\"type\":\"object\"},\"Dictionary<string>\":{\"additionalProperties\":{\"$ref\":\"#/definitions/T\"},\"type\":\"object\"},\"Directory\":{\"additionalProperties\":false,\"description\":\"Represents a directory to present to a command line tool.\\n\\nDirectories are represented as objects with `class` of `Directory`. Directory objects have\\na number of properties that provide metadata about the directory.\\n\\nThe `location` property of a Directory is a IRI that uniquely identifies\\nthe directory. Implementations must support the file:// IRI scheme and may\\nsupport other schemes such as http://. Alternately to `location`,\\nimplementations must also accept the `path` property on Directory, which\\nmust be a filesystem path available on the same host as the CWL runner (for\\ninputs) or the runtime environment of a command line tool execution (for\\ncommand line tool outputs).\\n\\nA Directory object may have a `listing` field. This is a list of File and\\nDirectory objects that are contained in the Directory. For each entry in\\n`listing`, the `basename` property defines the name of the File or\\nSubdirectory when staged to disk. If `listing` is not provided, the\\nimplementation must have some way of fetching the Directory listing at\\nruntime based on the `location` field.\\n\\nIf a Directory does not have `location`, it is a Directory literal. A\\nDirectory literal must provide `listing`. Directory literals must be\\ncreated on disk at runtime as needed.\\n\\nThe resources in a Directory literal do not need to have any implied\\nrelationship in their `location`. For example, a Directory listing may\\ncontain two files located on different hosts. It is the responsibility of\\nthe runtime to ensure that those files are staged to disk appropriately.\\nSecondary files associated with files in `listing` must also be staged to\\nthe same Directory.\\n\\nWhen executing a CommandLineTool, Directories must be recursively staged\\nfirst and have local values of `path` assigned.\\n\\nDirectory objects in CommandLineTool output must provide either a\\n`location` IRI or a `path` property in the context of the tool execution\\nruntime (local to the compute node, or within the executing container).\\n\\nAn ExpressionTool may forward file references from input to output by using\\nthe same value for `location`.\\n\\nName conflicts (the same `basename` appearing multiple times in `listing`\\nor in any entry in `secondaryFiles` in the listing) is a fatal error.\",\"properties\":{\"basename\":{\"description\":\"The base name of the directory, that is, the name of the file without any\\nleading directory path. The base name must not contain a slash `/`.\\n\\nIf not provided, the implementation must set this field based on the\\n`location` field by taking the final path component after parsing\\n`location` as an IRI. If `basename` is provided, it is not required to\\nmatch the value from `location`.\\n\\nWhen this file is made available to a CommandLineTool, it must be named\\nwith `basename`, i.e. the final component of the `path` field must match\\n`basename`.\",\"type\":\"string\"},\"class\":{\"const\":\"Directory\",\"description\":\"Must be `Directory` to indicate this object describes a Directory.\",\"type\":\"string\"},\"listing\":{\"description\":\"List of files or subdirectories contained in this directory. The name\\nof each file or subdirectory is determined by the `basename` field of\\neach `File` or `Directory` object. It is an error if a `File` shares a\\n`basename` with any other entry in `listing`. If two or more\\n`Directory` object share the same `basename`, this must be treated as\\nequivalent to a single subdirectory with the listings recursively\\nmerged.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"}]},\"type\":\"array\"},\"location\":{\"description\":\"An IRI that identifies the directory resource. This may be a relative\\nreference, in which case it must be resolved using the base IRI of the\\ndocument. The location may refer to a local or remote resource. If\\nthe `listing` field is not set, the implementation must use the\\nlocation IRI to retrieve directory listing. If an implementation is\\nunable to retrieve the directory listing stored at a remote resource (due to\\nunsupported protocol, access denied, or other issue) it must signal an\\nerror.\\n\\nIf the `location` field is not provided, the `listing` field must be\\nprovided. The implementation must assign a unique identifier for\\nthe `location` field.\\n\\nIf the `path` field is provided but the `location` field is not, an\\nimplementation may assign the value of the `path` field to `location`,\\nthen follow the rules above.\",\"type\":\"string\"},\"path\":{\"description\":\"The local path where the Directory is made available prior to executing a\\nCommandLineTool. This must be set by the implementation. This field\\nmust not be used in any other context. The command line tool being\\nexecuted must be able to access the directory at `path` using the POSIX\\n`opendir(2)` syscall.\\n\\nIf the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)\\n(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\\\\`, `\\\"`, `'`,\\n`<space>`, `<tab>`, and `<newline>`) or characters\\n[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)\\nfor [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)\\nthen implementations may terminate the process with a\\n`permanentFailure`.\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"Dirent\":{\"additionalProperties\":false,\"description\":\"Define a file or subdirectory that must be staged to a particular\\nplace prior to executing the command line tool. May be the result\\nof executing an expression, such as building a configuration file\\nfrom a template.\\n\\nUsually files are staged within the [designated output directory](#Runtime_environment).\\nHowever, under certain circumstances, files may be staged at\\narbitrary locations, see discussion for `entryname`.\",\"properties\":{\"entry\":{\"description\":\"If the value is a string literal or an expression which evaluates to a\\nstring, a new text file must be created with the string as the file contents.\\n\\nIf the value is an expression that evaluates to a `File` or\\n`Directory` object, or an array of `File` or `Directory`\\nobjects, this indicates the referenced file or directory\\nshould be added to the designated output directory prior to\\nexecuting the tool.\\n\\nIf the value is an expression that evaluates to `null`,\\nnothing is added to the designated output directory, the entry\\nhas no effect.\\n\\nIf the value is an expression that evaluates to some other\\narray, number, or object not consisting of `File` or\\n`Directory` objects, a new file must be created with the value\\nserialized to JSON text as the file contents. The JSON\\nserialization behavior should match the behavior of string\\ninterpolation of [Parameter\\nreferences](#Parameter_references).\",\"type\":\"string\"},\"entryname\":{\"description\":\"The \\\"target\\\" name of the file or subdirectory. If `entry` is\\na File or Directory, the `entryname` field overrides the value\\nof `basename` of the File or Directory object.\\n\\n* Required when `entry` evaluates to file contents only\\n* Optional when `entry` evaluates to a File or Directory object with a `basename`\\n* Invalid when `entry` evaluates to an array of File or Directory objects.\\n\\nIf `entryname` is a relative path, it specifies a name within\\nthe designated output directory. A relative path starting\\nwith `../` or that resolves to location above the designated output directory is an error.\\n\\nIf `entryname` is an absolute path (starts with a slash `/`)\\nit is an error unless the following conditions are met:\\n\\n * `DockerRequirement` is present in `requirements`\\n * The program is will run inside a software container\\n where, from the perspective of the program, the root\\n filesystem is not shared with any other user or\\n running program.\\n\\nIn this case, and the above conditions are met, then\\n`entryname` may specify the absolute path within the container\\nwhere the file or directory must be placed.\",\"type\":\"string\"},\"writable\":{\"description\":\"If true, the File or Directory (or array of Files or\\nDirectories) declared in `entry` must be writable by the tool.\\n\\nChanges to the file or directory must be isolated and not\\nvisible by any other CommandLineTool process. This may be\\nimplemented by making a copy of the original file or\\ndirectory.\\n\\nDisruptive changes to the referenced file or directory must not\\nbe allowed unless `InplaceUpdateRequirement.inplaceUpdate` is true.\\n\\nDefault false (files and directories read-only by default).\\n\\nA directory marked as `writable: true` implies that all files and\\nsubdirectories are recursively writable as well.\\n\\nIf `writable` is false, the file may be made available using a\\nbind mount or file system link to avoid unnecessary copying of\\nthe input file. Command line tools may receive an error on\\nattempting to rename or delete files or directories that are\\nnot explicitly marked as writable.\",\"type\":\"boolean\"}},\"required\":[\"entry\"],\"type\":\"object\"},\"DockerRequirement\":{\"additionalProperties\":false,\"description\":\"Indicates that a workflow component should be run in a\\n[Docker](https://docker.com) or Docker-compatible (such as\\n[Singularity](https://www.sylabs.io/) and [udocker](https://github.com/indigo-dc/udocker)) container environment and\\nspecifies how to fetch or build the image.\\n\\nIf a CommandLineTool lists `DockerRequirement` under\\n`hints` (or `requirements`), it may (or must) be run in the specified Docker\\ncontainer.\\n\\nThe platform must first acquire or install the correct Docker image as\\nspecified by `dockerPull`, `dockerImport`, `dockerLoad` or `dockerFile`.\\n\\nThe platform must execute the tool in the container using `docker run` with\\nthe appropriate Docker image and tool command line.\\n\\nThe workflow platform may provide input files and the designated output\\ndirectory through the use of volume bind mounts. The platform should rewrite\\nfile paths in the input object to correspond to the Docker bind mounted\\nlocations. That is, the platform should rewrite values in the parameter context\\nsuch as `runtime.outdir`, `runtime.tmpdir` and others to be valid paths\\nwithin the container. The platform must ensure that `runtime.outdir` and\\n`runtime.tmpdir` are distinct directories.\\n\\nWhen running a tool contained in Docker, the workflow platform must not\\nassume anything about the contents of the Docker container, such as the\\npresence or absence of specific software, except to assume that the\\ngenerated command line represents a valid command within the runtime\\nenvironment of the container.\\n\\nA container image may specify an\\n[ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint)\\nand/or\\n[CMD](https://docs.docker.com/engine/reference/builder/#cmd).\\nCommand line arguments will be appended after all elements of\\nENTRYPOINT, and will override all elements specified using CMD (in\\nother words, CMD is only used when the CommandLineTool definition\\nproduces an empty command line).\\n\\nUse of implicit ENTRYPOINT or CMD are discouraged due to reproducibility\\nconcerns of the implicit hidden execution point (For further discussion, see\\n[https://doi.org/10.12688/f1000research.15140.1](https://doi.org/10.12688/f1000research.15140.1)). Portable\\nCommandLineTool wrappers in which use of a container is optional must not rely on ENTRYPOINT or CMD.\\nCommandLineTools which do rely on ENTRYPOINT or CMD must list `DockerRequirement` in the\\n`requirements` section.\\n\\n## Interaction with other requirements\\n\\nIf [EnvVarRequirement](#EnvVarRequirement) is specified alongside a\\nDockerRequirement, the environment variables must be provided to Docker\\nusing `--env` or `--env-file` and interact with the container's preexisting\\nenvironment as defined by Docker.\",\"properties\":{\"class\":{\"const\":\"DockerRequirement\",\"description\":\"Always 'DockerRequirement'\",\"type\":\"string\"},\"dockerFile\":{\"description\":\"Supply the contents of a Dockerfile which will be built using `docker build`.\",\"type\":\"string\"},\"dockerImageId\":{\"description\":\"The image id that will be used for `docker run`. May be a\\nhuman-readable image name or the image identifier hash. May be skipped\\nif `dockerPull` is specified, in which case the `dockerPull` image id\\nmust be used.\",\"type\":\"string\"},\"dockerImport\":{\"description\":\"Provide HTTP URL to download and gunzip a Docker images using `docker import.\",\"type\":\"string\"},\"dockerLoad\":{\"description\":\"Specify an HTTP URL from which to download a Docker image using `docker load`.\",\"type\":\"string\"},\"dockerOutputDirectory\":{\"description\":\"Set the designated output directory to a specific location inside the\\nDocker container.\",\"type\":\"string\"},\"dockerPull\":{\"description\":\"Specify a Docker image to retrieve using `docker pull`. Can contain the\\nimmutable digest to ensure an exact container is used:\\n`dockerPull: ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"EnvVarRequirement\":{\"additionalProperties\":false,\"description\":\"Define a list of environment variables which will be set in the\\nexecution environment of the tool. See `EnvironmentDef` for details.\",\"properties\":{\"class\":{\"const\":\"EnvVarRequirement\",\"description\":\"Always 'EnvVarRequirement'\",\"type\":\"string\"},\"envDef\":{\"description\":\"The list of environment variables.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvironmentDef\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"type\":\"string\"}}}]}},\"required\":[\"class\",\"envDef\"],\"type\":\"object\"},\"EnvironmentDef\":{\"additionalProperties\":false,\"description\":\"Define an environment variable that will be set in the runtime environment\\nby the workflow platform when executing the command line tool. May be the\\nresult of executing an expression, such as getting a parameter from input.\",\"properties\":{\"envName\":{\"description\":\"The environment variable name\",\"type\":\"string\"},\"envValue\":{\"description\":\"The environment variable value\",\"type\":\"string\"}},\"required\":[\"envName\",\"envValue\"],\"type\":\"object\"},\"ExpressionTool\":{\"description\":\"An ExpressionTool is a type of Process object that can be run by itself\\nor as a Workflow step. It executes a pure Javascript expression that has\\naccess to the same input parameters as a workflow. It is meant to be used\\nsparingly as a way to isolate complex Javascript expressions that need to\\noperate on input data and produce some result; perhaps just a\\nrearrangement of the inputs. No Docker software container is required\\nor allowed.\",\"properties\":{\"class\":{\"const\":\"ExpressionTool\",\"type\":\"string\"},\"cwlVersion\":{\"description\":\"CWL document version. Always required at the document root. Not\\nrequired for a Process embedded inside another Process.\",\"enum\":[\"draft-2\",\"draft-3\",\"draft-3.dev1\",\"draft-3.dev2\",\"draft-3.dev3\",\"draft-3.dev4\",\"draft-3.dev5\",\"draft-4.dev1\",\"draft-4.dev2\",\"draft-4.dev3\",\"v1.0\",\"v1.0.dev4\",\"v1.1\",\"v1.1.0-dev1\",\"v1.2\",\"v1.2.0-dev1\",\"v1.2.0-dev2\",\"v1.2.0-dev3\",\"v1.2.0-dev4\",\"v1.2.0-dev5\"],\"type\":\"string\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"expression\":{\"description\":\"The expression to execute. The expression must return a plain\\nJavascript object which matches the output parameters of the\\nExpressionTool.\",\"type\":\"string\"},\"hints\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"id\":{\"description\":\"The unique identifier for this object.\\n\\nOnly useful for `$graph` at `Process` level. Should not be exposed\\nto users in graphical or terminal user interfaces.\",\"type\":\"string\"},\"inputs\":{\"description\":\"Defines the input parameters of the process. The process is ready to\\nrun when all required input parameters are associated with concrete\\nvalues. Input parameters include a schema for each parameter which is\\nused to validate the input object. It may also be used to build a user\\ninterface for constructing the input object.\\n\\nWhen accepting an input object, all input parameters must have a value.\\nIf an input parameter is missing from the input object, it must be\\nassigned a value of `null` (or the value of `default` for that\\nparameter, if provided) for the purposes of validation and evaluation\\nof expressions.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/WorkflowInputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/WorkflowInputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/WorkflowInputParameter\"}]}}]}},\"type\":\"object\"}]},\"intent\":{\"description\":\"An identifier for the type of computational operation, of this Process.\\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\\n\\nIf provided, then this must be an IRI of a concept node that\\nrepresents the type of operation, preferably defined within an ontology.\\n\\nFor example, in the domain of bioinformatics, one can use an IRI from\\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\\nlike [Alignment](http://edamontology.org/operation_2928),\\nor [Clustering](http://edamontology.org/operation_3432); or a more\\nspecific Operation concept like\\n[Split read mapping](http://edamontology.org/operation_3199).\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"outputs\":{\"description\":\"Defines the parameters representing the output of the process. May be\\nused to generate and/or validate the output object.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/ExpressionToolOutputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/ExpressionToolOutputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\\nNote that this field just acts as a hint, as the outputs of an\\nExpressionTool process are always considered valid.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ExpressionToolOutputParameter\"}]}}]}},\"type\":\"object\"}]},\"requirements\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]}},\"required\":[\"class\",\"expression\",\"inputs\",\"outputs\"],\"type\":\"object\"},\"ExpressionToolOutputParameter\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#ExpressionToolOutputParameter\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\\nNote that this field just acts as a hint, as the outputs of an\\nExpressionTool process are always considered valid.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"Fetcher\":{\"oneOf\":[{\"$ref\":\"#/definitions/DefaultFetcher\"}]},\"File\":{\"additionalProperties\":false,\"description\":\"Represents a file (or group of files when `secondaryFiles` is provided) that\\nwill be accessible by tools using standard POSIX file system call API such as\\nopen(2) and read(2).\\n\\nFiles are represented as objects with `class` of `File`. File objects have\\na number of properties that provide metadata about the file.\\n\\nThe `location` property of a File is a IRI that uniquely identifies the\\nfile. Implementations must support the `file://` IRI scheme and may support\\nother schemes such as `http://` and `https://`. The value of `location` may also be a\\nrelative reference, in which case it must be resolved relative to the IRI\\nof the document it appears in. Alternately to `location`, implementations\\nmust also accept the `path` property on File, which must be a filesystem\\npath available on the same host as the CWL runner (for inputs) or the\\nruntime environment of a command line tool execution (for command line tool\\noutputs).\\n\\nIf no `location` or `path` is specified, a file object must specify\\n`contents` with the UTF-8 text content of the file. This is a \\\"file\\nliteral\\\". File literals do not correspond to external resources, but are\\ncreated on disk with `contents` with when needed for executing a tool.\\nWhere appropriate, expressions can return file literals to define new files\\non a runtime. The maximum size of `contents` is 64 kilobytes.\\n\\nThe `basename` property defines the filename on disk where the file is\\nstaged. This may differ from the resource name. If not provided,\\n`basename` must be computed from the last path part of `location` and made\\navailable to expressions.\\n\\nThe `secondaryFiles` property is a list of File or Directory objects that\\nmust be staged in the same directory as the primary file. It is an error\\nfor file names to be duplicated in `secondaryFiles`.\\n\\nThe `size` property is the size in bytes of the File. It must be computed\\nfrom the resource and made available to expressions. The `checksum` field\\ncontains a cryptographic hash of the file content for use it verifying file\\ncontents. Implementations may, at user option, enable or disable\\ncomputation of the `checksum` field for performance or other reasons.\\nHowever, the ability to compute output checksums is required to pass the\\nCWL conformance test suite.\\n\\nWhen executing a CommandLineTool, the files and secondary files may be\\nstaged to an arbitrary directory, but must use the value of `basename` for\\nthe filename. The `path` property must be file path in the context of the\\ntool execution runtime (local to the compute node, or within the executing\\ncontainer). All computed properties should be available to expressions.\\nFile literals also must be staged and `path` must be set.\\n\\nWhen collecting CommandLineTool outputs, `glob` matching returns file paths\\n(with the `path` property) and the derived properties. This can all be\\nmodified by `outputEval`. Alternately, if the file `cwl.output.json` is\\npresent in the output, `outputBinding` is ignored.\\n\\nFile objects in the output must provide either a `location` IRI or a `path`\\nproperty in the context of the tool execution runtime (local to the compute\\nnode, or within the executing container).\\n\\nWhen evaluating an ExpressionTool, file objects must be referenced via\\n`location` (the expression tool does not have access to files on disk so\\n`path` is meaningless) or as file literals. It is legal to return a file\\nobject with an existing `location` but a different `basename`. The\\n`loadContents` field of ExpressionTool inputs behaves the same as on\\nCommandLineTool inputs, however it is not meaningful on the outputs.\\n\\nAn ExpressionTool may forward file references from input to output by using\\nthe same value for `location`.\",\"properties\":{\"basename\":{\"description\":\"The base name of the file, that is, the name of the file without any\\nleading directory path. The base name must not contain a slash `/`.\\n\\nIf not provided, the implementation must set this field based on the\\n`location` field by taking the final path component after parsing\\n`location` as an IRI. If `basename` is provided, it is not required to\\nmatch the value from `location`.\\n\\nWhen this file is made available to a CommandLineTool, it must be named\\nwith `basename`, i.e. the final component of the `path` field must match\\n`basename`.\",\"type\":\"string\"},\"checksum\":{\"description\":\"Optional hash code for validating file integrity. Currently, must be in the form\\n\\\"sha1$ + hexadecimal string\\\" using the SHA-1 algorithm.\",\"type\":\"string\"},\"class\":{\"const\":\"File\",\"description\":\"Must be `File` to indicate this object describes a file.\",\"type\":\"string\"},\"contents\":{\"description\":\"File contents literal.\\n\\nIf neither `location` nor `path` is provided, `contents` must be\\nnon-null. The implementation must assign a unique identifier for the\\n`location` field. When the file is staged as input to CommandLineTool,\\nthe value of `contents` must be written to a file.\\n\\nIf `contents` is set as a result of a Javascript expression,\\nan `entry` in `InitialWorkDirRequirement`, or read in from\\n`cwl.output.json`, there is no specified upper limit on the\\nsize of `contents`. Implementations may have practical limits\\non the size of `contents` based on memory and storage\\navailable to the workflow runner or other factors.\\n\\nIf the `loadContents` field of an `InputParameter` or\\n`OutputParameter` is true, and the input or output File object\\n`location` is valid, the file must be a UTF-8 text file 64 KiB\\nor smaller, and the implementation must read the entire\\ncontents of the file and place it in the `contents` field. If\\nthe size of the file is greater than 64 KiB, the\\nimplementation must raise a fatal error.\",\"type\":\"string\"},\"dirname\":{\"description\":\"The name of the directory containing file, that is, the path leading up\\nto the final slash in the path such that `dirname + '/' + basename ==\\npath`.\\n\\nThe implementation must set this field based on the value of `path`\\nprior to evaluating parameter references or expressions in a\\nCommandLineTool document. This field must not be used in any other\\ncontext.\",\"type\":\"string\"},\"format\":{\"description\":\"The format of the file: this must be an IRI of a concept node that\\nrepresents the file format, preferably defined within an ontology.\\nIf no ontology is available, file formats may be tested by exact match.\\n\\nReasoning about format compatibility must be done by checking that an\\ninput file format is the same, `owl:equivalentClass` or\\n`rdfs:subClassOf` the format required by the input parameter.\\n`owl:equivalentClass` is transitive with `rdfs:subClassOf`, e.g. if\\n`<B> owl:equivalentClass <C>` and `<B> owl:subclassOf <A>` then infer\\n`<C> owl:subclassOf <A>`.\\n\\nFile format ontologies may be provided in the \\\"$schemas\\\" metadata at the\\nroot of the document. If no ontologies are specified in `$schemas`, the\\nruntime may perform exact file format matches.\",\"type\":\"string\"},\"location\":{\"description\":\"An IRI that identifies the file resource. This may be a relative\\nreference, in which case it must be resolved using the base IRI of the\\ndocument. The location may refer to a local or remote resource; the\\nimplementation must use the IRI to retrieve file content. If an\\nimplementation is unable to retrieve the file content stored at a\\nremote resource (due to unsupported protocol, access denied, or other\\nissue) it must signal an error.\\n\\nIf the `location` field is not provided, the `contents` field must be\\nprovided. The implementation must assign a unique identifier for\\nthe `location` field.\\n\\nIf the `path` field is provided but the `location` field is not, an\\nimplementation may assign the value of the `path` field to `location`,\\nthen follow the rules above.\",\"type\":\"string\"},\"nameext\":{\"description\":\"The basename extension such that `nameroot + nameext == basename`, and\\n`nameext` is empty or begins with a period and contains at most one\\nperiod. Leading periods on the basename are ignored; a basename of\\n`.cshrc` will have an empty `nameext`.\\n\\nThe implementation must set this field automatically based on the value\\nof `basename` prior to evaluating parameter references or expressions.\",\"type\":\"string\"},\"nameroot\":{\"description\":\"The basename root such that `nameroot + nameext == basename`, and\\n`nameext` is empty or begins with a period and contains at most one\\nperiod. For the purposes of path splitting leading periods on the\\nbasename are ignored; a basename of `.cshrc` will have a nameroot of\\n`.cshrc`.\\n\\nThe implementation must set this field automatically based on the value\\nof `basename` prior to evaluating parameter references or expressions.\",\"type\":\"string\"},\"path\":{\"description\":\"The local host path where the File is available when a CommandLineTool is\\nexecuted. This field must be set by the implementation. The final\\npath component must match the value of `basename`. This field\\nmust not be used in any other context. The command line tool being\\nexecuted must be able to access the file at `path` using the POSIX\\n`open(2)` syscall.\\n\\nAs a special case, if the `path` field is provided but the `location`\\nfield is not, an implementation may assign the value of the `path`\\nfield to `location`, and remove the `path` field.\\n\\nIf the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)\\n(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\\\\`, `\\\"`, `'`,\\n`<space>`, `<tab>`, and `<newline>`) or characters\\n[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)\\nfor [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)\\nthen implementations may terminate the process with a\\n`permanentFailure`.\",\"type\":\"string\"},\"secondaryFiles\":{\"description\":\"A list of additional files or directories that are associated with the\\nprimary file and must be transferred alongside the primary file.\\nExamples include indexes of the primary file, or external references\\nwhich must be included when loading primary document. A file object\\nlisted in `secondaryFiles` may itself include `secondaryFiles` for\\nwhich the same rules apply.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"}]},\"type\":\"array\"},\"size\":{\"description\":\"Optional file size (in bytes)\",\"type\":\"number\"}},\"required\":[\"class\"],\"type\":\"object\"},\"InitialWorkDirRequirement\":{\"additionalProperties\":false,\"description\":\"Define a list of files and subdirectories that must be staged by the workflow platform prior to executing the command line tool.\\nNormally files are staged within the designated output directory. However, when running inside containers, files may be staged at arbitrary locations, see discussion for [`Dirent.entryname`](#Dirent). Together with `DockerRequirement.dockerOutputDirectory` it is possible to control the locations of both input and output files when running in containers.\",\"properties\":{\"class\":{\"const\":\"InitialWorkDirRequirement\",\"description\":\"InitialWorkDirRequirement\",\"type\":\"string\"},\"listing\":{\"anyOf\":[{\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"},{\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"$ref\":\"#/definitions/Dirent\"},{\"type\":\"string\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The list of files or subdirectories that must be staged prior\\nto executing the command line tool.\\n\\nReturn type of each expression must validate as `[\\\"null\\\",\\nFile, Directory, Dirent, {type: array, items: [File,\\nDirectory]}]`.\\n\\nEach `File` or `Directory` that is returned by an Expression\\nmust be added to the designated output directory prior to\\nexecuting the tool.\\n\\nEach `Dirent` record that is listed or returned by an\\nexpression specifies a file to be created or staged in the\\ndesignated output directory prior to executing the tool.\\n\\nExpressions may return null, in which case they have no effect.\\n\\nFiles or Directories which are listed in the input parameters\\nand appear in the `InitialWorkDirRequirement` listing must\\nhave their `path` set to their staged location. If the same\\nFile or Directory appears more than once in the\\n`InitialWorkDirRequirement` listing, the implementation must\\nchoose exactly one value for `path`; how this value is chosen\\nis undefined.\"}},\"required\":[\"class\"],\"type\":\"object\"},\"InlineJavascriptRequirement\":{\"additionalProperties\":false,\"description\":\"Indicates that the workflow platform must support inline Javascript expressions.\\nIf this requirement is not present, the workflow platform must not perform expression\\ninterpolation.\",\"properties\":{\"class\":{\"const\":\"InlineJavascriptRequirement\",\"description\":\"Always 'InlineJavascriptRequirement'\",\"type\":\"string\"},\"expressionLib\":{\"description\":\"Additional code fragments that will also be inserted\\nbefore executing the expression code. Allows for function definitions that may\\nbe called from CWL expressions.\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[\"class\"],\"type\":\"object\"},\"InplaceUpdateRequirement\":{\"additionalProperties\":false,\"description\":\"\\nIf `inplaceUpdate` is true, then an implementation supporting this\\nfeature may permit tools to directly update files with `writable:\\ntrue` in InitialWorkDirRequirement. That is, as an optimization,\\nfiles may be destructively modified in place as opposed to copied\\nand updated.\\n\\nAn implementation must ensure that only one workflow step may\\naccess a writable file at a time. It is an error if a file which\\nis writable by one workflow step file is accessed (for reading or\\nwriting) by any other workflow step running independently.\\nHowever, a file which has been updated in a previous completed\\nstep may be used as input to multiple steps, provided it is\\nread-only in every step.\\n\\nWorkflow steps which modify a file must produce the modified file\\nas output. Downstream steps which further process the file must\\nuse the output of previous steps, and not refer to a common input\\n(this is necessary for both ordering and correctness).\\n\\nWorkflow authors should provide this in the `hints` section. The\\nintent of this feature is that workflows produce the same results\\nwhether or not InplaceUpdateRequirement is supported by the\\nimplementation, and this feature is primarily available as an\\noptimization for particular environments.\\n\\nUsers and implementers should be aware that workflows that\\ndestructively modify inputs may not be repeatable or reproducible.\\nIn particular, enabling this feature implies that WorkReuse should\\nnot be enabled.\",\"properties\":{\"class\":{\"const\":\"InplaceUpdateRequirement\",\"description\":\"Always 'InplaceUpdateRequirement'\",\"type\":\"string\"},\"inplaceUpdate\":{\"type\":\"boolean\"}},\"required\":[\"class\",\"inplaceUpdate\"],\"type\":\"object\"},\"InputArraySchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputArraySchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Defines the type of the array elements.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"array\",\"description\":\"Must be `array`\",\"type\":\"string\"}},\"required\":[\"items\",\"type\"],\"type\":\"object\"},\"InputBinding\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputBinding\",\"properties\":{\"loadContents\":{\"description\":\"Use of `loadContents` in `InputBinding` is deprecated.\\nPreserved for v1.0 backwards compatibility. Will be removed in\\nCWL v2.0. Use `InputParameter.loadContents` instead.\",\"type\":\"boolean\"}},\"required\":[],\"type\":\"object\"},\"InputEnumSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputEnumSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"symbols\":{\"description\":\"Defines the set of valid symbols.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type\":{\"const\":\"enum\",\"description\":\"Must be `enum`\",\"type\":\"string\"}},\"required\":[\"symbols\",\"type\"],\"type\":\"object\"},\"InputRecordField\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"required\":[\"name\",\"type\"],\"type\":\"object\"},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}}]},\"InputRecordSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"fields\":{\"description\":\"Defines the fields of the record.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/InputRecordField\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"$ref\":\"#/definitions/InputRecordFieldMap\"}},\"type\":\"object\"}]},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"record\",\"description\":\"Must be `record`\",\"type\":\"string\"}},\"required\":[\"type\"],\"type\":\"object\"},\"LoadListingRequirement\":{\"additionalProperties\":false,\"description\":\"Specify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\",\"properties\":{\"class\":{\"const\":\"LoadListingRequirement\",\"description\":\"Always 'LoadListingRequirement'\",\"type\":\"string\"},\"loadListing\":{\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"LoadingOptions\":{\"additionalProperties\":false,\"properties\":{\"container\":{\"type\":\"string\"},\"copyFrom\":{\"$ref\":\"#/definitions/LoadingOptions\"},\"fetcher\":{\"$ref\":\"#/definitions/Fetcher\"},\"fileUri\":{\"type\":\"string\"},\"idx\":{\"$ref\":\"#/definitions/Dictionary<any>\"},\"namespaces\":{\"$ref\":\"#/definitions/Dictionary<string>\"},\"noLinkCheck\":{\"type\":\"boolean\"},\"originalDoc\":{},\"rvocab\":{\"$ref\":\"#/definitions/Dictionary<string>\"},\"schemas\":{\"$ref\":\"#/definitions/Dictionary<string>\"},\"vocab\":{\"$ref\":\"#/definitions/Dictionary<string>\"}},\"required\":[\"fetcher\",\"idx\",\"originalDoc\",\"rvocab\",\"vocab\"],\"type\":\"object\"},\"MultipleInputFeatureRequirement\":{\"additionalProperties\":false,\"description\":\"Indicates that the workflow platform must support multiple inbound data links\\nlisted in the `source` field of [WorkflowStepInput](#WorkflowStepInput).\",\"properties\":{\"class\":{\"const\":\"MultipleInputFeatureRequirement\",\"description\":\"Always 'MultipleInputFeatureRequirement'\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"NetworkAccess\":{\"additionalProperties\":false,\"description\":\"Indicate whether a process requires outgoing IPv4/IPv6 network\\naccess. Choice of IPv4 or IPv6 is implementation and site\\nspecific, correct tools must support both.\\n\\nIf `networkAccess` is false or not specified, tools must not\\nassume network access, except for localhost (the loopback device).\\n\\nIf `networkAccess` is true, the tool must be able to make outgoing\\nconnections to network resources. Resources may be on a private\\nsubnet or the public Internet. However, implementations and sites\\nmay apply their own security policies to restrict what is\\naccessible by the tool.\\n\\nEnabling network access does not imply a publicly routable IP\\naddress or the ability to accept inbound connections.\",\"properties\":{\"class\":{\"const\":\"NetworkAccess\",\"description\":\"Always 'NetworkAccess'\",\"type\":\"string\"},\"networkAccess\":{\"type\":[\"string\",\"boolean\"]}},\"required\":[\"class\",\"networkAccess\"],\"type\":\"object\"},\"Operation\":{\"additionalProperties\":false,\"description\":\"This record describes an abstract operation. It is a potential\\nstep of a workflow that has not yet been bound to a concrete\\nimplementation. It specifies an input and output signature, but\\ndoes not provide enough information to be executed. An\\nimplementation (or other tooling) may provide a means of binding\\nan Operation to a concrete process (such as Workflow,\\nCommandLineTool, or ExpressionTool) with a compatible signature.\",\"properties\":{\"class\":{\"const\":\"Operation\",\"type\":\"string\"},\"cwlVersion\":{\"description\":\"CWL document version. Always required at the document root. Not\\nrequired for a Process embedded inside another Process.\",\"enum\":[\"draft-2\",\"draft-3\",\"draft-3.dev1\",\"draft-3.dev2\",\"draft-3.dev3\",\"draft-3.dev4\",\"draft-3.dev5\",\"draft-4.dev1\",\"draft-4.dev2\",\"draft-4.dev3\",\"v1.0\",\"v1.0.dev4\",\"v1.1\",\"v1.1.0-dev1\",\"v1.2\",\"v1.2.0-dev1\",\"v1.2.0-dev2\",\"v1.2.0-dev3\",\"v1.2.0-dev4\",\"v1.2.0-dev5\"],\"type\":\"string\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"hints\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"id\":{\"description\":\"The unique identifier for this object.\\n\\nOnly useful for `$graph` at `Process` level. Should not be exposed\\nto users in graphical or terminal user interfaces.\",\"type\":\"string\"},\"inputs\":{\"description\":\"Defines the input parameters of the process. The process is ready to\\nrun when all required input parameters are associated with concrete\\nvalues. Input parameters include a schema for each parameter which is\\nused to validate the input object. It may also be used to build a user\\ninterface for constructing the input object.\\n\\nWhen accepting an input object, all input parameters must have a value.\\nIf an input parameter is missing from the input object, it must be\\nassigned a value of `null` (or the value of `default` for that\\nparameter, if provided) for the purposes of validation and evaluation\\nof expressions.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/OperationInputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/OperationInputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/OperationInputParameter\"}]}}]}},\"type\":\"object\"}]},\"intent\":{\"description\":\"An identifier for the type of computational operation, of this Process.\\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\\n\\nIf provided, then this must be an IRI of a concept node that\\nrepresents the type of operation, preferably defined within an ontology.\\n\\nFor example, in the domain of bioinformatics, one can use an IRI from\\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\\nlike [Alignment](http://edamontology.org/operation_2928),\\nor [Clustering](http://edamontology.org/operation_3432); or a more\\nspecific Operation concept like\\n[Split read mapping](http://edamontology.org/operation_3199).\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"outputs\":{\"description\":\"Defines the parameters representing the output of the process. May be\\nused to generate and/or validate the output object.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/OperationOutputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/OperationOutputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/OperationOutputParameter\"}]}}]}},\"type\":\"object\"}]},\"requirements\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]}},\"required\":[\"class\",\"inputs\",\"outputs\"],\"type\":\"object\"},\"OperationInputParameter\":{\"additionalProperties\":false,\"description\":\"Describe an input parameter of an operation.\",\"properties\":{\"default\":{\"description\":\"The default value to use for this parameter if the parameter is missing\\nfrom the input object, or if the value of the parameter in the input\\nobject is `null`. Default values are applied before evaluating expressions\\n(e.g. dependent `valueFrom` fields).\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"OperationOutputParameter\":{\"additionalProperties\":false,\"description\":\"Describe an output parameter of an operation.\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"OutputArraySchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputArraySchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Defines the type of the array elements.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"array\",\"description\":\"Must be `array`\",\"type\":\"string\"}},\"required\":[\"items\",\"type\"],\"type\":\"object\"},\"OutputEnumSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputEnumSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"symbols\":{\"description\":\"Defines the set of valid symbols.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type\":{\"const\":\"enum\",\"description\":\"Must be `enum`\",\"type\":\"string\"}},\"required\":[\"symbols\",\"type\"],\"type\":\"object\"},\"OutputRecordField\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"required\":[\"name\",\"type\"],\"type\":\"object\"},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}}]},\"OutputRecordSchema\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordSchema\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"fields\":{\"description\":\"Defines the fields of the record.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/OutputRecordField\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"$ref\":\"#/definitions/OutputRecordFieldMap\"}},\"type\":\"object\"}]},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The identifier for this type\",\"type\":\"string\"},\"type\":{\"const\":\"record\",\"description\":\"Must be `record`\",\"type\":\"string\"}},\"required\":[\"type\"],\"type\":\"object\"},\"ResourceRequirement\":{\"additionalProperties\":false,\"description\":\"Specify basic hardware resource requirements.\\n\\n\\\"min\\\" is the minimum amount of a resource that must be reserved to\\nschedule a job. If \\\"min\\\" cannot be satisfied, the job should not\\nbe run.\\n\\n\\\"max\\\" is the maximum amount of a resource that the job shall be\\nallocated. If a node has sufficient resources, multiple jobs may\\nbe scheduled on a single node provided each job's \\\"max\\\" resource\\nrequirements are met. If a job attempts to exceed its resource\\nallocation, an implementation may deny additional resources, which\\nmay result in job failure.\\n\\nIf both \\\"min\\\" and \\\"max\\\" are specified, an implementation may\\nchoose to allocate any amount between \\\"min\\\" and \\\"max\\\", with the\\nactual allocation provided in the `runtime` object.\\n\\nIf \\\"min\\\" is specified but \\\"max\\\" is not, then \\\"max\\\" == \\\"min\\\"\\nIf \\\"max\\\" is specified by \\\"min\\\" is not, then \\\"min\\\" == \\\"max\\\".\\n\\nIt is an error if max < min.\\n\\nIt is an error if the value of any of these fields is negative.\\n\\nIf neither \\\"min\\\" nor \\\"max\\\" is specified for a resource, use the default values below.\",\"properties\":{\"class\":{\"const\":\"ResourceRequirement\",\"description\":\"Always 'ResourceRequirement'\",\"type\":\"string\"},\"coresMax\":{\"description\":\"Maximum reserved number of CPU cores.\\n\\nSee `coresMin` for discussion about fractional CPU requests.\",\"type\":[\"string\",\"number\"]},\"coresMin\":{\"description\":\"Minimum reserved number of CPU cores (default is 1).\\n\\nMay be a fractional value to indicate to a scheduling\\nalgorithm that one core can be allocated to multiple\\njobs. For example, a value of 0.25 indicates that up to 4\\njobs may run in parallel on 1 core. A value of 1.25 means\\nthat up to 3 jobs can run on a 4 core system (4/1.25 \\u2248 3).\\n\\nProcesses can only share a core allocation if the sum of each\\nof their `ramMax`, `tmpdirMax`, and `outdirMax` requests also\\ndo not exceed the capacity of the node.\\n\\nProcesses sharing a core must have the same level of isolation\\n(typically a container or VM) that they would normally have.\\n\\nThe reported number of CPU cores reserved for the process,\\nwhich is available to expressions on the CommandLineTool as\\n`runtime.cores`, must be a non-zero integer, and may be\\ncalculated by rounding up the cores request to the next whole\\nnumber.\\n\\nScheduling systems may allocate fractional CPU resources by\\nsetting quotas or scheduling weights. Scheduling systems that\\ndo not support fractional CPUs may round up the request to the\\nnext whole number.\",\"type\":[\"string\",\"number\"]},\"outdirMax\":{\"description\":\"Maximum reserved filesystem based storage for the designated output directory, in mebibytes (2**20)\\n\\nSee `outdirMin` for discussion about fractional storage requests.\",\"type\":[\"string\",\"number\"]},\"outdirMin\":{\"description\":\"Minimum reserved filesystem based storage for the designated output directory, in mebibytes (2**20) (default is 1024)\\n\\nMay be a fractional value. If so, the actual storage request\\nmust be rounded up to the next whole number. The reported\\namount of storage reserved for the process, which is available\\nto expressions on the CommandLineTool as `runtime.outdirSize`,\\nmust be a non-zero integer.\",\"type\":[\"string\",\"number\"]},\"ramMax\":{\"description\":\"Maximum reserved RAM in mebibytes (2**20)\\n\\nSee `ramMin` for discussion about fractional RAM requests.\",\"type\":[\"string\",\"number\"]},\"ramMin\":{\"description\":\"Minimum reserved RAM in mebibytes (2**20) (default is 256)\\n\\nMay be a fractional value. If so, the actual RAM request must\\nbe rounded up to the next whole number. The reported amount of\\nRAM reserved for the process, which is available to\\nexpressions on the CommandLineTool as `runtime.ram`, must be a\\nnon-zero integer.\",\"type\":[\"string\",\"number\"]},\"tmpdirMax\":{\"description\":\"Maximum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20)\\n\\nSee `tmpdirMin` for discussion about fractional storage requests.\",\"type\":[\"string\",\"number\"]},\"tmpdirMin\":{\"description\":\"Minimum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20) (default is 1024)\\n\\nMay be a fractional value. If so, the actual storage request\\nmust be rounded up to the next whole number. The reported\\namount of storage reserved for the process, which is available\\nto expressions on the CommandLineTool as `runtime.tmpdirSize`,\\nmust be a non-zero integer.\",\"type\":[\"string\",\"number\"]}},\"required\":[\"class\"],\"type\":\"object\"},\"ScatterFeatureRequirement\":{\"additionalProperties\":false,\"description\":\"Indicates that the workflow platform must support the `scatter` and\\n`scatterMethod` fields of [WorkflowStep](#WorkflowStep).\",\"properties\":{\"class\":{\"const\":\"ScatterFeatureRequirement\",\"description\":\"Always 'ScatterFeatureRequirement'\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"SchemaDefRequirement\":{\"additionalProperties\":false,\"description\":\"This field consists of an array of type definitions which must be used when\\ninterpreting the `inputs` and `outputs` fields. When a `type` field\\ncontains a IRI, the implementation must check if the type is defined in\\n`schemaDefs` and use that definition. If the type is not found in\\n`schemaDefs`, it is an error. The entries in `schemaDefs` must be\\nprocessed in the order listed such that later schema definitions may refer\\nto earlier schema definitions.\\n\\n- **Type definitions are allowed for `enum` and `record` types only.**\\n- Type definitions may be shared by defining them in a file and then\\n `$include`-ing them in the `types` field.\\n- A file can contain a list of type definitions\",\"properties\":{\"class\":{\"const\":\"SchemaDefRequirement\",\"description\":\"Always 'SchemaDefRequirement'\",\"type\":\"string\"},\"types\":{\"description\":\"The list of type definitions.\",\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[\"class\",\"types\"],\"type\":\"object\"},\"SecondaryFileSchema\":{\"description\":\"Secondary files are specified using the following micro-DSL for secondary files:\\n\\n* If the value is a string, it is transformed to an object with two fields\\n `pattern` and `required`\\n* By default, the value of `required` is `null`\\n (this indicates default behavior, which may be based on the context)\\n* If the value ends with a question mark `?` the question mark is\\n stripped off and the value of the field `required` is set to `False`\\n* The remaining value is assigned to the field `pattern`\\n\\nFor implementation details and examples, please see\\n[this section](SchemaSalad.html#Domain_Specific_Language_for_secondary_files)\\nin the Schema Salad specification.\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"pattern\":{\"description\":\"Provides a pattern or expression specifying files or directories that\\nshould be included alongside the primary file.\\n\\nIf the value is an expression, the value of `self` in the\\nexpression must be the primary input or output File object to\\nwhich this binding applies. The `basename`, `nameroot` and\\n`nameext` fields must be present in `self`. For\\n`CommandLineTool` inputs the `location` field must also be\\npresent. For `CommandLineTool` outputs the `path` field must\\nalso be present. If secondary files were included on an input\\nFile object as part of the Process invocation, they must also\\nbe present in `secondaryFiles` on `self`.\\n\\nThe expression must return either: a filename string relative\\nto the path to the primary File, a File or Directory object\\n(`class: File` or `class: Directory`) with either `location`\\n(for inputs) or `path` (for outputs) and `basename` fields\\nset, or an array consisting of strings or File or Directory\\nobjects as previously described.\\n\\nIt is legal to use `location` from a File or Directory object\\npassed in as input, including `location` from secondary files\\non `self`. If an expression returns a File object with the\\nsame `location` but a different `basename` as a secondary file\\nthat was passed in, the expression result takes precedence.\\nSetting the basename with an expression this way affects the\\n`path` where the secondary file will be staged to in the\\nCommandLineTool.\\n\\nThe expression may return \\\"null\\\" in which case there is no\\nsecondary file from that expression.\\n\\nTo work on non-filename-preserving storage systems, portable\\ntool descriptions should treat `location` as an\\n[opaque identifier](#opaque-strings) and avoid constructing new\\nvalues from `location`, but should construct relative references\\nusing `basename` or `nameroot` instead, or propagate `location`\\nfrom defined inputs.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\",\"type\":\"string\"},\"required\":{\"description\":\"An implementation must not fail workflow execution if `required` is\\nset to `false` and the expected secondary file does not exist.\\nDefault value for `required` field is `true` for secondary files on\\ninput and `false` for secondary files on output.\",\"type\":[\"string\",\"boolean\"]}},\"required\":[\"pattern\"],\"type\":\"object\"},{\"type\":\"string\"}]},\"ShellCommandRequirement\":{\"additionalProperties\":false,\"description\":\"Modify the behavior of CommandLineTool to generate a single string\\ncontaining a shell command line. Each item in the `arguments` list must\\nbe joined into a string separated by single spaces and quoted to prevent\\ninterpretation by the shell, unless `CommandLineBinding` for that argument\\ncontains `shellQuote: false`. If `shellQuote: false` is specified, the\\nargument is joined into the command string without quoting, which allows\\nthe use of shell metacharacters such as `|` for pipes.\",\"properties\":{\"class\":{\"const\":\"ShellCommandRequirement\",\"description\":\"Always 'ShellCommandRequirement'\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"SoftwarePackage\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#SoftwarePackage\",\"properties\":{\"package\":{\"description\":\"The name of the software to be made available. If the name is\\ncommon, inconsistent, or otherwise ambiguous it should be combined with\\none or more identifiers in the `specs` field.\",\"type\":\"string\"},\"specs\":{\"description\":\"One or more [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)s\\nidentifying resources for installing or enabling the software named in\\nthe `package` field. Implementations may provide resolvers which map\\nthese software identifier IRIs to some configuration action; or they can\\nuse only the name from the `package` field on a best effort basis.\\n\\nFor example, the IRI https://packages.debian.org/bowtie could\\nbe resolved with `apt-get install bowtie`. The IRI\\nhttps://anaconda.org/bioconda/bowtie could be resolved with `conda\\ninstall -c bioconda bowtie`.\\n\\nIRIs can also be system independent and used to map to a specific\\nsoftware installation or selection mechanism.\\nUsing [RRID](https://www.identifiers.org/rrid/) as an example:\\nhttps://identifiers.org/rrid/RRID:SCR_005476\\ncould be fulfilled using the above-mentioned Debian or bioconda\\npackage, a local installation managed by [Environment Modules](https://modules.sourceforge.net/),\\nor any other mechanism the platform chooses. IRIs can also be from\\nidentifier sources that are discipline specific yet still system\\nindependent. As an example, the equivalent [ELIXIR Tools and Data\\nService Registry](https://bio.tools) IRI to the previous RRID example is\\nhttps://bio.tools/tool/bowtie2/version/2.2.8.\\nIf supported by a given registry, implementations are encouraged to\\nquery these system independent software identifier IRIs directly for\\nlinks to packaging systems.\\n\\nA site specific IRI can be listed as well. For example, an academic\\ncomputing cluster using Environment Modules could list the IRI\\n`https://hpc.example.edu/modules/bowtie-tbb/1.22` to indicate that\\n`module load bowtie-tbb/1.1.2` should be executed to make available\\n`bowtie` version 1.1.2 compiled with the TBB library prior to running\\nthe accompanying Workflow or CommandLineTool. Note that the example IRI\\nis specific to a particular institution and computing environment as\\nthe Environment Modules system does not have a common namespace or\\nstandardized naming convention.\\n\\nThis last example is the least portable and should only be used if\\nmechanisms based off of the `package` field or more generic IRIs are\\nunavailable or unsuitable. While harmless to other sites, site specific\\nsoftware IRIs should be left out of shared CWL descriptions to avoid\\nclutter.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"version\":{\"description\":\"The (optional) versions of the software that are known to be\\ncompatible.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"package\"],\"type\":\"object\"},\"SoftwareRequirement\":{\"additionalProperties\":false,\"description\":\"A list of software packages that should be configured in the environment of\\nthe defined process.\",\"properties\":{\"class\":{\"const\":\"SoftwareRequirement\",\"description\":\"Always 'SoftwareRequirement'\",\"type\":\"string\"},\"packages\":{\"description\":\"The list of software to be configured.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwarePackage\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[\"class\",\"packages\"],\"type\":\"object\"},\"StepInputExpressionRequirement\":{\"additionalProperties\":false,\"description\":\"Indicate that the workflow platform must support the `valueFrom` field\\nof [WorkflowStepInput](#WorkflowStepInput).\",\"properties\":{\"class\":{\"const\":\"StepInputExpressionRequirement\",\"description\":\"Always 'StepInputExpressionRequirement'\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"SubworkflowFeatureRequirement\":{\"additionalProperties\":false,\"description\":\"Indicates that the workflow platform must support nested workflows in\\nthe `run` field of [WorkflowStep](#WorkflowStep).\",\"properties\":{\"class\":{\"const\":\"SubworkflowFeatureRequirement\",\"description\":\"Always 'SubworkflowFeatureRequirement'\",\"type\":\"string\"}},\"required\":[\"class\"],\"type\":\"object\"},\"T\":{\"additionalProperties\":false,\"type\":\"object\"},\"ToolTimeLimit\":{\"additionalProperties\":false,\"description\":\"Set an upper limit on the execution time of a CommandLineTool.\\nA CommandLineTool whose execution duration exceeds the time\\nlimit may be preemptively terminated and considered failed.\\nMay also be used by batch systems to make scheduling decisions.\\nThe execution duration excludes external operations, such as\\nstaging of files, pulling a docker image etc, and only counts\\nwall-time for the execution of the command line itself.\",\"properties\":{\"class\":{\"const\":\"ToolTimeLimit\",\"description\":\"Always 'ToolTimeLimit'\",\"type\":\"string\"},\"timelimit\":{\"description\":\"The time limit, in seconds. A time limit of zero means no\\ntime limit. Negative time limits are an error.\",\"type\":[\"string\",\"number\"]}},\"required\":[\"class\",\"timelimit\"],\"type\":\"object\"},\"WorkReuse\":{\"additionalProperties\":false,\"description\":\"For implementations that support reusing output from past work (on\\nthe assumption that same code and same input produce same\\nresults), control whether to enable or disable the reuse behavior\\nfor a particular tool or step (to accommodate situations where that\\nassumption is incorrect). A reused step is not executed but\\ninstead returns the same output as the original execution.\\n\\nIf `WorkReuse` is not specified, correct tools should assume it\\nis enabled by default.\",\"properties\":{\"class\":{\"const\":\"WorkReuse\",\"description\":\"Always 'WorkReuse'\",\"type\":\"string\"},\"enableReuse\":{\"type\":[\"string\",\"boolean\"]}},\"required\":[\"class\",\"enableReuse\"],\"type\":\"object\"},\"Workflow\":{\"description\":\"A workflow describes a set of **steps** and the **dependencies** between\\nthose steps. When a step produces output that will be consumed by a\\nsecond step, the first step is a dependency of the second step.\\n\\nWhen there is a dependency, the workflow engine must execute the preceding\\nstep and wait for it to successfully produce output before executing the\\ndependent step. If two steps are defined in the workflow graph that\\nare not directly or indirectly dependent, these steps are **independent**,\\nand may execute in any order or execute concurrently. A workflow is\\ncomplete when all steps have been executed.\\n\\nDependencies between parameters are expressed using the `source`\\nfield on [workflow step input parameters](#WorkflowStepInput) and\\n`outputSource` field on [workflow output\\nparameters](#WorkflowOutputParameter).\\n\\nThe `source` field on each workflow step input parameter expresses\\nthe data links that contribute to the value of the step input\\nparameter (the \\\"sink\\\"). A workflow step can only begin execution\\nwhen every data link connected to a step has been fulfilled.\\n\\nThe `outputSource` field on each workflow step input parameter\\nexpresses the data links that contribute to the value of the\\nworkflow output parameter (the \\\"sink\\\"). Workflow execution cannot\\ncomplete successfully until every data link connected to an output\\nparameter has been fulfilled.\\n\\n## Workflow success and failure\\n\\nA completed step must result in one of `success`, `temporaryFailure` or\\n`permanentFailure` states. An implementation may choose to retry a step\\nexecution which resulted in `temporaryFailure`. An implementation may\\nchoose to either continue running other steps of a workflow, or terminate\\nimmediately upon `permanentFailure`.\\n\\n* If any step of a workflow execution results in `permanentFailure`, then\\nthe workflow status is `permanentFailure`.\\n\\n* If one or more steps result in `temporaryFailure` and all other steps\\ncomplete `success` or are not executed, then the workflow status is\\n`temporaryFailure`.\\n\\n* If all workflow steps are executed and complete with `success`, then the\\nworkflow status is `success`.\\n\\n# Extensions\\n\\n[ScatterFeatureRequirement](#ScatterFeatureRequirement) and\\n[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) are\\navailable as standard [extensions](#Extensions_and_Metadata) to core\\nworkflow semantics.\",\"properties\":{\"class\":{\"const\":\"Workflow\",\"type\":\"string\"},\"cwlVersion\":{\"description\":\"CWL document version. Always required at the document root. Not\\nrequired for a Process embedded inside another Process.\",\"enum\":[\"draft-2\",\"draft-3\",\"draft-3.dev1\",\"draft-3.dev2\",\"draft-3.dev3\",\"draft-3.dev4\",\"draft-3.dev5\",\"draft-4.dev1\",\"draft-4.dev2\",\"draft-4.dev3\",\"v1.0\",\"v1.0.dev4\",\"v1.1\",\"v1.1.0-dev1\",\"v1.2\",\"v1.2.0-dev1\",\"v1.2.0-dev2\",\"v1.2.0-dev3\",\"v1.2.0-dev4\",\"v1.2.0-dev5\"],\"type\":\"string\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"hints\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"id\":{\"description\":\"The unique identifier for this object.\\n\\nOnly useful for `$graph` at `Process` level. Should not be exposed\\nto users in graphical or terminal user interfaces.\",\"type\":\"string\"},\"inputs\":{\"description\":\"Defines the input parameters of the process. The process is ready to\\nrun when all required input parameters are associated with concrete\\nvalues. Input parameters include a schema for each parameter which is\\nused to validate the input object. It may also be used to build a user\\ninterface for constructing the input object.\\n\\nWhen accepting an input object, all input parameters must have a value.\\nIf an input parameter is missing from the input object, it must be\\nassigned a value of `null` (or the value of `default` for that\\nparameter, if provided) for the purposes of validation and evaluation\\nof expressions.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/WorkflowInputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/WorkflowInputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/WorkflowInputParameter\"}]}}]}},\"type\":\"object\"}]},\"intent\":{\"description\":\"An identifier for the type of computational operation, of this Process.\\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\\n\\nIf provided, then this must be an IRI of a concept node that\\nrepresents the type of operation, preferably defined within an ontology.\\n\\nFor example, in the domain of bioinformatics, one can use an IRI from\\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\\nlike [Alignment](http://edamontology.org/operation_2928),\\nor [Clustering](http://edamontology.org/operation_3432); or a more\\nspecific Operation concept like\\n[Split read mapping](http://edamontology.org/operation_3199).\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"outputs\":{\"description\":\"Defines the parameters representing the output of the process. May be\\nused to generate and/or validate the output object.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/WorkflowOutputParameter\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/WorkflowOutputParameter\"},{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/WorkflowOutputParameter\"}]}}]}},\"type\":\"object\"}]},\"requirements\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this process. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"steps\":{\"description\":\"The individual steps that make up the workflow. Each step is executed when all of its\\ninput data links are fulfilled. An implementation may choose to execute\\nthe steps in a different order than listed and/or execute steps\\nconcurrently, provided that dependencies between steps are met.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/WorkflowStep\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"$ref\":\"#/definitions/WorkflowStep\"}},\"type\":\"object\"}]}},\"required\":[\"class\",\"inputs\",\"outputs\",\"steps\"],\"type\":\"object\"},\"WorkflowInputParameter\":{\"additionalProperties\":false,\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#WorkflowInputParameter\",\"properties\":{\"default\":{\"description\":\"The default value to use for this parameter if the parameter is missing\\nfrom the input object, or if the value of the parameter in the input\\nobject is `null`. Default values are applied before evaluating expressions\\n(e.g. dependent `valueFrom` fields).\"},\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"inputBinding\":{\"$ref\":\"#/definitions/InputBinding\",\"description\":\"Deprecated. Preserved for v1.0 backwards compatibility. Will be removed in\\nCWL v2.0. Use `WorkflowInputParameter.loadContents` instead.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"WorkflowOutputParameter\":{\"additionalProperties\":false,\"description\":\"Describe an output parameter of a workflow. The parameter must be\\nconnected to one or more parameters defined in the workflow that\\nwill provide the value of the output parameter. It is legal to\\nconnect a WorkflowInputParameter to a WorkflowOutputParameter.\\n\\nSee [WorkflowStepInput](#WorkflowStepInput) for discussion of\\n`linkMerge` and `pickValue`.\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"linkMerge\":{\"description\":\"The method to use to merge multiple sources into a single array.\\nIf not specified, the default method is \\\"merge_nested\\\".\",\"enum\":[\"merge_flattened\",\"merge_nested\"],\"type\":\"string\"},\"outputSource\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specifies one or more names of an output from a workflow step (in the form\\n`step_name/output_name` with a `/` separator`), or a workflow input name,\\nthat supply their value(s) to the output parameter.\\nthe output parameter. It is valid to reference workflow level inputs\\nhere.\"},\"pickValue\":{\"description\":\"The method to use to choose non-null elements among multiple sources.\",\"enum\":[\"all_non_null\",\"first_non_null\",\"the_only_non_null\"],\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specify valid types of data that may be assigned to this parameter.\"}},\"required\":[\"type\"],\"type\":\"object\"},\"WorkflowStep\":{\"additionalProperties\":false,\"description\":\"A workflow step is an executable element of a workflow. It specifies the\\nunderlying process implementation (such as `CommandLineTool` or another\\n`Workflow`) in the `run` field and connects the input and output parameters\\nof the underlying process to workflow parameters.\\n\\n# Scatter/gather\\n\\nTo use scatter/gather,\\n[ScatterFeatureRequirement](#ScatterFeatureRequirement) must be specified\\nin the workflow or workflow step requirements.\\n\\nA \\\"scatter\\\" operation specifies that the associated workflow step or\\nsubworkflow should execute separately over a list of input elements. Each\\njob making up a scatter operation is independent and may be executed\\nconcurrently.\\n\\nThe `scatter` field specifies one or more input parameters which will be\\nscattered. An input parameter may be listed more than once. The declared\\ntype of each input parameter implicitly becomes an array of items of the\\ninput parameter type. If a parameter is listed more than once, it becomes\\na nested array. As a result, upstream parameters which are connected to\\nscattered parameters must be arrays.\\n\\nAll output parameter types are also implicitly wrapped in arrays. Each job\\nin the scatter results in an entry in the output array.\\n\\nIf any scattered parameter runtime value is an empty array, all outputs are\\nset to empty arrays and no work is done for the step, according to\\napplicable scattering rules.\\n\\nIf `scatter` declares more than one input parameter, `scatterMethod`\\ndescribes how to decompose the input into a discrete set of jobs.\\n\\n * **dotproduct** specifies that each of the input arrays are aligned and one\\n element taken from each array to construct each job. It is an error\\n if all input arrays are not the same length.\\n\\n * **nested_crossproduct** specifies the Cartesian product of the inputs,\\n producing a job for every combination of the scattered inputs. The\\n output must be nested arrays for each level of scattering, in the\\n order that the input arrays are listed in the `scatter` field.\\n\\n * **flat_crossproduct** specifies the Cartesian product of the inputs,\\n producing a job for every combination of the scattered inputs. The\\n output arrays must be flattened to a single level, but otherwise listed in the\\n order that the input arrays are listed in the `scatter` field.\\n\\n# Conditional execution (Optional)\\n\\nConditional execution makes execution of a step conditional on an\\nexpression. A step that is not executed is \\\"skipped\\\". A skipped\\nstep produces `null` for all output parameters.\\n\\nThe condition is evaluated after `scatter`, using the input object\\nof each individual scatter job. This means over a set of scatter\\njobs, some may be executed and some may be skipped. When the\\nresults are gathered, skipped steps must be `null` in the output\\narrays.\\n\\nThe `when` field controls conditional execution. This is an\\nexpression that must be evaluated with `inputs` bound to the step\\ninput object (or individual scatter job), and returns a boolean\\nvalue. It is an error if this expression returns a value other\\nthan `true` or `false`.\\n\\nConditionals in CWL are an optional feature and are not required\\nto be implemented by all consumers of CWL documents. An\\nimplementation that does not support conditionals must return a\\nfatal error when attempting to execute a workflow that uses\\nconditional constructs the implementation does not support.\\n\\n# Subworkflows\\n\\nTo specify a nested workflow as part of a workflow step,\\n[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) must be\\nspecified in the workflow or workflow step requirements.\\n\\nIt is a fatal error if a workflow directly or indirectly invokes itself as\\na subworkflow (recursive workflows are not allowed).\",\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"hints\":{\"description\":\"Declares hints applying to either the runtime environment or the\\nworkflow engine that may be helpful in executing this workflow step. It is\\nnot an error if an implementation cannot satisfy all hints, however\\nthe implementation may report a warning.\",\"items\":{},\"type\":\"array\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"in\":{\"description\":\"Defines the input parameters of the workflow step. The process is ready to\\nrun when all required input parameters are associated with concrete\\nvalues. Input parameters include a schema for each parameter which is\\nused to validate the input object. It may also be used build a user\\ninterface for constructing the input object.\",\"oneOf\":[{\"items\":{\"$ref\":\"#/definitions/WorkflowStepInput\"},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"oneOf\":[{\"$ref\":\"#/definitions/WorkflowStepInput\"},{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/WorkflowStepInput\"}]}}]}},\"type\":\"object\"}]},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"out\":{\"description\":\"Defines the parameters representing the output of the process. May be\\nused to generate and/or validate the output object.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkflowStepOutput\"},{\"type\":\"string\"}]},\"type\":\"array\"},\"requirements\":{\"description\":\"Declares requirements that apply to either the runtime environment or the\\nworkflow engine that must be met in order to execute this workflow step. If\\nan implementation cannot satisfy all requirements, or a requirement is\\nlisted which is not recognized by the implementation, it is a fatal\\nerror and the implementation must not attempt to run the process,\\nunless overridden at user option.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"},{\"$ref\":\"#/definitions/InlineJavascriptRequirement\"},{\"$ref\":\"#/definitions/SchemaDefRequirement\"},{\"$ref\":\"#/definitions/LoadListingRequirement\"},{\"$ref\":\"#/definitions/DockerRequirement\"},{\"$ref\":\"#/definitions/SoftwareRequirement\"},{\"$ref\":\"#/definitions/InitialWorkDirRequirement\"},{\"$ref\":\"#/definitions/EnvVarRequirement\"},{\"$ref\":\"#/definitions/ShellCommandRequirement\"},{\"$ref\":\"#/definitions/ResourceRequirement\"},{\"$ref\":\"#/definitions/WorkReuse\"},{\"$ref\":\"#/definitions/NetworkAccess\"},{\"$ref\":\"#/definitions/InplaceUpdateRequirement\"},{\"$ref\":\"#/definitions/ToolTimeLimit\"},{\"$ref\":\"#/definitions/SubworkflowFeatureRequirement\"},{\"$ref\":\"#/definitions/ScatterFeatureRequirement\"},{\"$ref\":\"#/definitions/MultipleInputFeatureRequirement\"},{\"$ref\":\"#/definitions/StepInputExpressionRequirement\"}]},\"type\":\"array\"},{\"type\":\"object\",\"properties\":{\"InlineJavascriptRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InlineJavascriptRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SchemaDefRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SchemaDefRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"LoadListingRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/LoadListingRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"DockerRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/DockerRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SoftwareRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwareRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InitialWorkDirRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InitialWorkDirRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"EnvVarRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvVarRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ShellCommandRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ShellCommandRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ResourceRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ResourceRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"WorkReuse\":{\"anyOf\":[{\"$ref\":\"#/definitions/WorkReuseMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"NetworkAccess\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkAccessMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"InplaceUpdateRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/InplaceUpdateRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ToolTimeLimit\":{\"anyOf\":[{\"$ref\":\"#/definitions/ToolTimeLimitMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"SubworkflowFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/SubworkflowFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"ScatterFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/ScatterFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"MultipleInputFeatureRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/MultipleInputFeatureRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]},\"StepInputExpressionRequirement\":{\"anyOf\":[{\"$ref\":\"#/definitions/StepInputExpressionRequirementMap\"},{\"type\":\"object\",\"properties\":{},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"run\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandLineTool\"},{\"$ref\":\"#/definitions/ExpressionTool\"},{\"$ref\":\"#/definitions/Workflow\"},{\"$ref\":\"#/definitions/Operation\"},{\"type\":\"string\"}],\"description\":\"Specifies the process to run. If `run` is a string, it must be an absolute IRI\\nor a relative path from the primary document.\"},\"scatter\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}]},\"scatterMethod\":{\"description\":\"Required if `scatter` is an array of more than one element.\",\"enum\":[\"dotproduct\",\"flat_crossproduct\",\"nested_crossproduct\"],\"type\":\"string\"},\"when\":{\"description\":\"If defined, only run the step when the expression evaluates to\\n`true`. If `false` the step is skipped. A skipped step\\nproduces a `null` on each output.\",\"type\":\"string\"}},\"required\":[\"in\",\"out\",\"run\"],\"type\":\"object\"},\"WorkflowStepInput\":{\"additionalProperties\":false,\"description\":\"The input of a workflow step connects an upstream parameter (from the\\nworkflow inputs, or the outputs of other workflows steps) with the input\\nparameters of the process specified by the `run` field. Only input parameters\\ndeclared by the target process will be passed through at runtime to the process\\nthough additional parameters may be specified (for use within `valueFrom`\\nexpressions for instance) - unconnected or unused parameters do not represent an\\nerror condition.\\n\\n# Input object\\n\\nA WorkflowStepInput object must contain an `id` field in the form\\n`#fieldname` or `#prefix/fieldname`. When the `id` field contains a slash\\n`/` the field name consists of the characters following the final slash\\n(the prefix portion may contain one or more slashes to indicate scope).\\nThis defines a field of the workflow step input object with the value of\\nthe `source` parameter(s).\\n\\n# Merging multiple inbound data links\\n\\nTo merge multiple inbound data links,\\n[MultipleInputFeatureRequirement](#MultipleInputFeatureRequirement) must be specified\\nin the workflow or workflow step requirements.\\n\\nIf the sink parameter is an array, or named in a [workflow\\nscatter](#WorkflowStep) operation, there may be multiple inbound\\ndata links listed in the `source` field. The values from the\\ninput links are merged depending on the method specified in the\\n`linkMerge` field. If both `linkMerge` and `pickValue` are null\\nor not specified, and there is more than one element in the\\n`source` array, the default method is \\\"merge_nested\\\".\\n\\nIf both `linkMerge` and `pickValue` are null or not specified, and\\nthere is only a single element in the `source`, then the input\\nparameter takes the scalar value from the single input link (it is\\n*not* wrapped in a single-list).\\n\\n* **merge_nested**\\n\\n The input must be an array consisting of exactly one entry for each\\n input link. If \\\"merge_nested\\\" is specified with a single link, the value\\n from the link must be wrapped in a single-item list.\\n\\n* **merge_flattened**\\n\\n 1. The source and sink parameters must be compatible types, or the source\\n type must be compatible with single element from the \\\"items\\\" type of\\n the destination array parameter.\\n 2. Source parameters which are arrays are concatenated.\\n Source parameters which are single element types are appended as\\n single elements.\\n\\n# Picking non-null values among inbound data links\\n\\nIf present, `pickValue` specifies how to pick non-null values among inbound data links.\\n\\n`pickValue` is evaluated\\n 1. Once all source values from upstream step or parameters are available.\\n 2. After `linkMerge`.\\n 3. Before `scatter` or `valueFrom`.\\n\\nThis is specifically intended to be useful in combination with\\n[conditional execution](#WorkflowStep), where several upstream\\nsteps may be connected to a single input (`source` is a list), and\\nskipped steps produce null values.\\n\\nStatic type checkers should check for type consistency after inferring what the type\\nwill be after `pickValue` is applied, just as they do currently for `linkMerge`.\\n\\n* **first_non_null**\\n\\n For the first level of a list input, pick the first non-null element. The result is a scalar.\\n It is an error if there is no non-null element. Examples:\\n * `[null, x, null, y] -> x`\\n * `[null, [null], null, y] -> [null]`\\n * `[null, null, null] -> Runtime Error`\\n\\n *Intended use case*: If-else pattern where the\\n value comes either from a conditional step or from a default or\\n fallback value. The conditional step(s) should be placed first in\\n the list.\\n\\n* **the_only_non_null**\\n\\n For the first level of a list input, pick the single non-null element. The result is a scalar.\\n It is an error if there is more than one non-null element. Examples:\\n\\n * `[null, x, null] -> x`\\n * `[null, x, null, y] -> Runtime Error`\\n * `[null, [null], null] -> [null]`\\n * `[null, null, null] -> Runtime Error`\\n\\n *Intended use case*: Switch type patterns where developer considers\\n more than one active code path as a workflow error\\n (possibly indicating an error in writing `when` condition expressions).\\n\\n* **all_non_null**\\n\\n For the first level of a list input, pick all non-null values.\\n The result is a list, which may be empty. Examples:\\n\\n * `[null, x, null] -> [x]`\\n * `[x, null, y] -> [x, y]`\\n * `[null, [x], [null]] -> [[x], [null]]`\\n * `[null, null, null] -> []`\\n\\n *Intended use case*: It is valid to have more than one source, but\\n sources are conditional, so null sources (from skipped steps)\\n should be filtered out.\",\"properties\":{\"default\":{\"description\":\"The default value for this parameter to use if either there is no\\n`source` field, or the value produced by the `source` is `null`. The\\ndefault must be applied prior to scattering or evaluating `valueFrom`.\"},\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"linkMerge\":{\"description\":\"The method to use to merge multiple inbound links into a single array.\\nIf not specified, the default method is \\\"merge_nested\\\".\",\"enum\":[\"merge_flattened\",\"merge_nested\"],\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"pickValue\":{\"description\":\"The method to use to choose non-null elements among multiple sources.\",\"enum\":[\"all_non_null\",\"first_non_null\",\"the_only_non_null\"],\"type\":\"string\"},\"source\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Specifies one or more workflow parameters that will provide input to\\nthe underlying step parameter.\"},\"valueFrom\":{\"description\":\"To use valueFrom, [StepInputExpressionRequirement](#StepInputExpressionRequirement) must\\nbe specified in the workflow or workflow step requirements.\\n\\nIf `valueFrom` is a constant string value, use this as the value for\\nthis input parameter.\\n\\nIf `valueFrom` is a parameter reference or expression, it must be\\nevaluated to yield the actual value to be assigned to the input field.\\n\\nThe `self` value in the parameter reference or expression must be\\n1. `null` if there is no `source` field\\n2. the value of the parameter(s) specified in the `source` field when this\\nworkflow input parameter **is not** specified in this workflow step's `scatter` field.\\n3. an element of the parameter specified in the `source` field when this workflow input\\nparameter **is** specified in this workflow step's `scatter` field.\\n\\nThe value of `inputs` in the parameter reference or expression must be\\nthe input object to the workflow step after assigning the `source`\\nvalues, applying `default`, and then scattering. The order of\\nevaluating `valueFrom` among step input parameters is undefined and the\\nresult of evaluating `valueFrom` on a parameter must not be visible to\\nevaluation of `valueFrom` on other parameters.\",\"type\":\"string\"}},\"required\":[],\"type\":\"object\"},\"WorkflowStepOutput\":{\"additionalProperties\":false,\"description\":\"Associate an output parameter of the underlying process with a workflow\\nparameter. The workflow parameter (given in the `id` field) be may be used\\nas a `source` to connect with input parameters of other workflow steps, or\\nwith an output parameter of the process.\\n\\nA unique identifier for this workflow output parameter. This is\\nthe identifier to use in the `source` field of `WorkflowStepInput`\\nto connect the output value to downstream parameters.\",\"properties\":{\"id\":{\"description\":\"The unique identifier for this object.\",\"type\":\"string\"}},\"required\":[],\"type\":\"object\"},\"CWLImportManual\":{\"description\":\"Represents an '$import' directive that should point toward another compatible CWL file to import where specified. The contents of the imported file should be relevant contextually where it is being imported\",\"$comment\":\"The schema validation of the CWL will not itself perform the '$import' to resolve and validate its contents. Therefore, the complete schema will not be validated entirely, and could still be partially malformed. To ensure proper and exhaustive validation of a CWL definition with this schema, all '$import' directives should be resolved and extended beforehand\",\"type\":\"object\",\"properties\":{\"$import\":{\"type\":\"string\"}},\"required\":[\"$import\"],\"additionalProperties\":false},\"CWLIncludeManual\":{\"description\":\"Represents an '$include' directive that should point toward another compatible CWL file to import where specified. The contents of the imported file should be relevant contextually where it is being imported\",\"$comment\":\"The schema validation of the CWL will not itself perform the '$include' to resolve and validate its contents. Therefore, the complete schema will not be validated entirely, and could still be partially malformed. To ensure proper and exhaustive validation of a CWL definition with this schema, all '$include' directives should be resolved and extended beforehand\",\"type\":\"object\",\"properties\":{\"$include\":{\"type\":\"string\"}},\"required\":[\"$include\"],\"additionalProperties\":false},\"CWLDocumentMetadata\":{\"description\":\"Metadata for a CWL document\",\"type\":\"object\",\"properties\":{\"$namespaces\":{\"description\":\"The namespaces used in the document\",\"type\":\"object\",\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"type\":\"string\"}}},\"$schemas\":{\"description\":\"The schemas used in the document\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"patternProperties\":{\"^\\\\w+:.*$\":{\"type\":\"object\"},\"^\\\\w+:\\\\/\\\\/.*\":{\"type\":\"object\"}},\"required\":[]},\"CommandInputRecordFieldMap\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"inputBinding\":{\"$ref\":\"#/definitions/CommandLineBinding\",\"description\":\"Describes how to turn this object into command line arguments.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"type\":\"object\",\"required\":[\"type\"]},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},{\"type\":\"string\"}]},\"InputRecordFieldMap\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis must be one or more IRIs of concept nodes\\nthat represents file formats which are allowed as input to this\\nparameter, preferably defined within an ontology. If no ontology is\\navailable, file formats may be tested by exact match.\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"loadContents\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nIf true, the file (or each file in the array) must be a UTF-8\\ntext file 64 KiB or smaller, and the implementation must read\\nthe entire contents of the file (or file array) and place it\\nin the `contents` field of the File object for use by\\nexpressions. If the size of the file is greater than 64 KiB,\\nthe implementation must raise a fatal error.\",\"type\":\"boolean\"},\"loadListing\":{\"description\":\"Only valid when `type: Directory` or is an array of `items: Directory`.\\n\\nSpecify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\\n\\nThe order of precedence for loadListing is:\\n\\n 1. `loadListing` on an individual parameter\\n 2. Inherited from `LoadListingRequirement`\\n 3. By default: `no_listing`\",\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"type\":\"object\",\"required\":[\"type\"]},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/InputRecordSchema\"},{\"$ref\":\"#/definitions/InputEnumSchema\"},{\"$ref\":\"#/definitions/InputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},{\"type\":\"string\"}]},\"CommandOutputRecordFieldMap\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"outputBinding\":{\"$ref\":\"#/definitions/CommandOutputBinding\",\"description\":\"Describes how to generate this output object based on the files\\nproduced by a CommandLineTool\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"type\":\"object\",\"required\":[\"type\"]},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandOutputArraySchema\"},{\"$ref\":\"#/definitions/CommandOutputRecordSchema\"},{\"$ref\":\"#/definitions/CommandOutputEnumSchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},{\"type\":\"string\"}]},\"OutputRecordFieldMap\":{\"description\":\"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordField\",\"oneOf\":[{\"additionalProperties\":false,\"properties\":{\"doc\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"A documentation string for this object, or an array of strings which should be concatenated.\"},\"format\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nThis is the file format that will be assigned to the output\\nFile object.\",\"type\":\"string\"},\"label\":{\"description\":\"A short, human-readable label of this object.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the field\",\"type\":\"string\"},\"secondaryFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/SecondaryFileSchema\"},{\"items\":{\"$ref\":\"#/definitions/SecondaryFileSchema\"},\"type\":\"array\"}],\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nProvides a pattern or expression specifying files or\\ndirectories that should be included alongside the primary\\nfile. Secondary files may be required or optional. When not\\nexplicitly specified, secondary files specified for `inputs`\\nare required and `outputs` are optional. An implementation\\nmust include matching Files and Directories in the\\n`secondaryFiles` property of the primary file. These Files\\nand Directories must be transferred and staged alongside the\\nprimary file. An implementation may fail workflow execution\\nif a required secondary file does not exist.\\n\\nIf the value is an expression, the value of `self` in the expression\\nmust be the primary input or output File object to which this binding\\napplies. The `basename`, `nameroot` and `nameext` fields must be\\npresent in `self`. For `CommandLineTool` outputs the `path` field must\\nalso be present. The expression must return a filename string relative\\nto the path to the primary File, a File or Directory object with either\\n`path` or `location` and `basename` fields set, or an array consisting\\nof strings or File or Directory objects. It is legal to reference an\\nunchanged File or Directory object taken from input as a secondaryFile.\\nThe expression may return \\\"null\\\" in which case there is no secondaryFile\\nfrom that expression.\\n\\nTo work on non-filename-preserving storage systems, portable tool\\ndescriptions should avoid constructing new values from `location`, but\\nshould construct relative references using `basename` or `nameroot`\\ninstead.\\n\\nIf a value in `secondaryFiles` is a string that is not an expression,\\nit specifies that the following pattern should be applied to the path\\nof the primary file to yield a filename relative to the primary File:\\n\\n 1. If string ends with `?` character, remove the last `?` and mark\\n the resulting secondary file as optional.\\n 2. If string begins with one or more caret `^` characters, for each\\n caret, remove the last file extension from the path (the last\\n period `.` and all following characters). If there are no file\\n extensions, the path is unchanged.\\n 3. Append the remainder of the string to the end of the file path.\"},\"streamable\":{\"description\":\"Only valid when `type: File` or is an array of `items: File`.\\n\\nA value of `true` indicates that the file is read or written\\nsequentially without seeking. An implementation may use this flag to\\nindicate whether it is valid to stream file contents using a named\\npipe. Default: `false`.\",\"type\":\"boolean\"},\"type\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},\"type\":\"object\",\"required\":[\"type\"]},{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/OutputRecordSchema\"},{\"$ref\":\"#/definitions/OutputEnumSchema\"},{\"$ref\":\"#/definitions/OutputArraySchema\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The field type\"}},{\"type\":\"string\"}]},\"InlineJavascriptRequirementMap\":{\"type\":\"object\",\"properties\":{\"expressionLib\":{\"description\":\"Additional code fragments that will also be inserted\\nbefore executing the expression code. Allows for function definitions that may\\nbe called from CWL expressions.\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[],\"description\":\"Indicates that the workflow platform must support inline Javascript expressions.\\nIf this requirement is not present, the workflow platform must not perform expression\\ninterpolation.\"},\"SchemaDefRequirementMap\":{\"type\":\"object\",\"properties\":{\"types\":{\"description\":\"The list of type definitions.\",\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/CommandInputArraySchema\"},{\"$ref\":\"#/definitions/CommandInputRecordSchema\"},{\"$ref\":\"#/definitions/CommandInputEnumSchema\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[\"types\"],\"description\":\"This field consists of an array of type definitions which must be used when\\ninterpreting the `inputs` and `outputs` fields. When a `type` field\\ncontains a IRI, the implementation must check if the type is defined in\\n`schemaDefs` and use that definition. If the type is not found in\\n`schemaDefs`, it is an error. The entries in `schemaDefs` must be\\nprocessed in the order listed such that later schema definitions may refer\\nto earlier schema definitions.\\n\\n- **Type definitions are allowed for `enum` and `record` types only.**\\n- Type definitions may be shared by defining them in a file and then\\n `$include`-ing them in the `types` field.\\n- A file can contain a list of type definitions\"},\"LoadListingRequirementMap\":{\"type\":\"object\",\"properties\":{\"loadListing\":{\"enum\":[\"deep_listing\",\"no_listing\",\"shallow_listing\"],\"type\":\"string\"}},\"required\":[],\"description\":\"Specify the desired behavior for loading the `listing` field of\\na Directory object for use by expressions.\"},\"DockerRequirementMap\":{\"type\":\"object\",\"properties\":{\"dockerFile\":{\"description\":\"Supply the contents of a Dockerfile which will be built using `docker build`.\",\"type\":\"string\"},\"dockerImageId\":{\"description\":\"The image id that will be used for `docker run`. May be a\\nhuman-readable image name or the image identifier hash. May be skipped\\nif `dockerPull` is specified, in which case the `dockerPull` image id\\nmust be used.\",\"type\":\"string\"},\"dockerImport\":{\"description\":\"Provide HTTP URL to download and gunzip a Docker images using `docker import.\",\"type\":\"string\"},\"dockerLoad\":{\"description\":\"Specify an HTTP URL from which to download a Docker image using `docker load`.\",\"type\":\"string\"},\"dockerOutputDirectory\":{\"description\":\"Set the designated output directory to a specific location inside the\\nDocker container.\",\"type\":\"string\"},\"dockerPull\":{\"description\":\"Specify a Docker image to retrieve using `docker pull`. Can contain the\\nimmutable digest to ensure an exact container is used:\\n`dockerPull: ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`\",\"type\":\"string\"}},\"required\":[],\"description\":\"Indicates that a workflow component should be run in a\\n[Docker](https://docker.com) or Docker-compatible (such as\\n[Singularity](https://www.sylabs.io/) and [udocker](https://github.com/indigo-dc/udocker)) container environment and\\nspecifies how to fetch or build the image.\\n\\nIf a CommandLineTool lists `DockerRequirement` under\\n`hints` (or `requirements`), it may (or must) be run in the specified Docker\\ncontainer.\\n\\nThe platform must first acquire or install the correct Docker image as\\nspecified by `dockerPull`, `dockerImport`, `dockerLoad` or `dockerFile`.\\n\\nThe platform must execute the tool in the container using `docker run` with\\nthe appropriate Docker image and tool command line.\\n\\nThe workflow platform may provide input files and the designated output\\ndirectory through the use of volume bind mounts. The platform should rewrite\\nfile paths in the input object to correspond to the Docker bind mounted\\nlocations. That is, the platform should rewrite values in the parameter context\\nsuch as `runtime.outdir`, `runtime.tmpdir` and others to be valid paths\\nwithin the container. The platform must ensure that `runtime.outdir` and\\n`runtime.tmpdir` are distinct directories.\\n\\nWhen running a tool contained in Docker, the workflow platform must not\\nassume anything about the contents of the Docker container, such as the\\npresence or absence of specific software, except to assume that the\\ngenerated command line represents a valid command within the runtime\\nenvironment of the container.\\n\\nA container image may specify an\\n[ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint)\\nand/or\\n[CMD](https://docs.docker.com/engine/reference/builder/#cmd).\\nCommand line arguments will be appended after all elements of\\nENTRYPOINT, and will override all elements specified using CMD (in\\nother words, CMD is only used when the CommandLineTool definition\\nproduces an empty command line).\\n\\nUse of implicit ENTRYPOINT or CMD are discouraged due to reproducibility\\nconcerns of the implicit hidden execution point (For further discussion, see\\n[https://doi.org/10.12688/f1000research.15140.1](https://doi.org/10.12688/f1000research.15140.1)). Portable\\nCommandLineTool wrappers in which use of a container is optional must not rely on ENTRYPOINT or CMD.\\nCommandLineTools which do rely on ENTRYPOINT or CMD must list `DockerRequirement` in the\\n`requirements` section.\\n\\n## Interaction with other requirements\\n\\nIf [EnvVarRequirement](#EnvVarRequirement) is specified alongside a\\nDockerRequirement, the environment variables must be provided to Docker\\nusing `--env` or `--env-file` and interact with the container's preexisting\\nenvironment as defined by Docker.\"},\"SoftwareRequirementMap\":{\"type\":\"object\",\"properties\":{\"packages\":{\"description\":\"The list of software to be configured.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/SoftwarePackage\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"}},\"required\":[\"packages\"],\"description\":\"A list of software packages that should be configured in the environment of\\nthe defined process.\"},\"InitialWorkDirRequirementMap\":{\"type\":\"object\",\"properties\":{\"listing\":{\"anyOf\":[{\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"},{\"items\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Directory\"},{\"$ref\":\"#/definitions/File\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"$ref\":\"#/definitions/Dirent\"},{\"type\":\"string\"}]},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The list of files or subdirectories that must be staged prior\\nto executing the command line tool.\\n\\nReturn type of each expression must validate as `[\\\"null\\\",\\nFile, Directory, Dirent, {type: array, items: [File,\\nDirectory]}]`.\\n\\nEach `File` or `Directory` that is returned by an Expression\\nmust be added to the designated output directory prior to\\nexecuting the tool.\\n\\nEach `Dirent` record that is listed or returned by an\\nexpression specifies a file to be created or staged in the\\ndesignated output directory prior to executing the tool.\\n\\nExpressions may return null, in which case they have no effect.\\n\\nFiles or Directories which are listed in the input parameters\\nand appear in the `InitialWorkDirRequirement` listing must\\nhave their `path` set to their staged location. If the same\\nFile or Directory appears more than once in the\\n`InitialWorkDirRequirement` listing, the implementation must\\nchoose exactly one value for `path`; how this value is chosen\\nis undefined.\"}},\"required\":[],\"description\":\"Define a list of files and subdirectories that must be staged by the workflow platform prior to executing the command line tool.\\nNormally files are staged within the designated output directory. However, when running inside containers, files may be staged at arbitrary locations, see discussion for [`Dirent.entryname`](#Dirent). Together with `DockerRequirement.dockerOutputDirectory` it is possible to control the locations of both input and output files when running in containers.\"},\"EnvVarRequirementMap\":{\"type\":\"object\",\"properties\":{\"envDef\":{\"description\":\"The list of environment variables.\",\"oneOf\":[{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/EnvironmentDef\"},{\"$ref\":\"#/definitions/CWLImportManual\"},{\"$ref\":\"#/definitions/CWLIncludeManual\"}]},\"type\":\"array\"},{\"patternProperties\":{\"^[_a-zA-Z][a-zA-Z0-9_-]*$\":{\"type\":\"string\"}}}]}},\"required\":[\"envDef\"],\"description\":\"Define a list of environment variables which will be set in the\\nexecution environment of the tool. See `EnvironmentDef` for details.\"},\"ShellCommandRequirementMap\":{\"type\":\"object\",\"properties\":{},\"required\":[],\"description\":\"Modify the behavior of CommandLineTool to generate a single string\\ncontaining a shell command line. Each item in the `arguments` list must\\nbe joined into a string separated by single spaces and quoted to prevent\\ninterpretation by the shell, unless `CommandLineBinding` for that argument\\ncontains `shellQuote: false`. If `shellQuote: false` is specified, the\\nargument is joined into the command string without quoting, which allows\\nthe use of shell metacharacters such as `|` for pipes.\"},\"ResourceRequirementMap\":{\"type\":\"object\",\"properties\":{\"coresMax\":{\"description\":\"Maximum reserved number of CPU cores.\\n\\nSee `coresMin` for discussion about fractional CPU requests.\",\"type\":[\"string\",\"number\"]},\"coresMin\":{\"description\":\"Minimum reserved number of CPU cores (default is 1).\\n\\nMay be a fractional value to indicate to a scheduling\\nalgorithm that one core can be allocated to multiple\\njobs. For example, a value of 0.25 indicates that up to 4\\njobs may run in parallel on 1 core. A value of 1.25 means\\nthat up to 3 jobs can run on a 4 core system (4/1.25 \\u2248 3).\\n\\nProcesses can only share a core allocation if the sum of each\\nof their `ramMax`, `tmpdirMax`, and `outdirMax` requests also\\ndo not exceed the capacity of the node.\\n\\nProcesses sharing a core must have the same level of isolation\\n(typically a container or VM) that they would normally have.\\n\\nThe reported number of CPU cores reserved for the process,\\nwhich is available to expressions on the CommandLineTool as\\n`runtime.cores`, must be a non-zero integer, and may be\\ncalculated by rounding up the cores request to the next whole\\nnumber.\\n\\nScheduling systems may allocate fractional CPU resources by\\nsetting quotas or scheduling weights. Scheduling systems that\\ndo not support fractional CPUs may round up the request to the\\nnext whole number.\",\"type\":[\"string\",\"number\"]},\"outdirMax\":{\"description\":\"Maximum reserved filesystem based storage for the designated output directory, in mebibytes (2**20)\\n\\nSee `outdirMin` for discussion about fractional storage requests.\",\"type\":[\"string\",\"number\"]},\"outdirMin\":{\"description\":\"Minimum reserved filesystem based storage for the designated output directory, in mebibytes (2**20) (default is 1024)\\n\\nMay be a fractional value. If so, the actual storage request\\nmust be rounded up to the next whole number. The reported\\namount of storage reserved for the process, which is available\\nto expressions on the CommandLineTool as `runtime.outdirSize`,\\nmust be a non-zero integer.\",\"type\":[\"string\",\"number\"]},\"ramMax\":{\"description\":\"Maximum reserved RAM in mebibytes (2**20)\\n\\nSee `ramMin` for discussion about fractional RAM requests.\",\"type\":[\"string\",\"number\"]},\"ramMin\":{\"description\":\"Minimum reserved RAM in mebibytes (2**20) (default is 256)\\n\\nMay be a fractional value. If so, the actual RAM request must\\nbe rounded up to the next whole number. The reported amount of\\nRAM reserved for the process, which is available to\\nexpressions on the CommandLineTool as `runtime.ram`, must be a\\nnon-zero integer.\",\"type\":[\"string\",\"number\"]},\"tmpdirMax\":{\"description\":\"Maximum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20)\\n\\nSee `tmpdirMin` for discussion about fractional storage requests.\",\"type\":[\"string\",\"number\"]},\"tmpdirMin\":{\"description\":\"Minimum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20) (default is 1024)\\n\\nMay be a fractional value. If so, the actual storage request\\nmust be rounded up to the next whole number. The reported\\namount of storage reserved for the process, which is available\\nto expressions on the CommandLineTool as `runtime.tmpdirSize`,\\nmust be a non-zero integer.\",\"type\":[\"string\",\"number\"]}},\"required\":[],\"description\":\"Specify basic hardware resource requirements.\\n\\n\\\"min\\\" is the minimum amount of a resource that must be reserved to\\nschedule a job. If \\\"min\\\" cannot be satisfied, the job should not\\nbe run.\\n\\n\\\"max\\\" is the maximum amount of a resource that the job shall be\\nallocated. If a node has sufficient resources, multiple jobs may\\nbe scheduled on a single node provided each job's \\\"max\\\" resource\\nrequirements are met. If a job attempts to exceed its resource\\nallocation, an implementation may deny additional resources, which\\nmay result in job failure.\\n\\nIf both \\\"min\\\" and \\\"max\\\" are specified, an implementation may\\nchoose to allocate any amount between \\\"min\\\" and \\\"max\\\", with the\\nactual allocation provided in the `runtime` object.\\n\\nIf \\\"min\\\" is specified but \\\"max\\\" is not, then \\\"max\\\" == \\\"min\\\"\\nIf \\\"max\\\" is specified by \\\"min\\\" is not, then \\\"min\\\" == \\\"max\\\".\\n\\nIt is an error if max < min.\\n\\nIt is an error if the value of any of these fields is negative.\\n\\nIf neither \\\"min\\\" nor \\\"max\\\" is specified for a resource, use the default values below.\"},\"WorkReuseMap\":{\"type\":\"object\",\"properties\":{\"enableReuse\":{\"type\":[\"string\",\"boolean\"]}},\"required\":[\"enableReuse\"],\"description\":\"For implementations that support reusing output from past work (on\\nthe assumption that same code and same input produce same\\nresults), control whether to enable or disable the reuse behavior\\nfor a particular tool or step (to accommodate situations where that\\nassumption is incorrect). A reused step is not executed but\\ninstead returns the same output as the original execution.\\n\\nIf `WorkReuse` is not specified, correct tools should assume it\\nis enabled by default.\"},\"NetworkAccessMap\":{\"type\":\"object\",\"properties\":{\"networkAccess\":{\"type\":[\"string\",\"boolean\"]}},\"required\":[\"networkAccess\"],\"description\":\"Indicate whether a process requires outgoing IPv4/IPv6 network\\naccess. Choice of IPv4 or IPv6 is implementation and site\\nspecific, correct tools must support both.\\n\\nIf `networkAccess` is false or not specified, tools must not\\nassume network access, except for localhost (the loopback device).\\n\\nIf `networkAccess` is true, the tool must be able to make outgoing\\nconnections to network resources. Resources may be on a private\\nsubnet or the public Internet. However, implementations and sites\\nmay apply their own security policies to restrict what is\\naccessible by the tool.\\n\\nEnabling network access does not imply a publicly routable IP\\naddress or the ability to accept inbound connections.\"},\"InplaceUpdateRequirementMap\":{\"type\":\"object\",\"properties\":{\"inplaceUpdate\":{\"type\":\"boolean\"}},\"required\":[\"inplaceUpdate\"],\"description\":\"\\nIf `inplaceUpdate` is true, then an implementation supporting this\\nfeature may permit tools to directly update files with `writable:\\ntrue` in InitialWorkDirRequirement. That is, as an optimization,\\nfiles may be destructively modified in place as opposed to copied\\nand updated.\\n\\nAn implementation must ensure that only one workflow step may\\naccess a writable file at a time. It is an error if a file which\\nis writable by one workflow step file is accessed (for reading or\\nwriting) by any other workflow step running independently.\\nHowever, a file which has been updated in a previous completed\\nstep may be used as input to multiple steps, provided it is\\nread-only in every step.\\n\\nWorkflow steps which modify a file must produce the modified file\\nas output. Downstream steps which further process the file must\\nuse the output of previous steps, and not refer to a common input\\n(this is necessary for both ordering and correctness).\\n\\nWorkflow authors should provide this in the `hints` section. The\\nintent of this feature is that workflows produce the same results\\nwhether or not InplaceUpdateRequirement is supported by the\\nimplementation, and this feature is primarily available as an\\noptimization for particular environments.\\n\\nUsers and implementers should be aware that workflows that\\ndestructively modify inputs may not be repeatable or reproducible.\\nIn particular, enabling this feature implies that WorkReuse should\\nnot be enabled.\"},\"ToolTimeLimitMap\":{\"type\":\"object\",\"properties\":{\"timelimit\":{\"description\":\"The time limit, in seconds. A time limit of zero means no\\ntime limit. Negative time limits are an error.\",\"type\":[\"string\",\"number\"]}},\"required\":[\"timelimit\"],\"description\":\"Set an upper limit on the execution time of a CommandLineTool.\\nA CommandLineTool whose execution duration exceeds the time\\nlimit may be preemptively terminated and considered failed.\\nMay also be used by batch systems to make scheduling decisions.\\nThe execution duration excludes external operations, such as\\nstaging of files, pulling a docker image etc, and only counts\\nwall-time for the execution of the command line itself.\"},\"SubworkflowFeatureRequirementMap\":{\"type\":\"object\",\"properties\":{},\"required\":[],\"description\":\"Indicates that the workflow platform must support nested workflows in\\nthe `run` field of [WorkflowStep](#WorkflowStep).\"},\"ScatterFeatureRequirementMap\":{\"type\":\"object\",\"properties\":{},\"required\":[],\"description\":\"Indicates that the workflow platform must support the `scatter` and\\n`scatterMethod` fields of [WorkflowStep](#WorkflowStep).\"},\"MultipleInputFeatureRequirementMap\":{\"type\":\"object\",\"properties\":{},\"required\":[],\"description\":\"Indicates that the workflow platform must support multiple inbound data links\\nlisted in the `source` field of [WorkflowStepInput](#WorkflowStepInput).\"},\"StepInputExpressionRequirementMap\":{\"type\":\"object\",\"properties\":{},\"required\":[],\"description\":\"Indicate that the workflow platform must support the `valueFrom` field\\nof [WorkflowStepInput](#WorkflowStepInput).\"},\"CWLFile\":{\"type\":\"object\",\"allOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/Workflow\"},{\"$ref\":\"#/definitions/CommandLineTool\"},{\"$ref\":\"#/definitions/ExpressionTool\"}]},{\"oneOf\":[{\"$ref\":\"#/definitions/CWLDocumentMetadata\"}]}],\"properties\":{\"inputs\":true,\"stdout\":true,\"hints\":true,\"temporaryFailCodes\":true,\"doc\":true,\"$schemas\":true,\"requirements\":true,\"cwlVersion\":true,\"successCodes\":true,\"baseCommand\":true,\"permanentFailCodes\":true,\"id\":true,\"expression\":true,\"steps\":true,\"stdin\":true,\"intent\":true,\"arguments\":true,\"stderr\":true,\"outputs\":true,\"$namespaces\":true,\"class\":true,\"label\":true},\"patternProperties\":{\"^\\\\w+:.*$\":{\"type\":\"object\"},\"^\\\\w+:\\\\/\\\\/.*\":{\"type\":\"object\"}},\"additionalProperties\":false},\"CWLGraph\":{\"type\":\"object\",\"properties\":{\"$graph\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/CWLFile\"}},\"cwlVersion\":{\"description\":\"CWL document version. Always required at the document root. Not\\nrequired for a Process embedded inside another Process.\",\"enum\":[\"draft-2\",\"draft-3\",\"draft-3.dev1\",\"draft-3.dev2\",\"draft-3.dev3\",\"draft-3.dev4\",\"draft-3.dev5\",\"draft-4.dev1\",\"draft-4.dev2\",\"draft-4.dev3\",\"v1.0\",\"v1.0.dev4\",\"v1.1\",\"v1.1.0-dev1\",\"v1.2\",\"v1.2.0-dev1\",\"v1.2.0-dev2\",\"v1.2.0-dev3\",\"v1.2.0-dev4\",\"v1.2.0-dev5\"],\"type\":\"string\"}},\"required\":[\"$graph\"]},\"CWLGraphOrFile\":{\"type\":\"object\",\"additionalProperties\":false,\"allOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/CWLGraph\"},{\"$ref\":\"#/definitions/CWLFile\"}]},{\"$ref\":\"#/definitions/CWLDocumentMetadata\"}],\"properties\":{\"inputs\":true,\"stdout\":true,\"hints\":true,\"temporaryFailCodes\":true,\"doc\":true,\"$schemas\":true,\"requirements\":true,\"cwlVersion\":true,\"successCodes\":true,\"baseCommand\":true,\"permanentFailCodes\":true,\"id\":true,\"expression\":true,\"steps\":true,\"stdin\":true,\"intent\":true,\"$graph\":true,\"arguments\":true,\"stderr\":true,\"outputs\":true,\"$namespaces\":true,\"class\":true,\"label\":true},\"patternProperties\":{\"^\\\\w+:.*$\":{\"type\":\"object\"},\"^\\\\w+:\\\\/\\\\/.*\":{\"type\":\"object\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"cwl_schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$ref":"#/definitions/CWLGraphOrFile","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"CommandInputArraySchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputArraySchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn this object into command line arguments."},"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Defines the type of the array elements."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"array","description":"Must be `array`","type":"string"}},"required":["items","type"],"type":"object"},"CommandInputEnumSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputEnumSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn this object into command line arguments."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"symbols":{"description":"Defines the set of valid symbols.","items":{"type":"string"},"type":"array"},"type":{"const":"enum","description":"Must be `enum`","type":"string"}},"required":["symbols","type"],"type":"object"},"CommandInputParameter":{"additionalProperties":false,"description":"An input parameter for a CommandLineTool.","properties":{"default":{"description":"The default value to use for this parameter if the parameter is missing\nfrom the input object, or if the value of the parameter in the input\nobject is `null`. Default values are applied before evaluating expressions\n(e.g. dependent `valueFrom` fields)."},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"id":{"description":"The unique identifier for this object.","type":"string"},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn the input parameters of a process into\ncommand line arguments."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"CommandInputRecordField":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn this object into command line arguments."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"required":["name","type"],"type":"object"},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}}]},"CommandInputRecordSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"fields":{"description":"Defines the fields of the record.","oneOf":[{"items":{"$ref":"#/definitions/CommandInputRecordField"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"$ref":"#/definitions/CommandInputRecordFieldMap"}},"type":"object"}]},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn this object into command line arguments."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"record","description":"Must be `record`","type":"string"}},"required":["type"],"type":"object"},"CommandLineBinding":{"additionalProperties":false,"description":"\nWhen listed under `inputBinding` in the input schema, the term\n\"value\" refers to the corresponding value in the input object. For\nbinding objects listed in `CommandLineTool.arguments`, the term \"value\"\nrefers to the effective value after evaluating `valueFrom`.\n\nThe binding behavior when building the command line depends on the data\ntype of the value. If there is a mismatch between the type described by\nthe input schema and the effective value, such as resulting from an\nexpression evaluation, an implementation must use the data type of the\neffective value.\n\n - **string**: Add `prefix` and the string to the command line.\n\n - **number**: Add `prefix` and decimal representation to command line.\n\n - **boolean**: If true, add `prefix` to the command line. If false, add\n nothing.\n\n - **File**: Add `prefix` and the value of\n [`File.path`](#File) to the command line.\n\n - **Directory**: Add `prefix` and the value of\n [`Directory.path`](#Directory) to the command line.\n\n - **array**: If `itemSeparator` is specified, add `prefix` and the join\n the array into a single string with `itemSeparator` separating the\n items. Otherwise, first add `prefix`, then recursively process\n individual elements.\n If the array is empty, it does not add anything to command line.\n\n - **object**: Add `prefix` only, and recursively add object fields for\n which `inputBinding` is specified.\n\n - **null**: Add nothing.","properties":{"itemSeparator":{"description":"Join the array elements into a single string with the elements\nseparated by `itemSeparator`.","type":"string"},"loadContents":{"description":"Use of `loadContents` in `InputBinding` is deprecated.\nPreserved for v1.0 backwards compatibility. Will be removed in\nCWL v2.0. Use `InputParameter.loadContents` instead.","type":"boolean"},"position":{"description":"The sorting key. Default position is 0. If a [CWL Parameter Reference](#Parameter_references)\nor [CWL Expression](#Expressions_(Optional)) is used and if the\ninputBinding is associated with an input parameter, then the value of\n`self` will be the value of the input parameter. Input parameter\ndefaults (as specified by the `InputParameter.default` field) must be\napplied before evaluating the expression. Expressions must return a\nsingle value of type int or a null.","type":["string","number"]},"prefix":{"description":"Command line prefix to add before the value.","type":"string"},"separate":{"description":"If true (default), then the prefix and value must be added as separate\ncommand line arguments; if false, prefix and value must be concatenated\ninto a single command line argument.","type":"boolean"},"shellQuote":{"description":"If `ShellCommandRequirement` is in the requirements for the current command,\nthis controls whether the value is quoted on the command line (default is true).\nUse `shellQuote: false` to inject metacharacters for operations such as pipes.\n\nIf `shellQuote` is true or not provided, the implementation must not\npermit interpretation of any shell metacharacters or directives.","type":"boolean"},"valueFrom":{"description":"If `valueFrom` is a constant string value, use this as the value and\napply the binding rules above.\n\nIf `valueFrom` is an expression, evaluate the expression to yield the\nactual value to use to build the command line and apply the binding\nrules above. If the inputBinding is associated with an input\nparameter, the value of `self` in the expression will be the value of\nthe input parameter. Input parameter defaults (as specified by the\n`InputParameter.default` field) must be applied before evaluating the\nexpression.\n\nIf the value of the associated input parameter is `null`, `valueFrom` is\nnot evaluated and nothing is added to the command line.\n\nWhen a binding is part of the `CommandLineTool.arguments` field,\nthe `valueFrom` field is required.","type":"string"}},"required":[],"type":"object"},"CommandLineTool":{"description":"This defines the schema of the CWL Command Line Tool Description document.","properties":{"arguments":{"description":"Command line bindings which are not directly associated with input\nparameters. If the value is a string, it is used as a string literal\nargument. If it is an Expression, the result of the evaluation is used\nas an argument.","items":{"anyOf":[{"$ref":"#/definitions/CommandLineBinding"},{"type":"string"}]},"type":"array"},"baseCommand":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Specifies the program to execute. If an array, the first element of\nthe array is the command to execute, and subsequent elements are\nmandatory command line arguments. The elements in `baseCommand` must\nappear before any command line bindings from `inputBinding` or\n`arguments`.\n\nIf `baseCommand` is not provided or is an empty array, the first\nelement of the command line produced after processing `inputBinding` or\n`arguments` must be used as the program to execute.\n\nIf the program includes a path separator character it must\nbe an absolute path, otherwise it is an error. If the program does not\ninclude a path separator, search the `$PATH` variable in the runtime\nenvironment of the workflow runner find the absolute path of the\nexecutable."},"class":{"const":"CommandLineTool","type":"string"},"cwlVersion":{"description":"CWL document version. Always required at the document root. Not\nrequired for a Process embedded inside another Process.","enum":["draft-2","draft-3","draft-3.dev1","draft-3.dev2","draft-3.dev3","draft-3.dev4","draft-3.dev5","draft-4.dev1","draft-4.dev2","draft-4.dev3","v1.0","v1.0.dev4","v1.1","v1.1.0-dev1","v1.2","v1.2.0-dev1","v1.2.0-dev2","v1.2.0-dev3","v1.2.0-dev4","v1.2.0-dev5"],"type":"string"},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"hints":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"id":{"description":"The unique identifier for this object.\n\nOnly useful for `$graph` at `Process` level. Should not be exposed\nto users in graphical or terminal user interfaces.","type":"string"},"inputs":{"description":"Defines the input parameters of the process. The process is ready to\nrun when all required input parameters are associated with concrete\nvalues. Input parameters include a schema for each parameter which is\nused to validate the input object. It may also be used to build a user\ninterface for constructing the input object.\n\nWhen accepting an input object, all input parameters must have a value.\nIf an input parameter is missing from the input object, it must be\nassigned a value of `null` (or the value of `default` for that\nparameter, if provided) for the purposes of validation and evaluation\nof expressions.","oneOf":[{"items":{"$ref":"#/definitions/CommandInputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/CommandInputParameter"},{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/CommandInputParameter"}]}}]}},"type":"object"}]},"intent":{"description":"An identifier for the type of computational operation, of this Process.\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\n\nIf provided, then this must be an IRI of a concept node that\nrepresents the type of operation, preferably defined within an ontology.\n\nFor example, in the domain of bioinformatics, one can use an IRI from\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\nlike [Alignment](http://edamontology.org/operation_2928),\nor [Clustering](http://edamontology.org/operation_3432); or a more\nspecific Operation concept like\n[Split read mapping](http://edamontology.org/operation_3199).","items":{"type":"string"},"type":"array"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"outputs":{"description":"Defines the parameters representing the output of the process. May be\nused to generate and/or validate the output object.","oneOf":[{"items":{"$ref":"#/definitions/CommandOutputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/CommandOutputParameter"},{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/CommandOutputParameter"}]}}]}},"type":"object"}]},"permanentFailCodes":{"description":"Exit codes that indicate the process failed due to a permanent logic error, where executing the process with the same runtime environment and same inputs is expected to always fail.\nIf not specified, all exit codes except 0 are considered permanent failure.","items":{"type":"number"},"type":"array"},"requirements":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"stderr":{"description":"Capture the command's standard error stream to a file written to\nthe designated output directory.\n\nIf `stderr` is a string, it specifies the file name to use.\n\nIf `stderr` is an expression, the expression is evaluated and must\nreturn a string with the file name to use to capture stderr. If the\nreturn value is not a string, or the resulting path contains illegal\ncharacters (such as the path separator `/`) it is an error.","type":"string"},"stdin":{"description":"A path to a file whose contents must be piped into the command's\nstandard input stream.","type":"string"},"stdout":{"description":"Capture the command's standard output stream to a file written to\nthe designated output directory.\n\nIf the `CommandLineTool` contains logically chained commands\n(e.g. `echo a && echo b`) `stdout` must include the output of\nevery command.\n\nIf `stdout` is a string, it specifies the file name to use.\n\nIf `stdout` is an expression, the expression is evaluated and must\nreturn a string with the file name to use to capture stdout. If the\nreturn value is not a string, or the resulting path contains illegal\ncharacters (such as the path separator `/`) it is an error.","type":"string"},"successCodes":{"description":"Exit codes that indicate the process completed successfully.\n\nIf not specified, only exit code 0 is considered success.","items":{"type":"number"},"type":"array"},"temporaryFailCodes":{"description":"Exit codes that indicate the process failed due to a possibly\ntemporary condition, where executing the process with the same\nruntime environment and inputs may produce different results.\n\nIf not specified, no exit codes are considered temporary failure.","items":{"type":"number"},"type":"array"}},"required":["class","inputs","outputs"],"type":"object"},"CommandOutputArraySchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputArraySchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Defines the type of the array elements."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"array","description":"Must be `array`","type":"string"}},"required":["items","type"],"type":"object"},"CommandOutputBinding":{"additionalProperties":false,"description":"Describes how to generate an output parameter based on the files produced\nby a CommandLineTool.\n\nThe output parameter value is generated by applying these operations in the\nfollowing order:\n\n - glob\n - loadContents\n - outputEval\n - secondaryFiles","properties":{"glob":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Find files or directories relative to the output directory, using POSIX\nglob(3) pathname matching. If an array is provided, find files or\ndirectories that match any pattern in the array. If an expression is\nprovided, the expression must return a string or an array of strings,\nwhich will then be evaluated as one or more glob patterns. Must only\nmatch and return files/directories which actually exist.\n\nIf the value of glob is a relative path pattern (does not\nbegin with a slash '/') then it is resolved relative to the\noutput directory. If the value of the glob is an absolute\npath pattern (it does begin with a slash '/') then it must\nrefer to a path within the output directory. It is an error\nif any glob resolves to a path outside the output directory.\nSpecifically this means globs that resolve to paths outside the output\ndirectory are illegal.\n\nA glob may match a path within the output directory which is\nactually a symlink to another file. In this case, the\nexpected behavior is for the resulting File/Directory object to take the\n`basename` (and corresponding `nameroot` and `nameext`) of the\nsymlink. The `location` of the File/Directory is implementation\ndependent, but logically the File/Directory should have the same content\nas the symlink target. Platforms may stage output files/directories to\ncloud storage that lack the concept of a symlink. In\nthis case file content and directories may be duplicated, or (to avoid\nduplication) the File/Directory `location` may refer to the symlink\ntarget.\n\nIt is an error if a symlink in the output directory (or any\nsymlink in a chain of links) refers to any file or directory\nthat is not under an input or output directory.\n\nImplementations may shut down a container before globbing\noutput, so globs and expressions must not assume access to the\ncontainer filesystem except for declared input and output."},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"outputEval":{"description":"Evaluate an expression to generate the output value. If\n`glob` was specified, the value of `self` must be an array\ncontaining file objects that were matched. If no files were\nmatched, `self` must be a zero length array; if a single file\nwas matched, the value of `self` is an array of a single\nelement. The exit code of the process is\navailable in the expression as `runtime.exitCode`.\n\nAdditionally, if `loadContents` is true, the file must be a\nUTF-8 text file 64 KiB or smaller, and the implementation must\nread the entire contents of the file (or file array) and place\nit in the `contents` field of the File object for use in\n`outputEval`. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.\n\nIf a tool needs to return a large amount of structured data to\nthe workflow, loading the output object from `cwl.output.json`\nbypasses `outputEval` and is not subject to the 64 KiB\n`loadContents` limit.","type":"string"}},"required":[],"type":"object"},"CommandOutputEnumSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputEnumSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"symbols":{"description":"Defines the set of valid symbols.","items":{"type":"string"},"type":"array"},"type":{"const":"enum","description":"Must be `enum`","type":"string"}},"required":["symbols","type"],"type":"object"},"CommandOutputParameter":{"additionalProperties":false,"description":"An output parameter for a CommandLineTool.","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"outputBinding":{"$ref":"#/definitions/CommandOutputBinding","description":"Describes how to generate this output object based on the files produced by a CommandLineTool"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"CommandOutputRecordField":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The name of the field","type":"string"},"outputBinding":{"$ref":"#/definitions/CommandOutputBinding","description":"Describes how to generate this output object based on the files\nproduced by a CommandLineTool"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"required":["name","type"],"type":"object"},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}}]},"CommandOutputRecordSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"fields":{"description":"Defines the fields of the record.","oneOf":[{"items":{"$ref":"#/definitions/CommandOutputRecordField"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"$ref":"#/definitions/CommandOutputRecordFieldMap"}},"type":"object"}]},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"record","description":"Must be `record`","type":"string"}},"required":["type"],"type":"object"},"DefaultFetcher":{"additionalProperties":false,"type":"object"},"Dictionary<any>":{"additionalProperties":{"$ref":"#/definitions/T"},"type":"object"},"Dictionary<string>":{"additionalProperties":{"$ref":"#/definitions/T"},"type":"object"},"Directory":{"additionalProperties":false,"description":"Represents a directory to present to a command line tool.\n\nDirectories are represented as objects with `class` of `Directory`. Directory objects have\na number of properties that provide metadata about the directory.\n\nThe `location` property of a Directory is a IRI that uniquely identifies\nthe directory. Implementations must support the file:// IRI scheme and may\nsupport other schemes such as http://. Alternately to `location`,\nimplementations must also accept the `path` property on Directory, which\nmust be a filesystem path available on the same host as the CWL runner (for\ninputs) or the runtime environment of a command line tool execution (for\ncommand line tool outputs).\n\nA Directory object may have a `listing` field. This is a list of File and\nDirectory objects that are contained in the Directory. For each entry in\n`listing`, the `basename` property defines the name of the File or\nSubdirectory when staged to disk. If `listing` is not provided, the\nimplementation must have some way of fetching the Directory listing at\nruntime based on the `location` field.\n\nIf a Directory does not have `location`, it is a Directory literal. A\nDirectory literal must provide `listing`. Directory literals must be\ncreated on disk at runtime as needed.\n\nThe resources in a Directory literal do not need to have any implied\nrelationship in their `location`. For example, a Directory listing may\ncontain two files located on different hosts. It is the responsibility of\nthe runtime to ensure that those files are staged to disk appropriately.\nSecondary files associated with files in `listing` must also be staged to\nthe same Directory.\n\nWhen executing a CommandLineTool, Directories must be recursively staged\nfirst and have local values of `path` assigned.\n\nDirectory objects in CommandLineTool output must provide either a\n`location` IRI or a `path` property in the context of the tool execution\nruntime (local to the compute node, or within the executing container).\n\nAn ExpressionTool may forward file references from input to output by using\nthe same value for `location`.\n\nName conflicts (the same `basename` appearing multiple times in `listing`\nor in any entry in `secondaryFiles` in the listing) is a fatal error.","properties":{"basename":{"description":"The base name of the directory, that is, the name of the file without any\nleading directory path. The base name must not contain a slash `/`.\n\nIf not provided, the implementation must set this field based on the\n`location` field by taking the final path component after parsing\n`location` as an IRI. If `basename` is provided, it is not required to\nmatch the value from `location`.\n\nWhen this file is made available to a CommandLineTool, it must be named\nwith `basename`, i.e. the final component of the `path` field must match\n`basename`.","type":"string"},"class":{"const":"Directory","description":"Must be `Directory` to indicate this object describes a Directory.","type":"string"},"listing":{"description":"List of files or subdirectories contained in this directory. The name\nof each file or subdirectory is determined by the `basename` field of\neach `File` or `Directory` object. It is an error if a `File` shares a\n`basename` with any other entry in `listing`. If two or more\n`Directory` object share the same `basename`, this must be treated as\nequivalent to a single subdirectory with the listings recursively\nmerged.","items":{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"}]},"type":"array"},"location":{"description":"An IRI that identifies the directory resource. This may be a relative\nreference, in which case it must be resolved using the base IRI of the\ndocument. The location may refer to a local or remote resource. If\nthe `listing` field is not set, the implementation must use the\nlocation IRI to retrieve directory listing. If an implementation is\nunable to retrieve the directory listing stored at a remote resource (due to\nunsupported protocol, access denied, or other issue) it must signal an\nerror.\n\nIf the `location` field is not provided, the `listing` field must be\nprovided. The implementation must assign a unique identifier for\nthe `location` field.\n\nIf the `path` field is provided but the `location` field is not, an\nimplementation may assign the value of the `path` field to `location`,\nthen follow the rules above.","type":"string"},"path":{"description":"The local path where the Directory is made available prior to executing a\nCommandLineTool. This must be set by the implementation. This field\nmust not be used in any other context. The command line tool being\nexecuted must be able to access the directory at `path` using the POSIX\n`opendir(2)` syscall.\n\nIf the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)\n(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\\`, `\"`, `'`,\n`<space>`, `<tab>`, and `<newline>`) or characters\n[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)\nfor [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)\nthen implementations may terminate the process with a\n`permanentFailure`.","type":"string"}},"required":["class"],"type":"object"},"Dirent":{"additionalProperties":false,"description":"Define a file or subdirectory that must be staged to a particular\nplace prior to executing the command line tool. May be the result\nof executing an expression, such as building a configuration file\nfrom a template.\n\nUsually files are staged within the [designated output directory](#Runtime_environment).\nHowever, under certain circumstances, files may be staged at\narbitrary locations, see discussion for `entryname`.","properties":{"entry":{"description":"If the value is a string literal or an expression which evaluates to a\nstring, a new text file must be created with the string as the file contents.\n\nIf the value is an expression that evaluates to a `File` or\n`Directory` object, or an array of `File` or `Directory`\nobjects, this indicates the referenced file or directory\nshould be added to the designated output directory prior to\nexecuting the tool.\n\nIf the value is an expression that evaluates to `null`,\nnothing is added to the designated output directory, the entry\nhas no effect.\n\nIf the value is an expression that evaluates to some other\narray, number, or object not consisting of `File` or\n`Directory` objects, a new file must be created with the value\nserialized to JSON text as the file contents. The JSON\nserialization behavior should match the behavior of string\ninterpolation of [Parameter\nreferences](#Parameter_references).","type":"string"},"entryname":{"description":"The \"target\" name of the file or subdirectory. If `entry` is\na File or Directory, the `entryname` field overrides the value\nof `basename` of the File or Directory object.\n\n* Required when `entry` evaluates to file contents only\n* Optional when `entry` evaluates to a File or Directory object with a `basename`\n* Invalid when `entry` evaluates to an array of File or Directory objects.\n\nIf `entryname` is a relative path, it specifies a name within\nthe designated output directory. A relative path starting\nwith `../` or that resolves to location above the designated output directory is an error.\n\nIf `entryname` is an absolute path (starts with a slash `/`)\nit is an error unless the following conditions are met:\n\n * `DockerRequirement` is present in `requirements`\n * The program is will run inside a software container\n where, from the perspective of the program, the root\n filesystem is not shared with any other user or\n running program.\n\nIn this case, and the above conditions are met, then\n`entryname` may specify the absolute path within the container\nwhere the file or directory must be placed.","type":"string"},"writable":{"description":"If true, the File or Directory (or array of Files or\nDirectories) declared in `entry` must be writable by the tool.\n\nChanges to the file or directory must be isolated and not\nvisible by any other CommandLineTool process. This may be\nimplemented by making a copy of the original file or\ndirectory.\n\nDisruptive changes to the referenced file or directory must not\nbe allowed unless `InplaceUpdateRequirement.inplaceUpdate` is true.\n\nDefault false (files and directories read-only by default).\n\nA directory marked as `writable: true` implies that all files and\nsubdirectories are recursively writable as well.\n\nIf `writable` is false, the file may be made available using a\nbind mount or file system link to avoid unnecessary copying of\nthe input file. Command line tools may receive an error on\nattempting to rename or delete files or directories that are\nnot explicitly marked as writable.","type":"boolean"}},"required":["entry"],"type":"object"},"DockerRequirement":{"additionalProperties":false,"description":"Indicates that a workflow component should be run in a\n[Docker](https://docker.com) or Docker-compatible (such as\n[Singularity](https://www.sylabs.io/) and [udocker](https://github.com/indigo-dc/udocker)) container environment and\nspecifies how to fetch or build the image.\n\nIf a CommandLineTool lists `DockerRequirement` under\n`hints` (or `requirements`), it may (or must) be run in the specified Docker\ncontainer.\n\nThe platform must first acquire or install the correct Docker image as\nspecified by `dockerPull`, `dockerImport`, `dockerLoad` or `dockerFile`.\n\nThe platform must execute the tool in the container using `docker run` with\nthe appropriate Docker image and tool command line.\n\nThe workflow platform may provide input files and the designated output\ndirectory through the use of volume bind mounts. The platform should rewrite\nfile paths in the input object to correspond to the Docker bind mounted\nlocations. That is, the platform should rewrite values in the parameter context\nsuch as `runtime.outdir`, `runtime.tmpdir` and others to be valid paths\nwithin the container. The platform must ensure that `runtime.outdir` and\n`runtime.tmpdir` are distinct directories.\n\nWhen running a tool contained in Docker, the workflow platform must not\nassume anything about the contents of the Docker container, such as the\npresence or absence of specific software, except to assume that the\ngenerated command line represents a valid command within the runtime\nenvironment of the container.\n\nA container image may specify an\n[ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint)\nand/or\n[CMD](https://docs.docker.com/engine/reference/builder/#cmd).\nCommand line arguments will be appended after all elements of\nENTRYPOINT, and will override all elements specified using CMD (in\nother words, CMD is only used when the CommandLineTool definition\nproduces an empty command line).\n\nUse of implicit ENTRYPOINT or CMD are discouraged due to reproducibility\nconcerns of the implicit hidden execution point (For further discussion, see\n[https://doi.org/10.12688/f1000research.15140.1](https://doi.org/10.12688/f1000research.15140.1)). Portable\nCommandLineTool wrappers in which use of a container is optional must not rely on ENTRYPOINT or CMD.\nCommandLineTools which do rely on ENTRYPOINT or CMD must list `DockerRequirement` in the\n`requirements` section.\n\n## Interaction with other requirements\n\nIf [EnvVarRequirement](#EnvVarRequirement) is specified alongside a\nDockerRequirement, the environment variables must be provided to Docker\nusing `--env` or `--env-file` and interact with the container's preexisting\nenvironment as defined by Docker.","properties":{"class":{"const":"DockerRequirement","description":"Always 'DockerRequirement'","type":"string"},"dockerFile":{"description":"Supply the contents of a Dockerfile which will be built using `docker build`.","type":"string"},"dockerImageId":{"description":"The image id that will be used for `docker run`. May be a\nhuman-readable image name or the image identifier hash. May be skipped\nif `dockerPull` is specified, in which case the `dockerPull` image id\nmust be used.","type":"string"},"dockerImport":{"description":"Provide HTTP URL to download and gunzip a Docker images using `docker import.","type":"string"},"dockerLoad":{"description":"Specify an HTTP URL from which to download a Docker image using `docker load`.","type":"string"},"dockerOutputDirectory":{"description":"Set the designated output directory to a specific location inside the\nDocker container.","type":"string"},"dockerPull":{"description":"Specify a Docker image to retrieve using `docker pull`. Can contain the\nimmutable digest to ensure an exact container is used:\n`dockerPull: ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`","type":"string"}},"required":["class"],"type":"object"},"EnvVarRequirement":{"additionalProperties":false,"description":"Define a list of environment variables which will be set in the\nexecution environment of the tool. See `EnvironmentDef` for details.","properties":{"class":{"const":"EnvVarRequirement","description":"Always 'EnvVarRequirement'","type":"string"},"envDef":{"description":"The list of environment variables.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/EnvironmentDef"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"type":"string"}}}]}},"required":["class","envDef"],"type":"object"},"EnvironmentDef":{"additionalProperties":false,"description":"Define an environment variable that will be set in the runtime environment\nby the workflow platform when executing the command line tool. May be the\nresult of executing an expression, such as getting a parameter from input.","properties":{"envName":{"description":"The environment variable name","type":"string"},"envValue":{"description":"The environment variable value","type":"string"}},"required":["envName","envValue"],"type":"object"},"ExpressionTool":{"description":"An ExpressionTool is a type of Process object that can be run by itself\nor as a Workflow step. It executes a pure Javascript expression that has\naccess to the same input parameters as a workflow. It is meant to be used\nsparingly as a way to isolate complex Javascript expressions that need to\noperate on input data and produce some result; perhaps just a\nrearrangement of the inputs. No Docker software container is required\nor allowed.","properties":{"class":{"const":"ExpressionTool","type":"string"},"cwlVersion":{"description":"CWL document version. Always required at the document root. Not\nrequired for a Process embedded inside another Process.","enum":["draft-2","draft-3","draft-3.dev1","draft-3.dev2","draft-3.dev3","draft-3.dev4","draft-3.dev5","draft-4.dev1","draft-4.dev2","draft-4.dev3","v1.0","v1.0.dev4","v1.1","v1.1.0-dev1","v1.2","v1.2.0-dev1","v1.2.0-dev2","v1.2.0-dev3","v1.2.0-dev4","v1.2.0-dev5"],"type":"string"},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"expression":{"description":"The expression to execute. The expression must return a plain\nJavascript object which matches the output parameters of the\nExpressionTool.","type":"string"},"hints":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"id":{"description":"The unique identifier for this object.\n\nOnly useful for `$graph` at `Process` level. Should not be exposed\nto users in graphical or terminal user interfaces.","type":"string"},"inputs":{"description":"Defines the input parameters of the process. The process is ready to\nrun when all required input parameters are associated with concrete\nvalues. Input parameters include a schema for each parameter which is\nused to validate the input object. It may also be used to build a user\ninterface for constructing the input object.\n\nWhen accepting an input object, all input parameters must have a value.\nIf an input parameter is missing from the input object, it must be\nassigned a value of `null` (or the value of `default` for that\nparameter, if provided) for the purposes of validation and evaluation\nof expressions.","oneOf":[{"items":{"$ref":"#/definitions/WorkflowInputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/WorkflowInputParameter"},{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/WorkflowInputParameter"}]}}]}},"type":"object"}]},"intent":{"description":"An identifier for the type of computational operation, of this Process.\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\n\nIf provided, then this must be an IRI of a concept node that\nrepresents the type of operation, preferably defined within an ontology.\n\nFor example, in the domain of bioinformatics, one can use an IRI from\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\nlike [Alignment](http://edamontology.org/operation_2928),\nor [Clustering](http://edamontology.org/operation_3432); or a more\nspecific Operation concept like\n[Split read mapping](http://edamontology.org/operation_3199).","items":{"type":"string"},"type":"array"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"outputs":{"description":"Defines the parameters representing the output of the process. May be\nused to generate and/or validate the output object.","oneOf":[{"items":{"$ref":"#/definitions/ExpressionToolOutputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/ExpressionToolOutputParameter"},{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter.\nNote that this field just acts as a hint, as the outputs of an\nExpressionTool process are always considered valid."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/ExpressionToolOutputParameter"}]}}]}},"type":"object"}]},"requirements":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]}},"required":["class","expression","inputs","outputs"],"type":"object"},"ExpressionToolOutputParameter":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#ExpressionToolOutputParameter","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter.\nNote that this field just acts as a hint, as the outputs of an\nExpressionTool process are always considered valid."}},"required":["type"],"type":"object"},"Fetcher":{"oneOf":[{"$ref":"#/definitions/DefaultFetcher"}]},"File":{"additionalProperties":false,"description":"Represents a file (or group of files when `secondaryFiles` is provided) that\nwill be accessible by tools using standard POSIX file system call API such as\nopen(2) and read(2).\n\nFiles are represented as objects with `class` of `File`. File objects have\na number of properties that provide metadata about the file.\n\nThe `location` property of a File is a IRI that uniquely identifies the\nfile. Implementations must support the `file://` IRI scheme and may support\nother schemes such as `http://` and `https://`. The value of `location` may also be a\nrelative reference, in which case it must be resolved relative to the IRI\nof the document it appears in. Alternately to `location`, implementations\nmust also accept the `path` property on File, which must be a filesystem\npath available on the same host as the CWL runner (for inputs) or the\nruntime environment of a command line tool execution (for command line tool\noutputs).\n\nIf no `location` or `path` is specified, a file object must specify\n`contents` with the UTF-8 text content of the file. This is a \"file\nliteral\". File literals do not correspond to external resources, but are\ncreated on disk with `contents` with when needed for executing a tool.\nWhere appropriate, expressions can return file literals to define new files\non a runtime. The maximum size of `contents` is 64 kilobytes.\n\nThe `basename` property defines the filename on disk where the file is\nstaged. This may differ from the resource name. If not provided,\n`basename` must be computed from the last path part of `location` and made\navailable to expressions.\n\nThe `secondaryFiles` property is a list of File or Directory objects that\nmust be staged in the same directory as the primary file. It is an error\nfor file names to be duplicated in `secondaryFiles`.\n\nThe `size` property is the size in bytes of the File. It must be computed\nfrom the resource and made available to expressions. The `checksum` field\ncontains a cryptographic hash of the file content for use it verifying file\ncontents. Implementations may, at user option, enable or disable\ncomputation of the `checksum` field for performance or other reasons.\nHowever, the ability to compute output checksums is required to pass the\nCWL conformance test suite.\n\nWhen executing a CommandLineTool, the files and secondary files may be\nstaged to an arbitrary directory, but must use the value of `basename` for\nthe filename. The `path` property must be file path in the context of the\ntool execution runtime (local to the compute node, or within the executing\ncontainer). All computed properties should be available to expressions.\nFile literals also must be staged and `path` must be set.\n\nWhen collecting CommandLineTool outputs, `glob` matching returns file paths\n(with the `path` property) and the derived properties. This can all be\nmodified by `outputEval`. Alternately, if the file `cwl.output.json` is\npresent in the output, `outputBinding` is ignored.\n\nFile objects in the output must provide either a `location` IRI or a `path`\nproperty in the context of the tool execution runtime (local to the compute\nnode, or within the executing container).\n\nWhen evaluating an ExpressionTool, file objects must be referenced via\n`location` (the expression tool does not have access to files on disk so\n`path` is meaningless) or as file literals. It is legal to return a file\nobject with an existing `location` but a different `basename`. The\n`loadContents` field of ExpressionTool inputs behaves the same as on\nCommandLineTool inputs, however it is not meaningful on the outputs.\n\nAn ExpressionTool may forward file references from input to output by using\nthe same value for `location`.","properties":{"basename":{"description":"The base name of the file, that is, the name of the file without any\nleading directory path. The base name must not contain a slash `/`.\n\nIf not provided, the implementation must set this field based on the\n`location` field by taking the final path component after parsing\n`location` as an IRI. If `basename` is provided, it is not required to\nmatch the value from `location`.\n\nWhen this file is made available to a CommandLineTool, it must be named\nwith `basename`, i.e. the final component of the `path` field must match\n`basename`.","type":"string"},"checksum":{"description":"Optional hash code for validating file integrity. Currently, must be in the form\n\"sha1$ + hexadecimal string\" using the SHA-1 algorithm.","type":"string"},"class":{"const":"File","description":"Must be `File` to indicate this object describes a file.","type":"string"},"contents":{"description":"File contents literal.\n\nIf neither `location` nor `path` is provided, `contents` must be\nnon-null. The implementation must assign a unique identifier for the\n`location` field. When the file is staged as input to CommandLineTool,\nthe value of `contents` must be written to a file.\n\nIf `contents` is set as a result of a Javascript expression,\nan `entry` in `InitialWorkDirRequirement`, or read in from\n`cwl.output.json`, there is no specified upper limit on the\nsize of `contents`. Implementations may have practical limits\non the size of `contents` based on memory and storage\navailable to the workflow runner or other factors.\n\nIf the `loadContents` field of an `InputParameter` or\n`OutputParameter` is true, and the input or output File object\n`location` is valid, the file must be a UTF-8 text file 64 KiB\nor smaller, and the implementation must read the entire\ncontents of the file and place it in the `contents` field. If\nthe size of the file is greater than 64 KiB, the\nimplementation must raise a fatal error.","type":"string"},"dirname":{"description":"The name of the directory containing file, that is, the path leading up\nto the final slash in the path such that `dirname + '/' + basename ==\npath`.\n\nThe implementation must set this field based on the value of `path`\nprior to evaluating parameter references or expressions in a\nCommandLineTool document. This field must not be used in any other\ncontext.","type":"string"},"format":{"description":"The format of the file: this must be an IRI of a concept node that\nrepresents the file format, preferably defined within an ontology.\nIf no ontology is available, file formats may be tested by exact match.\n\nReasoning about format compatibility must be done by checking that an\ninput file format is the same, `owl:equivalentClass` or\n`rdfs:subClassOf` the format required by the input parameter.\n`owl:equivalentClass` is transitive with `rdfs:subClassOf`, e.g. if\n`<B> owl:equivalentClass <C>` and `<B> owl:subclassOf <A>` then infer\n`<C> owl:subclassOf <A>`.\n\nFile format ontologies may be provided in the \"$schemas\" metadata at the\nroot of the document. If no ontologies are specified in `$schemas`, the\nruntime may perform exact file format matches.","type":"string"},"location":{"description":"An IRI that identifies the file resource. This may be a relative\nreference, in which case it must be resolved using the base IRI of the\ndocument. The location may refer to a local or remote resource; the\nimplementation must use the IRI to retrieve file content. If an\nimplementation is unable to retrieve the file content stored at a\nremote resource (due to unsupported protocol, access denied, or other\nissue) it must signal an error.\n\nIf the `location` field is not provided, the `contents` field must be\nprovided. The implementation must assign a unique identifier for\nthe `location` field.\n\nIf the `path` field is provided but the `location` field is not, an\nimplementation may assign the value of the `path` field to `location`,\nthen follow the rules above.","type":"string"},"nameext":{"description":"The basename extension such that `nameroot + nameext == basename`, and\n`nameext` is empty or begins with a period and contains at most one\nperiod. Leading periods on the basename are ignored; a basename of\n`.cshrc` will have an empty `nameext`.\n\nThe implementation must set this field automatically based on the value\nof `basename` prior to evaluating parameter references or expressions.","type":"string"},"nameroot":{"description":"The basename root such that `nameroot + nameext == basename`, and\n`nameext` is empty or begins with a period and contains at most one\nperiod. For the purposes of path splitting leading periods on the\nbasename are ignored; a basename of `.cshrc` will have a nameroot of\n`.cshrc`.\n\nThe implementation must set this field automatically based on the value\nof `basename` prior to evaluating parameter references or expressions.","type":"string"},"path":{"description":"The local host path where the File is available when a CommandLineTool is\nexecuted. This field must be set by the implementation. The final\npath component must match the value of `basename`. This field\nmust not be used in any other context. The command line tool being\nexecuted must be able to access the file at `path` using the POSIX\n`open(2)` syscall.\n\nAs a special case, if the `path` field is provided but the `location`\nfield is not, an implementation may assign the value of the `path`\nfield to `location`, and remove the `path` field.\n\nIf the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)\n(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\\`, `\"`, `'`,\n`<space>`, `<tab>`, and `<newline>`) or characters\n[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)\nfor [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)\nthen implementations may terminate the process with a\n`permanentFailure`.","type":"string"},"secondaryFiles":{"description":"A list of additional files or directories that are associated with the\nprimary file and must be transferred alongside the primary file.\nExamples include indexes of the primary file, or external references\nwhich must be included when loading primary document. A file object\nlisted in `secondaryFiles` may itself include `secondaryFiles` for\nwhich the same rules apply.","items":{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"}]},"type":"array"},"size":{"description":"Optional file size (in bytes)","type":"number"}},"required":["class"],"type":"object"},"InitialWorkDirRequirement":{"additionalProperties":false,"description":"Define a list of files and subdirectories that must be staged by the workflow platform prior to executing the command line tool.\nNormally files are staged within the designated output directory. However, when running inside containers, files may be staged at arbitrary locations, see discussion for [`Dirent.entryname`](#Dirent). Together with `DockerRequirement.dockerOutputDirectory` it is possible to control the locations of both input and output files when running in containers.","properties":{"class":{"const":"InitialWorkDirRequirement","description":"InitialWorkDirRequirement","type":"string"},"listing":{"anyOf":[{"items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"},{"items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"$ref":"#/definitions/Dirent"},{"type":"string"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"type":"string"}],"description":"The list of files or subdirectories that must be staged prior\nto executing the command line tool.\n\nReturn type of each expression must validate as `[\"null\",\nFile, Directory, Dirent, {type: array, items: [File,\nDirectory]}]`.\n\nEach `File` or `Directory` that is returned by an Expression\nmust be added to the designated output directory prior to\nexecuting the tool.\n\nEach `Dirent` record that is listed or returned by an\nexpression specifies a file to be created or staged in the\ndesignated output directory prior to executing the tool.\n\nExpressions may return null, in which case they have no effect.\n\nFiles or Directories which are listed in the input parameters\nand appear in the `InitialWorkDirRequirement` listing must\nhave their `path` set to their staged location. If the same\nFile or Directory appears more than once in the\n`InitialWorkDirRequirement` listing, the implementation must\nchoose exactly one value for `path`; how this value is chosen\nis undefined."}},"required":["class"],"type":"object"},"InlineJavascriptRequirement":{"additionalProperties":false,"description":"Indicates that the workflow platform must support inline Javascript expressions.\nIf this requirement is not present, the workflow platform must not perform expression\ninterpolation.","properties":{"class":{"const":"InlineJavascriptRequirement","description":"Always 'InlineJavascriptRequirement'","type":"string"},"expressionLib":{"description":"Additional code fragments that will also be inserted\nbefore executing the expression code. Allows for function definitions that may\nbe called from CWL expressions.","items":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":["class"],"type":"object"},"InplaceUpdateRequirement":{"additionalProperties":false,"description":"\nIf `inplaceUpdate` is true, then an implementation supporting this\nfeature may permit tools to directly update files with `writable:\ntrue` in InitialWorkDirRequirement. That is, as an optimization,\nfiles may be destructively modified in place as opposed to copied\nand updated.\n\nAn implementation must ensure that only one workflow step may\naccess a writable file at a time. It is an error if a file which\nis writable by one workflow step file is accessed (for reading or\nwriting) by any other workflow step running independently.\nHowever, a file which has been updated in a previous completed\nstep may be used as input to multiple steps, provided it is\nread-only in every step.\n\nWorkflow steps which modify a file must produce the modified file\nas output. Downstream steps which further process the file must\nuse the output of previous steps, and not refer to a common input\n(this is necessary for both ordering and correctness).\n\nWorkflow authors should provide this in the `hints` section. The\nintent of this feature is that workflows produce the same results\nwhether or not InplaceUpdateRequirement is supported by the\nimplementation, and this feature is primarily available as an\noptimization for particular environments.\n\nUsers and implementers should be aware that workflows that\ndestructively modify inputs may not be repeatable or reproducible.\nIn particular, enabling this feature implies that WorkReuse should\nnot be enabled.","properties":{"class":{"const":"InplaceUpdateRequirement","description":"Always 'InplaceUpdateRequirement'","type":"string"},"inplaceUpdate":{"type":"boolean"}},"required":["class","inplaceUpdate"],"type":"object"},"InputArraySchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputArraySchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Defines the type of the array elements."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"array","description":"Must be `array`","type":"string"}},"required":["items","type"],"type":"object"},"InputBinding":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputBinding","properties":{"loadContents":{"description":"Use of `loadContents` in `InputBinding` is deprecated.\nPreserved for v1.0 backwards compatibility. Will be removed in\nCWL v2.0. Use `InputParameter.loadContents` instead.","type":"boolean"}},"required":[],"type":"object"},"InputEnumSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputEnumSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"symbols":{"description":"Defines the set of valid symbols.","items":{"type":"string"},"type":"array"},"type":{"const":"enum","description":"Must be `enum`","type":"string"}},"required":["symbols","type"],"type":"object"},"InputRecordField":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"required":["name","type"],"type":"object"},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}}]},"InputRecordSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"fields":{"description":"Defines the fields of the record.","oneOf":[{"items":{"$ref":"#/definitions/InputRecordField"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"$ref":"#/definitions/InputRecordFieldMap"}},"type":"object"}]},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"record","description":"Must be `record`","type":"string"}},"required":["type"],"type":"object"},"LoadListingRequirement":{"additionalProperties":false,"description":"Specify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.","properties":{"class":{"const":"LoadListingRequirement","description":"Always 'LoadListingRequirement'","type":"string"},"loadListing":{"enum":["deep_listing","no_listing","shallow_listing"],"type":"string"}},"required":["class"],"type":"object"},"LoadingOptions":{"additionalProperties":false,"properties":{"container":{"type":"string"},"copyFrom":{"$ref":"#/definitions/LoadingOptions"},"fetcher":{"$ref":"#/definitions/Fetcher"},"fileUri":{"type":"string"},"idx":{"$ref":"#/definitions/Dictionary<any>"},"namespaces":{"$ref":"#/definitions/Dictionary<string>"},"noLinkCheck":{"type":"boolean"},"originalDoc":{},"rvocab":{"$ref":"#/definitions/Dictionary<string>"},"schemas":{"$ref":"#/definitions/Dictionary<string>"},"vocab":{"$ref":"#/definitions/Dictionary<string>"}},"required":["fetcher","idx","originalDoc","rvocab","vocab"],"type":"object"},"MultipleInputFeatureRequirement":{"additionalProperties":false,"description":"Indicates that the workflow platform must support multiple inbound data links\nlisted in the `source` field of [WorkflowStepInput](#WorkflowStepInput).","properties":{"class":{"const":"MultipleInputFeatureRequirement","description":"Always 'MultipleInputFeatureRequirement'","type":"string"}},"required":["class"],"type":"object"},"NetworkAccess":{"additionalProperties":false,"description":"Indicate whether a process requires outgoing IPv4/IPv6 network\naccess. Choice of IPv4 or IPv6 is implementation and site\nspecific, correct tools must support both.\n\nIf `networkAccess` is false or not specified, tools must not\nassume network access, except for localhost (the loopback device).\n\nIf `networkAccess` is true, the tool must be able to make outgoing\nconnections to network resources. Resources may be on a private\nsubnet or the public Internet. However, implementations and sites\nmay apply their own security policies to restrict what is\naccessible by the tool.\n\nEnabling network access does not imply a publicly routable IP\naddress or the ability to accept inbound connections.","properties":{"class":{"const":"NetworkAccess","description":"Always 'NetworkAccess'","type":"string"},"networkAccess":{"type":["string","boolean"]}},"required":["class","networkAccess"],"type":"object"},"Operation":{"additionalProperties":false,"description":"This record describes an abstract operation. It is a potential\nstep of a workflow that has not yet been bound to a concrete\nimplementation. It specifies an input and output signature, but\ndoes not provide enough information to be executed. An\nimplementation (or other tooling) may provide a means of binding\nan Operation to a concrete process (such as Workflow,\nCommandLineTool, or ExpressionTool) with a compatible signature.","properties":{"class":{"const":"Operation","type":"string"},"cwlVersion":{"description":"CWL document version. Always required at the document root. Not\nrequired for a Process embedded inside another Process.","enum":["draft-2","draft-3","draft-3.dev1","draft-3.dev2","draft-3.dev3","draft-3.dev4","draft-3.dev5","draft-4.dev1","draft-4.dev2","draft-4.dev3","v1.0","v1.0.dev4","v1.1","v1.1.0-dev1","v1.2","v1.2.0-dev1","v1.2.0-dev2","v1.2.0-dev3","v1.2.0-dev4","v1.2.0-dev5"],"type":"string"},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"hints":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"id":{"description":"The unique identifier for this object.\n\nOnly useful for `$graph` at `Process` level. Should not be exposed\nto users in graphical or terminal user interfaces.","type":"string"},"inputs":{"description":"Defines the input parameters of the process. The process is ready to\nrun when all required input parameters are associated with concrete\nvalues. Input parameters include a schema for each parameter which is\nused to validate the input object. It may also be used to build a user\ninterface for constructing the input object.\n\nWhen accepting an input object, all input parameters must have a value.\nIf an input parameter is missing from the input object, it must be\nassigned a value of `null` (or the value of `default` for that\nparameter, if provided) for the purposes of validation and evaluation\nof expressions.","oneOf":[{"items":{"$ref":"#/definitions/OperationInputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/OperationInputParameter"},{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/OperationInputParameter"}]}}]}},"type":"object"}]},"intent":{"description":"An identifier for the type of computational operation, of this Process.\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\n\nIf provided, then this must be an IRI of a concept node that\nrepresents the type of operation, preferably defined within an ontology.\n\nFor example, in the domain of bioinformatics, one can use an IRI from\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\nlike [Alignment](http://edamontology.org/operation_2928),\nor [Clustering](http://edamontology.org/operation_3432); or a more\nspecific Operation concept like\n[Split read mapping](http://edamontology.org/operation_3199).","items":{"type":"string"},"type":"array"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"outputs":{"description":"Defines the parameters representing the output of the process. May be\nused to generate and/or validate the output object.","oneOf":[{"items":{"$ref":"#/definitions/OperationOutputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/OperationOutputParameter"},{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/OperationOutputParameter"}]}}]}},"type":"object"}]},"requirements":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]}},"required":["class","inputs","outputs"],"type":"object"},"OperationInputParameter":{"additionalProperties":false,"description":"Describe an input parameter of an operation.","properties":{"default":{"description":"The default value to use for this parameter if the parameter is missing\nfrom the input object, or if the value of the parameter in the input\nobject is `null`. Default values are applied before evaluating expressions\n(e.g. dependent `valueFrom` fields)."},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"OperationOutputParameter":{"additionalProperties":false,"description":"Describe an output parameter of an operation.","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"OutputArraySchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputArraySchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Defines the type of the array elements."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"array","description":"Must be `array`","type":"string"}},"required":["items","type"],"type":"object"},"OutputEnumSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputEnumSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"symbols":{"description":"Defines the set of valid symbols.","items":{"type":"string"},"type":"array"},"type":{"const":"enum","description":"Must be `enum`","type":"string"}},"required":["symbols","type"],"type":"object"},"OutputRecordField":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"required":["name","type"],"type":"object"},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}}]},"OutputRecordSchema":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordSchema","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"fields":{"description":"Defines the fields of the record.","oneOf":[{"items":{"$ref":"#/definitions/OutputRecordField"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"$ref":"#/definitions/OutputRecordFieldMap"}},"type":"object"}]},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The identifier for this type","type":"string"},"type":{"const":"record","description":"Must be `record`","type":"string"}},"required":["type"],"type":"object"},"ResourceRequirement":{"additionalProperties":false,"description":"Specify basic hardware resource requirements.\n\n\"min\" is the minimum amount of a resource that must be reserved to\nschedule a job. If \"min\" cannot be satisfied, the job should not\nbe run.\n\n\"max\" is the maximum amount of a resource that the job shall be\nallocated. If a node has sufficient resources, multiple jobs may\nbe scheduled on a single node provided each job's \"max\" resource\nrequirements are met. If a job attempts to exceed its resource\nallocation, an implementation may deny additional resources, which\nmay result in job failure.\n\nIf both \"min\" and \"max\" are specified, an implementation may\nchoose to allocate any amount between \"min\" and \"max\", with the\nactual allocation provided in the `runtime` object.\n\nIf \"min\" is specified but \"max\" is not, then \"max\" == \"min\"\nIf \"max\" is specified by \"min\" is not, then \"min\" == \"max\".\n\nIt is an error if max < min.\n\nIt is an error if the value of any of these fields is negative.\n\nIf neither \"min\" nor \"max\" is specified for a resource, use the default values below.","properties":{"class":{"const":"ResourceRequirement","description":"Always 'ResourceRequirement'","type":"string"},"coresMax":{"description":"Maximum reserved number of CPU cores.\n\nSee `coresMin` for discussion about fractional CPU requests.","type":["string","number"]},"coresMin":{"description":"Minimum reserved number of CPU cores (default is 1).\n\nMay be a fractional value to indicate to a scheduling\nalgorithm that one core can be allocated to multiple\njobs. For example, a value of 0.25 indicates that up to 4\njobs may run in parallel on 1 core. A value of 1.25 means\nthat up to 3 jobs can run on a 4 core system (4/1.25 \u2248 3).\n\nProcesses can only share a core allocation if the sum of each\nof their `ramMax`, `tmpdirMax`, and `outdirMax` requests also\ndo not exceed the capacity of the node.\n\nProcesses sharing a core must have the same level of isolation\n(typically a container or VM) that they would normally have.\n\nThe reported number of CPU cores reserved for the process,\nwhich is available to expressions on the CommandLineTool as\n`runtime.cores`, must be a non-zero integer, and may be\ncalculated by rounding up the cores request to the next whole\nnumber.\n\nScheduling systems may allocate fractional CPU resources by\nsetting quotas or scheduling weights. Scheduling systems that\ndo not support fractional CPUs may round up the request to the\nnext whole number.","type":["string","number"]},"outdirMax":{"description":"Maximum reserved filesystem based storage for the designated output directory, in mebibytes (2**20)\n\nSee `outdirMin` for discussion about fractional storage requests.","type":["string","number"]},"outdirMin":{"description":"Minimum reserved filesystem based storage for the designated output directory, in mebibytes (2**20) (default is 1024)\n\nMay be a fractional value. If so, the actual storage request\nmust be rounded up to the next whole number. The reported\namount of storage reserved for the process, which is available\nto expressions on the CommandLineTool as `runtime.outdirSize`,\nmust be a non-zero integer.","type":["string","number"]},"ramMax":{"description":"Maximum reserved RAM in mebibytes (2**20)\n\nSee `ramMin` for discussion about fractional RAM requests.","type":["string","number"]},"ramMin":{"description":"Minimum reserved RAM in mebibytes (2**20) (default is 256)\n\nMay be a fractional value. If so, the actual RAM request must\nbe rounded up to the next whole number. The reported amount of\nRAM reserved for the process, which is available to\nexpressions on the CommandLineTool as `runtime.ram`, must be a\nnon-zero integer.","type":["string","number"]},"tmpdirMax":{"description":"Maximum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20)\n\nSee `tmpdirMin` for discussion about fractional storage requests.","type":["string","number"]},"tmpdirMin":{"description":"Minimum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20) (default is 1024)\n\nMay be a fractional value. If so, the actual storage request\nmust be rounded up to the next whole number. The reported\namount of storage reserved for the process, which is available\nto expressions on the CommandLineTool as `runtime.tmpdirSize`,\nmust be a non-zero integer.","type":["string","number"]}},"required":["class"],"type":"object"},"ScatterFeatureRequirement":{"additionalProperties":false,"description":"Indicates that the workflow platform must support the `scatter` and\n`scatterMethod` fields of [WorkflowStep](#WorkflowStep).","properties":{"class":{"const":"ScatterFeatureRequirement","description":"Always 'ScatterFeatureRequirement'","type":"string"}},"required":["class"],"type":"object"},"SchemaDefRequirement":{"additionalProperties":false,"description":"This field consists of an array of type definitions which must be used when\ninterpreting the `inputs` and `outputs` fields. When a `type` field\ncontains a IRI, the implementation must check if the type is defined in\n`schemaDefs` and use that definition. If the type is not found in\n`schemaDefs`, it is an error. The entries in `schemaDefs` must be\nprocessed in the order listed such that later schema definitions may refer\nto earlier schema definitions.\n\n- **Type definitions are allowed for `enum` and `record` types only.**\n- Type definitions may be shared by defining them in a file and then\n `$include`-ing them in the `types` field.\n- A file can contain a list of type definitions","properties":{"class":{"const":"SchemaDefRequirement","description":"Always 'SchemaDefRequirement'","type":"string"},"types":{"description":"The list of type definitions.","items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":["class","types"],"type":"object"},"SecondaryFileSchema":{"description":"Secondary files are specified using the following micro-DSL for secondary files:\n\n* If the value is a string, it is transformed to an object with two fields\n `pattern` and `required`\n* By default, the value of `required` is `null`\n (this indicates default behavior, which may be based on the context)\n* If the value ends with a question mark `?` the question mark is\n stripped off and the value of the field `required` is set to `False`\n* The remaining value is assigned to the field `pattern`\n\nFor implementation details and examples, please see\n[this section](SchemaSalad.html#Domain_Specific_Language_for_secondary_files)\nin the Schema Salad specification.","oneOf":[{"additionalProperties":false,"properties":{"pattern":{"description":"Provides a pattern or expression specifying files or directories that\nshould be included alongside the primary file.\n\nIf the value is an expression, the value of `self` in the\nexpression must be the primary input or output File object to\nwhich this binding applies. The `basename`, `nameroot` and\n`nameext` fields must be present in `self`. For\n`CommandLineTool` inputs the `location` field must also be\npresent. For `CommandLineTool` outputs the `path` field must\nalso be present. If secondary files were included on an input\nFile object as part of the Process invocation, they must also\nbe present in `secondaryFiles` on `self`.\n\nThe expression must return either: a filename string relative\nto the path to the primary File, a File or Directory object\n(`class: File` or `class: Directory`) with either `location`\n(for inputs) or `path` (for outputs) and `basename` fields\nset, or an array consisting of strings or File or Directory\nobjects as previously described.\n\nIt is legal to use `location` from a File or Directory object\npassed in as input, including `location` from secondary files\non `self`. If an expression returns a File object with the\nsame `location` but a different `basename` as a secondary file\nthat was passed in, the expression result takes precedence.\nSetting the basename with an expression this way affects the\n`path` where the secondary file will be staged to in the\nCommandLineTool.\n\nThe expression may return \"null\" in which case there is no\nsecondary file from that expression.\n\nTo work on non-filename-preserving storage systems, portable\ntool descriptions should treat `location` as an\n[opaque identifier](#opaque-strings) and avoid constructing new\nvalues from `location`, but should construct relative references\nusing `basename` or `nameroot` instead, or propagate `location`\nfrom defined inputs.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path.","type":"string"},"required":{"description":"An implementation must not fail workflow execution if `required` is\nset to `false` and the expected secondary file does not exist.\nDefault value for `required` field is `true` for secondary files on\ninput and `false` for secondary files on output.","type":["string","boolean"]}},"required":["pattern"],"type":"object"},{"type":"string"}]},"ShellCommandRequirement":{"additionalProperties":false,"description":"Modify the behavior of CommandLineTool to generate a single string\ncontaining a shell command line. Each item in the `arguments` list must\nbe joined into a string separated by single spaces and quoted to prevent\ninterpretation by the shell, unless `CommandLineBinding` for that argument\ncontains `shellQuote: false`. If `shellQuote: false` is specified, the\nargument is joined into the command string without quoting, which allows\nthe use of shell metacharacters such as `|` for pipes.","properties":{"class":{"const":"ShellCommandRequirement","description":"Always 'ShellCommandRequirement'","type":"string"}},"required":["class"],"type":"object"},"SoftwarePackage":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#SoftwarePackage","properties":{"package":{"description":"The name of the software to be made available. If the name is\ncommon, inconsistent, or otherwise ambiguous it should be combined with\none or more identifiers in the `specs` field.","type":"string"},"specs":{"description":"One or more [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)s\nidentifying resources for installing or enabling the software named in\nthe `package` field. Implementations may provide resolvers which map\nthese software identifier IRIs to some configuration action; or they can\nuse only the name from the `package` field on a best effort basis.\n\nFor example, the IRI https://packages.debian.org/bowtie could\nbe resolved with `apt-get install bowtie`. The IRI\nhttps://anaconda.org/bioconda/bowtie could be resolved with `conda\ninstall -c bioconda bowtie`.\n\nIRIs can also be system independent and used to map to a specific\nsoftware installation or selection mechanism.\nUsing [RRID](https://www.identifiers.org/rrid/) as an example:\nhttps://identifiers.org/rrid/RRID:SCR_005476\ncould be fulfilled using the above-mentioned Debian or bioconda\npackage, a local installation managed by [Environment Modules](https://modules.sourceforge.net/),\nor any other mechanism the platform chooses. IRIs can also be from\nidentifier sources that are discipline specific yet still system\nindependent. As an example, the equivalent [ELIXIR Tools and Data\nService Registry](https://bio.tools) IRI to the previous RRID example is\nhttps://bio.tools/tool/bowtie2/version/2.2.8.\nIf supported by a given registry, implementations are encouraged to\nquery these system independent software identifier IRIs directly for\nlinks to packaging systems.\n\nA site specific IRI can be listed as well. For example, an academic\ncomputing cluster using Environment Modules could list the IRI\n`https://hpc.example.edu/modules/bowtie-tbb/1.22` to indicate that\n`module load bowtie-tbb/1.1.2` should be executed to make available\n`bowtie` version 1.1.2 compiled with the TBB library prior to running\nthe accompanying Workflow or CommandLineTool. Note that the example IRI\nis specific to a particular institution and computing environment as\nthe Environment Modules system does not have a common namespace or\nstandardized naming convention.\n\nThis last example is the least portable and should only be used if\nmechanisms based off of the `package` field or more generic IRIs are\nunavailable or unsuitable. While harmless to other sites, site specific\nsoftware IRIs should be left out of shared CWL descriptions to avoid\nclutter.","items":{"type":"string"},"type":"array"},"version":{"description":"The (optional) versions of the software that are known to be\ncompatible.","items":{"type":"string"},"type":"array"}},"required":["package"],"type":"object"},"SoftwareRequirement":{"additionalProperties":false,"description":"A list of software packages that should be configured in the environment of\nthe defined process.","properties":{"class":{"const":"SoftwareRequirement","description":"Always 'SoftwareRequirement'","type":"string"},"packages":{"description":"The list of software to be configured.","items":{"anyOf":[{"$ref":"#/definitions/SoftwarePackage"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":["class","packages"],"type":"object"},"StepInputExpressionRequirement":{"additionalProperties":false,"description":"Indicate that the workflow platform must support the `valueFrom` field\nof [WorkflowStepInput](#WorkflowStepInput).","properties":{"class":{"const":"StepInputExpressionRequirement","description":"Always 'StepInputExpressionRequirement'","type":"string"}},"required":["class"],"type":"object"},"SubworkflowFeatureRequirement":{"additionalProperties":false,"description":"Indicates that the workflow platform must support nested workflows in\nthe `run` field of [WorkflowStep](#WorkflowStep).","properties":{"class":{"const":"SubworkflowFeatureRequirement","description":"Always 'SubworkflowFeatureRequirement'","type":"string"}},"required":["class"],"type":"object"},"T":{"additionalProperties":false,"type":"object"},"ToolTimeLimit":{"additionalProperties":false,"description":"Set an upper limit on the execution time of a CommandLineTool.\nA CommandLineTool whose execution duration exceeds the time\nlimit may be preemptively terminated and considered failed.\nMay also be used by batch systems to make scheduling decisions.\nThe execution duration excludes external operations, such as\nstaging of files, pulling a docker image etc, and only counts\nwall-time for the execution of the command line itself.","properties":{"class":{"const":"ToolTimeLimit","description":"Always 'ToolTimeLimit'","type":"string"},"timelimit":{"description":"The time limit, in seconds. A time limit of zero means no\ntime limit. Negative time limits are an error.","type":["string","number"]}},"required":["class","timelimit"],"type":"object"},"WorkReuse":{"additionalProperties":false,"description":"For implementations that support reusing output from past work (on\nthe assumption that same code and same input produce same\nresults), control whether to enable or disable the reuse behavior\nfor a particular tool or step (to accommodate situations where that\nassumption is incorrect). A reused step is not executed but\ninstead returns the same output as the original execution.\n\nIf `WorkReuse` is not specified, correct tools should assume it\nis enabled by default.","properties":{"class":{"const":"WorkReuse","description":"Always 'WorkReuse'","type":"string"},"enableReuse":{"type":["string","boolean"]}},"required":["class","enableReuse"],"type":"object"},"Workflow":{"description":"A workflow describes a set of **steps** and the **dependencies** between\nthose steps. When a step produces output that will be consumed by a\nsecond step, the first step is a dependency of the second step.\n\nWhen there is a dependency, the workflow engine must execute the preceding\nstep and wait for it to successfully produce output before executing the\ndependent step. If two steps are defined in the workflow graph that\nare not directly or indirectly dependent, these steps are **independent**,\nand may execute in any order or execute concurrently. A workflow is\ncomplete when all steps have been executed.\n\nDependencies between parameters are expressed using the `source`\nfield on [workflow step input parameters](#WorkflowStepInput) and\n`outputSource` field on [workflow output\nparameters](#WorkflowOutputParameter).\n\nThe `source` field on each workflow step input parameter expresses\nthe data links that contribute to the value of the step input\nparameter (the \"sink\"). A workflow step can only begin execution\nwhen every data link connected to a step has been fulfilled.\n\nThe `outputSource` field on each workflow step input parameter\nexpresses the data links that contribute to the value of the\nworkflow output parameter (the \"sink\"). Workflow execution cannot\ncomplete successfully until every data link connected to an output\nparameter has been fulfilled.\n\n## Workflow success and failure\n\nA completed step must result in one of `success`, `temporaryFailure` or\n`permanentFailure` states. An implementation may choose to retry a step\nexecution which resulted in `temporaryFailure`. An implementation may\nchoose to either continue running other steps of a workflow, or terminate\nimmediately upon `permanentFailure`.\n\n* If any step of a workflow execution results in `permanentFailure`, then\nthe workflow status is `permanentFailure`.\n\n* If one or more steps result in `temporaryFailure` and all other steps\ncomplete `success` or are not executed, then the workflow status is\n`temporaryFailure`.\n\n* If all workflow steps are executed and complete with `success`, then the\nworkflow status is `success`.\n\n# Extensions\n\n[ScatterFeatureRequirement](#ScatterFeatureRequirement) and\n[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) are\navailable as standard [extensions](#Extensions_and_Metadata) to core\nworkflow semantics.","properties":{"class":{"const":"Workflow","type":"string"},"cwlVersion":{"description":"CWL document version. Always required at the document root. Not\nrequired for a Process embedded inside another Process.","enum":["draft-2","draft-3","draft-3.dev1","draft-3.dev2","draft-3.dev3","draft-3.dev4","draft-3.dev5","draft-4.dev1","draft-4.dev2","draft-4.dev3","v1.0","v1.0.dev4","v1.1","v1.1.0-dev1","v1.2","v1.2.0-dev1","v1.2.0-dev2","v1.2.0-dev3","v1.2.0-dev4","v1.2.0-dev5"],"type":"string"},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"hints":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"id":{"description":"The unique identifier for this object.\n\nOnly useful for `$graph` at `Process` level. Should not be exposed\nto users in graphical or terminal user interfaces.","type":"string"},"inputs":{"description":"Defines the input parameters of the process. The process is ready to\nrun when all required input parameters are associated with concrete\nvalues. Input parameters include a schema for each parameter which is\nused to validate the input object. It may also be used to build a user\ninterface for constructing the input object.\n\nWhen accepting an input object, all input parameters must have a value.\nIf an input parameter is missing from the input object, it must be\nassigned a value of `null` (or the value of `default` for that\nparameter, if provided) for the purposes of validation and evaluation\nof expressions.","oneOf":[{"items":{"$ref":"#/definitions/WorkflowInputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/WorkflowInputParameter"},{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/WorkflowInputParameter"}]}}]}},"type":"object"}]},"intent":{"description":"An identifier for the type of computational operation, of this Process.\nEspecially useful for [`Operation`](Workflow.html#Operation), but can also be used for\n[`CommandLineTool`](CommandLineTool.html#CommandLineTool),\n[`Workflow`](Workflow.html#Workflow), or [ExpressionTool](Workflow.html#ExpressionTool).\n\nIf provided, then this must be an IRI of a concept node that\nrepresents the type of operation, preferably defined within an ontology.\n\nFor example, in the domain of bioinformatics, one can use an IRI from\nthe EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),\nlike [Alignment](http://edamontology.org/operation_2928),\nor [Clustering](http://edamontology.org/operation_3432); or a more\nspecific Operation concept like\n[Split read mapping](http://edamontology.org/operation_3199).","items":{"type":"string"},"type":"array"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"outputs":{"description":"Defines the parameters representing the output of the process. May be\nused to generate and/or validate the output object.","oneOf":[{"items":{"$ref":"#/definitions/WorkflowOutputParameter"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/WorkflowOutputParameter"},{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/WorkflowOutputParameter"}]}}]}},"type":"object"}]},"requirements":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this process. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"steps":{"description":"The individual steps that make up the workflow. Each step is executed when all of its\ninput data links are fulfilled. An implementation may choose to execute\nthe steps in a different order than listed and/or execute steps\nconcurrently, provided that dependencies between steps are met.","oneOf":[{"items":{"$ref":"#/definitions/WorkflowStep"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"$ref":"#/definitions/WorkflowStep"}},"type":"object"}]}},"required":["class","inputs","outputs","steps"],"type":"object"},"WorkflowInputParameter":{"additionalProperties":false,"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#WorkflowInputParameter","properties":{"default":{"description":"The default value to use for this parameter if the parameter is missing\nfrom the input object, or if the value of the parameter in the input\nobject is `null`. Default values are applied before evaluating expressions\n(e.g. dependent `valueFrom` fields)."},"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"id":{"description":"The unique identifier for this object.","type":"string"},"inputBinding":{"$ref":"#/definitions/InputBinding","description":"Deprecated. Preserved for v1.0 backwards compatibility. Will be removed in\nCWL v2.0. Use `WorkflowInputParameter.loadContents` instead."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"WorkflowOutputParameter":{"additionalProperties":false,"description":"Describe an output parameter of a workflow. The parameter must be\nconnected to one or more parameters defined in the workflow that\nwill provide the value of the output parameter. It is legal to\nconnect a WorkflowInputParameter to a WorkflowOutputParameter.\n\nSee [WorkflowStepInput](#WorkflowStepInput) for discussion of\n`linkMerge` and `pickValue`.","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"linkMerge":{"description":"The method to use to merge multiple sources into a single array.\nIf not specified, the default method is \"merge_nested\".","enum":["merge_flattened","merge_nested"],"type":"string"},"outputSource":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Specifies one or more names of an output from a workflow step (in the form\n`step_name/output_name` with a `/` separator`), or a workflow input name,\nthat supply their value(s) to the output parameter.\nthe output parameter. It is valid to reference workflow level inputs\nhere."},"pickValue":{"description":"The method to use to choose non-null elements among multiple sources.","enum":["all_non_null","first_non_null","the_only_non_null"],"type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"Specify valid types of data that may be assigned to this parameter."}},"required":["type"],"type":"object"},"WorkflowStep":{"additionalProperties":false,"description":"A workflow step is an executable element of a workflow. It specifies the\nunderlying process implementation (such as `CommandLineTool` or another\n`Workflow`) in the `run` field and connects the input and output parameters\nof the underlying process to workflow parameters.\n\n# Scatter/gather\n\nTo use scatter/gather,\n[ScatterFeatureRequirement](#ScatterFeatureRequirement) must be specified\nin the workflow or workflow step requirements.\n\nA \"scatter\" operation specifies that the associated workflow step or\nsubworkflow should execute separately over a list of input elements. Each\njob making up a scatter operation is independent and may be executed\nconcurrently.\n\nThe `scatter` field specifies one or more input parameters which will be\nscattered. An input parameter may be listed more than once. The declared\ntype of each input parameter implicitly becomes an array of items of the\ninput parameter type. If a parameter is listed more than once, it becomes\na nested array. As a result, upstream parameters which are connected to\nscattered parameters must be arrays.\n\nAll output parameter types are also implicitly wrapped in arrays. Each job\nin the scatter results in an entry in the output array.\n\nIf any scattered parameter runtime value is an empty array, all outputs are\nset to empty arrays and no work is done for the step, according to\napplicable scattering rules.\n\nIf `scatter` declares more than one input parameter, `scatterMethod`\ndescribes how to decompose the input into a discrete set of jobs.\n\n * **dotproduct** specifies that each of the input arrays are aligned and one\n element taken from each array to construct each job. It is an error\n if all input arrays are not the same length.\n\n * **nested_crossproduct** specifies the Cartesian product of the inputs,\n producing a job for every combination of the scattered inputs. The\n output must be nested arrays for each level of scattering, in the\n order that the input arrays are listed in the `scatter` field.\n\n * **flat_crossproduct** specifies the Cartesian product of the inputs,\n producing a job for every combination of the scattered inputs. The\n output arrays must be flattened to a single level, but otherwise listed in the\n order that the input arrays are listed in the `scatter` field.\n\n# Conditional execution (Optional)\n\nConditional execution makes execution of a step conditional on an\nexpression. A step that is not executed is \"skipped\". A skipped\nstep produces `null` for all output parameters.\n\nThe condition is evaluated after `scatter`, using the input object\nof each individual scatter job. This means over a set of scatter\njobs, some may be executed and some may be skipped. When the\nresults are gathered, skipped steps must be `null` in the output\narrays.\n\nThe `when` field controls conditional execution. This is an\nexpression that must be evaluated with `inputs` bound to the step\ninput object (or individual scatter job), and returns a boolean\nvalue. It is an error if this expression returns a value other\nthan `true` or `false`.\n\nConditionals in CWL are an optional feature and are not required\nto be implemented by all consumers of CWL documents. An\nimplementation that does not support conditionals must return a\nfatal error when attempting to execute a workflow that uses\nconditional constructs the implementation does not support.\n\n# Subworkflows\n\nTo specify a nested workflow as part of a workflow step,\n[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) must be\nspecified in the workflow or workflow step requirements.\n\nIt is a fatal error if a workflow directly or indirectly invokes itself as\na subworkflow (recursive workflows are not allowed).","properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"hints":{"description":"Declares hints applying to either the runtime environment or the\nworkflow engine that may be helpful in executing this workflow step. It is\nnot an error if an implementation cannot satisfy all hints, however\nthe implementation may report a warning.","items":{},"type":"array"},"id":{"description":"The unique identifier for this object.","type":"string"},"in":{"description":"Defines the input parameters of the workflow step. The process is ready to\nrun when all required input parameters are associated with concrete\nvalues. Input parameters include a schema for each parameter which is\nused to validate the input object. It may also be used build a user\ninterface for constructing the input object.","oneOf":[{"items":{"$ref":"#/definitions/WorkflowStepInput"},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"oneOf":[{"$ref":"#/definitions/WorkflowStepInput"},{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/definitions/WorkflowStepInput"}]}}]}},"type":"object"}]},"label":{"description":"A short, human-readable label of this object.","type":"string"},"out":{"description":"Defines the parameters representing the output of the process. May be\nused to generate and/or validate the output object.","items":{"anyOf":[{"$ref":"#/definitions/WorkflowStepOutput"},{"type":"string"}]},"type":"array"},"requirements":{"description":"Declares requirements that apply to either the runtime environment or the\nworkflow engine that must be met in order to execute this workflow step. If\nan implementation cannot satisfy all requirements, or a requirement is\nlisted which is not recognized by the implementation, it is a fatal\nerror and the implementation must not attempt to run the process,\nunless overridden at user option.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"},{"$ref":"#/definitions/InlineJavascriptRequirement"},{"$ref":"#/definitions/SchemaDefRequirement"},{"$ref":"#/definitions/LoadListingRequirement"},{"$ref":"#/definitions/DockerRequirement"},{"$ref":"#/definitions/SoftwareRequirement"},{"$ref":"#/definitions/InitialWorkDirRequirement"},{"$ref":"#/definitions/EnvVarRequirement"},{"$ref":"#/definitions/ShellCommandRequirement"},{"$ref":"#/definitions/ResourceRequirement"},{"$ref":"#/definitions/WorkReuse"},{"$ref":"#/definitions/NetworkAccess"},{"$ref":"#/definitions/InplaceUpdateRequirement"},{"$ref":"#/definitions/ToolTimeLimit"},{"$ref":"#/definitions/SubworkflowFeatureRequirement"},{"$ref":"#/definitions/ScatterFeatureRequirement"},{"$ref":"#/definitions/MultipleInputFeatureRequirement"},{"$ref":"#/definitions/StepInputExpressionRequirement"}]},"type":"array"},{"type":"object","properties":{"InlineJavascriptRequirement":{"anyOf":[{"$ref":"#/definitions/InlineJavascriptRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SchemaDefRequirement":{"anyOf":[{"$ref":"#/definitions/SchemaDefRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"LoadListingRequirement":{"anyOf":[{"$ref":"#/definitions/LoadListingRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"DockerRequirement":{"anyOf":[{"$ref":"#/definitions/DockerRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SoftwareRequirement":{"anyOf":[{"$ref":"#/definitions/SoftwareRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InitialWorkDirRequirement":{"anyOf":[{"$ref":"#/definitions/InitialWorkDirRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"EnvVarRequirement":{"anyOf":[{"$ref":"#/definitions/EnvVarRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ShellCommandRequirement":{"anyOf":[{"$ref":"#/definitions/ShellCommandRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ResourceRequirement":{"anyOf":[{"$ref":"#/definitions/ResourceRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"WorkReuse":{"anyOf":[{"$ref":"#/definitions/WorkReuseMap"},{"type":"object","properties":{},"additionalProperties":false}]},"NetworkAccess":{"anyOf":[{"$ref":"#/definitions/NetworkAccessMap"},{"type":"object","properties":{},"additionalProperties":false}]},"InplaceUpdateRequirement":{"anyOf":[{"$ref":"#/definitions/InplaceUpdateRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ToolTimeLimit":{"anyOf":[{"$ref":"#/definitions/ToolTimeLimitMap"},{"type":"object","properties":{},"additionalProperties":false}]},"SubworkflowFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/SubworkflowFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"ScatterFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/ScatterFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"MultipleInputFeatureRequirement":{"anyOf":[{"$ref":"#/definitions/MultipleInputFeatureRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]},"StepInputExpressionRequirement":{"anyOf":[{"$ref":"#/definitions/StepInputExpressionRequirementMap"},{"type":"object","properties":{},"additionalProperties":false}]}},"additionalProperties":false}]},"run":{"anyOf":[{"$ref":"#/definitions/CommandLineTool"},{"$ref":"#/definitions/ExpressionTool"},{"$ref":"#/definitions/Workflow"},{"$ref":"#/definitions/Operation"},{"type":"string"}],"description":"Specifies the process to run. If `run` is a string, it must be an absolute IRI\nor a relative path from the primary document."},"scatter":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}]},"scatterMethod":{"description":"Required if `scatter` is an array of more than one element.","enum":["dotproduct","flat_crossproduct","nested_crossproduct"],"type":"string"},"when":{"description":"If defined, only run the step when the expression evaluates to\n`true`. If `false` the step is skipped. A skipped step\nproduces a `null` on each output.","type":"string"}},"required":["in","out","run"],"type":"object"},"WorkflowStepInput":{"additionalProperties":false,"description":"The input of a workflow step connects an upstream parameter (from the\nworkflow inputs, or the outputs of other workflows steps) with the input\nparameters of the process specified by the `run` field. Only input parameters\ndeclared by the target process will be passed through at runtime to the process\nthough additional parameters may be specified (for use within `valueFrom`\nexpressions for instance) - unconnected or unused parameters do not represent an\nerror condition.\n\n# Input object\n\nA WorkflowStepInput object must contain an `id` field in the form\n`#fieldname` or `#prefix/fieldname`. When the `id` field contains a slash\n`/` the field name consists of the characters following the final slash\n(the prefix portion may contain one or more slashes to indicate scope).\nThis defines a field of the workflow step input object with the value of\nthe `source` parameter(s).\n\n# Merging multiple inbound data links\n\nTo merge multiple inbound data links,\n[MultipleInputFeatureRequirement](#MultipleInputFeatureRequirement) must be specified\nin the workflow or workflow step requirements.\n\nIf the sink parameter is an array, or named in a [workflow\nscatter](#WorkflowStep) operation, there may be multiple inbound\ndata links listed in the `source` field. The values from the\ninput links are merged depending on the method specified in the\n`linkMerge` field. If both `linkMerge` and `pickValue` are null\nor not specified, and there is more than one element in the\n`source` array, the default method is \"merge_nested\".\n\nIf both `linkMerge` and `pickValue` are null or not specified, and\nthere is only a single element in the `source`, then the input\nparameter takes the scalar value from the single input link (it is\n*not* wrapped in a single-list).\n\n* **merge_nested**\n\n The input must be an array consisting of exactly one entry for each\n input link. If \"merge_nested\" is specified with a single link, the value\n from the link must be wrapped in a single-item list.\n\n* **merge_flattened**\n\n 1. The source and sink parameters must be compatible types, or the source\n type must be compatible with single element from the \"items\" type of\n the destination array parameter.\n 2. Source parameters which are arrays are concatenated.\n Source parameters which are single element types are appended as\n single elements.\n\n# Picking non-null values among inbound data links\n\nIf present, `pickValue` specifies how to pick non-null values among inbound data links.\n\n`pickValue` is evaluated\n 1. Once all source values from upstream step or parameters are available.\n 2. After `linkMerge`.\n 3. Before `scatter` or `valueFrom`.\n\nThis is specifically intended to be useful in combination with\n[conditional execution](#WorkflowStep), where several upstream\nsteps may be connected to a single input (`source` is a list), and\nskipped steps produce null values.\n\nStatic type checkers should check for type consistency after inferring what the type\nwill be after `pickValue` is applied, just as they do currently for `linkMerge`.\n\n* **first_non_null**\n\n For the first level of a list input, pick the first non-null element. The result is a scalar.\n It is an error if there is no non-null element. Examples:\n * `[null, x, null, y] -> x`\n * `[null, [null], null, y] -> [null]`\n * `[null, null, null] -> Runtime Error`\n\n *Intended use case*: If-else pattern where the\n value comes either from a conditional step or from a default or\n fallback value. The conditional step(s) should be placed first in\n the list.\n\n* **the_only_non_null**\n\n For the first level of a list input, pick the single non-null element. The result is a scalar.\n It is an error if there is more than one non-null element. Examples:\n\n * `[null, x, null] -> x`\n * `[null, x, null, y] -> Runtime Error`\n * `[null, [null], null] -> [null]`\n * `[null, null, null] -> Runtime Error`\n\n *Intended use case*: Switch type patterns where developer considers\n more than one active code path as a workflow error\n (possibly indicating an error in writing `when` condition expressions).\n\n* **all_non_null**\n\n For the first level of a list input, pick all non-null values.\n The result is a list, which may be empty. Examples:\n\n * `[null, x, null] -> [x]`\n * `[x, null, y] -> [x, y]`\n * `[null, [x], [null]] -> [[x], [null]]`\n * `[null, null, null] -> []`\n\n *Intended use case*: It is valid to have more than one source, but\n sources are conditional, so null sources (from skipped steps)\n should be filtered out.","properties":{"default":{"description":"The default value for this parameter to use if either there is no\n`source` field, or the value produced by the `source` is `null`. The\ndefault must be applied prior to scattering or evaluating `valueFrom`."},"id":{"description":"The unique identifier for this object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"linkMerge":{"description":"The method to use to merge multiple inbound links into a single array.\nIf not specified, the default method is \"merge_nested\".","enum":["merge_flattened","merge_nested"],"type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"pickValue":{"description":"The method to use to choose non-null elements among multiple sources.","enum":["all_non_null","first_non_null","the_only_non_null"],"type":"string"},"source":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Specifies one or more workflow parameters that will provide input to\nthe underlying step parameter."},"valueFrom":{"description":"To use valueFrom, [StepInputExpressionRequirement](#StepInputExpressionRequirement) must\nbe specified in the workflow or workflow step requirements.\n\nIf `valueFrom` is a constant string value, use this as the value for\nthis input parameter.\n\nIf `valueFrom` is a parameter reference or expression, it must be\nevaluated to yield the actual value to be assigned to the input field.\n\nThe `self` value in the parameter reference or expression must be\n1. `null` if there is no `source` field\n2. the value of the parameter(s) specified in the `source` field when this\nworkflow input parameter **is not** specified in this workflow step's `scatter` field.\n3. an element of the parameter specified in the `source` field when this workflow input\nparameter **is** specified in this workflow step's `scatter` field.\n\nThe value of `inputs` in the parameter reference or expression must be\nthe input object to the workflow step after assigning the `source`\nvalues, applying `default`, and then scattering. The order of\nevaluating `valueFrom` among step input parameters is undefined and the\nresult of evaluating `valueFrom` on a parameter must not be visible to\nevaluation of `valueFrom` on other parameters.","type":"string"}},"required":[],"type":"object"},"WorkflowStepOutput":{"additionalProperties":false,"description":"Associate an output parameter of the underlying process with a workflow\nparameter. The workflow parameter (given in the `id` field) be may be used\nas a `source` to connect with input parameters of other workflow steps, or\nwith an output parameter of the process.\n\nA unique identifier for this workflow output parameter. This is\nthe identifier to use in the `source` field of `WorkflowStepInput`\nto connect the output value to downstream parameters.","properties":{"id":{"description":"The unique identifier for this object.","type":"string"}},"required":[],"type":"object"},"CWLImportManual":{"description":"Represents an '$import' directive that should point toward another compatible CWL file to import where specified. The contents of the imported file should be relevant contextually where it is being imported","$comment":"The schema validation of the CWL will not itself perform the '$import' to resolve and validate its contents. Therefore, the complete schema will not be validated entirely, and could still be partially malformed. To ensure proper and exhaustive validation of a CWL definition with this schema, all '$import' directives should be resolved and extended beforehand","type":"object","properties":{"$import":{"type":"string"}},"required":["$import"],"additionalProperties":false},"CWLIncludeManual":{"description":"Represents an '$include' directive that should point toward another compatible CWL file to import where specified. The contents of the imported file should be relevant contextually where it is being imported","$comment":"The schema validation of the CWL will not itself perform the '$include' to resolve and validate its contents. Therefore, the complete schema will not be validated entirely, and could still be partially malformed. To ensure proper and exhaustive validation of a CWL definition with this schema, all '$include' directives should be resolved and extended beforehand","type":"object","properties":{"$include":{"type":"string"}},"required":["$include"],"additionalProperties":false},"CWLDocumentMetadata":{"description":"Metadata for a CWL document","type":"object","properties":{"$namespaces":{"description":"The namespaces used in the document","type":"object","patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"type":"string"}}},"$schemas":{"description":"The schemas used in the document","type":"array","items":{"type":"string"}}},"patternProperties":{"^\\w+:.*$":{"type":"object"},"^\\w+:\\/\\/.*":{"type":"object"}},"required":[]},"CommandInputRecordFieldMap":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandInputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"inputBinding":{"$ref":"#/definitions/CommandLineBinding","description":"Describes how to turn this object into command line arguments."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"type":"object","required":["type"]},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},{"type":"string"}]},"InputRecordFieldMap":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#InputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis must be one or more IRIs of concept nodes\nthat represents file formats which are allowed as input to this\nparameter, preferably defined within an ontology. If no ontology is\navailable, file formats may be tested by exact match."},"label":{"description":"A short, human-readable label of this object.","type":"string"},"loadContents":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nIf true, the file (or each file in the array) must be a UTF-8\ntext file 64 KiB or smaller, and the implementation must read\nthe entire contents of the file (or file array) and place it\nin the `contents` field of the File object for use by\nexpressions. If the size of the file is greater than 64 KiB,\nthe implementation must raise a fatal error.","type":"boolean"},"loadListing":{"description":"Only valid when `type: Directory` or is an array of `items: Directory`.\n\nSpecify the desired behavior for loading the `listing` field of\na Directory object for use by expressions.\n\nThe order of precedence for loadListing is:\n\n 1. `loadListing` on an individual parameter\n 2. Inherited from `LoadListingRequirement`\n 3. By default: `no_listing`","enum":["deep_listing","no_listing","shallow_listing"],"type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"type":"object","required":["type"]},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/InputRecordSchema"},{"$ref":"#/definitions/InputEnumSchema"},{"$ref":"#/definitions/InputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},{"type":"string"}]},"CommandOutputRecordFieldMap":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#CommandOutputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The name of the field","type":"string"},"outputBinding":{"$ref":"#/definitions/CommandOutputBinding","description":"Describes how to generate this output object based on the files\nproduced by a CommandLineTool"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"type":"object","required":["type"]},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"items":{"anyOf":[{"$ref":"#/definitions/CommandOutputArraySchema"},{"$ref":"#/definitions/CommandOutputRecordSchema"},{"$ref":"#/definitions/CommandOutputEnumSchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},{"type":"string"}]},"OutputRecordFieldMap":{"description":"Auto-generated class implementation for https://w3id.org/cwl/cwl#OutputRecordField","oneOf":[{"additionalProperties":false,"properties":{"doc":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"A documentation string for this object, or an array of strings which should be concatenated."},"format":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nThis is the file format that will be assigned to the output\nFile object.","type":"string"},"label":{"description":"A short, human-readable label of this object.","type":"string"},"name":{"description":"The name of the field","type":"string"},"secondaryFiles":{"anyOf":[{"$ref":"#/definitions/SecondaryFileSchema"},{"items":{"$ref":"#/definitions/SecondaryFileSchema"},"type":"array"}],"description":"Only valid when `type: File` or is an array of `items: File`.\n\nProvides a pattern or expression specifying files or\ndirectories that should be included alongside the primary\nfile. Secondary files may be required or optional. When not\nexplicitly specified, secondary files specified for `inputs`\nare required and `outputs` are optional. An implementation\nmust include matching Files and Directories in the\n`secondaryFiles` property of the primary file. These Files\nand Directories must be transferred and staged alongside the\nprimary file. An implementation may fail workflow execution\nif a required secondary file does not exist.\n\nIf the value is an expression, the value of `self` in the expression\nmust be the primary input or output File object to which this binding\napplies. The `basename`, `nameroot` and `nameext` fields must be\npresent in `self`. For `CommandLineTool` outputs the `path` field must\nalso be present. The expression must return a filename string relative\nto the path to the primary File, a File or Directory object with either\n`path` or `location` and `basename` fields set, or an array consisting\nof strings or File or Directory objects. It is legal to reference an\nunchanged File or Directory object taken from input as a secondaryFile.\nThe expression may return \"null\" in which case there is no secondaryFile\nfrom that expression.\n\nTo work on non-filename-preserving storage systems, portable tool\ndescriptions should avoid constructing new values from `location`, but\nshould construct relative references using `basename` or `nameroot`\ninstead.\n\nIf a value in `secondaryFiles` is a string that is not an expression,\nit specifies that the following pattern should be applied to the path\nof the primary file to yield a filename relative to the primary File:\n\n 1. If string ends with `?` character, remove the last `?` and mark\n the resulting secondary file as optional.\n 2. If string begins with one or more caret `^` characters, for each\n caret, remove the last file extension from the path (the last\n period `.` and all following characters). If there are no file\n extensions, the path is unchanged.\n 3. Append the remainder of the string to the end of the file path."},"streamable":{"description":"Only valid when `type: File` or is an array of `items: File`.\n\nA value of `true` indicates that the file is read or written\nsequentially without seeking. An implementation may use this flag to\nindicate whether it is valid to stream file contents using a named\npipe. Default: `false`.","type":"boolean"},"type":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},"type":"object","required":["type"]},{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"items":{"anyOf":[{"$ref":"#/definitions/OutputRecordSchema"},{"$ref":"#/definitions/OutputEnumSchema"},{"$ref":"#/definitions/OutputArraySchema"},{"type":"string"}]},"type":"array"},{"type":"string"}],"description":"The field type"}},{"type":"string"}]},"InlineJavascriptRequirementMap":{"type":"object","properties":{"expressionLib":{"description":"Additional code fragments that will also be inserted\nbefore executing the expression code. Allows for function definitions that may\nbe called from CWL expressions.","items":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":[],"description":"Indicates that the workflow platform must support inline Javascript expressions.\nIf this requirement is not present, the workflow platform must not perform expression\ninterpolation."},"SchemaDefRequirementMap":{"type":"object","properties":{"types":{"description":"The list of type definitions.","items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/CommandInputArraySchema"},{"$ref":"#/definitions/CommandInputRecordSchema"},{"$ref":"#/definitions/CommandInputEnumSchema"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":["types"],"description":"This field consists of an array of type definitions which must be used when\ninterpreting the `inputs` and `outputs` fields. When a `type` field\ncontains a IRI, the implementation must check if the type is defined in\n`schemaDefs` and use that definition. If the type is not found in\n`schemaDefs`, it is an error. The entries in `schemaDefs` must be\nprocessed in the order listed such that later schema definitions may refer\nto earlier schema definitions.\n\n- **Type definitions are allowed for `enum` and `record` types only.**\n- Type definitions may be shared by defining them in a file and then\n `$include`-ing them in the `types` field.\n- A file can contain a list of type definitions"},"LoadListingRequirementMap":{"type":"object","properties":{"loadListing":{"enum":["deep_listing","no_listing","shallow_listing"],"type":"string"}},"required":[],"description":"Specify the desired behavior for loading the `listing` field of\na Directory object for use by expressions."},"DockerRequirementMap":{"type":"object","properties":{"dockerFile":{"description":"Supply the contents of a Dockerfile which will be built using `docker build`.","type":"string"},"dockerImageId":{"description":"The image id that will be used for `docker run`. May be a\nhuman-readable image name or the image identifier hash. May be skipped\nif `dockerPull` is specified, in which case the `dockerPull` image id\nmust be used.","type":"string"},"dockerImport":{"description":"Provide HTTP URL to download and gunzip a Docker images using `docker import.","type":"string"},"dockerLoad":{"description":"Specify an HTTP URL from which to download a Docker image using `docker load`.","type":"string"},"dockerOutputDirectory":{"description":"Set the designated output directory to a specific location inside the\nDocker container.","type":"string"},"dockerPull":{"description":"Specify a Docker image to retrieve using `docker pull`. Can contain the\nimmutable digest to ensure an exact container is used:\n`dockerPull: ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`","type":"string"}},"required":[],"description":"Indicates that a workflow component should be run in a\n[Docker](https://docker.com) or Docker-compatible (such as\n[Singularity](https://www.sylabs.io/) and [udocker](https://github.com/indigo-dc/udocker)) container environment and\nspecifies how to fetch or build the image.\n\nIf a CommandLineTool lists `DockerRequirement` under\n`hints` (or `requirements`), it may (or must) be run in the specified Docker\ncontainer.\n\nThe platform must first acquire or install the correct Docker image as\nspecified by `dockerPull`, `dockerImport`, `dockerLoad` or `dockerFile`.\n\nThe platform must execute the tool in the container using `docker run` with\nthe appropriate Docker image and tool command line.\n\nThe workflow platform may provide input files and the designated output\ndirectory through the use of volume bind mounts. The platform should rewrite\nfile paths in the input object to correspond to the Docker bind mounted\nlocations. That is, the platform should rewrite values in the parameter context\nsuch as `runtime.outdir`, `runtime.tmpdir` and others to be valid paths\nwithin the container. The platform must ensure that `runtime.outdir` and\n`runtime.tmpdir` are distinct directories.\n\nWhen running a tool contained in Docker, the workflow platform must not\nassume anything about the contents of the Docker container, such as the\npresence or absence of specific software, except to assume that the\ngenerated command line represents a valid command within the runtime\nenvironment of the container.\n\nA container image may specify an\n[ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint)\nand/or\n[CMD](https://docs.docker.com/engine/reference/builder/#cmd).\nCommand line arguments will be appended after all elements of\nENTRYPOINT, and will override all elements specified using CMD (in\nother words, CMD is only used when the CommandLineTool definition\nproduces an empty command line).\n\nUse of implicit ENTRYPOINT or CMD are discouraged due to reproducibility\nconcerns of the implicit hidden execution point (For further discussion, see\n[https://doi.org/10.12688/f1000research.15140.1](https://doi.org/10.12688/f1000research.15140.1)). Portable\nCommandLineTool wrappers in which use of a container is optional must not rely on ENTRYPOINT or CMD.\nCommandLineTools which do rely on ENTRYPOINT or CMD must list `DockerRequirement` in the\n`requirements` section.\n\n## Interaction with other requirements\n\nIf [EnvVarRequirement](#EnvVarRequirement) is specified alongside a\nDockerRequirement, the environment variables must be provided to Docker\nusing `--env` or `--env-file` and interact with the container's preexisting\nenvironment as defined by Docker."},"SoftwareRequirementMap":{"type":"object","properties":{"packages":{"description":"The list of software to be configured.","items":{"anyOf":[{"$ref":"#/definitions/SoftwarePackage"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"}},"required":["packages"],"description":"A list of software packages that should be configured in the environment of\nthe defined process."},"InitialWorkDirRequirementMap":{"type":"object","properties":{"listing":{"anyOf":[{"items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"},{"items":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Directory"},{"$ref":"#/definitions/File"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"$ref":"#/definitions/Dirent"},{"type":"string"}]},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"type":"string"}],"description":"The list of files or subdirectories that must be staged prior\nto executing the command line tool.\n\nReturn type of each expression must validate as `[\"null\",\nFile, Directory, Dirent, {type: array, items: [File,\nDirectory]}]`.\n\nEach `File` or `Directory` that is returned by an Expression\nmust be added to the designated output directory prior to\nexecuting the tool.\n\nEach `Dirent` record that is listed or returned by an\nexpression specifies a file to be created or staged in the\ndesignated output directory prior to executing the tool.\n\nExpressions may return null, in which case they have no effect.\n\nFiles or Directories which are listed in the input parameters\nand appear in the `InitialWorkDirRequirement` listing must\nhave their `path` set to their staged location. If the same\nFile or Directory appears more than once in the\n`InitialWorkDirRequirement` listing, the implementation must\nchoose exactly one value for `path`; how this value is chosen\nis undefined."}},"required":[],"description":"Define a list of files and subdirectories that must be staged by the workflow platform prior to executing the command line tool.\nNormally files are staged within the designated output directory. However, when running inside containers, files may be staged at arbitrary locations, see discussion for [`Dirent.entryname`](#Dirent). Together with `DockerRequirement.dockerOutputDirectory` it is possible to control the locations of both input and output files when running in containers."},"EnvVarRequirementMap":{"type":"object","properties":{"envDef":{"description":"The list of environment variables.","oneOf":[{"items":{"anyOf":[{"$ref":"#/definitions/EnvironmentDef"},{"$ref":"#/definitions/CWLImportManual"},{"$ref":"#/definitions/CWLIncludeManual"}]},"type":"array"},{"patternProperties":{"^[_a-zA-Z][a-zA-Z0-9_-]*$":{"type":"string"}}}]}},"required":["envDef"],"description":"Define a list of environment variables which will be set in the\nexecution environment of the tool. See `EnvironmentDef` for details."},"ShellCommandRequirementMap":{"type":"object","properties":{},"required":[],"description":"Modify the behavior of CommandLineTool to generate a single string\ncontaining a shell command line. Each item in the `arguments` list must\nbe joined into a string separated by single spaces and quoted to prevent\ninterpretation by the shell, unless `CommandLineBinding` for that argument\ncontains `shellQuote: false`. If `shellQuote: false` is specified, the\nargument is joined into the command string without quoting, which allows\nthe use of shell metacharacters such as `|` for pipes."},"ResourceRequirementMap":{"type":"object","properties":{"coresMax":{"description":"Maximum reserved number of CPU cores.\n\nSee `coresMin` for discussion about fractional CPU requests.","type":["string","number"]},"coresMin":{"description":"Minimum reserved number of CPU cores (default is 1).\n\nMay be a fractional value to indicate to a scheduling\nalgorithm that one core can be allocated to multiple\njobs. For example, a value of 0.25 indicates that up to 4\njobs may run in parallel on 1 core. A value of 1.25 means\nthat up to 3 jobs can run on a 4 core system (4/1.25 \u2248 3).\n\nProcesses can only share a core allocation if the sum of each\nof their `ramMax`, `tmpdirMax`, and `outdirMax` requests also\ndo not exceed the capacity of the node.\n\nProcesses sharing a core must have the same level of isolation\n(typically a container or VM) that they would normally have.\n\nThe reported number of CPU cores reserved for the process,\nwhich is available to expressions on the CommandLineTool as\n`runtime.cores`, must be a non-zero integer, and may be\ncalculated by rounding up the cores request to the next whole\nnumber.\n\nScheduling systems may allocate fractional CPU resources by\nsetting quotas or scheduling weights. Scheduling systems that\ndo not support fractional CPUs may round up the request to the\nnext whole number.","type":["string","number"]},"outdirMax":{"description":"Maximum reserved filesystem based storage for the designated output directory, in mebibytes (2**20)\n\nSee `outdirMin` for discussion about fractional storage requests.","type":["string","number"]},"outdirMin":{"description":"Minimum reserved filesystem based storage for the designated output directory, in mebibytes (2**20) (default is 1024)\n\nMay be a fractional value. If so, the actual storage request\nmust be rounded up to the next whole number. The reported\namount of storage reserved for the process, which is available\nto expressions on the CommandLineTool as `runtime.outdirSize`,\nmust be a non-zero integer.","type":["string","number"]},"ramMax":{"description":"Maximum reserved RAM in mebibytes (2**20)\n\nSee `ramMin` for discussion about fractional RAM requests.","type":["string","number"]},"ramMin":{"description":"Minimum reserved RAM in mebibytes (2**20) (default is 256)\n\nMay be a fractional value. If so, the actual RAM request must\nbe rounded up to the next whole number. The reported amount of\nRAM reserved for the process, which is available to\nexpressions on the CommandLineTool as `runtime.ram`, must be a\nnon-zero integer.","type":["string","number"]},"tmpdirMax":{"description":"Maximum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20)\n\nSee `tmpdirMin` for discussion about fractional storage requests.","type":["string","number"]},"tmpdirMin":{"description":"Minimum reserved filesystem based storage for the designated temporary directory, in mebibytes (2**20) (default is 1024)\n\nMay be a fractional value. If so, the actual storage request\nmust be rounded up to the next whole number. The reported\namount of storage reserved for the process, which is available\nto expressions on the CommandLineTool as `runtime.tmpdirSize`,\nmust be a non-zero integer.","type":["string","number"]}},"required":[],"description":"Specify basic hardware resource requirements.\n\n\"min\" is the minimum amount of a resource that must be reserved to\nschedule a job. If \"min\" cannot be satisfied, the job should not\nbe run.\n\n\"max\" is the maximum amount of a resource that the job shall be\nallocated. If a node has sufficient resources, multiple jobs may\nbe scheduled on a single node provided each job's \"max\" resource\nrequirements are met. If a job attempts to exceed its resource\nallocation, an implementation may deny additional resources, which\nmay result in job failure.\n\nIf both \"min\" and \"max\" are specified, an implementation may\nchoose to allocate any amount between \"min\" and \"max\", with the\nactual allocation provided in the `runtime` object.\n\nIf \"min\" is specified but \"max\" is not, then \"max\" == \"min\"\nIf \"max\" is specified by \"min\" is not, then \"min\" == \"max\".\n\nIt is an error if max < min.\n\nIt is an error if the value of any of these fields is negative.\n\nIf neither \"min\" nor \"max\" is specified for a resource, use the default values below."},"WorkReuseMap":{"type":"object","properties":{"enableReuse":{"type":["string","boolean"]}},"required":["enableReuse"],"description":"For implementations that support reusing output from past work (on\nthe assumption that same code and same input produce same\nresults), control whether to enable or disable the reuse behavior\nfor a particular tool or step (to accommodate situations where that\nassumption is incorrect). A reused step is not executed but\ninstead returns the same output as the original execution.\n\nIf `WorkReuse` is not specified, correct tools should assume it\nis enabled by default."},"NetworkAccessMap":{"type":"object","properties":{"networkAccess":{"type":["string","boolean"]}},"required":["networkAccess"],"description":"Indicate whether a process requires outgoing IPv4/IPv6 network\naccess. Choice of IPv4 or IPv6 is implementation and site\nspecific, correct tools must support both.\n\nIf `networkAccess` is false or not specified, tools must not\nassume network access, except for localhost (the loopback device).\n\nIf `networkAccess` is true, the tool must be able to make outgoing\nconnections to network resources. Resources may be on a private\nsubnet or the public Internet. However, implementations and sites\nmay apply their own security policies to restrict what is\naccessible by the tool.\n\nEnabling network access does not imply a publicly routable IP\naddress or the ability to accept inbound connections."},"InplaceUpdateRequirementMap":{"type":"object","properties":{"inplaceUpdate":{"type":"boolean"}},"required":["inplaceUpdate"],"description":"\nIf `inplaceUpdate` is true, then an implementation supporting this\nfeature may permit tools to directly update files with `writable:\ntrue` in InitialWorkDirRequirement. That is, as an optimization,\nfiles may be destructively modified in place as opposed to copied\nand updated.\n\nAn implementation must ensure that only one workflow step may\naccess a writable file at a time. It is an error if a file which\nis writable by one workflow step file is accessed (for reading or\nwriting) by any other workflow step running independently.\nHowever, a file which has been updated in a previous completed\nstep may be used as input to multiple steps, provided it is\nread-only in every step.\n\nWorkflow steps which modify a file must produce the modified file\nas output. Downstream steps which further process the file must\nuse the output of previous steps, and not refer to a common input\n(this is necessary for both ordering and correctness).\n\nWorkflow authors should provide this in the `hints` section. The\nintent of this feature is that workflows produce the same results\nwhether or not InplaceUpdateRequirement is supported by the\nimplementation, and this feature is primarily available as an\noptimization for particular environments.\n\nUsers and implementers should be aware that workflows that\ndestructively modify inputs may not be repeatable or reproducible.\nIn particular, enabling this feature implies that WorkReuse should\nnot be enabled."},"ToolTimeLimitMap":{"type":"object","properties":{"timelimit":{"description":"The time limit, in seconds. A time limit of zero means no\ntime limit. Negative time limits are an error.","type":["string","number"]}},"required":["timelimit"],"description":"Set an upper limit on the execution time of a CommandLineTool.\nA CommandLineTool whose execution duration exceeds the time\nlimit may be preemptively terminated and considered failed.\nMay also be used by batch systems to make scheduling decisions.\nThe execution duration excludes external operations, such as\nstaging of files, pulling a docker image etc, and only counts\nwall-time for the execution of the command line itself."},"SubworkflowFeatureRequirementMap":{"type":"object","properties":{},"required":[],"description":"Indicates that the workflow platform must support nested workflows in\nthe `run` field of [WorkflowStep](#WorkflowStep)."},"ScatterFeatureRequirementMap":{"type":"object","properties":{},"required":[],"description":"Indicates that the workflow platform must support the `scatter` and\n`scatterMethod` fields of [WorkflowStep](#WorkflowStep)."},"MultipleInputFeatureRequirementMap":{"type":"object","properties":{},"required":[],"description":"Indicates that the workflow platform must support multiple inbound data links\nlisted in the `source` field of [WorkflowStepInput](#WorkflowStepInput)."},"StepInputExpressionRequirementMap":{"type":"object","properties":{},"required":[],"description":"Indicate that the workflow platform must support the `valueFrom` field\nof [WorkflowStepInput](#WorkflowStepInput)."},"CWLFile":{"type":"object","allOf":[{"oneOf":[{"$ref":"#/definitions/Workflow"},{"$ref":"#/definitions/CommandLineTool"},{"$ref":"#/definitions/ExpressionTool"}]},{"oneOf":[{"$ref":"#/definitions/CWLDocumentMetadata"}]}],"properties":{"inputs":true,"stdout":true,"hints":true,"temporaryFailCodes":true,"doc":true,"$schemas":true,"requirements":true,"cwlVersion":true,"successCodes":true,"baseCommand":true,"permanentFailCodes":true,"id":true,"expression":true,"steps":true,"stdin":true,"intent":true,"arguments":true,"stderr":true,"outputs":true,"$namespaces":true,"class":true,"label":true},"patternProperties":{"^\\w+:.*$":{"type":"object"},"^\\w+:\\/\\/.*":{"type":"object"}},"additionalProperties":false},"CWLGraph":{"type":"object","properties":{"$graph":{"type":"array","items":{"$ref":"#/definitions/CWLFile"}},"cwlVersion":{"description":"CWL document version. Always required at the document root. Not\nrequired for a Process embedded inside another Process.","enum":["draft-2","draft-3","draft-3.dev1","draft-3.dev2","draft-3.dev3","draft-3.dev4","draft-3.dev5","draft-4.dev1","draft-4.dev2","draft-4.dev3","v1.0","v1.0.dev4","v1.1","v1.1.0-dev1","v1.2","v1.2.0-dev1","v1.2.0-dev2","v1.2.0-dev3","v1.2.0-dev4","v1.2.0-dev5"],"type":"string"}},"required":["$graph"]},"CWLGraphOrFile":{"type":"object","additionalProperties":false,"allOf":[{"oneOf":[{"$ref":"#/definitions/CWLGraph"},{"$ref":"#/definitions/CWLFile"}]},{"$ref":"#/definitions/CWLDocumentMetadata"}],"properties":{"inputs":true,"stdout":true,"hints":true,"temporaryFailCodes":true,"doc":true,"$schemas":true,"requirements":true,"cwlVersion":true,"successCodes":true,"baseCommand":true,"permanentFailCodes":true,"id":true,"expression":true,"steps":true,"stdin":true,"intent":true,"$graph":true,"arguments":true,"stderr":true,"outputs":true,"$namespaces":true,"class":true,"label":true},"patternProperties":{"^\\w+:.*$":{"type":"object"},"^\\w+:\\/\\/.*":{"type":"object"}}}}}
|
Provide a JSON object that satisfies the schema "cwl_schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
cwl_schema
|
schema-store
|
schema_store_235
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration\",\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"type\":\"object\",\"definitions\":{\"cypressConfig\":{\"properties\":{\"baseUrl\":{\"type\":\"string\",\"default\":null,\"description\":\"Url used as prefix for cy.visit() or cy.request() command\\u2019s url. Example http://localhost:3030 or https://test.my-domain.com\"},\"env\":{\"type\":\"object\",\"description\":\"Any values to be set as environment variables. See https://on.cypress.io/environment-variables\",\"body\":{}},\"ignoreTestFiles\":{\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"},\"description\":\"A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.\"},\"numTestsKeptInMemory\":{\"type\":\"number\",\"default\":50,\"description\":\"The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run.\"},\"port\":{\"type\":\"number\",\"default\":null,\"description\":\"Port used to host Cypress. Normally this is a randomly generated port\"},\"reporter\":{\"type\":\"string\",\"default\":\"spec\",\"description\":\"The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters\"},\"reporterOptions\":{\"type\":\"object\",\"default\":null,\"description\":\"The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options\"},\"slowTestThreshold\":{\"type\":\"number\",\"default\":10000,\"description\":\"Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts\"},\"testFiles\":{\"type\":[\"string\",\"array\"],\"default\":\"**/*.*\",\"description\":\"A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global\"},\"watchForFileChanges\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will watch and restart tests on test file changes\"},\"defaultCommandTimeout\":{\"type\":\"number\",\"default\":4000,\"description\":\"Time, in milliseconds, to wait until most DOM based commands are considered timed out\"},\"execTimeout\":{\"type\":\"number\",\"default\":60000,\"description\":\"Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command\"},\"taskTimeout\":{\"type\":\"number\",\"default\":60000,\"description\":\"Time, in milliseconds, to wait for a task to finish executing during a cy.task() command\"},\"pageLoadTimeout\":{\"type\":\"number\",\"default\":60000,\"description\":\"Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased.\"},\"requestTimeout\":{\"type\":\"number\",\"default\":5000,\"description\":\"Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command\"},\"responseTimeout\":{\"type\":\"number\",\"default\":30000,\"description\":\"Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands\"},\"fileServerFolder\":{\"type\":\"string\",\"default\":\"root project folder\",\"description\":\"Path to folder where application files will attempt to be served from\"},\"fixturesFolder\":{\"type\":[\"string\",\"boolean\"],\"default\":\"cypress/fixtures\",\"description\":\"Path to folder containing fixture files (Pass false to disable)\"},\"integrationFolder\":{\"type\":\"string\",\"default\":\"cypress/integration\",\"description\":\"Path to folder containing integration test files\"},\"downloadsFolder\":{\"type\":\"string\",\"default\":\"cypress/downloads\",\"description\":\"Path to folder where files downloaded during a test are saved\"},\"componentFolder\":{\"type\":[\"string\",\"boolean\"],\"default\":false,\"description\":\"Path to folder containing component test files (Pass false to disable)\"},\"pluginsFile\":{\"type\":[\"string\",\"boolean\"],\"default\":\"cypress/plugins/index.js\",\"description\":\"Path to plugins file. (Pass false to disable)\"},\"screenshotOnRunFailure\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will take a screenshot when a test fails during cypress run\"},\"screenshotsFolder\":{\"type\":\"string\",\"default\":\"cypress/screenshots\",\"description\":\"Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run\"},\"supportFile\":{\"type\":[\"string\",\"boolean\"],\"default\":\"cypress/support/index.js\",\"description\":\"Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)\"},\"videosFolder\":{\"type\":\"string\",\"default\":\"cypress/videos\",\"description\":\"Path to folder where videos will be saved during cypress run\"},\"trashAssetsBeforeRuns\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run\"},\"videoCompression\":{\"type\":[\"number\",\"boolean\"],\"default\":32,\"description\":\"The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size).\"},\"video\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will capture a video of the tests run with cypress run\"},\"videoUploadOnPasses\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you\\u2019d like to only upload the spec file\\u2019s video when there are failing tests.\"},\"chromeWebSecurity\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security\"},\"userAgent\":{\"type\":\"string\",\"default\":null,\"description\":\"Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent\"},\"blockHosts\":{\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"},\"default\":null,\"description\":\"A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts\"},\"modifyObstructiveCode\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode\"},\"viewportHeight\":{\"type\":\"number\",\"default\":660,\"description\":\"Default height in pixels for the application under tests\\u2019 viewport (Override with cy.viewport() command)\"},\"viewportWidth\":{\"type\":\"number\",\"default\":1000,\"description\":\"Default width in pixels for the application under tests\\u2019 viewport. (Override with cy.viewport() command)\"},\"animationDistanceThreshold\":{\"type\":\"number\",\"default\":5,\"description\":\"The distance in pixels an element must exceed over time to be considered animating\"},\"waitForAnimations\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether to wait for elements to finish animating before executing commands\"},\"scrollBehavior\":{\"enum\":[false,\"center\",\"top\",\"bottom\",\"nearest\"],\"default\":\"top\",\"description\":\"Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling.\"},\"projectId\":{\"type\":\"string\",\"default\":null,\"description\":\"A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification\"},\"nodeVersion\":{\"enum\":[\"system\",\"bundled\"],\"default\":\"system\",\"description\":\"DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files.\"},\"experimentalInteractiveRunEvents\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.\"},\"experimentalSourceRewriting\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm.\"},\"experimentalSessionSupport\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Enable experimental session support. See https://on.cypress.io/session\"},\"experimentalFetchPolyfill\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Polyfills `window.fetch` to enable Network spying and stubbing\"},\"experimentalStudio\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Generate and save commands directly to your test suite by interacting with your app as an end user would.\"},\"retries\":{\"type\":[\"object\",\"number\",\"null\"],\"default\":{\"runMode\":0,\"openMode\":0},\"description\":\"The number of times to retry a failing. Can be configured to apply only in runMode or openMode\"},\"includeShadowDom\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()\"},\"clientCertificates\":{\"description\":\"Defines client certificates to use when sending requests to the specified URLs\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"url\":{\"description\":\"Requests for URLs matching this minimatch pattern will use the supplied client certificate\",\"type\":\"string\"},\"ca\":{\"description\":\"Path(s) to CA file(s) to validate certs against, relative to project root\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"certs\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"description\":\"PEM file specific properties\",\"type\":\"object\",\"properties\":{\"cert\":{\"description\":\"Path to the certificate, relative to project root\",\"type\":\"string\"},\"key\":{\"description\":\"Path to the private key, relative to project root\",\"type\":\"string\"},\"passphrase\":{\"description\":\"(Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root\",\"type\":\"string\"}},\"required\":[\"cert\",\"key\"]},{\"description\":\"PFX file specific properties\",\"type\":\"object\",\"properties\":{\"pfx\":{\"description\":\"Path to the certificate container, relative to project root\",\"type\":\"string\"},\"passphrase\":{\"description\":\"(Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root\",\"type\":\"string\"}},\"required\":[\"pfx\"]}]}}},\"required\":[\"url\",\"certs\"]}}}}},\"allOf\":[{\"$ref\":\"#/definitions/cypressConfig\"},{\"properties\":{\"component\":{\"description\":\"Any component runner specific overrides\",\"$ref\":\"#/definitions/cypressConfig\"},\"e2e\":{\"description\":\"Any e2e runner specific overrides\",\"$ref\":\"#/definitions/cypressConfig\"}}}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration","$schema":"http://json-schema.org/draft-04/schema#","type":"object","definitions":{"cypressConfig":{"properties":{"baseUrl":{"type":"string","default":null,"description":"Url used as prefix for cy.visit() or cy.request() command\u2019s url. Example http://localhost:3030 or https://test.my-domain.com"},"env":{"type":"object","description":"Any values to be set as environment variables. See https://on.cypress.io/environment-variables","body":{}},"ignoreTestFiles":{"type":["string","array"],"items":{"type":"string"},"description":"A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match."},"numTestsKeptInMemory":{"type":"number","default":50,"description":"The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run."},"port":{"type":"number","default":null,"description":"Port used to host Cypress. Normally this is a randomly generated port"},"reporter":{"type":"string","default":"spec","description":"The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters"},"reporterOptions":{"type":"object","default":null,"description":"The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options"},"slowTestThreshold":{"type":"number","default":10000,"description":"Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts"},"testFiles":{"type":["string","array"],"default":"**/*.*","description":"A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global"},"watchForFileChanges":{"type":"boolean","default":true,"description":"Whether Cypress will watch and restart tests on test file changes"},"defaultCommandTimeout":{"type":"number","default":4000,"description":"Time, in milliseconds, to wait until most DOM based commands are considered timed out"},"execTimeout":{"type":"number","default":60000,"description":"Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command"},"taskTimeout":{"type":"number","default":60000,"description":"Time, in milliseconds, to wait for a task to finish executing during a cy.task() command"},"pageLoadTimeout":{"type":"number","default":60000,"description":"Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased."},"requestTimeout":{"type":"number","default":5000,"description":"Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command"},"responseTimeout":{"type":"number","default":30000,"description":"Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands"},"fileServerFolder":{"type":"string","default":"root project folder","description":"Path to folder where application files will attempt to be served from"},"fixturesFolder":{"type":["string","boolean"],"default":"cypress/fixtures","description":"Path to folder containing fixture files (Pass false to disable)"},"integrationFolder":{"type":"string","default":"cypress/integration","description":"Path to folder containing integration test files"},"downloadsFolder":{"type":"string","default":"cypress/downloads","description":"Path to folder where files downloaded during a test are saved"},"componentFolder":{"type":["string","boolean"],"default":false,"description":"Path to folder containing component test files (Pass false to disable)"},"pluginsFile":{"type":["string","boolean"],"default":"cypress/plugins/index.js","description":"Path to plugins file. (Pass false to disable)"},"screenshotOnRunFailure":{"type":"boolean","default":true,"description":"Whether Cypress will take a screenshot when a test fails during cypress run"},"screenshotsFolder":{"type":"string","default":"cypress/screenshots","description":"Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run"},"supportFile":{"type":["string","boolean"],"default":"cypress/support/index.js","description":"Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)"},"videosFolder":{"type":"string","default":"cypress/videos","description":"Path to folder where videos will be saved during cypress run"},"trashAssetsBeforeRuns":{"type":"boolean","default":true,"description":"Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run"},"videoCompression":{"type":["number","boolean"],"default":32,"description":"The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size)."},"video":{"type":"boolean","default":true,"description":"Whether Cypress will capture a video of the tests run with cypress run"},"videoUploadOnPasses":{"type":"boolean","default":true,"description":"Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you\u2019d like to only upload the spec file\u2019s video when there are failing tests."},"chromeWebSecurity":{"type":"boolean","default":true,"description":"Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security"},"userAgent":{"type":"string","default":null,"description":"Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent"},"blockHosts":{"type":["string","array"],"items":{"type":"string"},"default":null,"description":"A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts"},"modifyObstructiveCode":{"type":"boolean","default":true,"description":"Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode"},"viewportHeight":{"type":"number","default":660,"description":"Default height in pixels for the application under tests\u2019 viewport (Override with cy.viewport() command)"},"viewportWidth":{"type":"number","default":1000,"description":"Default width in pixels for the application under tests\u2019 viewport. (Override with cy.viewport() command)"},"animationDistanceThreshold":{"type":"number","default":5,"description":"The distance in pixels an element must exceed over time to be considered animating"},"waitForAnimations":{"type":"boolean","default":true,"description":"Whether to wait for elements to finish animating before executing commands"},"scrollBehavior":{"enum":[false,"center","top","bottom","nearest"],"default":"top","description":"Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling."},"projectId":{"type":"string","default":null,"description":"A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification"},"nodeVersion":{"enum":["system","bundled"],"default":"system","description":"DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files."},"experimentalInteractiveRunEvents":{"type":"boolean","default":false,"description":"Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode."},"experimentalSourceRewriting":{"type":"boolean","default":false,"description":"Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm."},"experimentalSessionSupport":{"type":"boolean","default":false,"description":"Enable experimental session support. See https://on.cypress.io/session"},"experimentalFetchPolyfill":{"type":"boolean","default":false,"description":"Polyfills `window.fetch` to enable Network spying and stubbing"},"experimentalStudio":{"type":"boolean","default":false,"description":"Generate and save commands directly to your test suite by interacting with your app as an end user would."},"retries":{"type":["object","number","null"],"default":{"runMode":0,"openMode":0},"description":"The number of times to retry a failing. Can be configured to apply only in runMode or openMode"},"includeShadowDom":{"type":"boolean","default":false,"description":"Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()"},"clientCertificates":{"description":"Defines client certificates to use when sending requests to the specified URLs","type":"array","items":{"type":"object","properties":{"url":{"description":"Requests for URLs matching this minimatch pattern will use the supplied client certificate","type":"string"},"ca":{"description":"Path(s) to CA file(s) to validate certs against, relative to project root","type":"array","items":{"type":"string"}},"certs":{"type":"array","items":{"anyOf":[{"description":"PEM file specific properties","type":"object","properties":{"cert":{"description":"Path to the certificate, relative to project root","type":"string"},"key":{"description":"Path to the private key, relative to project root","type":"string"},"passphrase":{"description":"(Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root","type":"string"}},"required":["cert","key"]},{"description":"PFX file specific properties","type":"object","properties":{"pfx":{"description":"Path to the certificate container, relative to project root","type":"string"},"passphrase":{"description":"(Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root","type":"string"}},"required":["pfx"]}]}}},"required":["url","certs"]}}}}},"allOf":[{"$ref":"#/definitions/cypressConfig"},{"properties":{"component":{"description":"Any component runner specific overrides","$ref":"#/definitions/cypressConfig"},"e2e":{"description":"Any e2e runner specific overrides","$ref":"#/definitions/cypressConfig"}}}]}
|
Provide a JSON object that satisfies the schema "JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration
|
schema-store
|
schema_store_236
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dart-build\",\"$ref\":\"#/definitions/buildConfig\",\"definitions\":{\"_listOfGlobs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"buildConfig\":{\"type\":\"object\",\"properties\":{\"targets\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/buildTarget\"},\"propertyNames\":{\"$ref\":\"#/definitions/targetKey\"}},\"builders\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/builderDefinition\"},\"propertyNames\":{\"$ref\":\"#/definitions/builderKey\"}},\"post_process_builders\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/postProcessBuilderDefinition\"}},\"global_options\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/globalBuilderOptions\"}},\"additional_public_assets\":{\"$ref\":\"#/definitions/_listOfGlobs\"}},\"additionalProperties\":false},\"buildTarget\":{\"type\":\"object\",\"properties\":{\"auto_apply_builders\":{\"type\":\"boolean\",\"default\":true},\"builders\":{\"type\":\"object\",\"propertyNames\":{\"$ref\":\"#/definitions/builderKey\"},\"additionalProperties\":{\"$ref\":\"#/definitions/targetBuilderConfig\"}},\"dependencies\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/targetKey\"}},\"sources\":{\"$ref\":\"#/definitions/inputSet\"}},\"additionalProperties\":false},\"builderDefinition\":{\"type\":\"object\",\"properties\":{\"builder_factories\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"import\":{\"type\":\"string\"},\"build_extensions\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"auto_apply\":{\"$ref\":\"#/definitions/autoApply\",\"default\":\"none\"},\"required_inputs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"runs_before\":{\"$ref\":\"#/definitions/runsBefore\"},\"applies_builders\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/builderKey\"}},\"is_optional\":{\"type\":\"boolean\",\"default\":false},\"build_to\":{\"$ref\":\"#/definitions/buildTo\",\"default\":\"cache\"},\"defaults\":{\"$ref\":\"#/definitions/targetBuilderConfigDefaults\"},\"target\":{\"type\":\"string\",\"title\":\"The name of the dart_library target that contains the import\",\"deprecated\":true,\"deprecationMessage\":\"May be null or unreliable and should not be used.\"}},\"additionalProperties\":false},\"postProcessBuilderDefinition\":{\"type\":\"object\",\"properties\":{\"builder_factory\":{\"type\":\"string\"},\"import\":{\"type\":\"string\"},\"input_extensions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"defaults\":{\"$ref\":\"#/definitions/targetBuilderConfigDefaults\"}},\"additionalProperties\":false},\"inputSet\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"include\":{\"$ref\":\"#/definitions/_listOfGlobs\"},\"exclude\":{\"$ref\":\"#/definitions/_listOfGlobs\"}},\"additionalProperties\":false},{\"$comment\":\"Use List<String> directly, inferred to mean include.\",\"$ref\":\"#/definitions/_listOfGlobs\"}]},\"targetBuilderConfig\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"default\":true},\"generate_for\":{\"$ref\":\"#/definitions/inputSet\"},\"options\":{\"$ref\":\"#/definitions/builderOptions\"},\"dev_options\":{\"$ref\":\"#/definitions/builderOptions\"},\"release_options\":{\"$ref\":\"#/definitions/builderOptions\"}},\"additionalProperties\":false},\"targetBuilderConfigDefaults\":{\"type\":\"object\",\"properties\":{\"generate_for\":{\"$ref\":\"#/definitions/inputSet\"},\"options\":{\"$ref\":\"#/definitions/builderOptions\"},\"dev_options\":{\"$ref\":\"#/definitions/builderOptions\"},\"release_options\":{\"$ref\":\"#/definitions/builderOptions\"}},\"additionalProperties\":false},\"globalBuilderOptions\":{\"type\":\"object\",\"properties\":{\"options\":{\"$ref\":\"#/definitions/builderOptions\"},\"dev_options\":{\"$ref\":\"#/definitions/builderOptions\"},\"release_options\":{\"$ref\":\"#/definitions/builderOptions\"},\"runs_before\":{\"$ref\":\"#/definitions/runsBefore\"}},\"additionalProperties\":false},\"builderOptions\":{\"type\":\"object\",\"title\":\"Options to apply to a builder\",\"description\":\"An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.\",\"additionalProperties\":true},\"autoApply\":{\"type\":\"string\",\"description\":\"On which packages the builder is applied by default\",\"enum\":[\"none\",\"dependents\",\"all_packages\",\"root_package\"]},\"buildTo\":{\"type\":\"string\",\"description\":\"Whether the outputs should be stored in a hidden cache or in the source directory.\",\"enum\":[\"cache\",\"source\"]},\"targetKey\":{\"type\":\"string\",\"title\":\"An identifier for a target\",\"description\":\"A target key has two parts, a package and a name. They are separated by a colon.\",\"pattern\":\"^(?:\\\\w+:)?\\\\w+|\\\\$default$\"},\"builderKey\":{\"type\":\"string\",\"title\":\"An identifier for a builder\",\"description\":\"To construct a key, you join the package name and the builder name with a colon.\",\"pattern\":\"^(?:\\\\w*:)?\\\\w+$\"},\"runsBefore\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/builderKey\"}}},\"description\":\"Configuration for Dart's build system\",\"title\":\"build.yaml files\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"build.yaml files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dart-build","$ref":"#/definitions/buildConfig","definitions":{"_listOfGlobs":{"type":"array","items":{"type":"string"}},"buildConfig":{"type":"object","properties":{"targets":{"type":"object","additionalProperties":{"$ref":"#/definitions/buildTarget"},"propertyNames":{"$ref":"#/definitions/targetKey"}},"builders":{"type":"object","additionalProperties":{"$ref":"#/definitions/builderDefinition"},"propertyNames":{"$ref":"#/definitions/builderKey"}},"post_process_builders":{"type":"object","additionalProperties":{"$ref":"#/definitions/postProcessBuilderDefinition"}},"global_options":{"type":"object","additionalProperties":{"$ref":"#/definitions/globalBuilderOptions"}},"additional_public_assets":{"$ref":"#/definitions/_listOfGlobs"}},"additionalProperties":false},"buildTarget":{"type":"object","properties":{"auto_apply_builders":{"type":"boolean","default":true},"builders":{"type":"object","propertyNames":{"$ref":"#/definitions/builderKey"},"additionalProperties":{"$ref":"#/definitions/targetBuilderConfig"}},"dependencies":{"type":"array","items":{"$ref":"#/definitions/targetKey"}},"sources":{"$ref":"#/definitions/inputSet"}},"additionalProperties":false},"builderDefinition":{"type":"object","properties":{"builder_factories":{"type":"array","items":{"type":"string"}},"import":{"type":"string"},"build_extensions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"auto_apply":{"$ref":"#/definitions/autoApply","default":"none"},"required_inputs":{"type":"array","items":{"type":"string"}},"runs_before":{"$ref":"#/definitions/runsBefore"},"applies_builders":{"type":"array","items":{"$ref":"#/definitions/builderKey"}},"is_optional":{"type":"boolean","default":false},"build_to":{"$ref":"#/definitions/buildTo","default":"cache"},"defaults":{"$ref":"#/definitions/targetBuilderConfigDefaults"},"target":{"type":"string","title":"The name of the dart_library target that contains the import","deprecated":true,"deprecationMessage":"May be null or unreliable and should not be used."}},"additionalProperties":false},"postProcessBuilderDefinition":{"type":"object","properties":{"builder_factory":{"type":"string"},"import":{"type":"string"},"input_extensions":{"type":"array","items":{"type":"string"}},"defaults":{"$ref":"#/definitions/targetBuilderConfigDefaults"}},"additionalProperties":false},"inputSet":{"oneOf":[{"type":"object","properties":{"include":{"$ref":"#/definitions/_listOfGlobs"},"exclude":{"$ref":"#/definitions/_listOfGlobs"}},"additionalProperties":false},{"$comment":"Use List<String> directly, inferred to mean include.","$ref":"#/definitions/_listOfGlobs"}]},"targetBuilderConfig":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"generate_for":{"$ref":"#/definitions/inputSet"},"options":{"$ref":"#/definitions/builderOptions"},"dev_options":{"$ref":"#/definitions/builderOptions"},"release_options":{"$ref":"#/definitions/builderOptions"}},"additionalProperties":false},"targetBuilderConfigDefaults":{"type":"object","properties":{"generate_for":{"$ref":"#/definitions/inputSet"},"options":{"$ref":"#/definitions/builderOptions"},"dev_options":{"$ref":"#/definitions/builderOptions"},"release_options":{"$ref":"#/definitions/builderOptions"}},"additionalProperties":false},"globalBuilderOptions":{"type":"object","properties":{"options":{"$ref":"#/definitions/builderOptions"},"dev_options":{"$ref":"#/definitions/builderOptions"},"release_options":{"$ref":"#/definitions/builderOptions"},"runs_before":{"$ref":"#/definitions/runsBefore"}},"additionalProperties":false},"builderOptions":{"type":"object","title":"Options to apply to a builder","description":"An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.","additionalProperties":true},"autoApply":{"type":"string","description":"On which packages the builder is applied by default","enum":["none","dependents","all_packages","root_package"]},"buildTo":{"type":"string","description":"Whether the outputs should be stored in a hidden cache or in the source directory.","enum":["cache","source"]},"targetKey":{"type":"string","title":"An identifier for a target","description":"A target key has two parts, a package and a name. They are separated by a colon.","pattern":"^(?:\\w+:)?\\w+|\\$default$"},"builderKey":{"type":"string","title":"An identifier for a builder","description":"To construct a key, you join the package name and the builder name with a colon.","pattern":"^(?:\\w*:)?\\w+$"},"runsBefore":{"type":"array","items":{"$ref":"#/definitions/builderKey"}}},"description":"Configuration for Dart's build system","title":"build.yaml files"}
|
Provide a JSON object that satisfies the schema "build.yaml files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
build.yaml files
|
schema-store
|
schema_store_237
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dart-test\",\"$ref\":\"#/definitions/runnerConfiguration\",\"definitions\":{\"timeout\":{\"$comment\":\"Based on https://github.com/dart-lang/test/blob/3b8d3b90efd24f55f7316cd414716d1cb031761c/pkgs/test_api/lib/src/frontend/timeout.dart#L55-L68\",\"oneOf\":[{\"enum\":[\"none\"],\"title\":\"No timeout\",\"description\":\"Indicates that tests should never time out.\"},{\"type\":\"string\",\"title\":\"Exact timeout\",\"description\":\"Exact timeout duration for a test.\",\"pattern\":\"^(?:[^a-df-zA-DF-Z\\\\s]+(?:[umUM][sS]|[dhmsDHMS])\\\\s?)+$\",\"examples\":[\"1m\",\"30s\",\"1m 30s\"]},{\"type\":\"string\",\"title\":\"Multiplicative timeout\",\"description\":\"Timeout is applied as a multiple of the default value (30 seconds)\",\"pattern\":\"^[^a-df-zA-DF-Z\\\\s]+[xX]$\",\"examples\":[\"12x\",\"1.5X\"]}]},\"skip\":{\"oneOf\":[{\"type\":\"boolean\",\"title\":\"Skip the test if true\"},{\"type\":\"string\",\"title\":\"Reason for skipping the test\"}]},\"executable\":{\"type\":\"string\",\"description\":\"The executable to run. Can be a plain basename, an absolute path or a relative path on Windows.\"},\"browserAndNodeSettings\":{\"type\":\"object\",\"title\":\"Settings for browsers and Node.js\",\"additionalProperties\":false,\"properties\":{\"arguments\":{\"type\":\"string\",\"title\":\"Extra arguments to the executable\",\"description\":\"The arguments are parsed in the same way as the POSIX shell\"},\"executable\":{\"oneOf\":[{\"$ref\":\"#/definitions/executable\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"linux\":{\"$ref\":\"#/definitions/executable\"},\"mac_os\":{\"$ref\":\"#/definitions/executable\"},\"windows\":{\"$ref\":\"#/definitions/executable\"}}}]},\"headless\":{\"type\":\"boolean\",\"title\":\"Run the browser in headless mode\"}}},\"foldStackFrameOptions\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"except\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"only\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}]},\"testConfiguration\":{\"$comment\":\"Based on https://github.com/dart-lang/test/blob/master/pkgs/test/doc/configuration.md#test-configuration\",\"type\":\"object\",\"properties\":{\"timeout\":{\"$ref\":\"#/definitions/timeout\"},\"verbose_trace\":{\"type\":\"boolean\",\"title\":\"Remove internal stack frames\",\"description\":\"This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.\",\"default\":false},\"chain_stack_traces\":{\"type\":\"boolean\",\"title\":\"Whether stack traces are chained\",\"description\":\"Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability.\"},\"js_trace\":{\"type\":\"boolean\",\"title\":\"Convert JS traces to Dart traces\",\"description\":\"Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.\",\"default\":false},\"skip\":{\"$ref\":\"#/definitions/skip\"},\"retry\":{\"type\":\"number\",\"description\":\"This field controls how many times a test is retried upon failure.\"},\"test_on\":{\"type\":\"string\",\"examples\":[\"browser && !ie\"]},\"tags\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/_testConfigurationInner\"}},\"add_tags\":{\"type\":\"array\",\"description\":\"Adds additional tags. This is usually used in a tag definition to enable tag inheritance.\",\"items\":{\"type\":\"string\"}},\"on_platform\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/_testConfigurationInner\"}}}},\"_testConfigurationInner\":{\"$comment\":\"presets and on_os can have different properties when used in a test vs runner configuration. We make runnerConfiguration extend from testConfiguration, so this configuration is used when we're definitely in a non-runner configuration context.\",\"allOf\":[{\"$ref\":\"#/definitions/testConfiguration\"},{\"properties\":{\"presets\":{\"type\":\"object\",\"description\":\"A preset used in a test configuration can contain test configuration.\",\"additionalProperties\":{\"$ref\":\"#/definitions/testConfiguration\"}},\"on_os\":{\"type\":\"object\",\"description\":\"Applies test options when a specific operating system is used\",\"additionalProperties\":{\"$ref\":\"#/definitions/testConfiguration\"}}}}]},\"runnerConfiguration\":{\"allOf\":[{\"$comment\":\"Runner configurations are a superset of test configurations\",\"$ref\":\"#/definitions/testConfiguration\"},{\"properties\":{\"include\":{\"type\":\"string\",\"format\":\"uri\"},\"paths\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"default\":[\"test\"]},\"filename\":{\"type\":\"string\",\"description\":\"Filename pattern that the test runner uses to find test files in directories.\"},\"names\":{\"type\":\"array\",\"description\":\"Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.\",\"items\":{\"type\":\"string\"}},\"plain_names\":{\"type\":\"array\",\"description\":\"This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.\",\"items\":{\"type\":\"string\"}},\"include_tags\":{\"type\":\"string\",\"description\":\"This field causes the runner to only run tests whose tags match the given boolean selector.\"},\"exclude_tags\":{\"type\":\"string\",\"description\":\"This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags\"},\"platforms\":{\"description\":\"The platforms on which tests should be run.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"default\":[\"vm\"]},\"concurrency\":{\"type\":\"integer\",\"description\":\"The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency\"},\"pause_after_load\":{\"type\":\"boolean\",\"description\":\"Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts.\"},\"run_skipped\":{\"type\":\"boolean\",\"description\":\"Run tests even if they're marked as skipped.\"},\"reporter\":{\"type\":\"string\",\"description\":\"This field indicates the default reporter to use.\",\"examples\":[\"compact\",\"expanded\",\"json\"]},\"file_reporters\":{\"type\":\"object\",\"description\":\"Specifies additional reporters that will write their output to a file rather than stdout\",\"additionalProperties\":{\"type\":\"string\"}},\"fold_stack_frames\":{\"$ref\":\"#/definitions/foldStackFrameOptions\"},\"custom_html_template_path\":{\"description\":\"This field specifies the path of the HTML template to be used for tests run in an HTML environment.\",\"type\":\"string\"},\"presets\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/runnerConfiguration\"}},\"add_presets\":{\"type\":\"array\",\"description\":\"Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.\",\"items\":{\"type\":\"string\"}},\"on_os\":{\"type\":\"object\",\"description\":\"Applies test or runner options when a specific operating system is used\",\"additionalProperties\":{\"$ref\":\"#/definitions/runnerConfiguration\"}},\"override_platforms\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"settings\":{\"$ref\":\"#/definitions/browserAndNodeSettings\"}}}},\"define_platforms\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"extends\":{\"type\":\"string\"},\"settings\":{\"$ref\":\"#/definitions/browserAndNodeSettings\"}}}}}}]}},\"description\":\"Configuration for Dart tests\",\"title\":\"dart_test.yaml\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dart_test.yaml\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dart-test","$ref":"#/definitions/runnerConfiguration","definitions":{"timeout":{"$comment":"Based on https://github.com/dart-lang/test/blob/3b8d3b90efd24f55f7316cd414716d1cb031761c/pkgs/test_api/lib/src/frontend/timeout.dart#L55-L68","oneOf":[{"enum":["none"],"title":"No timeout","description":"Indicates that tests should never time out."},{"type":"string","title":"Exact timeout","description":"Exact timeout duration for a test.","pattern":"^(?:[^a-df-zA-DF-Z\\s]+(?:[umUM][sS]|[dhmsDHMS])\\s?)+$","examples":["1m","30s","1m 30s"]},{"type":"string","title":"Multiplicative timeout","description":"Timeout is applied as a multiple of the default value (30 seconds)","pattern":"^[^a-df-zA-DF-Z\\s]+[xX]$","examples":["12x","1.5X"]}]},"skip":{"oneOf":[{"type":"boolean","title":"Skip the test if true"},{"type":"string","title":"Reason for skipping the test"}]},"executable":{"type":"string","description":"The executable to run. Can be a plain basename, an absolute path or a relative path on Windows."},"browserAndNodeSettings":{"type":"object","title":"Settings for browsers and Node.js","additionalProperties":false,"properties":{"arguments":{"type":"string","title":"Extra arguments to the executable","description":"The arguments are parsed in the same way as the POSIX shell"},"executable":{"oneOf":[{"$ref":"#/definitions/executable"},{"type":"object","additionalProperties":false,"properties":{"linux":{"$ref":"#/definitions/executable"},"mac_os":{"$ref":"#/definitions/executable"},"windows":{"$ref":"#/definitions/executable"}}}]},"headless":{"type":"boolean","title":"Run the browser in headless mode"}}},"foldStackFrameOptions":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"except":{"type":"array","items":{"type":"string"}}}},{"type":"object","additionalProperties":false,"properties":{"only":{"type":"array","items":{"type":"string"}}}}]},"testConfiguration":{"$comment":"Based on https://github.com/dart-lang/test/blob/master/pkgs/test/doc/configuration.md#test-configuration","type":"object","properties":{"timeout":{"$ref":"#/definitions/timeout"},"verbose_trace":{"type":"boolean","title":"Remove internal stack frames","description":"This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.","default":false},"chain_stack_traces":{"type":"boolean","title":"Whether stack traces are chained","description":"Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability."},"js_trace":{"type":"boolean","title":"Convert JS traces to Dart traces","description":"Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.","default":false},"skip":{"$ref":"#/definitions/skip"},"retry":{"type":"number","description":"This field controls how many times a test is retried upon failure."},"test_on":{"type":"string","examples":["browser && !ie"]},"tags":{"type":"object","additionalProperties":{"$ref":"#/definitions/_testConfigurationInner"}},"add_tags":{"type":"array","description":"Adds additional tags. This is usually used in a tag definition to enable tag inheritance.","items":{"type":"string"}},"on_platform":{"type":"object","additionalProperties":{"$ref":"#/definitions/_testConfigurationInner"}}}},"_testConfigurationInner":{"$comment":"presets and on_os can have different properties when used in a test vs runner configuration. We make runnerConfiguration extend from testConfiguration, so this configuration is used when we're definitely in a non-runner configuration context.","allOf":[{"$ref":"#/definitions/testConfiguration"},{"properties":{"presets":{"type":"object","description":"A preset used in a test configuration can contain test configuration.","additionalProperties":{"$ref":"#/definitions/testConfiguration"}},"on_os":{"type":"object","description":"Applies test options when a specific operating system is used","additionalProperties":{"$ref":"#/definitions/testConfiguration"}}}}]},"runnerConfiguration":{"allOf":[{"$comment":"Runner configurations are a superset of test configurations","$ref":"#/definitions/testConfiguration"},{"properties":{"include":{"type":"string","format":"uri"},"paths":{"type":"array","items":{"type":"string"},"default":["test"]},"filename":{"type":"string","description":"Filename pattern that the test runner uses to find test files in directories."},"names":{"type":"array","description":"Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.","items":{"type":"string"}},"plain_names":{"type":"array","description":"This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.","items":{"type":"string"}},"include_tags":{"type":"string","description":"This field causes the runner to only run tests whose tags match the given boolean selector."},"exclude_tags":{"type":"string","description":"This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags"},"platforms":{"description":"The platforms on which tests should be run.","type":"array","items":{"type":"string"},"default":["vm"]},"concurrency":{"type":"integer","description":"The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency"},"pause_after_load":{"type":"boolean","description":"Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts."},"run_skipped":{"type":"boolean","description":"Run tests even if they're marked as skipped."},"reporter":{"type":"string","description":"This field indicates the default reporter to use.","examples":["compact","expanded","json"]},"file_reporters":{"type":"object","description":"Specifies additional reporters that will write their output to a file rather than stdout","additionalProperties":{"type":"string"}},"fold_stack_frames":{"$ref":"#/definitions/foldStackFrameOptions"},"custom_html_template_path":{"description":"This field specifies the path of the HTML template to be used for tests run in an HTML environment.","type":"string"},"presets":{"type":"object","additionalProperties":{"$ref":"#/definitions/runnerConfiguration"}},"add_presets":{"type":"array","description":"Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.","items":{"type":"string"}},"on_os":{"type":"object","description":"Applies test or runner options when a specific operating system is used","additionalProperties":{"$ref":"#/definitions/runnerConfiguration"}},"override_platforms":{"type":"object","additionalProperties":{"type":"object","properties":{"settings":{"$ref":"#/definitions/browserAndNodeSettings"}}}},"define_platforms":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"extends":{"type":"string"},"settings":{"$ref":"#/definitions/browserAndNodeSettings"}}}}}}]}},"description":"Configuration for Dart tests","title":"dart_test.yaml"}
|
Provide a JSON object that satisfies the schema "dart_test.yaml". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
dart_test.yaml
|
schema-store
|
schema_store_238
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).\",\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"definitions\":{\"CodeGeneration\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (database-driven)\",\"description\":\"The `CodeGeneration` object defines global properties that are used to drive the underlying database-driven code generation.\",\"properties\":{\"schema\":{\"type\":\"string\",\"title\":\"The name of the `Schema` where the artefacts are defined in, or should be created in, the database.\",\"description\":\"This is used as the default `Schema` for all child objects.\"},\"replace\":{\"type\":\"boolean\",\"title\":\"Indicates whether the existing database object should be replaced/altered or whether the object is dropped and recreated.\",\"description\":\"Defaults to `true`.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the `IsDeleted` capability.\",\"description\":\"Defaults to `IsDeleted`.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the `TenantId` capability.\",\"description\":\"Defaults to `TenantId`.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the `OrgUnitId` capability.\",\"description\":\"Defaults to `OrgUnitId`.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the `RowVersion` capability.\",\"description\":\"Defaults to `RowVersion`.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedBy` capability.\",\"description\":\"Defaults to `CreatedBy`.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedDate` capability.\",\"description\":\"Defaults to `CreatedDate`.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedBy` capability.\",\"description\":\"Defaults to `UpdatedBy`.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedDate` capability.\",\"description\":\"Defaults to `UpdatedDate`.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedBy` capability.\",\"description\":\"Defaults to `UpdatedBy`.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedDate` capability.\",\"description\":\"Defaults to `UpdatedDate`.\"},\"orgUnitJoinSql\":{\"type\":\"string\",\"title\":\"The SQL table or function that is to be used to join against for security-based `OrgUnitId` verification.\",\"description\":\"Defaults to `[Sec].[fnGetUserOrgUnits]()`.\"},\"checkUserPermissionSql\":{\"type\":\"string\",\"title\":\"The SQL stored procedure that is to be used for `Permission` verification.\",\"description\":\"Defaults to `[Sec].[spCheckUserHasPermission]`.\"},\"getUserPermissionSql\":{\"type\":\"string\",\"title\":\"The SQL function that is to be used for `Permission` verification.\",\"description\":\"Defaults to `[Sec].[fnGetUserHasPermission]`.\"},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.\",\"description\":\"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`.\",\"items\":{\"type\":\"string\"}},\"autoDotNetRename\":{\"type\":\"string\",\"title\":\"The option to automatically rename the SQL Tables and Columns for use in .NET.\",\"description\":\"Defaults `SnakeKebabToPascalCase` that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. `internal-customer_id` would be renamed as `InternalCustomerId`. The `PascalCase` option will capatilize the first character only.\",\"enum\":[\"None\",\"PascalCase\",\"SnakeKebabToPascalCase\"]},\"preprocessorDirectives\":{\"type\":\"boolean\",\"title\":\"Indicates whether to use preprocessor directives in the generated output.\"},\"collectionType\":{\"type\":\"string\",\"title\":\"The collection type.\",\"description\":\"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `JSON`.\",\"enum\":[\"JSON\",\"UDT\"]},\"efModel\":{\"type\":\"boolean\",\"title\":\"Indicates whether an `Entity Framework` .NET (C#) model is to be generated for all tables.\",\"description\":\"This can be overridden within the `Table`(s).\"},\"outbox\":{\"type\":\"boolean\",\"title\":\"Indicates whether to generate the event outbox SQL and .NET artefacts.\",\"description\":\"Defaults to `false`.\"},\"outboxSchema\":{\"type\":\"string\",\"title\":\"The schema name of the event outbox table.\",\"description\":\"Defaults to `Outbox` (literal).\"},\"outboxSchemaCreate\":{\"type\":\"boolean\",\"title\":\"Indicates whether to create the `OutboxSchema` within the database.\",\"description\":\"Defaults to `true`.\"},\"outboxTable\":{\"type\":\"string\",\"title\":\"The name of the event outbox table.\",\"description\":\"Defaults to `EventOutbox` (literal).\"},\"outboxEnqueueStoredProcedure\":{\"type\":\"string\",\"title\":\"The stored procedure name for the event outbox enqueue.\",\"description\":\"Defaults to `spEventOutboxEnqueue` (literal).\"},\"outboxDequeueStoredProcedure\":{\"type\":\"string\",\"title\":\"The stored procedure name for the event outbox dequeue.\",\"description\":\"Defaults to `spEventOutboxDequeue` (literal).\"},\"pathBase\":{\"type\":\"string\",\"title\":\"The base path (directory) prefix for the Database-related artefacts; other `Path*` properties append to this value when they are not specifically overridden.\",\"description\":\"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`.\"},\"pathDatabaseSchema\":{\"type\":\"string\",\"title\":\"The path (directory) for the Schema Database-related artefacts.\",\"description\":\"Defaults to `PathBase` + `.Database/Schema` (literal). For example `Beef.Demo.Database/Schema`.\"},\"pathDatabaseMigrations\":{\"type\":\"string\",\"title\":\"The path (directory) for the Schema Database-related artefacts.\",\"description\":\"Defaults to `PathBase` + `.Database/Migrations` (literal). For example `Beef.Demo.Database/Migrations`.\"},\"pathBusiness\":{\"type\":\"string\",\"title\":\"The path (directory) for the Business-related (.NET) artefacts.\",\"description\":\"Defaults to `PathBase` + `.Business` (literal). For example `Beef.Demo.Business`.\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.\",\"description\":\"This is only applicable for stored procedures.\"},\"namespaceBase\":{\"type\":\"string\",\"title\":\"The base Namespace (root) for the .NET artefacts.\",\"description\":\"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`.\"},\"namespaceCommon\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Common-related .NET artefacts.\",\"description\":\"Defaults to `NamespaceBase` + `.Common` (literal). For example `Beef.Demo.Common`.\"},\"namespaceBusiness\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Business-related .NET artefacts.\",\"description\":\"Defaults to `NamespaceBase` + `.Business` (literal). For example `Beef.Demo.Business`.\"},\"namespaceOutbox\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Outbox-related Publisher .NET artefacts.\",\"description\":\"Defaults to `NamespaceBusiness`.\"},\"tables\":{\"type\":\"array\",\"title\":\"The corresponding `Table` collection.\",\"items\":{\"$ref\":\"#/definitions/Table\"}},\"queries\":{\"type\":\"array\",\"title\":\"The corresponding `Query` collection.\",\"items\":{\"$ref\":\"#/definitions/Query\"}}}},\"Table\":{\"type\":\"object\",\"title\":\"'Table' object (entity-driven)\",\"description\":\"The `Table` object identifies an existing database `Table` (or `View`) and defines its code-generation characteristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the `Table` in the database.\"},\"schema\":{\"type\":\"string\",\"title\":\"The name of the `Schema` where the `Table` is defined in the database.\",\"description\":\"Defaults to `CodeGeneration.Schema`.\"},\"alias\":{\"type\":\"string\",\"title\":\"The `Schema.Table` alias name.\",\"description\":\"Will automatically default where not specified.\"},\"replace\":{\"type\":\"boolean\",\"title\":\"Indicates whether the existing database object should be replaced/altered or whether the object is dropped and recreated.\",\"description\":\"Defaults to `CodeGeneration.Replace`.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all `Columns` are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no `Columns` are to be excluded.\",\"items\":{\"type\":\"string\"}},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.\",\"description\":\"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`.\",\"items\":{\"type\":\"string\"}},\"jsonAliasColumns\":{\"type\":\"array\",\"title\":\"The list of JSON `Column` and `JsonAlias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.\",\"description\":\"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `ProductCode^product`.\",\"items\":{\"type\":\"string\"}},\"get\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Get` stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"getAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `GetAll` stored procedure is to be automatically generated where not otherwise explicitly specified.\",\"description\":\"The `GetAllOrderBy` is used to specify the `GetAll` query sort order.\"},\"getAllOrderBy\":{\"type\":\"array\",\"title\":\"The list of `Column` names (including sort order `ASC`/`DESC` literal) to be used as the `GetAll` query sort order.\",\"description\":\"This relates to the `GetAll` selection.\",\"items\":{\"type\":\"string\"}},\"create\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Create` stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"update\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Update` stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"upsert\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Upsert` stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"delete\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Delete` stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"merge\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Merge` (insert/update/delete of `Udt` list) stored procedure is to be automatically generated where not otherwise explicitly specified.\",\"description\":\"This will also require a `Udt` (SQL User Defined Table) and `Tvp` (.NET Table-Valued Parameter) to function.\"},\"efModel\":{\"type\":\"boolean\",\"title\":\"Indicates whether an `Entity Framework` .NET (C#) model is to be generated.\",\"description\":\"Defaults to `CodeGeneration.EfModel`.\"},\"efModelName\":{\"type\":\"string\",\"title\":\"The .NET (C#) EntityFramework (EF) model name.\",\"description\":\"Defaults to `Name` applying the `CodeGeneration.AutoDotNetRename`.\"},\"udt\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `User Defined Table (UDT)` type should be created.\"},\"udtExcludeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be excluded from the `User Defined Table (UDT)`.\",\"description\":\"Where not specified this indicates that no `Columns` are to be excluded.\",\"items\":{\"type\":\"string\"}},\"tvp\":{\"type\":\"string\",\"title\":\"The name of the .NET entity associated with the `Udt` so that it can be expressed (created) as a Table-Valued Parameter for usage within the corresponding `DbMapper`.\"},\"collectionType\":{\"type\":\"string\",\"title\":\"The collection type.\",\"description\":\"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `Config.CollectionType`.\",\"enum\":[\"JSON\",\"UDT\"]},\"permission\":{\"type\":\"string\",\"title\":\"The permission (prefix) to be used for security permission checking (suffix defaults to `Read`, `Write` or `Delete` and can be overridden in the underlying stored procedure).\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.\",\"description\":\"Defaults to `CodeGeneration.OrgUnitImmutable`. This is only applicable for stored procedures.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the `IsDeleted` capability.\",\"description\":\"Defaults to `CodeGeneration.IsDeleted`.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the `TenantId` capability.\",\"description\":\"Defaults to `CodeGeneration.TenantId`.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the `OrgUnitId` capability.\",\"description\":\"Defaults to `CodeGeneration.OrgUnitId`.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the `RowVersion` capability.\",\"description\":\"Defaults to `CodeGeneration.RowVersion`.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedBy`.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedDate`.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"storedProcedures\":{\"type\":\"array\",\"title\":\"The corresponding `StoredProcedure` collection.\",\"items\":{\"$ref\":\"#/definitions/StoredProcedure\"}},\"relationships\":{\"type\":\"array\",\"title\":\"The corresponding Entity Frameworrk (EF) `Relationship` collection.\",\"items\":{\"$ref\":\"#/definitions/Relationship\"}}},\"required\":[\"name\"]},\"StoredProcedure\":{\"type\":\"object\",\"title\":\"'StoredProcedure' object (database-driven)\",\"description\":\"The code generation for an `StoredProcedure` is primarily driven by the `Type` property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting `Upsert`, `Merge` and ad-hoc queries as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the `StoredProcedure`; generally the verb/action, i.e. `Get`, `Update`, etc.\",\"description\":\"See `StoredProcedureName` for the actual name used in the database.\"},\"type\":{\"type\":\"string\",\"title\":\"The stored procedure operation type.\",\"description\":\"Defaults to `GetColl`.\",\"enum\":[\"Get\",\"GetColl\",\"Create\",\"Update\",\"Upsert\",\"Delete\",\"Merge\"]},\"paging\":{\"type\":\"boolean\",\"title\":\"Indicates whether standardized paging support should be added.\",\"description\":\"This only applies where the stored procedure operation `Type` is `GetColl`.\"},\"storedProcedureName\":{\"type\":\"string\",\"title\":\"The `StoredProcedure` name in the database.\",\"description\":\"Defaults to `sp` + `Table.Name` + `Name`; e.g. `spTableName` or `spPersonGet`.\"},\"replace\":{\"type\":\"boolean\",\"title\":\"Indicates whether the existing `StoredProcedure` database object should be replaced/altered or whether the object is dropped and recreated.\",\"description\":\"Defaults to `CodeGeneration.Replace`.\"},\"reselectStatement\":{\"type\":\"string\",\"title\":\"The SQL statement to perform the reselect after a `Create`, `Update` or `Upsert` stored procedure operation `Type`.\",\"description\":\"Defaults to `[{{Table.Schema}}].[sp{{Table.Name}}Get]` passing the primary key column(s).\"},\"intoTempTable\":{\"type\":\"boolean\",\"title\":\"Indicates whether to select into a `#TempTable` to allow other statements access to the selected data.\",\"description\":\"A `Select * from #TempTable` is also performed (code-generated) where the stored procedure operation `Type` is `GetColl`.\"},\"withHints\":{\"type\":\"string\",\"title\":\"the table hints using the SQL Server `WITH()` statement; the value specified will be used as-is; e.g. `NOLOCK` will result in `WITH(NOLOCK)`.\"},\"collectionType\":{\"type\":\"string\",\"title\":\"The collection type.\",\"description\":\"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `Table.CollectionType`.\",\"enum\":[\"JSON\",\"UDT\"]},\"mergeOverrideIdentityColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be used in the `Merge` statement to determine whether to _insert_, _update_ or _delete_.\",\"description\":\"This is used to override the default behaviour of using the primary key column(s).\",\"items\":{\"type\":\"string\"}},\"permission\":{\"type\":\"string\",\"title\":\"The name of the `StoredProcedure` in the database.\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.\",\"description\":\"Defaults to `Table.OrgUnitImmutable`.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be included in the underlying generated _settable_ output (further filters `Table.IncludeColumns`).\",\"description\":\"Where not specified this indicates that all `Columns` are to be included. Only filters the columns where `Type` is `Get`, `GetColl`, `Create`, `Update` or `Upsert`.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be excluded from the underlying generated _settable_ output (further filters `Table.ExcludeColumns`).\",\"description\":\"Where not specified this indicates no `Columns` are to be excluded. Only filters the columns where `Type` is `Get`, `GetColl`, `Create`, `Update` or `Upsert`.\",\"items\":{\"type\":\"string\"}},\"parameters\":{\"type\":\"array\",\"title\":\"The corresponding `Parameter` collection.\",\"items\":{\"$ref\":\"#/definitions/Parameter\"}},\"where\":{\"type\":\"array\",\"title\":\"The corresponding `Where` collection.\",\"items\":{\"$ref\":\"#/definitions/Where\"}},\"orderby\":{\"type\":\"array\",\"title\":\"The corresponding `OrderBy` collection.\",\"items\":{\"$ref\":\"#/definitions/OrderBy\"}},\"execute\":{\"type\":\"array\",\"title\":\"The corresponding `Execute` collection.\",\"items\":{\"$ref\":\"#/definitions/Execute\"}}},\"required\":[\"name\"]},\"Parameter\":{\"type\":\"object\",\"title\":\"'Parameter' object (database-driven)\",\"description\":\"The `Parameter` is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected `StoredProcedure.Type`.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The parameter name (without the `@` prefix).\"},\"column\":{\"type\":\"string\",\"title\":\"The corresponding column name; used to infer characteristics.\",\"description\":\"Defaults to `Name`.\"},\"sqlType\":{\"type\":\"string\",\"title\":\"The SQL type definition (overrides inherited Column definition) including length/precision/scale.\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the parameter is nullable.\",\"description\":\"Note that when the parameter value is `NULL` it will not be included in the query.\"},\"treatColumnNullAs\":{\"type\":\"boolean\",\"title\":\"Indicates whether the column value where NULL should be treated as the specified value; results in: `ISNULL([x].[col], value)`.\"},\"collection\":{\"type\":\"boolean\",\"title\":\"Indicates whether the parameter is a collection (one or more values to be included `IN` the query).\"},\"collectionType\":{\"type\":\"string\",\"title\":\"The collection type.\",\"description\":\"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `StoredProcedure.CollectionType`.\",\"enum\":[\"JSON\",\"UDT\"]},\"operator\":{\"type\":\"string\",\"title\":\"The where clause equality operator\",\"description\":\"Defaults to `EQ`.\",\"enum\":[\"EQ\",\"NE\",\"LT\",\"LE\",\"GT\",\"GE\",\"LIKE\"]}},\"required\":[\"name\"]},\"Where\":{\"type\":\"object\",\"title\":\"'Where' object (database-driven)\",\"description\":\"The `Where` object defines an additional where `Statement` to be added. This is in addition to those automatically added based on the `StoredProcedure.Type`.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The where statement (TSQL).\"}},\"required\":[\"statement\"]},\"OrderBy\":{\"type\":\"object\",\"title\":\"'OrderBy' object (database-driven)\",\"description\":\"The `OrderBy` object defines the query order. Only valid for `StoredProcedure.Type` of `GetAll`.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the `Column` to order by.\"},\"order\":{\"type\":\"string\",\"title\":\"The corresponding sort order.\",\"description\":\"Defaults to `Ascending`.\",\"enum\":[\"Ascending\",\"Descending\"]}},\"required\":[\"name\"]},\"Execute\":{\"type\":\"object\",\"title\":\"'Execute' object (database-driven)\",\"description\":\"The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The additional TSQL statement.\"},\"location\":{\"type\":\"string\",\"title\":\"The location of the statement in relation to the underlying primary stored procedure statement.\",\"description\":\"Defaults to `After`.\",\"enum\":[\"Before\",\"After\"]}},\"required\":[\"statement\"]},\"Relationship\":{\"type\":\"object\",\"title\":\"'Relationship' object (database-driven)\",\"description\":\"The `Relationship` object enables the definition of an entity framework (EF) model relationship.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the primary table of the query.\"},\"schema\":{\"type\":\"string\",\"title\":\"The schema name of the primary table of the view.\",\"description\":\"Defaults to `CodeGeneration.Schema`.\"},\"type\":{\"type\":\"string\",\"title\":\"The relationship type between the parent and child (self).\",\"description\":\"Defaults to `OneToMany`.\",\"enum\":[\"OneToMany\",\"ManyToOne\"]},\"foreignKeyColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names from the related table that reference the parent.\",\"items\":{\"type\":\"string\"}},\"principalKeyColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names from the principal table that reference the child.\",\"description\":\" Typically this is only used where referencing property(s) other than the primary key as the principal property(s).\",\"items\":{\"type\":\"string\"}},\"onDelete\":{\"type\":\"string\",\"title\":\"The operation applied to dependent entities in the relationship when the principal is deleted or the relationship is severed.\",\"description\":\"Defaults to `NoAction`. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.deletebehavior for more information.\",\"enum\":[\"NoAction\",\"Cascade\",\"ClientCascade\",\"ClientNoAction\",\"ClientSetNull\",\"Restrict\",\"SetNull\"]},\"autoInclude\":{\"type\":\"boolean\",\"title\":\"Indicates whether to automatically include navigation to the property.\",\"description\":\"Defaults to `false`.\"},\"propertyName\":{\"type\":\"string\",\"title\":\"The corresponding property name within the entity framework (EF) model.\",\"description\":\"Defaults to `Name` using the `CodeGeneration.AutoDotNetRename` option.\"},\"efModelName\":{\"type\":\"string\",\"title\":\"The corresponding entity framework (EF) model name (.NET Type).\",\"description\":\"Defaults to `Name` using the `CodeGeneration.AutoDotNetRename` option.\"}},\"required\":[\"name\"]},\"Query\":{\"type\":\"object\",\"title\":\"'Query' object (database-driven)\",\"description\":\"The `Query` object enables the definition of more complex multi-table queries (`Joins`) that would primarily result in a database _View_. The primary table `Name` for the query is required to be specified. Multiple queries can be specified for the same table(s). The `IncludeColumns` and `ExcludeColumns` provide a shorthand to include or exclude selected columns; with the `AliasColumns` providing a means to rename where required (for example duplicate name). Additional `Where` and `Order` configuration can also be added as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the primary table of the query.\"},\"schema\":{\"type\":\"string\",\"title\":\"The schema name of the primary table of the view.\",\"description\":\"Defaults to `CodeGeneration.Schema`.\"},\"alias\":{\"type\":\"string\",\"title\":\"The `Schema.Table` alias name.\",\"description\":\"Will automatically default where not specified.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all `Columns` are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no `Columns` are to be excluded.\",\"items\":{\"type\":\"string\"}},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.\",\"description\":\"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`\",\"items\":{\"type\":\"string\"}},\"view\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `View` is to be generated.\"},\"viewName\":{\"type\":\"string\",\"title\":\"The `View` name.\",\"description\":\"Defaults to `vw` + `Name`; e.g. `vwTableName`.\"},\"viewSchema\":{\"type\":\"string\",\"title\":\"The schema name for the `View`.\",\"description\":\"Defaults to `Schema`.\"},\"viewReplace\":{\"type\":\"boolean\",\"title\":\"Indicates whether the existing `View` database object should be replaced/altered or whether the object is dropped and recreated.\",\"description\":\"Defaults to `CodeGeneration.Replace`.\"},\"permission\":{\"type\":\"string\",\"title\":\"The permission to be used for security permission checking.\",\"description\":\"The suffix is optional, and where not specified will default to `.READ`.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the `IsDeleted` capability.\",\"description\":\"Defaults to `CodeGeneration.IsDeleted`.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the `TenantId` capability.\",\"description\":\"Defaults to `CodeGeneration.TenantId`.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the `OrgUnitId` capability.\",\"description\":\"Defaults to `CodeGeneration.OrgUnitId`.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the `RowVersion` capability.\",\"description\":\"Defaults to `CodeGeneration.RowVersion`.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedBy`.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedDate`.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"joins\":{\"type\":\"array\",\"title\":\"The corresponding `Join` collection.\",\"items\":{\"$ref\":\"#/definitions/QueryJoin\"}},\"order\":{\"type\":\"array\",\"title\":\"The corresponding `Order` collection.\",\"items\":{\"$ref\":\"#/definitions/QueryOrder\"}},\"where\":{\"type\":\"array\",\"title\":\"The corresponding `Where` collection.\",\"items\":{\"$ref\":\"#/definitions/QueryWhere\"}}},\"required\":[\"name\"]},\"QueryJoin\":{\"type\":\"object\",\"title\":\"'QueryJoin' object (database-driven)\",\"description\":\"The `QueryJoin` object defines a join to another (or same) table within a query. The `Type` defines the join type, such as inner join, etc. The `IncludeColumns` and `ExcludeColumns` provide a shorthand to include or exclude selected columns; with the `AliasColumns` providing a means to rename where required (for example duplicate name).\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the table to join.\"},\"schema\":{\"type\":\"string\",\"title\":\"The schema name of the table to join.\",\"description\":\"Defaults to `Table.Schema`; i.e. same schema.\"},\"alias\":{\"type\":\"string\",\"title\":\"The `Schema.Table` alias name.\",\"description\":\"Will automatically default where not specified.\"},\"type\":{\"type\":\"string\",\"title\":\"The SQL join type.\",\"description\":\"Defaults to `Inner`.\",\"enum\":[\"Inner\",\"Left\",\"Right\",\"Full\"]},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all `Columns` are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no `Columns` are to be excluded.\",\"items\":{\"type\":\"string\"}},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column renaming.\",\"description\":\"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`\",\"items\":{\"type\":\"string\"}},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the `IsDeleted` capability.\",\"description\":\"Defaults to `CodeGeneration.IsDeleted`.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the `TenantId` capability.\",\"description\":\"Defaults to `CodeGeneration.TenantId`.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the `OrgUnitId` capability.\",\"description\":\"Defaults to `CodeGeneration.OrgUnitId`.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the `RowVersion` capability.\",\"description\":\"Defaults to `CodeGeneration.RowVersion`.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedBy`.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `CreatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.CreatedDate`.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the `UpdatedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedBy` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedBy`.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the `DeletedDate` capability.\",\"description\":\"Defaults to `CodeGeneration.UpdatedDate`.\"},\"on\":{\"type\":\"array\",\"title\":\"The corresponding `JoinOn` collection.\",\"items\":{\"$ref\":\"#/definitions/QueryJoinOn\"}}},\"required\":[\"name\"]},\"QueryJoinOn\":{\"type\":\"object\",\"title\":\"'QueryJoinOn' object (database-driven)\",\"description\":\"The `QueryJoinOn` object defines the join on characteristics for a join within a query.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the join column (from the `Join` table).\"},\"toSchema\":{\"type\":\"string\",\"title\":\"The name of the other join to table schema.\",\"description\":\"Defaults to `Table.Schema`; i.e. same schema. See also `ToTable` and `ToColumn` as these all relate.\"},\"toTable\":{\"type\":\"string\",\"title\":\"The name of the other join to table.\",\"description\":\"Defaults to `Table.Name`; i.e. primary table. See also `ToSchema` and `ToColumn` as these all relate.\"},\"toColumn\":{\"type\":\"string\",\"title\":\"The name of the other join to column.\",\"description\":\"Defaults to `Name`; i.e. assumes same name. See also `ToSchema` and `ToTable` as these all relate.\"},\"toStatement\":{\"type\":\"string\",\"title\":\"The fully qualified name (`Alias.Name`) of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding `Schema`, `Table` and `Column` logic.\"}},\"required\":[\"name\"]},\"QueryOrder\":{\"type\":\"object\",\"title\":\"'QueryOrder' object (database-driven)\",\"description\":\"The `QueryOrder` object that defines the query order.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the `Column` to order by.\",\"description\":\"See also `Schema` and `Table` as these all relate.\"},\"schema\":{\"type\":\"string\",\"title\":\"The name of order by table schema. See also `Name` and `Column` as these all relate.\",\"description\":\"Defaults to `Query.Schema`.\"},\"table\":{\"type\":\"string\",\"title\":\"The name of the order by table.\",\"description\":\"Defaults to `Table.Name`; i.e. primary table. See also `Schema` and `Column` as these all relate.\"},\"order\":{\"type\":\"string\",\"title\":\"The corresponding sort order.\",\"description\":\"Defaults to `Ascending`.\",\"enum\":[\"Ascending\",\"Descending\"]}},\"required\":[\"name\"]},\"QueryWhere\":{\"type\":\"object\",\"title\":\"'QueryWhere' object (database-driven)\",\"description\":\"The `QueryWhere` object defines an additional where `Statement` to be added.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The where TSQL statement.\"}},\"required\":[\"statement\"]}},\"allOf\":[{\"$ref\":\"#/definitions/CodeGeneration\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).","$schema":"https://json-schema.org/draft-04/schema#","definitions":{"CodeGeneration":{"type":"object","title":"'CodeGeneration' object (database-driven)","description":"The `CodeGeneration` object defines global properties that are used to drive the underlying database-driven code generation.","properties":{"schema":{"type":"string","title":"The name of the `Schema` where the artefacts are defined in, or should be created in, the database.","description":"This is used as the default `Schema` for all child objects."},"replace":{"type":"boolean","title":"Indicates whether the existing database object should be replaced/altered or whether the object is dropped and recreated.","description":"Defaults to `true`."},"columnNameIsDeleted":{"type":"string","title":"The column name for the `IsDeleted` capability.","description":"Defaults to `IsDeleted`."},"columnNameTenantId":{"type":"string","title":"The column name for the `TenantId` capability.","description":"Defaults to `TenantId`."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the `OrgUnitId` capability.","description":"Defaults to `OrgUnitId`."},"columnNameRowVersion":{"type":"string","title":"The column name for the `RowVersion` capability.","description":"Defaults to `RowVersion`."},"columnNameCreatedBy":{"type":"string","title":"The column name for the `CreatedBy` capability.","description":"Defaults to `CreatedBy`."},"columnNameCreatedDate":{"type":"string","title":"The column name for the `CreatedDate` capability.","description":"Defaults to `CreatedDate`."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the `UpdatedBy` capability.","description":"Defaults to `UpdatedBy`."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the `UpdatedDate` capability.","description":"Defaults to `UpdatedDate`."},"columnNameDeletedBy":{"type":"string","title":"The column name for the `DeletedBy` capability.","description":"Defaults to `UpdatedBy`."},"columnNameDeletedDate":{"type":"string","title":"The column name for the `DeletedDate` capability.","description":"Defaults to `UpdatedDate`."},"orgUnitJoinSql":{"type":"string","title":"The SQL table or function that is to be used to join against for security-based `OrgUnitId` verification.","description":"Defaults to `[Sec].[fnGetUserOrgUnits]()`."},"checkUserPermissionSql":{"type":"string","title":"The SQL stored procedure that is to be used for `Permission` verification.","description":"Defaults to `[Sec].[spCheckUserHasPermission]`."},"getUserPermissionSql":{"type":"string","title":"The SQL function that is to be used for `Permission` verification.","description":"Defaults to `[Sec].[fnGetUserHasPermission]`."},"aliasColumns":{"type":"array","title":"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.","description":"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`.","items":{"type":"string"}},"autoDotNetRename":{"type":"string","title":"The option to automatically rename the SQL Tables and Columns for use in .NET.","description":"Defaults `SnakeKebabToPascalCase` that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. `internal-customer_id` would be renamed as `InternalCustomerId`. The `PascalCase` option will capatilize the first character only.","enum":["None","PascalCase","SnakeKebabToPascalCase"]},"preprocessorDirectives":{"type":"boolean","title":"Indicates whether to use preprocessor directives in the generated output."},"collectionType":{"type":"string","title":"The collection type.","description":"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `JSON`.","enum":["JSON","UDT"]},"efModel":{"type":"boolean","title":"Indicates whether an `Entity Framework` .NET (C#) model is to be generated for all tables.","description":"This can be overridden within the `Table`(s)."},"outbox":{"type":"boolean","title":"Indicates whether to generate the event outbox SQL and .NET artefacts.","description":"Defaults to `false`."},"outboxSchema":{"type":"string","title":"The schema name of the event outbox table.","description":"Defaults to `Outbox` (literal)."},"outboxSchemaCreate":{"type":"boolean","title":"Indicates whether to create the `OutboxSchema` within the database.","description":"Defaults to `true`."},"outboxTable":{"type":"string","title":"The name of the event outbox table.","description":"Defaults to `EventOutbox` (literal)."},"outboxEnqueueStoredProcedure":{"type":"string","title":"The stored procedure name for the event outbox enqueue.","description":"Defaults to `spEventOutboxEnqueue` (literal)."},"outboxDequeueStoredProcedure":{"type":"string","title":"The stored procedure name for the event outbox dequeue.","description":"Defaults to `spEventOutboxDequeue` (literal)."},"pathBase":{"type":"string","title":"The base path (directory) prefix for the Database-related artefacts; other `Path*` properties append to this value when they are not specifically overridden.","description":"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`."},"pathDatabaseSchema":{"type":"string","title":"The path (directory) for the Schema Database-related artefacts.","description":"Defaults to `PathBase` + `.Database/Schema` (literal). For example `Beef.Demo.Database/Schema`."},"pathDatabaseMigrations":{"type":"string","title":"The path (directory) for the Schema Database-related artefacts.","description":"Defaults to `PathBase` + `.Database/Migrations` (literal). For example `Beef.Demo.Database/Migrations`."},"pathBusiness":{"type":"string","title":"The path (directory) for the Business-related (.NET) artefacts.","description":"Defaults to `PathBase` + `.Business` (literal). For example `Beef.Demo.Business`."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.","description":"This is only applicable for stored procedures."},"namespaceBase":{"type":"string","title":"The base Namespace (root) for the .NET artefacts.","description":"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`."},"namespaceCommon":{"type":"string","title":"The Namespace (root) for the Common-related .NET artefacts.","description":"Defaults to `NamespaceBase` + `.Common` (literal). For example `Beef.Demo.Common`."},"namespaceBusiness":{"type":"string","title":"The Namespace (root) for the Business-related .NET artefacts.","description":"Defaults to `NamespaceBase` + `.Business` (literal). For example `Beef.Demo.Business`."},"namespaceOutbox":{"type":"string","title":"The Namespace (root) for the Outbox-related Publisher .NET artefacts.","description":"Defaults to `NamespaceBusiness`."},"tables":{"type":"array","title":"The corresponding `Table` collection.","items":{"$ref":"#/definitions/Table"}},"queries":{"type":"array","title":"The corresponding `Query` collection.","items":{"$ref":"#/definitions/Query"}}}},"Table":{"type":"object","title":"'Table' object (entity-driven)","description":"The `Table` object identifies an existing database `Table` (or `View`) and defines its code-generation characteristics.","properties":{"name":{"type":"string","title":"The name of the `Table` in the database."},"schema":{"type":"string","title":"The name of the `Schema` where the `Table` is defined in the database.","description":"Defaults to `CodeGeneration.Schema`."},"alias":{"type":"string","title":"The `Schema.Table` alias name.","description":"Will automatically default where not specified."},"replace":{"type":"boolean","title":"Indicates whether the existing database object should be replaced/altered or whether the object is dropped and recreated.","description":"Defaults to `CodeGeneration.Replace`."},"includeColumns":{"type":"array","title":"The list of `Column` names to be included in the underlying generated output.","description":"Where not specified this indicates that all `Columns` are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of `Column` names to be excluded from the underlying generated output.","description":"Where not specified this indicates no `Columns` are to be excluded.","items":{"type":"string"}},"aliasColumns":{"type":"array","title":"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.","description":"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`.","items":{"type":"string"}},"jsonAliasColumns":{"type":"array","title":"The list of JSON `Column` and `JsonAlias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.","description":"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `ProductCode^product`.","items":{"type":"string"}},"get":{"type":"boolean","title":"Indicates whether a `Get` stored procedure is to be automatically generated where not otherwise explicitly specified."},"getAll":{"type":"boolean","title":"Indicates whether a `GetAll` stored procedure is to be automatically generated where not otherwise explicitly specified.","description":"The `GetAllOrderBy` is used to specify the `GetAll` query sort order."},"getAllOrderBy":{"type":"array","title":"The list of `Column` names (including sort order `ASC`/`DESC` literal) to be used as the `GetAll` query sort order.","description":"This relates to the `GetAll` selection.","items":{"type":"string"}},"create":{"type":"boolean","title":"Indicates whether a `Create` stored procedure is to be automatically generated where not otherwise explicitly specified."},"update":{"type":"boolean","title":"Indicates whether a `Update` stored procedure is to be automatically generated where not otherwise explicitly specified."},"upsert":{"type":"boolean","title":"Indicates whether a `Upsert` stored procedure is to be automatically generated where not otherwise explicitly specified."},"delete":{"type":"boolean","title":"Indicates whether a `Delete` stored procedure is to be automatically generated where not otherwise explicitly specified."},"merge":{"type":"boolean","title":"Indicates whether a `Merge` (insert/update/delete of `Udt` list) stored procedure is to be automatically generated where not otherwise explicitly specified.","description":"This will also require a `Udt` (SQL User Defined Table) and `Tvp` (.NET Table-Valued Parameter) to function."},"efModel":{"type":"boolean","title":"Indicates whether an `Entity Framework` .NET (C#) model is to be generated.","description":"Defaults to `CodeGeneration.EfModel`."},"efModelName":{"type":"string","title":"The .NET (C#) EntityFramework (EF) model name.","description":"Defaults to `Name` applying the `CodeGeneration.AutoDotNetRename`."},"udt":{"type":"boolean","title":"Indicates whether a `User Defined Table (UDT)` type should be created."},"udtExcludeColumns":{"type":"array","title":"The list of `Column` names to be excluded from the `User Defined Table (UDT)`.","description":"Where not specified this indicates that no `Columns` are to be excluded.","items":{"type":"string"}},"tvp":{"type":"string","title":"The name of the .NET entity associated with the `Udt` so that it can be expressed (created) as a Table-Valued Parameter for usage within the corresponding `DbMapper`."},"collectionType":{"type":"string","title":"The collection type.","description":"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `Config.CollectionType`.","enum":["JSON","UDT"]},"permission":{"type":"string","title":"The permission (prefix) to be used for security permission checking (suffix defaults to `Read`, `Write` or `Delete` and can be overridden in the underlying stored procedure)."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.","description":"Defaults to `CodeGeneration.OrgUnitImmutable`. This is only applicable for stored procedures."},"columnNameIsDeleted":{"type":"string","title":"The column name for the `IsDeleted` capability.","description":"Defaults to `CodeGeneration.IsDeleted`."},"columnNameTenantId":{"type":"string","title":"The column name for the `TenantId` capability.","description":"Defaults to `CodeGeneration.TenantId`."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the `OrgUnitId` capability.","description":"Defaults to `CodeGeneration.OrgUnitId`."},"columnNameRowVersion":{"type":"string","title":"The column name for the `RowVersion` capability.","description":"Defaults to `CodeGeneration.RowVersion`."},"columnNameCreatedBy":{"type":"string","title":"The column name for the `CreatedBy` capability.","description":"Defaults to `CodeGeneration.CreatedBy`."},"columnNameCreatedDate":{"type":"string","title":"The column name for the `CreatedDate` capability.","description":"Defaults to `CodeGeneration.CreatedDate`."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the `UpdatedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the `UpdatedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"columnNameDeletedBy":{"type":"string","title":"The column name for the `DeletedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameDeletedDate":{"type":"string","title":"The column name for the `DeletedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"storedProcedures":{"type":"array","title":"The corresponding `StoredProcedure` collection.","items":{"$ref":"#/definitions/StoredProcedure"}},"relationships":{"type":"array","title":"The corresponding Entity Frameworrk (EF) `Relationship` collection.","items":{"$ref":"#/definitions/Relationship"}}},"required":["name"]},"StoredProcedure":{"type":"object","title":"'StoredProcedure' object (database-driven)","description":"The code generation for an `StoredProcedure` is primarily driven by the `Type` property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting `Upsert`, `Merge` and ad-hoc queries as required.","properties":{"name":{"type":"string","title":"The name of the `StoredProcedure`; generally the verb/action, i.e. `Get`, `Update`, etc.","description":"See `StoredProcedureName` for the actual name used in the database."},"type":{"type":"string","title":"The stored procedure operation type.","description":"Defaults to `GetColl`.","enum":["Get","GetColl","Create","Update","Upsert","Delete","Merge"]},"paging":{"type":"boolean","title":"Indicates whether standardized paging support should be added.","description":"This only applies where the stored procedure operation `Type` is `GetColl`."},"storedProcedureName":{"type":"string","title":"The `StoredProcedure` name in the database.","description":"Defaults to `sp` + `Table.Name` + `Name`; e.g. `spTableName` or `spPersonGet`."},"replace":{"type":"boolean","title":"Indicates whether the existing `StoredProcedure` database object should be replaced/altered or whether the object is dropped and recreated.","description":"Defaults to `CodeGeneration.Replace`."},"reselectStatement":{"type":"string","title":"The SQL statement to perform the reselect after a `Create`, `Update` or `Upsert` stored procedure operation `Type`.","description":"Defaults to `[{{Table.Schema}}].[sp{{Table.Name}}Get]` passing the primary key column(s)."},"intoTempTable":{"type":"boolean","title":"Indicates whether to select into a `#TempTable` to allow other statements access to the selected data.","description":"A `Select * from #TempTable` is also performed (code-generated) where the stored procedure operation `Type` is `GetColl`."},"withHints":{"type":"string","title":"the table hints using the SQL Server `WITH()` statement; the value specified will be used as-is; e.g. `NOLOCK` will result in `WITH(NOLOCK)`."},"collectionType":{"type":"string","title":"The collection type.","description":"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `Table.CollectionType`.","enum":["JSON","UDT"]},"mergeOverrideIdentityColumns":{"type":"array","title":"The list of `Column` names to be used in the `Merge` statement to determine whether to _insert_, _update_ or _delete_.","description":"This is used to override the default behaviour of using the primary key column(s).","items":{"type":"string"}},"permission":{"type":"string","title":"The name of the `StoredProcedure` in the database."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the `OrgUnitId` column is considered immutable, in that it can not be changed once set.","description":"Defaults to `Table.OrgUnitImmutable`."},"includeColumns":{"type":"array","title":"The list of `Column` names to be included in the underlying generated _settable_ output (further filters `Table.IncludeColumns`).","description":"Where not specified this indicates that all `Columns` are to be included. Only filters the columns where `Type` is `Get`, `GetColl`, `Create`, `Update` or `Upsert`.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of `Column` names to be excluded from the underlying generated _settable_ output (further filters `Table.ExcludeColumns`).","description":"Where not specified this indicates no `Columns` are to be excluded. Only filters the columns where `Type` is `Get`, `GetColl`, `Create`, `Update` or `Upsert`.","items":{"type":"string"}},"parameters":{"type":"array","title":"The corresponding `Parameter` collection.","items":{"$ref":"#/definitions/Parameter"}},"where":{"type":"array","title":"The corresponding `Where` collection.","items":{"$ref":"#/definitions/Where"}},"orderby":{"type":"array","title":"The corresponding `OrderBy` collection.","items":{"$ref":"#/definitions/OrderBy"}},"execute":{"type":"array","title":"The corresponding `Execute` collection.","items":{"$ref":"#/definitions/Execute"}}},"required":["name"]},"Parameter":{"type":"object","title":"'Parameter' object (database-driven)","description":"The `Parameter` is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected `StoredProcedure.Type`.","properties":{"name":{"type":"string","title":"The parameter name (without the `@` prefix)."},"column":{"type":"string","title":"The corresponding column name; used to infer characteristics.","description":"Defaults to `Name`."},"sqlType":{"type":"string","title":"The SQL type definition (overrides inherited Column definition) including length/precision/scale."},"nullable":{"type":"boolean","title":"Indicates whether the parameter is nullable.","description":"Note that when the parameter value is `NULL` it will not be included in the query."},"treatColumnNullAs":{"type":"boolean","title":"Indicates whether the column value where NULL should be treated as the specified value; results in: `ISNULL([x].[col], value)`."},"collection":{"type":"boolean","title":"Indicates whether the parameter is a collection (one or more values to be included `IN` the query)."},"collectionType":{"type":"string","title":"The collection type.","description":"Values are `JSON` being a JSON array (preferred) or `UDT` for a User-Defined Type (legacy). Defaults to `StoredProcedure.CollectionType`.","enum":["JSON","UDT"]},"operator":{"type":"string","title":"The where clause equality operator","description":"Defaults to `EQ`.","enum":["EQ","NE","LT","LE","GT","GE","LIKE"]}},"required":["name"]},"Where":{"type":"object","title":"'Where' object (database-driven)","description":"The `Where` object defines an additional where `Statement` to be added. This is in addition to those automatically added based on the `StoredProcedure.Type`.","properties":{"statement":{"type":"string","title":"The where statement (TSQL)."}},"required":["statement"]},"OrderBy":{"type":"object","title":"'OrderBy' object (database-driven)","description":"The `OrderBy` object defines the query order. Only valid for `StoredProcedure.Type` of `GetAll`.","properties":{"name":{"type":"string","title":"The name of the `Column` to order by."},"order":{"type":"string","title":"The corresponding sort order.","description":"Defaults to `Ascending`.","enum":["Ascending","Descending"]}},"required":["name"]},"Execute":{"type":"object","title":"'Execute' object (database-driven)","description":"The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.","properties":{"statement":{"type":"string","title":"The additional TSQL statement."},"location":{"type":"string","title":"The location of the statement in relation to the underlying primary stored procedure statement.","description":"Defaults to `After`.","enum":["Before","After"]}},"required":["statement"]},"Relationship":{"type":"object","title":"'Relationship' object (database-driven)","description":"The `Relationship` object enables the definition of an entity framework (EF) model relationship.","properties":{"name":{"type":"string","title":"The name of the primary table of the query."},"schema":{"type":"string","title":"The schema name of the primary table of the view.","description":"Defaults to `CodeGeneration.Schema`."},"type":{"type":"string","title":"The relationship type between the parent and child (self).","description":"Defaults to `OneToMany`.","enum":["OneToMany","ManyToOne"]},"foreignKeyColumns":{"type":"array","title":"The list of `Column` names from the related table that reference the parent.","items":{"type":"string"}},"principalKeyColumns":{"type":"array","title":"The list of `Column` names from the principal table that reference the child.","description":" Typically this is only used where referencing property(s) other than the primary key as the principal property(s).","items":{"type":"string"}},"onDelete":{"type":"string","title":"The operation applied to dependent entities in the relationship when the principal is deleted or the relationship is severed.","description":"Defaults to `NoAction`. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.deletebehavior for more information.","enum":["NoAction","Cascade","ClientCascade","ClientNoAction","ClientSetNull","Restrict","SetNull"]},"autoInclude":{"type":"boolean","title":"Indicates whether to automatically include navigation to the property.","description":"Defaults to `false`."},"propertyName":{"type":"string","title":"The corresponding property name within the entity framework (EF) model.","description":"Defaults to `Name` using the `CodeGeneration.AutoDotNetRename` option."},"efModelName":{"type":"string","title":"The corresponding entity framework (EF) model name (.NET Type).","description":"Defaults to `Name` using the `CodeGeneration.AutoDotNetRename` option."}},"required":["name"]},"Query":{"type":"object","title":"'Query' object (database-driven)","description":"The `Query` object enables the definition of more complex multi-table queries (`Joins`) that would primarily result in a database _View_. The primary table `Name` for the query is required to be specified. Multiple queries can be specified for the same table(s). The `IncludeColumns` and `ExcludeColumns` provide a shorthand to include or exclude selected columns; with the `AliasColumns` providing a means to rename where required (for example duplicate name). Additional `Where` and `Order` configuration can also be added as required.","properties":{"name":{"type":"string","title":"The name of the primary table of the query."},"schema":{"type":"string","title":"The schema name of the primary table of the view.","description":"Defaults to `CodeGeneration.Schema`."},"alias":{"type":"string","title":"The `Schema.Table` alias name.","description":"Will automatically default where not specified."},"includeColumns":{"type":"array","title":"The list of `Column` names to be included in the underlying generated output.","description":"Where not specified this indicates that all `Columns` are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of `Column` names to be excluded from the underlying generated output.","description":"Where not specified this indicates no `Columns` are to be excluded.","items":{"type":"string"}},"aliasColumns":{"type":"array","title":"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column aliasing/renaming.","description":"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`","items":{"type":"string"}},"view":{"type":"boolean","title":"Indicates whether a `View` is to be generated."},"viewName":{"type":"string","title":"The `View` name.","description":"Defaults to `vw` + `Name`; e.g. `vwTableName`."},"viewSchema":{"type":"string","title":"The schema name for the `View`.","description":"Defaults to `Schema`."},"viewReplace":{"type":"boolean","title":"Indicates whether the existing `View` database object should be replaced/altered or whether the object is dropped and recreated.","description":"Defaults to `CodeGeneration.Replace`."},"permission":{"type":"string","title":"The permission to be used for security permission checking.","description":"The suffix is optional, and where not specified will default to `.READ`."},"columnNameIsDeleted":{"type":"string","title":"The column name for the `IsDeleted` capability.","description":"Defaults to `CodeGeneration.IsDeleted`."},"columnNameTenantId":{"type":"string","title":"The column name for the `TenantId` capability.","description":"Defaults to `CodeGeneration.TenantId`."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the `OrgUnitId` capability.","description":"Defaults to `CodeGeneration.OrgUnitId`."},"columnNameRowVersion":{"type":"string","title":"The column name for the `RowVersion` capability.","description":"Defaults to `CodeGeneration.RowVersion`."},"columnNameCreatedBy":{"type":"string","title":"The column name for the `CreatedBy` capability.","description":"Defaults to `CodeGeneration.CreatedBy`."},"columnNameCreatedDate":{"type":"string","title":"The column name for the `CreatedDate` capability.","description":"Defaults to `CodeGeneration.CreatedDate`."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the `UpdatedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the `UpdatedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"columnNameDeletedBy":{"type":"string","title":"The column name for the `DeletedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameDeletedDate":{"type":"string","title":"The column name for the `DeletedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"joins":{"type":"array","title":"The corresponding `Join` collection.","items":{"$ref":"#/definitions/QueryJoin"}},"order":{"type":"array","title":"The corresponding `Order` collection.","items":{"$ref":"#/definitions/QueryOrder"}},"where":{"type":"array","title":"The corresponding `Where` collection.","items":{"$ref":"#/definitions/QueryWhere"}}},"required":["name"]},"QueryJoin":{"type":"object","title":"'QueryJoin' object (database-driven)","description":"The `QueryJoin` object defines a join to another (or same) table within a query. The `Type` defines the join type, such as inner join, etc. The `IncludeColumns` and `ExcludeColumns` provide a shorthand to include or exclude selected columns; with the `AliasColumns` providing a means to rename where required (for example duplicate name).","properties":{"name":{"type":"string","title":"The name of the table to join."},"schema":{"type":"string","title":"The schema name of the table to join.","description":"Defaults to `Table.Schema`; i.e. same schema."},"alias":{"type":"string","title":"The `Schema.Table` alias name.","description":"Will automatically default where not specified."},"type":{"type":"string","title":"The SQL join type.","description":"Defaults to `Inner`.","enum":["Inner","Left","Right","Full"]},"includeColumns":{"type":"array","title":"The list of `Column` names to be included in the underlying generated output.","description":"Where not specified this indicates that all `Columns` are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of `Column` names to be excluded from the underlying generated output.","description":"Where not specified this indicates no `Columns` are to be excluded.","items":{"type":"string"}},"aliasColumns":{"type":"array","title":"The list of `Column` and `Alias` pairs (split by a `^` lookup character) to enable column renaming.","description":"Each alias value should be formatted as `Column` + `^` + `Alias`; e.g. `PCODE^ProductCode`","items":{"type":"string"}},"columnNameIsDeleted":{"type":"string","title":"The column name for the `IsDeleted` capability.","description":"Defaults to `CodeGeneration.IsDeleted`."},"columnNameTenantId":{"type":"string","title":"The column name for the `TenantId` capability.","description":"Defaults to `CodeGeneration.TenantId`."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the `OrgUnitId` capability.","description":"Defaults to `CodeGeneration.OrgUnitId`."},"columnNameRowVersion":{"type":"string","title":"The column name for the `RowVersion` capability.","description":"Defaults to `CodeGeneration.RowVersion`."},"columnNameCreatedBy":{"type":"string","title":"The column name for the `CreatedBy` capability.","description":"Defaults to `CodeGeneration.CreatedBy`."},"columnNameCreatedDate":{"type":"string","title":"The column name for the `CreatedDate` capability.","description":"Defaults to `CodeGeneration.CreatedDate`."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the `UpdatedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the `UpdatedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"columnNameDeletedBy":{"type":"string","title":"The column name for the `DeletedBy` capability.","description":"Defaults to `CodeGeneration.UpdatedBy`."},"columnNameDeletedDate":{"type":"string","title":"The column name for the `DeletedDate` capability.","description":"Defaults to `CodeGeneration.UpdatedDate`."},"on":{"type":"array","title":"The corresponding `JoinOn` collection.","items":{"$ref":"#/definitions/QueryJoinOn"}}},"required":["name"]},"QueryJoinOn":{"type":"object","title":"'QueryJoinOn' object (database-driven)","description":"The `QueryJoinOn` object defines the join on characteristics for a join within a query.","properties":{"name":{"type":"string","title":"The name of the join column (from the `Join` table)."},"toSchema":{"type":"string","title":"The name of the other join to table schema.","description":"Defaults to `Table.Schema`; i.e. same schema. See also `ToTable` and `ToColumn` as these all relate."},"toTable":{"type":"string","title":"The name of the other join to table.","description":"Defaults to `Table.Name`; i.e. primary table. See also `ToSchema` and `ToColumn` as these all relate."},"toColumn":{"type":"string","title":"The name of the other join to column.","description":"Defaults to `Name`; i.e. assumes same name. See also `ToSchema` and `ToTable` as these all relate."},"toStatement":{"type":"string","title":"The fully qualified name (`Alias.Name`) of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding `Schema`, `Table` and `Column` logic."}},"required":["name"]},"QueryOrder":{"type":"object","title":"'QueryOrder' object (database-driven)","description":"The `QueryOrder` object that defines the query order.","properties":{"name":{"type":"string","title":"The name of the `Column` to order by.","description":"See also `Schema` and `Table` as these all relate."},"schema":{"type":"string","title":"The name of order by table schema. See also `Name` and `Column` as these all relate.","description":"Defaults to `Query.Schema`."},"table":{"type":"string","title":"The name of the order by table.","description":"Defaults to `Table.Name`; i.e. primary table. See also `Schema` and `Column` as these all relate."},"order":{"type":"string","title":"The corresponding sort order.","description":"Defaults to `Ascending`.","enum":["Ascending","Descending"]}},"required":["name"]},"QueryWhere":{"type":"object","title":"'QueryWhere' object (database-driven)","description":"The `QueryWhere` object defines an additional where `Statement` to be added.","properties":{"statement":{"type":"string","title":"The where TSQL statement."}},"required":["statement"]}},"allOf":[{"$ref":"#/definitions/CodeGeneration"}]}
|
Provide a JSON object that satisfies the schema "JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).
|
schema-store
|
schema_store_239
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).\",\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"definitions\":{\"CodeGeneration\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (database-driven)\",\"description\":\"The 'CodeGeneration' object defines global properties that are used to drive the underlying database-driven code generation.\",\"properties\":{\"schema\":{\"type\":\"string\",\"title\":\"The name of the 'Schema' where the artefacts are defined in, or should be created in, the database.\",\"description\":\"This is used as the default 'Schema' for all child objects.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the 'IsDeleted' capability.\",\"description\":\"Defaults to 'IsDeleted'.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the 'TenantId' capability.\",\"description\":\"Defaults to 'TenantId'.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the 'OrgUnitId' capability.\",\"description\":\"Defaults to 'OrgUnitId'.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the 'RowVersion' capability.\",\"description\":\"Defaults to 'RowVersion'.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedBy' capability.\",\"description\":\"Defaults to 'CreatedBy'.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedDate' capability.\",\"description\":\"Defaults to 'CreatedDate'.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedBy' capability.\",\"description\":\"Defaults to 'UpdatedBy'.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedDate' capability.\",\"description\":\"Defaults to 'UpdatedDate'.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedBy' capability.\",\"description\":\"Defaults to 'UpdatedBy'.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedDate' capability.\",\"description\":\"Defaults to 'UpdatedDate'.\"},\"orgUnitJoinSql\":{\"type\":\"string\",\"title\":\"The SQL table or function that is to be used to join against for security-based 'OrgUnitId' verification.\",\"description\":\"Defaults to '[Sec].[fnGetUserOrgUnits]()'.\"},\"checkUserPermissionSql\":{\"type\":\"string\",\"title\":\"The SQL stored procedure that is to be used for 'Permission' verification.\",\"description\":\"Defaults to '[Sec].[spCheckUserHasPermission]'.\"},\"getUserPermissionSql\":{\"type\":\"string\",\"title\":\"The SQL function that is to be used for 'Permission' verification.\",\"description\":\"Defaults to '[Sec].[fnGetUserHasPermission]'.\"},\"cdcSchema\":{\"type\":\"string\",\"title\":\"The schema name for the generated 'CDC'-related database artefacts.\",\"description\":\"Defaults to 'XCdc' (literal).\"},\"cdcAuditTableName\":{\"type\":\"string\",\"title\":\"The table name for the 'Cdc'-Tracking.\",\"description\":\"Defaults to 'CdcTracking' (literal).\"},\"cdcIdentifierMapping\":{\"type\":\"boolean\",\"title\":\"Indicates whether to include the generation of the generic 'Cdc'-IdentifierMapping database capabilities.\"},\"cdcIdentifierMappingTableName\":{\"type\":\"string\",\"title\":\"The table name for the 'Cdc'-IdentifierMapping.\",\"description\":\"Defaults to 'CdcIdentifierMapping' (literal).\"},\"cdcIdentifierMappingStoredProcedureName\":{\"type\":\"string\",\"title\":\"The table name for the 'Cdc'-IdentifierMapping.\",\"description\":\"Defaults to 'spCreateCdcIdentifierMapping' (literal).\"},\"cdcExcludeColumnsFromETag\":{\"type\":\"array\",\"title\":\"The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)\",\"items\":{\"type\":\"string\"}},\"jsonSerializer\":{\"type\":\"string\",\"title\":\"The JSON Serializer to use for JSON property attribution.\",\"description\":\"Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).\",\"enum\":[\"None\",\"Newtonsoft\"]},\"pluralizeCollectionProperties\":{\"type\":\"boolean\",\"title\":\"Indicates whether the .NET collection properties should be pluralized.\"},\"hasBeefDbo\":{\"type\":\"boolean\",\"title\":\"Indicates whether the database has (contains) the standard _Beef_ 'dbo' schema objects.\",\"description\":\"Defaults to 'true'.\"},\"autoDotNetRename\":{\"type\":\"string\",\"title\":\"The option to automatically rename the SQL Tables and Columns for use in .NET.\",\"description\":\"Defaults 'SnakeKebabToPascalCase' that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.\",\"enum\":[\"None\",\"PascalCase\",\"SnakeKebabToPascalCase\"]},\"entityScope\":{\"type\":\"string\",\"title\":\"The entity scope option.\",\"description\":\"Defaults to 'Common' for backwards compatibility; 'Autonomous' is recommended. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).\",\"enum\":[\"Common\",\"Business\",\"Autonomous\"]},\"eventSubjectRoot\":{\"type\":\"string\",\"title\":\"The root for the event name by prepending to all event subject names via CDC.\",\"description\":\"Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be extended within the 'Entity'(s).\"},\"eventSubjectFormat\":{\"type\":\"string\",\"title\":\"The default formatting for the Subject when an Event is published via CDC.\",\"description\":\"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.\",\"enum\":[\"NameOnly\",\"NameAndKey\"]},\"eventActionFormat\":{\"type\":\"string\",\"title\":\"The formatting for the Action when an Event is published via CDC.\",\"description\":\"Defaults to 'None' (no formatting required, i.e. as-is).\",\"enum\":[\"None\",\"PastTense\"]},\"eventSourceRoot\":{\"type\":\"string\",\"title\":\"The URI root for the event source by prepending to all event source URIs for CDC.\",\"description\":\"The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s).\"},\"eventSourceKind\":{\"type\":\"string\",\"title\":\"The URI kind for the event source URIs for CDC.\",\"description\":\"Defaults to 'None' (being the event source is not updated).\",\"enum\":[\"None\",\"Absolute\",\"Relative\",\"RelativeOrAbsolute\"]},\"eventSourceFormat\":{\"type\":\"string\",\"title\":\"The default formatting for the Source when an Event is published via CDC.\",\"description\":\"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.\",\"enum\":[\"NameOnly\",\"NameAndKey\",\"NameAndGlobalId\"]},\"eventOutbox\":{\"type\":\"boolean\",\"title\":\"Indicates whether events will publish using the outbox pattern and therefore the event outbox artefacts are required.\"},\"eventOutboxTableName\":{\"type\":\"string\",\"title\":\"The table name for the 'EventOutbox'.\",\"description\":\"Defaults to 'EventOutbox' (literal).\"},\"pathBase\":{\"type\":\"string\",\"title\":\"The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.\",\"description\":\"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.\"},\"pathDatabaseSchema\":{\"type\":\"string\",\"title\":\"The path (directory) for the Schema Database-related artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Database/Schema' (literal). For example 'Beef.Demo.Database/Schema'.\"},\"pathDatabaseMigrations\":{\"type\":\"string\",\"title\":\"The path (directory) for the Schema Database-related artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Database/Migrations' (literal). For example 'Beef.Demo.Database/Migrations'.\"},\"pathBusiness\":{\"type\":\"string\",\"title\":\"The path (directory) for the Business-related (.NET) artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.\"},\"PathCdcPublisher\":{\"type\":\"string\",\"title\":\"The path (directory) for the CDC-related (.NET) artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Cdc' (literal). For example 'Beef.Demo.Cdc'.\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.\",\"description\":\"This is only applicable for stored procedures.\"},\"namespaceBase\":{\"type\":\"string\",\"title\":\"The base Namespace (root) for the .NET artefacts.\",\"description\":\"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.\"},\"namespaceCommon\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Common-related .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.\"},\"namespaceBusiness\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Business-related .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.\"},\"NamespaceCdcPublisher\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the CDC-related publisher .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.CdcPublisher' (literal). For example 'Beef.Demo.CdcPublisher'.\"},\"tables\":{\"type\":\"array\",\"title\":\"The corresponding 'Table' collection.\",\"items\":{\"$ref\":\"#/definitions/Table\"}},\"queries\":{\"type\":\"array\",\"title\":\"The corresponding 'Query' collection.\",\"items\":{\"$ref\":\"#/definitions/Query\"}}}},\"Table\":{\"type\":\"object\",\"title\":\"'Table' object (entity-driven)\",\"description\":\"The 'Table' object identifies an existing database 'Table' (or 'View') and defines its code-generation characteristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the 'Table' in the database.\"},\"schema\":{\"type\":\"string\",\"title\":\"The name of the 'Schema' where the 'Table' is defined in the database.\",\"description\":\"Defaults to 'CodeGeneration.Schema'.\"},\"alias\":{\"type\":\"string\",\"title\":\"The 'Schema.Table' alias name.\",\"description\":\"Will automatically default where not specified.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all 'Columns' are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no 'Columns' are to be excluded.\",\"items\":{\"type\":\"string\"}},\"get\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Get' stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"getAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'GetAll' stored procedure is to be automatically generated where not otherwise explicitly specified.\",\"description\":\"The 'GetAllOrderBy' is used to specify the 'GetAll' query sort order.\"},\"getAllOrderBy\":{\"type\":\"array\",\"title\":\"The list of 'Column' names (including sort order 'ASC'/'DESC' literal) to be used as the 'GetAll' query sort order.\",\"description\":\"This relates to the 'GetAll' selection.\",\"items\":{\"type\":\"string\"}},\"create\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Create' stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"update\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Update' stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"upsert\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Upsert' stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"delete\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Delete' stored procedure is to be automatically generated where not otherwise explicitly specified.\"},\"merge\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'Merge' (insert/update/delete of 'Udt' list) stored procedure is to be automatically generated where not otherwise explicitly specified.\",\"description\":\"This will also require a 'Udt' (SQL User Defined Table) and 'Tvp' (.NET Table-Valued Parameter) to function.\"},\"efModel\":{\"type\":\"boolean\",\"title\":\"Indicates whether an 'Entity Framework' .NET (C#) model is to be generated.\"},\"efModelName\":{\"type\":\"string\",\"title\":\"The .NET (C#) EntityFramework (EF) model name.\",\"description\":\"Defaults to 'Name'.\"},\"udt\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'User Defined Table (UDT)' type should be created.\"},\"udtExcludeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be excluded from the 'User Defined Table (UDT)'.\",\"description\":\"Where not specified this indicates that no 'Columns' are to be excluded.\",\"items\":{\"type\":\"string\"}},\"tvp\":{\"type\":\"string\",\"title\":\"The name of the .NET entity associated with the 'Udt' so that it can be expressed (created) as a Table-Valued Parameter for usage within the corresponding 'DbMapper'.\"},\"entityScope\":{\"type\":\"string\",\"title\":\"The entity scope option.\",\"description\":\"Defaults to 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).\",\"enum\":[\"Common\",\"Business\",\"Autonomous\"]},\"permission\":{\"type\":\"string\",\"title\":\"The permission (prefix) to be used for security permission checking (suffix defaults to 'Read', 'Write' or 'Delete' and can be overridden in the underlying stored procedure).\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.\",\"description\":\"Defaults to 'CodeGeneration.OrgUnitImmutable'. This is only applicable for stored procedures.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the 'IsDeleted' capability.\",\"description\":\"Defaults to 'CodeGeneration.IsDeleted'.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the 'TenantId' capability.\",\"description\":\"Defaults to 'CodeGeneration.TenantId'.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the 'OrgUnitId' capability.\",\"description\":\"Defaults to 'CodeGeneration.OrgUnitId'.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the 'RowVersion' capability.\",\"description\":\"Defaults to 'CodeGeneration.RowVersion'.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedBy'.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedDate'.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"storedProcedures\":{\"type\":\"array\",\"title\":\"The corresponding 'StoredProcedure' collection.\",\"items\":{\"$ref\":\"#/definitions/StoredProcedure\"}}},\"required\":[\"name\"]},\"StoredProcedure\":{\"type\":\"object\",\"title\":\"'StoredProcedure' object (database-driven)\",\"description\":\"The code generation for an 'StoredProcedure' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting 'Upsert', 'Merge' and ad-hoc queries as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the 'StoredProcedure'; generally the verb/action, i.e. 'Get', 'Update', etc.\",\"description\":\"See 'StoredProcedureName' for the actual name used in the database.\"},\"type\":{\"type\":\"string\",\"title\":\"The stored procedure operation type.\",\"description\":\"Defaults to 'GetColl'.\",\"enum\":[\"Get\",\"GetColl\",\"Create\",\"Update\",\"Upsert\",\"Delete\",\"Merge\"]},\"paging\":{\"type\":\"boolean\",\"title\":\"Indicates whether standardized paging support should be added.\",\"description\":\"This only applies where the stored procedure operation 'Type' is 'GetColl'.\"},\"storedProcedureName\":{\"type\":\"string\",\"title\":\"The 'StoredProcedure' name in the database.\",\"description\":\"Defaults to 'sp' + 'Table.Name' + 'Name'; e.g. 'spTableName' or 'spPersonGet'.\"},\"reselectStatement\":{\"type\":\"string\",\"title\":\"The SQL statement to perform the reselect after a 'Create', 'Update' or 'Upsert' stored procedure operation 'Type'.\",\"description\":\"Defaults to '[{{Table.Schema}}].[sp{{Table.Name}}Get]' passing the primary key column(s).\"},\"intoTempTable\":{\"type\":\"boolean\",\"title\":\"Indicates whether to select into a '#TempTable' to allow other statements access to the selected data.\",\"description\":\"A 'Select * from #TempTable' is also performed (code-generated) where the stored procedure operation 'Type' is 'GetColl'.\"},\"withHints\":{\"type\":\"string\",\"title\":\"the table hints using the SQL Server 'WITH()' statement; the value specified will be used as-is; e.g. 'NOLOCK' will result in 'WITH(NOLOCK)'.\"},\"mergeOverrideIdentityColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be used in the 'Merge' statement to determine whether to _insert_, _update_ or _delete_.\",\"description\":\"This is used to override the default behaviour of using the primary key column(s).\",\"items\":{\"type\":\"string\"}},\"permission\":{\"type\":\"string\",\"title\":\"The name of the 'StoredProcedure' in the database.\"},\"orgUnitImmutable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.\",\"description\":\"Defaults to 'Table.OrgUnitImmutable'.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be included in the underlying generated _settable_ output (further filters 'Table.IncludeColumns').\",\"description\":\"Where not specified this indicates that all 'Columns' are to be included. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be excluded from the underlying generated _settable_ output (further filters 'Table.ExcludeColumns').\",\"description\":\"Where not specified this indicates no 'Columns' are to be excluded. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.\",\"items\":{\"type\":\"string\"}},\"parameters\":{\"type\":\"array\",\"title\":\"The corresponding 'Parameter' collection.\",\"items\":{\"$ref\":\"#/definitions/Parameter\"}},\"where\":{\"type\":\"array\",\"title\":\"The corresponding 'Where' collection.\",\"items\":{\"$ref\":\"#/definitions/Where\"}},\"orderby\":{\"type\":\"array\",\"title\":\"The corresponding 'OrderBy' collection.\",\"items\":{\"$ref\":\"#/definitions/OrderBy\"}},\"execute\":{\"type\":\"array\",\"title\":\"The corresponding 'Execute' collection.\",\"items\":{\"$ref\":\"#/definitions/Execute\"}}},\"required\":[\"name\"]},\"Parameter\":{\"type\":\"object\",\"title\":\"'Parameter' object (database-driven)\",\"description\":\"The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The parameter name (without the '@' prefix).\"},\"column\":{\"type\":\"string\",\"title\":\"The corresponding column name; used to infer characteristics.\",\"description\":\"Defaults to 'Name'.\"},\"sqlType\":{\"type\":\"string\",\"title\":\"The SQL type definition (overrides inherited Column definition) including length/precision/scale.\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the parameter is nullable.\",\"description\":\"Note that when the parameter value is 'NULL' it will not be included in the query.\"},\"treatColumnNullAs\":{\"type\":\"boolean\",\"title\":\"Indicates whether the column value where NULL should be treated as the specified value; results in: 'ISNULL([x].[col], value)'.\"},\"collection\":{\"type\":\"boolean\",\"title\":\"Indicates whether the parameter is a collection (one or more values to be included 'IN' the query).\"},\"operator\":{\"type\":\"string\",\"title\":\"The where clause equality operator\",\"description\":\"Defaults to 'EQ'.\",\"enum\":[\"EQ\",\"NE\",\"LT\",\"LE\",\"GT\",\"GE\",\"LIKE\"]}},\"required\":[\"name\"]},\"Where\":{\"type\":\"object\",\"title\":\"'Where' object (database-driven)\",\"description\":\"The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The where statement (TSQL).\"}},\"required\":[\"statement\"]},\"OrderBy\":{\"type\":\"object\",\"title\":\"'OrderBy' object (database-driven)\",\"description\":\"The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the 'Column' to order by.\"},\"order\":{\"type\":\"string\",\"title\":\"The corresponding sort order.\",\"description\":\"Defaults to 'Ascending'.\",\"enum\":[\"Ascending\",\"Descending\"]}},\"required\":[\"name\"]},\"Execute\":{\"type\":\"object\",\"title\":\"'Execute' object (database-driven)\",\"description\":\"The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The additional TSQL statement.\"},\"location\":{\"type\":\"string\",\"title\":\"The location of the statement in relation to the underlying primary stored procedure statement.\",\"description\":\"Defaults to 'After'.\",\"enum\":[\"Before\",\"After\"]}},\"required\":[\"statement\"]},\"Query\":{\"type\":\"object\",\"title\":\"'Query' object (database-driven)\",\"description\":\"The 'Query' object enables the definition of more complex multi-table queries ('Joins') that would primarily result in a database _View_. The primary table 'Name' for the query is required to be specified. Multiple queries can be specified for the same table(s). The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name). Additional 'Where' and 'Order' configuration can also be added as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the primary table of the query.\"},\"schema\":{\"type\":\"string\",\"title\":\"The schema name of the primary table of the view.\",\"description\":\"Defaults to 'CodeGeneration.dbo'.\"},\"alias\":{\"type\":\"string\",\"title\":\"The 'Schema.Table' alias name.\",\"description\":\"Will automatically default where not specified.\"},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all 'Columns' are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no 'Columns' are to be excluded.\",\"items\":{\"type\":\"string\"}},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.\",\"description\":\"Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'\",\"items\":{\"type\":\"string\"}},\"view\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'View' is to be generated.\"},\"viewName\":{\"type\":\"string\",\"title\":\"The 'View' name.\",\"description\":\"Defaults to 'vw' + 'Name'; e.g. 'vwTableName'.\"},\"viewSchema\":{\"type\":\"string\",\"title\":\"The schema name for the 'View'.\",\"description\":\"Defaults to 'Schema'.\"},\"permission\":{\"type\":\"string\",\"title\":\"The permission to be used for security permission checking.\",\"description\":\"The suffix is optional, and where not specified will default to '.READ'.\"},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the 'IsDeleted' capability.\",\"description\":\"Defaults to 'CodeGeneration.IsDeleted'.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the 'TenantId' capability.\",\"description\":\"Defaults to 'CodeGeneration.TenantId'.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the 'OrgUnitId' capability.\",\"description\":\"Defaults to 'CodeGeneration.OrgUnitId'.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the 'RowVersion' capability.\",\"description\":\"Defaults to 'CodeGeneration.RowVersion'.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedBy'.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedDate'.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"joins\":{\"type\":\"array\",\"title\":\"The corresponding 'Join' collection.\",\"items\":{\"$ref\":\"#/definitions/QueryJoin\"}},\"order\":{\"type\":\"array\",\"title\":\"The corresponding 'Order' collection.\",\"items\":{\"$ref\":\"#/definitions/QueryOrder\"}},\"where\":{\"type\":\"array\",\"title\":\"The corresponding 'Where' collection.\",\"items\":{\"$ref\":\"#/definitions/QueryWhere\"}}},\"required\":[\"name\"]},\"QueryJoin\":{\"type\":\"object\",\"title\":\"'QueryJoin' object (database-driven)\",\"description\":\"The 'QueryJoin' object defines a join to another (or same) table within a query. The 'Type' defines the join type, such as inner join, etc. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name).\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the table to join.\"},\"schema\":{\"type\":\"string\",\"title\":\"The schema name of the table to join.\",\"description\":\"Defaults to 'Table.Schema'; i.e. same schema.\"},\"alias\":{\"type\":\"string\",\"title\":\"The 'Schema.Table' alias name.\",\"description\":\"Will automatically default where not specified.\"},\"type\":{\"type\":\"string\",\"title\":\"The SQL join type.\",\"description\":\"Defaults to 'Inner'.\",\"enum\":[\"Inner\",\"Left\",\"Right\",\"Full\"]},\"includeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be included in the underlying generated output.\",\"description\":\"Where not specified this indicates that all 'Columns' are to be included.\",\"items\":{\"type\":\"string\"}},\"excludeColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' names to be excluded from the underlying generated output.\",\"description\":\"Where not specified this indicates no 'Columns' are to be excluded.\",\"items\":{\"type\":\"string\"}},\"aliasColumns\":{\"type\":\"array\",\"title\":\"The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.\",\"description\":\"Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'\",\"items\":{\"type\":\"string\"}},\"columnNameIsDeleted\":{\"type\":\"string\",\"title\":\"The column name for the 'IsDeleted' capability.\",\"description\":\"Defaults to 'CodeGeneration.IsDeleted'.\"},\"columnNameTenantId\":{\"type\":\"string\",\"title\":\"The column name for the 'TenantId' capability.\",\"description\":\"Defaults to 'CodeGeneration.TenantId'.\"},\"columnNameOrgUnitId\":{\"type\":\"string\",\"title\":\"The column name for the 'OrgUnitId' capability.\",\"description\":\"Defaults to 'CodeGeneration.OrgUnitId'.\"},\"columnNameRowVersion\":{\"type\":\"string\",\"title\":\"The column name for the 'RowVersion' capability.\",\"description\":\"Defaults to 'CodeGeneration.RowVersion'.\"},\"columnNameCreatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedBy'.\"},\"columnNameCreatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'CreatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.CreatedDate'.\"},\"columnNameUpdatedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameUpdatedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'UpdatedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"columnNameDeletedBy\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedBy' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedBy'.\"},\"columnNameDeletedDate\":{\"type\":\"string\",\"title\":\"The column name for the 'DeletedDate' capability.\",\"description\":\"Defaults to 'CodeGeneration.UpdatedDate'.\"},\"on\":{\"type\":\"array\",\"title\":\"The corresponding 'JoinOn' collection.\",\"items\":{\"$ref\":\"#/definitions/QueryJoinOn\"}}},\"required\":[\"name\"]},\"QueryJoinOn\":{\"type\":\"object\",\"title\":\"'QueryJoinOn' object (database-driven)\",\"description\":\"The 'QueryJoinOn' object defines the join on characteristics for a join within a query.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the join column (from the 'Join' table).\"},\"toSchema\":{\"type\":\"string\",\"title\":\"The name of the other join to table schema.\",\"description\":\"Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate.\"},\"toTable\":{\"type\":\"string\",\"title\":\"The name of the other join to table.\",\"description\":\"Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate.\"},\"toColumn\":{\"type\":\"string\",\"title\":\"The name of the other join to column.\",\"description\":\"Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate.\"},\"toStatement\":{\"type\":\"string\",\"title\":\"The fully qualified name ('Alias.Name') of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding 'Schema', 'Table' and 'Column' logic.\"}},\"required\":[\"name\"]},\"QueryOrder\":{\"type\":\"object\",\"title\":\"'QueryOrder' object (database-driven)\",\"description\":\"The 'QueryOrder' object that defines the query order.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The name of the 'Column' to order by.\",\"description\":\"See also 'Schema' and 'Table' as these all relate.\"},\"schema\":{\"type\":\"string\",\"title\":\"The name of order by table schema. See also 'Name' and 'Column' as these all relate.\",\"description\":\"Defaults to 'Query.Schema'.\"},\"table\":{\"type\":\"string\",\"title\":\"The name of the order by table.\",\"description\":\"Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate.\"},\"order\":{\"type\":\"string\",\"title\":\"The corresponding sort order.\",\"description\":\"Defaults to 'Ascending'.\",\"enum\":[\"Ascending\",\"Descending\"]}},\"required\":[\"name\"]},\"QueryWhere\":{\"type\":\"object\",\"title\":\"'QueryWhere' object (database-driven)\",\"description\":\"The 'QueryWhere' object defines an additional where 'Statement' to be added.\",\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"The where TSQL statement.\"}},\"required\":[\"statement\"]}},\"allOf\":[{\"$ref\":\"#/definitions/CodeGeneration\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).","$schema":"https://json-schema.org/draft-04/schema#","definitions":{"CodeGeneration":{"type":"object","title":"'CodeGeneration' object (database-driven)","description":"The 'CodeGeneration' object defines global properties that are used to drive the underlying database-driven code generation.","properties":{"schema":{"type":"string","title":"The name of the 'Schema' where the artefacts are defined in, or should be created in, the database.","description":"This is used as the default 'Schema' for all child objects."},"columnNameIsDeleted":{"type":"string","title":"The column name for the 'IsDeleted' capability.","description":"Defaults to 'IsDeleted'."},"columnNameTenantId":{"type":"string","title":"The column name for the 'TenantId' capability.","description":"Defaults to 'TenantId'."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the 'OrgUnitId' capability.","description":"Defaults to 'OrgUnitId'."},"columnNameRowVersion":{"type":"string","title":"The column name for the 'RowVersion' capability.","description":"Defaults to 'RowVersion'."},"columnNameCreatedBy":{"type":"string","title":"The column name for the 'CreatedBy' capability.","description":"Defaults to 'CreatedBy'."},"columnNameCreatedDate":{"type":"string","title":"The column name for the 'CreatedDate' capability.","description":"Defaults to 'CreatedDate'."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the 'UpdatedBy' capability.","description":"Defaults to 'UpdatedBy'."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the 'UpdatedDate' capability.","description":"Defaults to 'UpdatedDate'."},"columnNameDeletedBy":{"type":"string","title":"The column name for the 'DeletedBy' capability.","description":"Defaults to 'UpdatedBy'."},"columnNameDeletedDate":{"type":"string","title":"The column name for the 'DeletedDate' capability.","description":"Defaults to 'UpdatedDate'."},"orgUnitJoinSql":{"type":"string","title":"The SQL table or function that is to be used to join against for security-based 'OrgUnitId' verification.","description":"Defaults to '[Sec].[fnGetUserOrgUnits]()'."},"checkUserPermissionSql":{"type":"string","title":"The SQL stored procedure that is to be used for 'Permission' verification.","description":"Defaults to '[Sec].[spCheckUserHasPermission]'."},"getUserPermissionSql":{"type":"string","title":"The SQL function that is to be used for 'Permission' verification.","description":"Defaults to '[Sec].[fnGetUserHasPermission]'."},"cdcSchema":{"type":"string","title":"The schema name for the generated 'CDC'-related database artefacts.","description":"Defaults to 'XCdc' (literal)."},"cdcAuditTableName":{"type":"string","title":"The table name for the 'Cdc'-Tracking.","description":"Defaults to 'CdcTracking' (literal)."},"cdcIdentifierMapping":{"type":"boolean","title":"Indicates whether to include the generation of the generic 'Cdc'-IdentifierMapping database capabilities."},"cdcIdentifierMappingTableName":{"type":"string","title":"The table name for the 'Cdc'-IdentifierMapping.","description":"Defaults to 'CdcIdentifierMapping' (literal)."},"cdcIdentifierMappingStoredProcedureName":{"type":"string","title":"The table name for the 'Cdc'-IdentifierMapping.","description":"Defaults to 'spCreateCdcIdentifierMapping' (literal)."},"cdcExcludeColumnsFromETag":{"type":"array","title":"The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)","items":{"type":"string"}},"jsonSerializer":{"type":"string","title":"The JSON Serializer to use for JSON property attribution.","description":"Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).","enum":["None","Newtonsoft"]},"pluralizeCollectionProperties":{"type":"boolean","title":"Indicates whether the .NET collection properties should be pluralized."},"hasBeefDbo":{"type":"boolean","title":"Indicates whether the database has (contains) the standard _Beef_ 'dbo' schema objects.","description":"Defaults to 'true'."},"autoDotNetRename":{"type":"string","title":"The option to automatically rename the SQL Tables and Columns for use in .NET.","description":"Defaults 'SnakeKebabToPascalCase' that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.","enum":["None","PascalCase","SnakeKebabToPascalCase"]},"entityScope":{"type":"string","title":"The entity scope option.","description":"Defaults to 'Common' for backwards compatibility; 'Autonomous' is recommended. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).","enum":["Common","Business","Autonomous"]},"eventSubjectRoot":{"type":"string","title":"The root for the event name by prepending to all event subject names via CDC.","description":"Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be extended within the 'Entity'(s)."},"eventSubjectFormat":{"type":"string","title":"The default formatting for the Subject when an Event is published via CDC.","description":"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.","enum":["NameOnly","NameAndKey"]},"eventActionFormat":{"type":"string","title":"The formatting for the Action when an Event is published via CDC.","description":"Defaults to 'None' (no formatting required, i.e. as-is).","enum":["None","PastTense"]},"eventSourceRoot":{"type":"string","title":"The URI root for the event source by prepending to all event source URIs for CDC.","description":"The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s)."},"eventSourceKind":{"type":"string","title":"The URI kind for the event source URIs for CDC.","description":"Defaults to 'None' (being the event source is not updated).","enum":["None","Absolute","Relative","RelativeOrAbsolute"]},"eventSourceFormat":{"type":"string","title":"The default formatting for the Source when an Event is published via CDC.","description":"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.","enum":["NameOnly","NameAndKey","NameAndGlobalId"]},"eventOutbox":{"type":"boolean","title":"Indicates whether events will publish using the outbox pattern and therefore the event outbox artefacts are required."},"eventOutboxTableName":{"type":"string","title":"The table name for the 'EventOutbox'.","description":"Defaults to 'EventOutbox' (literal)."},"pathBase":{"type":"string","title":"The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.","description":"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'."},"pathDatabaseSchema":{"type":"string","title":"The path (directory) for the Schema Database-related artefacts.","description":"Defaults to 'PathBase' + '.Database/Schema' (literal). For example 'Beef.Demo.Database/Schema'."},"pathDatabaseMigrations":{"type":"string","title":"The path (directory) for the Schema Database-related artefacts.","description":"Defaults to 'PathBase' + '.Database/Migrations' (literal). For example 'Beef.Demo.Database/Migrations'."},"pathBusiness":{"type":"string","title":"The path (directory) for the Business-related (.NET) artefacts.","description":"Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'."},"PathCdcPublisher":{"type":"string","title":"The path (directory) for the CDC-related (.NET) artefacts.","description":"Defaults to 'PathBase' + '.Cdc' (literal). For example 'Beef.Demo.Cdc'."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.","description":"This is only applicable for stored procedures."},"namespaceBase":{"type":"string","title":"The base Namespace (root) for the .NET artefacts.","description":"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'."},"namespaceCommon":{"type":"string","title":"The Namespace (root) for the Common-related .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'."},"namespaceBusiness":{"type":"string","title":"The Namespace (root) for the Business-related .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'."},"NamespaceCdcPublisher":{"type":"string","title":"The Namespace (root) for the CDC-related publisher .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.CdcPublisher' (literal). For example 'Beef.Demo.CdcPublisher'."},"tables":{"type":"array","title":"The corresponding 'Table' collection.","items":{"$ref":"#/definitions/Table"}},"queries":{"type":"array","title":"The corresponding 'Query' collection.","items":{"$ref":"#/definitions/Query"}}}},"Table":{"type":"object","title":"'Table' object (entity-driven)","description":"The 'Table' object identifies an existing database 'Table' (or 'View') and defines its code-generation characteristics.","properties":{"name":{"type":"string","title":"The name of the 'Table' in the database."},"schema":{"type":"string","title":"The name of the 'Schema' where the 'Table' is defined in the database.","description":"Defaults to 'CodeGeneration.Schema'."},"alias":{"type":"string","title":"The 'Schema.Table' alias name.","description":"Will automatically default where not specified."},"includeColumns":{"type":"array","title":"The list of 'Column' names to be included in the underlying generated output.","description":"Where not specified this indicates that all 'Columns' are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of 'Column' names to be excluded from the underlying generated output.","description":"Where not specified this indicates no 'Columns' are to be excluded.","items":{"type":"string"}},"get":{"type":"boolean","title":"Indicates whether a 'Get' stored procedure is to be automatically generated where not otherwise explicitly specified."},"getAll":{"type":"boolean","title":"Indicates whether a 'GetAll' stored procedure is to be automatically generated where not otherwise explicitly specified.","description":"The 'GetAllOrderBy' is used to specify the 'GetAll' query sort order."},"getAllOrderBy":{"type":"array","title":"The list of 'Column' names (including sort order 'ASC'/'DESC' literal) to be used as the 'GetAll' query sort order.","description":"This relates to the 'GetAll' selection.","items":{"type":"string"}},"create":{"type":"boolean","title":"Indicates whether a 'Create' stored procedure is to be automatically generated where not otherwise explicitly specified."},"update":{"type":"boolean","title":"Indicates whether a 'Update' stored procedure is to be automatically generated where not otherwise explicitly specified."},"upsert":{"type":"boolean","title":"Indicates whether a 'Upsert' stored procedure is to be automatically generated where not otherwise explicitly specified."},"delete":{"type":"boolean","title":"Indicates whether a 'Delete' stored procedure is to be automatically generated where not otherwise explicitly specified."},"merge":{"type":"boolean","title":"Indicates whether a 'Merge' (insert/update/delete of 'Udt' list) stored procedure is to be automatically generated where not otherwise explicitly specified.","description":"This will also require a 'Udt' (SQL User Defined Table) and 'Tvp' (.NET Table-Valued Parameter) to function."},"efModel":{"type":"boolean","title":"Indicates whether an 'Entity Framework' .NET (C#) model is to be generated."},"efModelName":{"type":"string","title":"The .NET (C#) EntityFramework (EF) model name.","description":"Defaults to 'Name'."},"udt":{"type":"boolean","title":"Indicates whether a 'User Defined Table (UDT)' type should be created."},"udtExcludeColumns":{"type":"array","title":"The list of 'Column' names to be excluded from the 'User Defined Table (UDT)'.","description":"Where not specified this indicates that no 'Columns' are to be excluded.","items":{"type":"string"}},"tvp":{"type":"string","title":"The name of the .NET entity associated with the 'Udt' so that it can be expressed (created) as a Table-Valued Parameter for usage within the corresponding 'DbMapper'."},"entityScope":{"type":"string","title":"The entity scope option.","description":"Defaults to 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).","enum":["Common","Business","Autonomous"]},"permission":{"type":"string","title":"The permission (prefix) to be used for security permission checking (suffix defaults to 'Read', 'Write' or 'Delete' and can be overridden in the underlying stored procedure)."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.","description":"Defaults to 'CodeGeneration.OrgUnitImmutable'. This is only applicable for stored procedures."},"columnNameIsDeleted":{"type":"string","title":"The column name for the 'IsDeleted' capability.","description":"Defaults to 'CodeGeneration.IsDeleted'."},"columnNameTenantId":{"type":"string","title":"The column name for the 'TenantId' capability.","description":"Defaults to 'CodeGeneration.TenantId'."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the 'OrgUnitId' capability.","description":"Defaults to 'CodeGeneration.OrgUnitId'."},"columnNameRowVersion":{"type":"string","title":"The column name for the 'RowVersion' capability.","description":"Defaults to 'CodeGeneration.RowVersion'."},"columnNameCreatedBy":{"type":"string","title":"The column name for the 'CreatedBy' capability.","description":"Defaults to 'CodeGeneration.CreatedBy'."},"columnNameCreatedDate":{"type":"string","title":"The column name for the 'CreatedDate' capability.","description":"Defaults to 'CodeGeneration.CreatedDate'."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the 'UpdatedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the 'UpdatedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"columnNameDeletedBy":{"type":"string","title":"The column name for the 'DeletedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameDeletedDate":{"type":"string","title":"The column name for the 'DeletedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"storedProcedures":{"type":"array","title":"The corresponding 'StoredProcedure' collection.","items":{"$ref":"#/definitions/StoredProcedure"}}},"required":["name"]},"StoredProcedure":{"type":"object","title":"'StoredProcedure' object (database-driven)","description":"The code generation for an 'StoredProcedure' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting 'Upsert', 'Merge' and ad-hoc queries as required.","properties":{"name":{"type":"string","title":"The name of the 'StoredProcedure'; generally the verb/action, i.e. 'Get', 'Update', etc.","description":"See 'StoredProcedureName' for the actual name used in the database."},"type":{"type":"string","title":"The stored procedure operation type.","description":"Defaults to 'GetColl'.","enum":["Get","GetColl","Create","Update","Upsert","Delete","Merge"]},"paging":{"type":"boolean","title":"Indicates whether standardized paging support should be added.","description":"This only applies where the stored procedure operation 'Type' is 'GetColl'."},"storedProcedureName":{"type":"string","title":"The 'StoredProcedure' name in the database.","description":"Defaults to 'sp' + 'Table.Name' + 'Name'; e.g. 'spTableName' or 'spPersonGet'."},"reselectStatement":{"type":"string","title":"The SQL statement to perform the reselect after a 'Create', 'Update' or 'Upsert' stored procedure operation 'Type'.","description":"Defaults to '[{{Table.Schema}}].[sp{{Table.Name}}Get]' passing the primary key column(s)."},"intoTempTable":{"type":"boolean","title":"Indicates whether to select into a '#TempTable' to allow other statements access to the selected data.","description":"A 'Select * from #TempTable' is also performed (code-generated) where the stored procedure operation 'Type' is 'GetColl'."},"withHints":{"type":"string","title":"the table hints using the SQL Server 'WITH()' statement; the value specified will be used as-is; e.g. 'NOLOCK' will result in 'WITH(NOLOCK)'."},"mergeOverrideIdentityColumns":{"type":"array","title":"The list of 'Column' names to be used in the 'Merge' statement to determine whether to _insert_, _update_ or _delete_.","description":"This is used to override the default behaviour of using the primary key column(s).","items":{"type":"string"}},"permission":{"type":"string","title":"The name of the 'StoredProcedure' in the database."},"orgUnitImmutable":{"type":"boolean","title":"Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.","description":"Defaults to 'Table.OrgUnitImmutable'."},"includeColumns":{"type":"array","title":"The list of 'Column' names to be included in the underlying generated _settable_ output (further filters 'Table.IncludeColumns').","description":"Where not specified this indicates that all 'Columns' are to be included. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of 'Column' names to be excluded from the underlying generated _settable_ output (further filters 'Table.ExcludeColumns').","description":"Where not specified this indicates no 'Columns' are to be excluded. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.","items":{"type":"string"}},"parameters":{"type":"array","title":"The corresponding 'Parameter' collection.","items":{"$ref":"#/definitions/Parameter"}},"where":{"type":"array","title":"The corresponding 'Where' collection.","items":{"$ref":"#/definitions/Where"}},"orderby":{"type":"array","title":"The corresponding 'OrderBy' collection.","items":{"$ref":"#/definitions/OrderBy"}},"execute":{"type":"array","title":"The corresponding 'Execute' collection.","items":{"$ref":"#/definitions/Execute"}}},"required":["name"]},"Parameter":{"type":"object","title":"'Parameter' object (database-driven)","description":"The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.","properties":{"name":{"type":"string","title":"The parameter name (without the '@' prefix)."},"column":{"type":"string","title":"The corresponding column name; used to infer characteristics.","description":"Defaults to 'Name'."},"sqlType":{"type":"string","title":"The SQL type definition (overrides inherited Column definition) including length/precision/scale."},"nullable":{"type":"boolean","title":"Indicates whether the parameter is nullable.","description":"Note that when the parameter value is 'NULL' it will not be included in the query."},"treatColumnNullAs":{"type":"boolean","title":"Indicates whether the column value where NULL should be treated as the specified value; results in: 'ISNULL([x].[col], value)'."},"collection":{"type":"boolean","title":"Indicates whether the parameter is a collection (one or more values to be included 'IN' the query)."},"operator":{"type":"string","title":"The where clause equality operator","description":"Defaults to 'EQ'.","enum":["EQ","NE","LT","LE","GT","GE","LIKE"]}},"required":["name"]},"Where":{"type":"object","title":"'Where' object (database-driven)","description":"The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.","properties":{"statement":{"type":"string","title":"The where statement (TSQL)."}},"required":["statement"]},"OrderBy":{"type":"object","title":"'OrderBy' object (database-driven)","description":"The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.","properties":{"name":{"type":"string","title":"The name of the 'Column' to order by."},"order":{"type":"string","title":"The corresponding sort order.","description":"Defaults to 'Ascending'.","enum":["Ascending","Descending"]}},"required":["name"]},"Execute":{"type":"object","title":"'Execute' object (database-driven)","description":"The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.","properties":{"statement":{"type":"string","title":"The additional TSQL statement."},"location":{"type":"string","title":"The location of the statement in relation to the underlying primary stored procedure statement.","description":"Defaults to 'After'.","enum":["Before","After"]}},"required":["statement"]},"Query":{"type":"object","title":"'Query' object (database-driven)","description":"The 'Query' object enables the definition of more complex multi-table queries ('Joins') that would primarily result in a database _View_. The primary table 'Name' for the query is required to be specified. Multiple queries can be specified for the same table(s). The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name). Additional 'Where' and 'Order' configuration can also be added as required.","properties":{"name":{"type":"string","title":"The name of the primary table of the query."},"schema":{"type":"string","title":"The schema name of the primary table of the view.","description":"Defaults to 'CodeGeneration.dbo'."},"alias":{"type":"string","title":"The 'Schema.Table' alias name.","description":"Will automatically default where not specified."},"includeColumns":{"type":"array","title":"The list of 'Column' names to be included in the underlying generated output.","description":"Where not specified this indicates that all 'Columns' are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of 'Column' names to be excluded from the underlying generated output.","description":"Where not specified this indicates no 'Columns' are to be excluded.","items":{"type":"string"}},"aliasColumns":{"type":"array","title":"The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.","description":"Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'","items":{"type":"string"}},"view":{"type":"boolean","title":"Indicates whether a 'View' is to be generated."},"viewName":{"type":"string","title":"The 'View' name.","description":"Defaults to 'vw' + 'Name'; e.g. 'vwTableName'."},"viewSchema":{"type":"string","title":"The schema name for the 'View'.","description":"Defaults to 'Schema'."},"permission":{"type":"string","title":"The permission to be used for security permission checking.","description":"The suffix is optional, and where not specified will default to '.READ'."},"columnNameIsDeleted":{"type":"string","title":"The column name for the 'IsDeleted' capability.","description":"Defaults to 'CodeGeneration.IsDeleted'."},"columnNameTenantId":{"type":"string","title":"The column name for the 'TenantId' capability.","description":"Defaults to 'CodeGeneration.TenantId'."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the 'OrgUnitId' capability.","description":"Defaults to 'CodeGeneration.OrgUnitId'."},"columnNameRowVersion":{"type":"string","title":"The column name for the 'RowVersion' capability.","description":"Defaults to 'CodeGeneration.RowVersion'."},"columnNameCreatedBy":{"type":"string","title":"The column name for the 'CreatedBy' capability.","description":"Defaults to 'CodeGeneration.CreatedBy'."},"columnNameCreatedDate":{"type":"string","title":"The column name for the 'CreatedDate' capability.","description":"Defaults to 'CodeGeneration.CreatedDate'."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the 'UpdatedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the 'UpdatedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"columnNameDeletedBy":{"type":"string","title":"The column name for the 'DeletedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameDeletedDate":{"type":"string","title":"The column name for the 'DeletedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"joins":{"type":"array","title":"The corresponding 'Join' collection.","items":{"$ref":"#/definitions/QueryJoin"}},"order":{"type":"array","title":"The corresponding 'Order' collection.","items":{"$ref":"#/definitions/QueryOrder"}},"where":{"type":"array","title":"The corresponding 'Where' collection.","items":{"$ref":"#/definitions/QueryWhere"}}},"required":["name"]},"QueryJoin":{"type":"object","title":"'QueryJoin' object (database-driven)","description":"The 'QueryJoin' object defines a join to another (or same) table within a query. The 'Type' defines the join type, such as inner join, etc. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name).","properties":{"name":{"type":"string","title":"The name of the table to join."},"schema":{"type":"string","title":"The schema name of the table to join.","description":"Defaults to 'Table.Schema'; i.e. same schema."},"alias":{"type":"string","title":"The 'Schema.Table' alias name.","description":"Will automatically default where not specified."},"type":{"type":"string","title":"The SQL join type.","description":"Defaults to 'Inner'.","enum":["Inner","Left","Right","Full"]},"includeColumns":{"type":"array","title":"The list of 'Column' names to be included in the underlying generated output.","description":"Where not specified this indicates that all 'Columns' are to be included.","items":{"type":"string"}},"excludeColumns":{"type":"array","title":"The list of 'Column' names to be excluded from the underlying generated output.","description":"Where not specified this indicates no 'Columns' are to be excluded.","items":{"type":"string"}},"aliasColumns":{"type":"array","title":"The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.","description":"Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'","items":{"type":"string"}},"columnNameIsDeleted":{"type":"string","title":"The column name for the 'IsDeleted' capability.","description":"Defaults to 'CodeGeneration.IsDeleted'."},"columnNameTenantId":{"type":"string","title":"The column name for the 'TenantId' capability.","description":"Defaults to 'CodeGeneration.TenantId'."},"columnNameOrgUnitId":{"type":"string","title":"The column name for the 'OrgUnitId' capability.","description":"Defaults to 'CodeGeneration.OrgUnitId'."},"columnNameRowVersion":{"type":"string","title":"The column name for the 'RowVersion' capability.","description":"Defaults to 'CodeGeneration.RowVersion'."},"columnNameCreatedBy":{"type":"string","title":"The column name for the 'CreatedBy' capability.","description":"Defaults to 'CodeGeneration.CreatedBy'."},"columnNameCreatedDate":{"type":"string","title":"The column name for the 'CreatedDate' capability.","description":"Defaults to 'CodeGeneration.CreatedDate'."},"columnNameUpdatedBy":{"type":"string","title":"The column name for the 'UpdatedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameUpdatedDate":{"type":"string","title":"The column name for the 'UpdatedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"columnNameDeletedBy":{"type":"string","title":"The column name for the 'DeletedBy' capability.","description":"Defaults to 'CodeGeneration.UpdatedBy'."},"columnNameDeletedDate":{"type":"string","title":"The column name for the 'DeletedDate' capability.","description":"Defaults to 'CodeGeneration.UpdatedDate'."},"on":{"type":"array","title":"The corresponding 'JoinOn' collection.","items":{"$ref":"#/definitions/QueryJoinOn"}}},"required":["name"]},"QueryJoinOn":{"type":"object","title":"'QueryJoinOn' object (database-driven)","description":"The 'QueryJoinOn' object defines the join on characteristics for a join within a query.","properties":{"name":{"type":"string","title":"The name of the join column (from the 'Join' table)."},"toSchema":{"type":"string","title":"The name of the other join to table schema.","description":"Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate."},"toTable":{"type":"string","title":"The name of the other join to table.","description":"Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate."},"toColumn":{"type":"string","title":"The name of the other join to column.","description":"Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate."},"toStatement":{"type":"string","title":"The fully qualified name ('Alias.Name') of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding 'Schema', 'Table' and 'Column' logic."}},"required":["name"]},"QueryOrder":{"type":"object","title":"'QueryOrder' object (database-driven)","description":"The 'QueryOrder' object that defines the query order.","properties":{"name":{"type":"string","title":"The name of the 'Column' to order by.","description":"See also 'Schema' and 'Table' as these all relate."},"schema":{"type":"string","title":"The name of order by table schema. See also 'Name' and 'Column' as these all relate.","description":"Defaults to 'Query.Schema'."},"table":{"type":"string","title":"The name of the order by table.","description":"Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate."},"order":{"type":"string","title":"The corresponding sort order.","description":"Defaults to 'Ascending'.","enum":["Ascending","Descending"]}},"required":["name"]},"QueryWhere":{"type":"object","title":"'QueryWhere' object (database-driven)","description":"The 'QueryWhere' object defines an additional where 'Statement' to be added.","properties":{"statement":{"type":"string","title":"The where TSQL statement."}},"required":["statement"]}},"allOf":[{"$ref":"#/definitions/CodeGeneration"}]}
|
Provide a JSON object that satisfies the schema "JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).
|
schema-store
|
schema_store_240
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/databricks-asset-bundles.json\",\"$defs\":{\"bool\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(resources(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(bundle(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(workspace(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(artifacts(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"float64\":{\"oneOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(resources(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(bundle(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(workspace(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(artifacts(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"github.com\":{\"databricks\":{\"cli\":{\"bundle\":{\"config\":{\"resources.App\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"active_deployment\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeployment\"},\"app_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ApplicationStatus\"},\"compute_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeStatus\"},\"config\":{\"$ref\":\"#/$defs/map/interface\"},\"create_time\":{\"$ref\":\"#/$defs/string\"},\"creator\":{\"$ref\":\"#/$defs/string\"},\"default_source_code_path\":{\"$ref\":\"#/$defs/string\"},\"description\":{\"$ref\":\"#/$defs/string\"},\"name\":{\"$ref\":\"#/$defs/string\"},\"pending_deployment\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeployment\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"resources\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource\"},\"service_principal_client_id\":{\"$ref\":\"#/$defs/string\"},\"service_principal_id\":{\"$ref\":\"#/$defs/int64\"},\"service_principal_name\":{\"$ref\":\"#/$defs/string\"},\"source_code_path\":{\"$ref\":\"#/$defs/string\"},\"update_time\":{\"$ref\":\"#/$defs/string\"},\"updater\":{\"$ref\":\"#/$defs/string\"},\"url\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false,\"required\":[\"source_code_path\",\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Cluster\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"apply_policy_default_values\":{\"$ref\":\"#/$defs/bool\",\"description\":\"When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.\"},\"autoscale\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale\",\"description\":\"Parameters needed in order to automatically scale clusters up and down based on load.\\nNote: autoscaling works best with DB runtime versions 3.0 or later.\"},\"autotermination_minutes\":{\"$ref\":\"#/$defs/int\",\"description\":\"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\\nthis cluster will not be automatically terminated. If specified, the threshold must be between\\n10 and 10000 minutes.\\nUsers can also set this value to 0 to explicitly disable automatic termination.\"},\"aws_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes\",\"description\":\"Attributes related to clusters running on Amazon Web Services.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"azure_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes\",\"description\":\"Attributes related to clusters running on Microsoft Azure.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"cluster_log_conf\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf\",\"description\":\"The configuration for delivering spark logs to a long-term storage destination.\\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\\nthe destination of executor logs is `$destination/$clusterId/executor`.\"},\"cluster_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Cluster name requested by the user. This doesn't have to be unique.\\nIf not specified at creation, the cluster name will be an empty string.\\n\"},\"custom_tags\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\\n\\n- Currently, Databricks allows at most 45 custom tags\\n\\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags\"},\"data_security_mode\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode\"},\"docker_image\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage\"},\"driver_instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool for the driver of the cluster belongs.\\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\\nassigned.\"},\"driver_node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The node type of the Spark driver. Note that this field is optional;\\nif unset, the driver node type will be set as the same value\\nas `node_type_id` defined above.\\n\"},\"enable_elastic_disk\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\\npermissions to function correctly - refer to the User Guide for more details.\"},\"enable_local_disk_encryption\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to enable LUKS on cluster VMs' local disks\"},\"gcp_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes\",\"description\":\"Attributes related to clusters running on Google Cloud Platform.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"init_scripts\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo\",\"description\":\"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`.\"},\"instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool to which the cluster belongs.\"},\"is_single_node\":{\"$ref\":\"#/$defs/bool\",\"description\":\"This field can only be used with `kind`.\\n\\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`\\n\"},\"kind\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind\"},\"node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field encodes, through a single value, the resources available to each of\\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\\nand optimized for memory or compute intensive workloads. A list of available node\\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\\n\"},\"num_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\\n\\nNote: When reading the properties of a cluster, this field reflects the desired number\\nof workers rather than the actual current number of workers. For instance, if a cluster\\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\\nincrease from 5 to 10 as the new nodes are provisioned.\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"policy_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The ID of the cluster policy used to create the cluster if applicable.\"},\"runtime_engine\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine\"},\"single_user_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Single user name if data_security_mode is `SINGLE_USER`\"},\"spark_conf\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified Spark configuration key-value pairs.\\nUsers can also pass in a string of extra JVM options to the driver and the executors via\\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\\n\"},\"spark_env_vars\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified environment variable key-value pairs.\\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\\n`export X='Y'`) while launching the driver and workers.\\n\\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\\ndefault databricks managed environmental variables are included as well.\\n\\nExample Spark environment variables:\\n`{\\\"SPARK_WORKER_MEMORY\\\": \\\"28000m\\\", \\\"SPARK_LOCAL_DIRS\\\": \\\"/local_disk0\\\"}` or\\n`{\\\"SPARK_DAEMON_JAVA_OPTS\\\": \\\"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\\\"}`\"},\"spark_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\\nA list of available Spark versions can be retrieved by using\\nthe :method:clusters/sparkVersions API call.\\n\"},\"ssh_public_keys\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"SSH public key contents that will be added to each Spark node in this cluster. The\\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\\nUp to 10 keys can be specified.\"},\"use_ml_runtime\":{\"$ref\":\"#/$defs/bool\",\"description\":\"This field can only be used with `kind`.\\n\\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.\\n\"},\"workload_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Dashboard\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"create_time\":{\"$ref\":\"#/$defs/string\",\"description\":\"The timestamp of when the dashboard was created.\"},\"dashboard_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"UUID identifying the dashboard.\"},\"display_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The display name of the dashboard.\"},\"embed_credentials\":{\"$ref\":\"#/$defs/bool\"},\"etag\":{\"$ref\":\"#/$defs/string\",\"description\":\"The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\\nhas not been modified since the last read.\\nThis field is excluded in List Dashboards responses.\"},\"file_path\":{\"$ref\":\"#/$defs/string\"},\"lifecycle_state\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/dashboards.LifecycleState\",\"description\":\"The state of the dashboard resource. Used for tracking trashed status.\"},\"parent_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workspace path of the folder containing the dashboard. Includes leading slash and no\\ntrailing slash.\\nThis field is excluded in List Dashboards responses.\"},\"path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workspace path of the dashboard asset, including the file name.\\nExported dashboards always have the file extension `.lvdash.json`.\\nThis field is excluded in List Dashboards responses.\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"serialized_dashboard\":{\"$ref\":\"#/$defs/interface\",\"description\":\"The contents of the dashboard in serialized string form.\\nThis field is excluded in List Dashboards responses.\\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\\nto retrieve an example response, which includes the `serialized_dashboard` field.\\nThis field provides the structure of the JSON string that represents the dashboard's\\nlayout and components.\"},\"update_time\":{\"$ref\":\"#/$defs/string\",\"description\":\"The timestamp of when the dashboard was last updated by the user.\\nThis field is excluded in List Dashboards responses.\"},\"warehouse_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The warehouse ID used to run the dashboard.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Grant\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"principal\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the principal that will be granted privileges\"},\"privileges\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The privileges to grant to the specified entity\"}},\"additionalProperties\":false,\"required\":[\"privileges\",\"principal\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Job\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"budget_policy_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The id of the user specified budget policy to use for this job.\\nIf not specified, a default budget policy may be applied when creating or modifying the job.\\nSee `effective_budget_policy_id` for the budget policy used by this workload.\"},\"continuous\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Continuous\",\"description\":\"An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used.\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.\"},\"email_notifications\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications\",\"description\":\"An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.\"},\"environments\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment\",\"description\":\"A list of task execution environment specifications that can be referenced by serverless tasks of this job.\\nAn environment is required to be present for serverless tasks.\\nFor serverless notebook tasks, the environment is accessible in the notebook environment panel.\\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.\"},\"git_source\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitSource\",\"description\":\"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\\n\\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\\n\\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.\"},\"health\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules\"},\"job_clusters\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster\",\"description\":\"A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.\\nIf more than 100 job clusters are available, you can paginate through them using :method:jobs/get.\"},\"max_concurrent_runs\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional maximum allowed number of concurrent runs of the job.\\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\\nThis setting affects only new runs. For example, suppose the job\\u2019s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won\\u2019t kill any of the active runs.\\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.\"},\"notification_settings\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobNotificationSettings\",\"description\":\"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.\"},\"parameters\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition\",\"description\":\"Job-level parameter definitions\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"queue\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings\",\"description\":\"The queue settings of the job.\"},\"run_as\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs\"},\"schedule\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronSchedule\",\"description\":\"An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking \\u201cRun Now\\u201d in the Jobs UI or sending an API request to `runNow`.\"},\"tags\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.\"},\"tasks\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Task\",\"description\":\"A list of task specifications to be executed by this job.\\nIf more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.\"},\"timeout_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional timeout applied to each run of this job. A value of `0` means no timeout.\"},\"trigger\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings\",\"description\":\"A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking \\u201cRun Now\\u201d in the Jobs UI or sending an API request to `runNow`.\"},\"webhook_notifications\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications\",\"description\":\"A collection of system notification IDs to notify when runs of this job begin or complete.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.MlflowExperiment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"artifact_location\":{\"$ref\":\"#/$defs/string\",\"description\":\"Location where artifacts for the experiment are stored.\"},\"creation_time\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Creation time\"},\"experiment_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Unique identifier for the experiment.\"},\"last_update_time\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Last update time\"},\"lifecycle_stage\":{\"$ref\":\"#/$defs/string\",\"description\":\"Current life cycle stage of the experiment: \\\"active\\\" or \\\"deleted\\\".\\nDeleted experiments are not returned by APIs.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Human readable name that identifies the experiment.\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"tags\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag\",\"description\":\"Tags: Additional metadata key-value pairs.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.MlflowModel\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"creation_timestamp\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Timestamp recorded when this `registered_model` was created.\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"Description of this `registered_model`.\"},\"last_updated_timestamp\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Timestamp recorded when metadata for this `registered_model` was last updated.\"},\"latest_versions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelVersion\",\"description\":\"Collection of latest model versions for each stage.\\nOnly contains models with current `READY` status.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Unique name for the model.\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"tags\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag\",\"description\":\"Tags: Additional metadata key-value pairs for this `registered_model`.\"},\"user_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"User that created this `registered_model`\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.ModelServingEndpoint\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"ai_gateway\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig\",\"description\":\"The AI Gateway configuration for the serving endpoint. NOTE: only external model endpoints are supported as of now.\"},\"config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointCoreConfigInput\",\"description\":\"The core config of the serving endpoint.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.\\n\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"rate_limits\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.RateLimit\",\"description\":\"Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.\"},\"route_optimized\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Enable route optimization for the serving endpoint.\"},\"tags\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag\",\"description\":\"Tags to be attached to the serving endpoint and automatically propagated to billing logs.\"}},\"additionalProperties\":false,\"required\":[\"config\",\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Permission\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"group_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the group that has the permission set in level.\"},\"level\":{\"$ref\":\"#/$defs/string\",\"description\":\"The allowed permission for user, group, service principal defined for this permission.\"},\"service_principal_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the service principal that has the permission set in level.\"},\"user_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the user that has the permission set in level.\"}},\"additionalProperties\":false,\"required\":[\"level\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Pipeline\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"budget_policy_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Budget policy of this pipeline.\"},\"catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog.\"},\"channel\":{\"$ref\":\"#/$defs/string\",\"description\":\"DLT Release Channel that specifies which version to use.\"},\"clusters\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster\",\"description\":\"Cluster settings for this pipeline deployment.\"},\"configuration\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"String-String configuration for this pipeline execution.\"},\"continuous\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether the pipeline is continuous or triggered. This replaces `trigger`.\"},\"deployment\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment\",\"description\":\"Deployment type of this pipeline.\"},\"development\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether the pipeline is in Development mode. Defaults to false.\"},\"edition\":{\"$ref\":\"#/$defs/string\",\"description\":\"Pipeline product edition.\"},\"filters\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters\",\"description\":\"Filters on which Pipeline packages to include in the deployed graph.\"},\"gateway_definition\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition\",\"description\":\"The definition of a gateway pipeline to support change data capture.\"},\"id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Unique identifier for this pipeline.\"},\"ingestion_definition\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition\",\"description\":\"The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'target' or 'catalog' settings.\"},\"libraries\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary\",\"description\":\"Libraries or code needed by this deployment.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Friendly identifier for this pipeline.\"},\"notifications\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications\",\"description\":\"List of notification settings for this pipeline.\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\"},\"photon\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether Photon is enabled for this pipeline.\"},\"restart_window\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow\",\"description\":\"Restart window of this pipeline.\"},\"schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"The default schema (database) where tables are read from or published to. The presence of this field implies that the pipeline is in direct publishing mode.\"},\"serverless\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether serverless compute is enabled for this pipeline.\"},\"storage\":{\"$ref\":\"#/$defs/string\",\"description\":\"DBFS root directory for storing checkpoints and tables.\"},\"target\":{\"$ref\":\"#/$defs/string\",\"description\":\"Target schema (database) to add tables in this pipeline to. If not specified, no data is published to the Hive metastore or Unity Catalog. To publish to Unity Catalog, also specify `catalog`.\"},\"trigger\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTrigger\",\"description\":\"Which pipeline trigger to use. Deprecated: Use `continuous` instead.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.QualityMonitor\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"assets_dir\":{\"$ref\":\"#/$defs/string\",\"description\":\"The directory to store monitoring assets (e.g. dashboard, metric tables).\"},\"baseline_table_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the baseline table from which drift metrics are computed from.\\nColumns in the monitored table should also be present in the baseline table.\\n\"},\"custom_metrics\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric\",\"description\":\"Custom metrics to compute on the monitored table. These can be aggregate metrics, derived\\nmetrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time\\nwindows).\\n\"},\"data_classification_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig\",\"description\":\"The data classification config for the monitor.\"},\"inference_log\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog\",\"description\":\"Configuration for monitoring inference logs.\"},\"notifications\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications\",\"description\":\"The notification settings for the monitor.\"},\"output_schema_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Schema where output metric tables are created.\"},\"schedule\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedule\",\"description\":\"The schedule for automatically updating and refreshing metric tables.\"},\"skip_builtin_dashboard\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to skip creating a default dashboard summarizing data quality metrics.\"},\"slicing_exprs\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"List of column expressions to slice data with for targeted analysis. The data is grouped by\\neach expression independently, resulting in a separate slice for each predicate and its\\ncomplements. For high-cardinality columns, only the top 100 unique values by frequency will\\ngenerate slices.\\n\"},\"snapshot\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot\",\"description\":\"Configuration for monitoring snapshot tables.\"},\"table_name\":{\"$ref\":\"#/$defs/string\"},\"time_series\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries\",\"description\":\"Configuration for monitoring time series tables.\"},\"warehouse_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\\nwarehouse will be used.\\n\"}},\"additionalProperties\":false,\"required\":[\"table_name\",\"assets_dir\",\"output_schema_name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.RegisteredModel\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the catalog where the schema and the registered model reside\"},\"comment\":{\"$ref\":\"#/$defs/string\",\"description\":\"The comment attached to the registered model\"},\"grants\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the registered model\"},\"schema_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the schema where the registered model resides\"},\"storage_location\":{\"$ref\":\"#/$defs/string\",\"description\":\"The storage location on the cloud under which model version data files are stored\"}},\"additionalProperties\":false,\"required\":[\"catalog_name\",\"name\",\"schema_name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Schema\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of parent catalog.\"},\"comment\":{\"$ref\":\"#/$defs/string\",\"description\":\"User-provided free-form text description.\"},\"grants\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of schema, relative to parent catalog.\"},\"properties\":{\"$ref\":\"#/$defs/map/string\"},\"storage_root\":{\"$ref\":\"#/$defs/string\",\"description\":\"Storage root URL for managed tables within schema.\"}},\"additionalProperties\":false,\"required\":[\"catalog_name\",\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Volume\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the catalog where the schema and the volume are\"},\"comment\":{\"$ref\":\"#/$defs/string\",\"description\":\"The comment attached to the volume\"},\"grants\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the volume\"},\"schema_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the schema where the volume is\"},\"storage_location\":{\"$ref\":\"#/$defs/string\",\"description\":\"The storage location on the cloud\"},\"volume_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType\"}},\"additionalProperties\":false,\"required\":[\"catalog_name\",\"name\",\"schema_name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"variable.Lookup\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"alert\":{\"$ref\":\"#/$defs/string\"},\"cluster\":{\"$ref\":\"#/$defs/string\"},\"cluster_policy\":{\"$ref\":\"#/$defs/string\"},\"dashboard\":{\"$ref\":\"#/$defs/string\"},\"instance_pool\":{\"$ref\":\"#/$defs/string\"},\"job\":{\"$ref\":\"#/$defs/string\"},\"metastore\":{\"$ref\":\"#/$defs/string\"},\"notification_destination\":{\"$ref\":\"#/$defs/string\"},\"pipeline\":{\"$ref\":\"#/$defs/string\"},\"query\":{\"$ref\":\"#/$defs/string\"},\"service_principal\":{\"$ref\":\"#/$defs/string\"},\"warehouse\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"variable.TargetVariable\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/$defs/interface\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"The description of the variable.\"},\"lookup\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup\",\"description\":\"The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.\"},\"type\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType\",\"description\":\"The type of the variable.\"}},\"additionalProperties\":false},{}]},\"variable.Variable\":{\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/$defs/interface\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"The description of the variable\"},\"lookup\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup\",\"description\":\"The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.\",\"markdownDescription\":\"The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID.\\\"\"},\"type\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType\",\"description\":\"The type of the variable.\"}},\"additionalProperties\":false},\"variable.VariableType\":{\"type\":\"string\"}},\"config.Artifact\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"build\":{\"$ref\":\"#/$defs/string\",\"description\":\"An optional set of non-default build commands that you want to run locally before deployment.\\n\\nFor Python wheel builds, the Databricks CLI assumes that it can find a local install of the Python wheel package to run builds, and it runs the command python setup.py bdist_wheel by default during each bundle deployment.\\n\\nTo specify multiple build commands, separate each command with double-ampersand (&&) characters.\"},\"executable\":{\"$ref\":\"#/$defs/github.com/databricks/cli/libs/exec.ExecutableType\",\"description\":\"The executable type.\"},\"files\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile\",\"description\":\"The source files for the artifact.\",\"markdownDescription\":\"The source files for the artifact, defined as an [artifact_file](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact_file).\"},\"path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The location where the built artifact will be saved.\"},\"type\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.ArtifactType\",\"description\":\"The type of the artifact.\",\"markdownDescription\":\"The type of the artifact. Valid values are `wheel` or `jar`\"}},\"additionalProperties\":false,\"required\":[\"type\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.ArtifactFile\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"source\":{\"$ref\":\"#/$defs/string\",\"description\":\"The path of the files used to build the artifact.\"}},\"additionalProperties\":false,\"required\":[\"source\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.ArtifactType\":{\"type\":\"string\"},\"config.Bundle\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cluster_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The ID of a cluster to use to run the bundle.\",\"markdownDescription\":\"The ID of a cluster to use to run the bundle. See [cluster_id](https://docs.databricks.com/dev-tools/bundles/settings.html#cluster_id).\"},\"compute_id\":{\"$ref\":\"#/$defs/string\"},\"databricks_cli_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks CLI version to use for the bundle.\",\"markdownDescription\":\"The Databricks CLI version to use for the bundle. See [databricks_cli_version](https://docs.databricks.com/dev-tools/bundles/settings.html#databricks_cli_version).\"},\"deployment\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Deployment\",\"description\":\"The definition of the bundle deployment\",\"markdownDescription\":\"The definition of the bundle deployment. For supported attributes, see [deployment](https://docs.databricks.com/dev-tools/bundles/reference.html#deployment) and [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html).\"},\"git\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Git\",\"description\":\"The Git version control details that are associated with your bundle.\",\"markdownDescription\":\"The Git version control details that are associated with your bundle. For supported attributes, see [git](https://docs.databricks.com/dev-tools/bundles/reference.html#git) and [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the bundle.\"},\"uuid\":{\"$ref\":\"#/$defs/string\",\"description\":\"Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the `databricks bundle init` command).\"}},\"additionalProperties\":false,\"required\":[\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Command\":{\"type\":\"string\"},\"config.Deployment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"fail_on_active_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.\"},\"lock\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Lock\",\"description\":\"The deployment lock attributes.\",\"markdownDescription\":\"The deployment lock attributes. See [lock](https://docs.databricks.com/dev-tools/bundles/reference.html#lock).\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Experimental\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"pydabs\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.PyDABs\",\"description\":\"The PyDABs configuration.\"},\"python\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Python\",\"description\":\"Configures loading of Python code defined with 'databricks-bundles' package.\"},\"python_wheel_wrapper\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to use a Python wheel wrapper\"},\"scripts\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config.Command\",\"description\":\"The commands to run\"},\"use_legacy_run_as\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to use the legacy run_as behavior\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Git\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"branch\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Git branch name.\",\"markdownDescription\":\"The Git branch name. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).\"},\"origin_url\":{\"$ref\":\"#/$defs/string\",\"description\":\"The origin URL of the repository.\",\"markdownDescription\":\"The origin URL of the repository. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Lock\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether this lock is enabled.\"},\"force\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to force this lock if it is enabled.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Mode\":{\"type\":\"string\"},\"config.Presets\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"jobs_max_concurrent_runs\":{\"$ref\":\"#/$defs/int\",\"description\":\"The maximum concurrent runs for a job.\"},\"name_prefix\":{\"$ref\":\"#/$defs/string\",\"description\":\"The prefix for job runs of the bundle.\"},\"pipelines_development\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether pipeline deployments should be locked in development mode.\"},\"source_linked_deployment\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to link the deployment to the bundle source.\"},\"tags\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"The tags for the bundle deployment.\"},\"trigger_pause_status\":{\"$ref\":\"#/$defs/string\",\"description\":\"A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.PyDABs\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether or not PyDABs (Private Preview) is enabled\"},\"import\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The PyDABs project to import to discover resources, resource generator and mutators\"},\"venv_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Python virtual environment path\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Python\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"mutators\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Mutators contains a list of fully qualified function paths to mutator functions.\\n\\nExample: [\\\"my_project.mutators:add_default_cluster\\\"]\"},\"resources\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Resources contains a list of fully qualified function paths to load resources\\ndefined in Python code.\\n\\nExample: [\\\"my_project.resources:load_resources\\\"]\"},\"venv_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"VEnvPath is path to the virtual environment.\\n\\nIf enabled, Python code will execute within this environment. If disabled,\\nit defaults to using the Python interpreter available in the current shell.\"}},\"additionalProperties\":false,\"required\":[\"resources\",\"mutators\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Resources\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"apps\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.App\"},\"clusters\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster\",\"description\":\"The cluster definitions for the bundle.\",\"markdownDescription\":\"The cluster definitions for the bundle. See [cluster](https://docs.databricks.com/dev-tools/bundles/resources.html#cluster)\"},\"dashboards\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard\",\"description\":\"The dashboard definitions for the bundle.\",\"markdownDescription\":\"The dashboard definitions for the bundle. See [dashboard](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboard)\"},\"experiments\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment\",\"description\":\"The experiment definitions for the bundle.\",\"markdownDescription\":\"The experiment definitions for the bundle. See [experiment](https://docs.databricks.com/dev-tools/bundles/resources.html#experiment)\"},\"jobs\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job\",\"description\":\"The job definitions for the bundle.\",\"markdownDescription\":\"The job definitions for the bundle. See [job](https://docs.databricks.com/dev-tools/bundles/resources.html#job)\"},\"model_serving_endpoints\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint\",\"description\":\"The model serving endpoint definitions for the bundle.\",\"markdownDescription\":\"The model serving endpoint definitions for the bundle. See [model_serving_endpoint](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoint)\"},\"models\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel\",\"description\":\"The model definitions for the bundle.\",\"markdownDescription\":\"The model definitions for the bundle. See [model](https://docs.databricks.com/dev-tools/bundles/resources.html#model)\"},\"pipelines\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline\",\"description\":\"The pipeline definitions for the bundle.\",\"markdownDescription\":\"The pipeline definitions for the bundle. See [pipeline](https://docs.databricks.com/dev-tools/bundles/resources.html#pipeline)\"},\"quality_monitors\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor\",\"description\":\"The quality monitor definitions for the bundle.\",\"markdownDescription\":\"The quality monitor definitions for the bundle. See [quality_monitor](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitor)\"},\"registered_models\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel\",\"description\":\"The registered model definitions for the bundle.\",\"markdownDescription\":\"The registered model definitions for the bundle. See [registered_model](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_model)\"},\"schemas\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema\",\"description\":\"The schema definitions for the bundle.\",\"markdownDescription\":\"The schema definitions for the bundle. See [schema](https://docs.databricks.com/dev-tools/bundles/resources.html#schema)\"},\"volumes\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Sync\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"exclude\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of files or folders to exclude from the bundle.\"},\"include\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of files or folders to include in the bundle.\"},\"paths\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Target\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"artifacts\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config.Artifact\",\"description\":\"The artifacts to include in the target deployment.\",\"markdownDescription\":\"The artifacts to include in the target deployment. See [artifact](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact)\"},\"bundle\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Bundle\",\"description\":\"The name of the bundle when deploying to this target.\"},\"cluster_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The ID of the cluster to use for this target.\"},\"compute_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Deprecated. The ID of the compute to use for this target.\"},\"default\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether this target is the default target.\"},\"git\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Git\",\"description\":\"The Git version control settings for the target.\",\"markdownDescription\":\"The Git version control settings for the target. See [git](https://docs.databricks.com/dev-tools/bundles/reference.html#git).\"},\"mode\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Mode\",\"description\":\"The deployment mode for the target.\",\"markdownDescription\":\"The deployment mode for the target. Valid values are `development` or `production`. See [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html).\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\",\"description\":\"The permissions for deploying and running the bundle in the target.\",\"markdownDescription\":\"The permissions for deploying and running the bundle in the target. See [permission](https://docs.databricks.com/dev-tools/bundles/reference.html#permission).\"},\"presets\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Presets\",\"description\":\"The deployment presets for the target.\",\"markdownDescription\":\"The deployment presets for the target. See [preset](https://docs.databricks.com/dev-tools/bundles/reference.html#preset).\"},\"resources\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Resources\",\"description\":\"The resource definitions for the target.\",\"markdownDescription\":\"The resource definitions for the target. See [resources](https://docs.databricks.com/dev-tools/bundles/reference.html#resources).\"},\"run_as\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs\",\"description\":\"The identity to use to run the bundle.\",\"markdownDescription\":\"The identity to use to run the bundle. See [job_run_as](https://docs.databricks.com/dev-tools/bundles/reference.html#job_run_as) and [link](https://docs.databricks.com/dev-tools/bundles/run_as.html).\"},\"sync\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Sync\",\"description\":\"The local paths to sync to the target workspace when a bundle is run or deployed.\",\"markdownDescription\":\"The local paths to sync to the target workspace when a bundle is run or deployed. See [sync](https://docs.databricks.com/dev-tools/bundles/reference.html#sync).\"},\"variables\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable\",\"description\":\"The custom variable definitions for the target.\",\"markdownDescription\":\"The custom variable definitions for the target. See [variables](https://docs.databricks.com/dev-tools/bundles/settings.html#variables) and [link](https://docs.databricks.com/dev-tools/bundles/variables.html).\"},\"workspace\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Workspace\",\"description\":\"The Databricks workspace for the target.\",\"markdownDescription\":\"The Databricks workspace for the target. [workspace](https://docs.databricks.com/dev-tools/bundles/reference.html#workspace)\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Workspace\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"artifact_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The artifact path to use within the workspace for both deployments and workflow runs\"},\"auth_type\":{\"$ref\":\"#/$defs/string\",\"description\":\"The authentication type.\"},\"azure_client_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Azure client ID\"},\"azure_environment\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Azure environment\"},\"azure_login_app_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Azure login app ID\"},\"azure_tenant_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Azure tenant ID\"},\"azure_use_msi\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to use MSI for Azure\"},\"azure_workspace_resource_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Azure workspace resource ID\"},\"client_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The client ID for the workspace\"},\"file_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The file path to use within the workspace for both deployments and workflow runs\"},\"google_service_account\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Google service account name\"},\"host\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks workspace host URL\"},\"profile\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks workspace profile name\"},\"resource_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workspace resource path\"},\"root_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks workspace root path\"},\"state_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workspace state path\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}},\"libs\":{\"exec.ExecutableType\":{\"type\":\"string\"}}},\"databricks-sdk-go\":{\"service\":{\"apps.AppDeployment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"create_time\":{\"$ref\":\"#/$defs/string\"},\"creator\":{\"$ref\":\"#/$defs/string\"},\"deployment_artifacts\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentArtifacts\"},\"deployment_id\":{\"$ref\":\"#/$defs/string\"},\"mode\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode\"},\"source_code_path\":{\"$ref\":\"#/$defs/string\"},\"status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentStatus\"},\"update_time\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppDeploymentArtifacts\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"source_code_path\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppDeploymentMode\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"SNAPSHOT\",\"AUTO_SYNC\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppDeploymentState\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"SUCCEEDED\",\"FAILED\",\"IN_PROGRESS\",\"CANCELLED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppDeploymentStatus\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"message\":{\"$ref\":\"#/$defs/string\"},\"state\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentState\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResource\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"description\":{\"$ref\":\"#/$defs/string\"},\"job\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob\"},\"name\":{\"$ref\":\"#/$defs/string\"},\"secret\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret\"},\"serving_endpoint\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint\"},\"sql_warehouse\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse\"}},\"additionalProperties\":false,\"required\":[\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceJob\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/$defs/string\"},\"permission\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission\"}},\"additionalProperties\":false,\"required\":[\"id\",\"permission\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceJobJobPermission\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"CAN_MANAGE\",\"IS_OWNER\",\"CAN_MANAGE_RUN\",\"CAN_VIEW\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceSecret\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"key\":{\"$ref\":\"#/$defs/string\"},\"permission\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission\"},\"scope\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false,\"required\":[\"key\",\"permission\",\"scope\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceSecretSecretPermission\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Permission to grant on the secret scope. Supported permissions are: \\\"READ\\\", \\\"WRITE\\\", \\\"MANAGE\\\".\",\"enum\":[\"READ\",\"WRITE\",\"MANAGE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceServingEndpoint\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/$defs/string\"},\"permission\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission\"}},\"additionalProperties\":false,\"required\":[\"name\",\"permission\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceServingEndpointServingEndpointPermission\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"CAN_MANAGE\",\"CAN_QUERY\",\"CAN_VIEW\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceSqlWarehouse\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/$defs/string\"},\"permission\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission\"}},\"additionalProperties\":false,\"required\":[\"id\",\"permission\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.AppResourceSqlWarehouseSqlWarehousePermission\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"CAN_MANAGE\",\"CAN_USE\",\"IS_OWNER\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.ApplicationState\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"DEPLOYING\",\"RUNNING\",\"CRASHED\",\"UNAVAILABLE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.ApplicationStatus\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"message\":{\"$ref\":\"#/$defs/string\"},\"state\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ApplicationState\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.ComputeState\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"ERROR\",\"DELETING\",\"STARTING\",\"STOPPING\",\"UPDATING\",\"STOPPED\",\"ACTIVE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"apps.ComputeStatus\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"message\":{\"$ref\":\"#/$defs/string\"},\"state\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeState\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorCronSchedule\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"pause_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedulePauseStatus\",\"description\":\"Read only field that indicates whether a schedule is paused or not.\"},\"quartz_cron_expression\":{\"$ref\":\"#/$defs/string\",\"description\":\"The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).\\n\"},\"timezone_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The timezone id (e.g., ``\\\"PST\\\"``) in which to evaluate the quartz expression.\\n\"}},\"additionalProperties\":false,\"required\":[\"quartz_cron_expression\",\"timezone_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorCronSchedulePauseStatus\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Read only field that indicates whether a schedule is paused or not.\",\"enum\":[\"UNPAUSED\",\"PAUSED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorDataClassificationConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether data classification is enabled.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorDestination\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"email_addresses\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorInferenceLog\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"granularities\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Granularities for aggregating data into time windows based on their timestamp. Currently the following static\\ngranularities are supported:\\n{``\\\"5 minutes\\\"``, ``\\\"30 minutes\\\"``, ``\\\"1 hour\\\"``, ``\\\"1 day\\\"``, ``\\\"<n> week(s)\\\"``, ``\\\"1 month\\\"``, ``\\\"1 year\\\"``}.\\n\"},\"label_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional column that contains the ground truth for the prediction.\"},\"model_id_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Column that contains the id of the model generating the predictions. Metrics will be computed per model id by\\ndefault, and also across all model ids.\\n\"},\"prediction_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Column that contains the output/prediction from the model.\"},\"prediction_proba_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional column that contains the prediction probabilities for each class in a classification problem type.\\nThe values in this column should be a map, mapping each class label to the prediction probability for a given\\nsample. The map should be of PySpark MapType().\\n\"},\"problem_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLogProblemType\",\"description\":\"Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed.\"},\"timestamp_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Column that contains the timestamps of requests. The column must be one of the following:\\n- A ``TimestampType`` column\\n- A column whose values can be converted to timestamps through the pyspark\\n ``to_timestamp`` [function](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html).\\n\"}},\"additionalProperties\":false,\"required\":[\"granularities\",\"model_id_col\",\"prediction_col\",\"problem_type\",\"timestamp_col\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorInferenceLogProblemType\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed.\",\"enum\":[\"PROBLEM_TYPE_CLASSIFICATION\",\"PROBLEM_TYPE_REGRESSION\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorMetric\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"definition\":{\"$ref\":\"#/$defs/string\",\"description\":\"Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).\"},\"input_columns\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of column names in the input table the metric should be computed for.\\nCan use ``\\\":table\\\"`` to indicate that the metric needs information from multiple columns.\\n\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the metric in the output tables.\"},\"output_data_type\":{\"$ref\":\"#/$defs/string\",\"description\":\"The output type of the custom metric.\"},\"type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetricType\",\"description\":\"Can only be one of ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"``, ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"``, or ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"``.\\nThe ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"`` and ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"`` metrics\\nare computed on a single table, whereas the ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"`` compare metrics across\\nbaseline and input table, or across the two consecutive time windows.\\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics\\n\"}},\"additionalProperties\":false,\"required\":[\"definition\",\"input_columns\",\"name\",\"output_data_type\",\"type\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorMetricType\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Can only be one of ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"``, ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"``, or ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"``.\\nThe ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"`` and ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"`` metrics\\nare computed on a single table, whereas the ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"`` compare metrics across\\nbaseline and input table, or across the two consecutive time windows.\\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics\\n\",\"enum\":[\"CUSTOM_METRIC_TYPE_AGGREGATE\",\"CUSTOM_METRIC_TYPE_DERIVED\",\"CUSTOM_METRIC_TYPE_DRIFT\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorNotifications\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"on_failure\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination\",\"description\":\"Who to send notifications to on monitor failure.\"},\"on_new_classification_tag_detected\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination\",\"description\":\"Who to send notifications to when new data classification tags are detected.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorSnapshot\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorTimeSeries\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"granularities\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Granularities for aggregating data into time windows based on their timestamp. Currently the following static\\ngranularities are supported:\\n{``\\\"5 minutes\\\"``, ``\\\"30 minutes\\\"``, ``\\\"1 hour\\\"``, ``\\\"1 day\\\"``, ``\\\"<n> week(s)\\\"``, ``\\\"1 month\\\"``, ``\\\"1 year\\\"``}.\\n\"},\"timestamp_col\":{\"$ref\":\"#/$defs/string\",\"description\":\"Column that contains the timestamps of requests. The column must be one of the following:\\n- A ``TimestampType`` column\\n- A column whose values can be converted to timestamps through the pyspark\\n ``to_timestamp`` [function](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html).\\n\"}},\"additionalProperties\":false,\"required\":[\"granularities\",\"timestamp_col\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.VolumeType\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"EXTERNAL\",\"MANAGED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.Adlsgen2Info\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"abfss destination, e.g. `abfss://<container-name>@<storage-account-name>.dfs.core.windows.net/<directory-name>`.\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.AutoScale\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"max_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"The maximum number of workers to which the cluster can scale up when overloaded.\\nNote that `max_workers` must be strictly greater than `min_workers`.\"},\"min_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"The minimum number of workers to which the cluster can scale down when underutilized.\\nIt is also the initial number of workers the cluster will have after creation.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.AwsAttributes\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"availability\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability\"},\"ebs_volume_count\":{\"$ref\":\"#/$defs/int\",\"description\":\"The number of volumes launched for each instance. Users can choose up to 10 volumes.\\nThis feature is only enabled for supported node types. Legacy node types cannot specify\\ncustom EBS volumes.\\nFor node types with no instance store, at least one EBS volume needs to be specified;\\notherwise, cluster creation will fail.\\n\\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\\n\\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\\nstore volumes.\\n\\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\\nwill be overridden.\"},\"ebs_volume_iops\":{\"$ref\":\"#/$defs/int\",\"description\":\"If using gp3 volumes, what IOPS to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.\"},\"ebs_volume_size\":{\"$ref\":\"#/$defs/int\",\"description\":\"The size of each EBS volume (in GiB) launched for each instance. For general purpose\\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\\nthis value must be within the range 500 - 4096.\"},\"ebs_volume_throughput\":{\"$ref\":\"#/$defs/int\",\"description\":\"If using gp3 volumes, what throughput to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.\"},\"ebs_volume_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType\"},\"first_on_demand\":{\"$ref\":\"#/$defs/int\",\"description\":\"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\\non-demand instance. If this value is greater than or equal to the current cluster size, all\\nnodes will be placed on on-demand instances. If this value is less than the current cluster\\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\\nbe placed on `availability` instances. Note that this value does not affect\\ncluster size and cannot currently be mutated over the lifetime of a cluster.\"},\"instance_profile_arn\":{\"$ref\":\"#/$defs/string\",\"description\":\"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\\nomitted, nodes will be placed on instances without an IAM instance profile. The instance\\nprofile must have previously been added to the Databricks environment by an account\\nadministrator.\\n\\nThis feature may only be available to certain customer plans.\\n\\nIf this field is omitted, we will pull in the default from the conf if it exists.\"},\"spot_bid_price_percent\":{\"$ref\":\"#/$defs/int\",\"description\":\"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\\non-demand price.\\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\\ninstance, then the bid price is half of the price of\\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\\nWhen spot instances are requested for this cluster, only spot instances whose bid price\\npercentage matches this field will be considered.\\nNote that, for safety, we enforce this field to be no more than 10000.\\n\\nThe default value and documentation here should be kept consistent with\\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent.\"},\"zone_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Identifier for the availability zone/datacenter in which the cluster resides.\\nThis string will be of a form like \\\"us-west-2a\\\". The provided availability\\nzone must be in the same region as the Databricks deployment. For example, \\\"us-west-2a\\\"\\nis not a valid zone id if the Databricks deployment resides in the \\\"us-east-1\\\" region.\\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\\nIf the zone specified is \\\"auto\\\", will try to place cluster in a zone with high availability,\\nand will retry placement in a different AZ if there is not enough capacity.\\nThe list of available zones as well as the default value can be found by using the\\n`List Zones` method.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.AwsAvailability\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Availability type used for all subsequent nodes past the `first_on_demand` ones.\\n\\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.\\n\",\"enum\":[\"SPOT\",\"ON_DEMAND\",\"SPOT_WITH_FALLBACK\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.AzureAttributes\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"availability\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability\"},\"first_on_demand\":{\"$ref\":\"#/$defs/int\",\"description\":\"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\\non-demand instance. If this value is greater than or equal to the current cluster size, all\\nnodes will be placed on on-demand instances. If this value is less than the current cluster\\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\\nbe placed on `availability` instances. Note that this value does not affect\\ncluster size and cannot currently be mutated over the lifetime of a cluster.\"},\"log_analytics_info\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo\",\"description\":\"Defines values necessary to configure and run Azure Log Analytics agent\"},\"spot_bid_max_price\":{\"$ref\":\"#/$defs/float64\",\"description\":\"The max bid price to be used for Azure spot instances.\\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\\non the basis of price, and only on the basis of availability. Further, the value should > 0 or -1.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.AzureAvailability\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Availability type used for all subsequent nodes past the `first_on_demand` ones.\\nNote: If `first_on_demand` is zero (which only happens on pool clusters), this availability\\ntype will be used for the entire cluster.\",\"enum\":[\"SPOT_AZURE\",\"ON_DEMAND_AZURE\",\"SPOT_WITH_FALLBACK_AZURE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.ClientsTypes\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"jobs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"With jobs set, the cluster can be used for jobs\"},\"notebooks\":{\"$ref\":\"#/$defs/bool\",\"description\":\"With notebooks set, this cluster can be used for notebooks\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.ClusterLogConf\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"dbfs\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"dbfs\\\" : { \\\"destination\\\" : \\\"dbfs:/home/cluster_log\\\" } }`\"},\"s3\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo\",\"description\":\"destination and either the region or endpoint need to be provided. e.g.\\n`{ \\\"s3\\\": { \\\"destination\\\" : \\\"s3://cluster_log_bucket/prefix\\\", \\\"region\\\" : \\\"us-west-2\\\" } }`\\nCluster iam role is used to access s3, please make sure the cluster iam role in\\n`instance_profile_arn` has permission to write data to the s3 destination.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.ClusterSpec\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"apply_policy_default_values\":{\"$ref\":\"#/$defs/bool\",\"description\":\"When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.\"},\"autoscale\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale\",\"description\":\"Parameters needed in order to automatically scale clusters up and down based on load.\\nNote: autoscaling works best with DB runtime versions 3.0 or later.\"},\"autotermination_minutes\":{\"$ref\":\"#/$defs/int\",\"description\":\"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\\nthis cluster will not be automatically terminated. If specified, the threshold must be between\\n10 and 10000 minutes.\\nUsers can also set this value to 0 to explicitly disable automatic termination.\"},\"aws_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes\",\"description\":\"Attributes related to clusters running on Amazon Web Services.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"azure_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes\",\"description\":\"Attributes related to clusters running on Microsoft Azure.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"cluster_log_conf\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf\",\"description\":\"The configuration for delivering spark logs to a long-term storage destination.\\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\\nthe destination of executor logs is `$destination/$clusterId/executor`.\"},\"cluster_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Cluster name requested by the user. This doesn't have to be unique.\\nIf not specified at creation, the cluster name will be an empty string.\\n\"},\"custom_tags\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\\n\\n- Currently, Databricks allows at most 45 custom tags\\n\\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags\"},\"data_security_mode\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode\"},\"docker_image\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage\"},\"driver_instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool for the driver of the cluster belongs.\\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\\nassigned.\"},\"driver_node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The node type of the Spark driver. Note that this field is optional;\\nif unset, the driver node type will be set as the same value\\nas `node_type_id` defined above.\\n\"},\"enable_elastic_disk\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\\npermissions to function correctly - refer to the User Guide for more details.\"},\"enable_local_disk_encryption\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to enable LUKS on cluster VMs' local disks\"},\"gcp_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes\",\"description\":\"Attributes related to clusters running on Google Cloud Platform.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"init_scripts\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo\",\"description\":\"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`.\"},\"instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool to which the cluster belongs.\"},\"is_single_node\":{\"$ref\":\"#/$defs/bool\",\"description\":\"This field can only be used with `kind`.\\n\\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`\\n\"},\"kind\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind\"},\"node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field encodes, through a single value, the resources available to each of\\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\\nand optimized for memory or compute intensive workloads. A list of available node\\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\\n\"},\"num_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\\n\\nNote: When reading the properties of a cluster, this field reflects the desired number\\nof workers rather than the actual current number of workers. For instance, if a cluster\\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\\nincrease from 5 to 10 as the new nodes are provisioned.\"},\"policy_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The ID of the cluster policy used to create the cluster if applicable.\"},\"runtime_engine\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine\"},\"single_user_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Single user name if data_security_mode is `SINGLE_USER`\"},\"spark_conf\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified Spark configuration key-value pairs.\\nUsers can also pass in a string of extra JVM options to the driver and the executors via\\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\\n\"},\"spark_env_vars\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified environment variable key-value pairs.\\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\\n`export X='Y'`) while launching the driver and workers.\\n\\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\\ndefault databricks managed environmental variables are included as well.\\n\\nExample Spark environment variables:\\n`{\\\"SPARK_WORKER_MEMORY\\\": \\\"28000m\\\", \\\"SPARK_LOCAL_DIRS\\\": \\\"/local_disk0\\\"}` or\\n`{\\\"SPARK_DAEMON_JAVA_OPTS\\\": \\\"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\\\"}`\"},\"spark_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\\nA list of available Spark versions can be retrieved by using\\nthe :method:clusters/sparkVersions API call.\\n\"},\"ssh_public_keys\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"SSH public key contents that will be added to each Spark node in this cluster. The\\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\\nUp to 10 keys can be specified.\"},\"use_ml_runtime\":{\"$ref\":\"#/$defs/bool\",\"description\":\"This field can only be used with `kind`.\\n\\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.\\n\"},\"workload_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.DataSecurityMode\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Data security mode decides what data governance model to use when accessing data\\nfrom a cluster.\\n\\nThe following modes can only be used with `kind`.\\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\\n\\nThe following modes can be used regardless of `kind`.\\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\\n* `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\\n* `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\\n\\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\\nwill be removed for future Databricks Runtime versions:\\n\\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn\\u2019t have UC nor passthrough enabled.\\n\",\"enum\":[\"DATA_SECURITY_MODE_AUTO\",\"DATA_SECURITY_MODE_STANDARD\",\"DATA_SECURITY_MODE_DEDICATED\",\"NONE\",\"SINGLE_USER\",\"USER_ISOLATION\",\"LEGACY_TABLE_ACL\",\"LEGACY_PASSTHROUGH\",\"LEGACY_SINGLE_USER\",\"LEGACY_SINGLE_USER_STANDARD\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.DbfsStorageInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"dbfs destination, e.g. `dbfs:/my/path`\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.DockerBasicAuth\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"password\":{\"$ref\":\"#/$defs/string\",\"description\":\"Password of the user\"},\"username\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the user\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.DockerImage\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"basic_auth\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth\"},\"url\":{\"$ref\":\"#/$defs/string\",\"description\":\"URL of the docker image.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.EbsVolumeType\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The type of EBS volumes that will be launched with this cluster.\",\"enum\":[\"GENERAL_PURPOSE_SSD\",\"THROUGHPUT_OPTIMIZED_HDD\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.Environment\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"The environment entity used to preserve serverless environment side panel and jobs' environment for non-notebook task.\\nIn this minimal environment spec, only pip dependencies are supported.\",\"properties\":{\"client\":{\"$ref\":\"#/$defs/string\",\"description\":\"Client version used by the environment\\nThe client is the user-facing environment of the runtime.\\nEach client comes with a specific set of pre-installed libraries.\\nThe version is a string, consisting of the major client version.\"},\"dependencies\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"List of pip dependencies, as supported by the version of pip in this environment.\\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\\nAllowed dependency could be <requirement specifier>, <archive url/path>, <local project path>(WSFS or Volumes in Databricks), <vcs project url>\\nE.g. dependencies: [\\\"foo==0.0.1\\\", \\\"-r /Workspace/test/requirements.txt\\\"]\"}},\"additionalProperties\":false,\"required\":[\"client\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.GcpAttributes\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"availability\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability\"},\"boot_disk_size\":{\"$ref\":\"#/$defs/int\",\"description\":\"boot disk size in GB\"},\"google_service_account\":{\"$ref\":\"#/$defs/string\",\"description\":\"If provided, the cluster will impersonate the google service account when accessing\\ngcloud services (like GCS). The google service account\\nmust have previously been added to the Databricks environment by an account\\nadministrator.\"},\"local_ssd_count\":{\"$ref\":\"#/$defs/int\",\"description\":\"If provided, each node (workers and driver) in the cluster will have this number of local SSDs attached. Each local SSD is 375GB in size. Refer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds) for the supported number of local SSDs for each instance type.\"},\"use_preemptible_executors\":{\"$ref\":\"#/$defs/bool\",\"description\":\"This field determines whether the spark executors will be scheduled to run on preemptible VMs (when set to true) versus standard compute engine VMs (when set to false; default).\\nNote: Soon to be deprecated, use the availability field instead.\"},\"zone_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Identifier for the availability zone in which the cluster resides.\\nThis can be one of the following:\\n- \\\"HA\\\" => High availability, spread nodes across availability zones for a Databricks deployment region [default]\\n- \\\"AUTO\\\" => Databricks picks an availability zone to schedule the cluster on.\\n- A GCP availability zone => Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.GcpAvailability\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"This field determines whether the instance pool will contain preemptible\\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.\",\"enum\":[\"PREEMPTIBLE_GCP\",\"ON_DEMAND_GCP\",\"PREEMPTIBLE_WITH_FALLBACK_GCP\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.GcsStorageInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"GCS destination/URI, e.g. `gs://my-bucket/some-prefix`\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.InitScriptInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"abfss\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"abfss\\\" : { \\\"destination\\\" : \\\"abfss://<container-name>@<storage-account-name>.dfs.core.windows.net/<directory-name>\\\" } }\"},\"dbfs\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"dbfs\\\" : { \\\"destination\\\" : \\\"dbfs:/home/cluster_log\\\" } }`\"},\"file\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LocalFileInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"file\\\" : { \\\"destination\\\" : \\\"file:/my/local/file.sh\\\" } }`\"},\"gcs\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcsStorageInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"gcs\\\": { \\\"destination\\\": \\\"gs://my-bucket/file.sh\\\" } }`\"},\"s3\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo\",\"description\":\"destination and either the region or endpoint need to be provided. e.g.\\n`{ \\\"s3\\\": { \\\"destination\\\" : \\\"s3://cluster_log_bucket/prefix\\\", \\\"region\\\" : \\\"us-west-2\\\" } }`\\nCluster iam role is used to access s3, please make sure the cluster iam role in\\n`instance_profile_arn` has permission to write data to the s3 destination.\"},\"volumes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"volumes\\\" : { \\\"destination\\\" : \\\"/Volumes/my-init.sh\\\" } }`\"},\"workspace\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkspaceStorageInfo\",\"description\":\"destination needs to be provided. e.g.\\n`{ \\\"workspace\\\" : { \\\"destination\\\" : \\\"/Users/[email protected]/my-init.sh\\\" } }`\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.Kind\":{\"type\":\"string\"},\"compute.Library\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cran\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RCranLibrary\",\"description\":\"Specification of a CRAN library to be installed as part of the library\"},\"egg\":{\"$ref\":\"#/$defs/string\",\"description\":\"Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.\"},\"jar\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\\nFor example: `{ \\\"jar\\\": \\\"/Workspace/path/to/library.jar\\\" }`, `{ \\\"jar\\\" : \\\"/Volumes/path/to/library.jar\\\" }` or\\n`{ \\\"jar\\\": \\\"s3://my-bucket/library.jar\\\" }`.\\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\\nlaunch the cluster with an IAM role to access the S3 URI.\"},\"maven\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary\",\"description\":\"Specification of a maven library to be installed. For example:\\n`{ \\\"coordinates\\\": \\\"org.jsoup:jsoup:1.7.2\\\" }`\"},\"pypi\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.PythonPyPiLibrary\",\"description\":\"Specification of a PyPi library to be installed. For example:\\n`{ \\\"package\\\": \\\"simplejson\\\" }`\"},\"requirements\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\\nFor example: `{ \\\"requirements\\\": \\\"/Workspace/path/to/requirements.txt\\\" }` or `{ \\\"requirements\\\" : \\\"/Volumes/path/to/requirements.txt\\\" }`\"},\"whl\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\\nFor example: `{ \\\"whl\\\": \\\"/Workspace/path/to/library.whl\\\" }`, `{ \\\"whl\\\" : \\\"/Volumes/path/to/library.whl\\\" }` or\\n`{ \\\"whl\\\": \\\"s3://my-bucket/library.whl\\\" }`.\\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\\nlaunch the cluster with an IAM role to access the S3 URI.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.LocalFileInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"local file destination, e.g. `file:/my/local/file.sh`\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.LogAnalyticsInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"log_analytics_primary_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"<needs content added>\"},\"log_analytics_workspace_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"<needs content added>\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.MavenLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"coordinates\":{\"$ref\":\"#/$defs/string\",\"description\":\"Gradle-style maven coordinates. For example: \\\"org.jsoup:jsoup:1.7.2\\\".\"},\"exclusions\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"List of dependences to exclude. For example: `[\\\"slf4j:slf4j\\\", \\\"*:hadoop-client\\\"]`.\\n\\nMaven dependency exclusions:\\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.\"},\"repo\":{\"$ref\":\"#/$defs/string\",\"description\":\"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\\nand Spark Packages are searched.\"}},\"additionalProperties\":false,\"required\":[\"coordinates\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.PythonPyPiLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"package\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the pypi package to install. An optional exact version specification is also\\nsupported. Examples: \\\"simplejson\\\" and \\\"simplejson==3.8.0\\\".\"},\"repo\":{\"$ref\":\"#/$defs/string\",\"description\":\"The repository where the package can be found. If not specified, the default pip index is\\nused.\"}},\"additionalProperties\":false,\"required\":[\"package\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.RCranLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"package\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the CRAN package to install.\"},\"repo\":{\"$ref\":\"#/$defs/string\",\"description\":\"The repository where the package can be found. If not specified, the default CRAN repo is used.\"}},\"additionalProperties\":false,\"required\":[\"package\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.RuntimeEngine\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Determines the cluster's runtime engine, either standard or Photon.\\n\\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\\n\\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\\ncontains -photon-, in which case Photon will be used.\\n\",\"enum\":[\"NULL\",\"STANDARD\",\"PHOTON\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.S3StorageInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"canned_acl\":{\"$ref\":\"#/$defs/string\",\"description\":\"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\\nthe destination bucket and prefix. The full list of possible canned acl can be found at\\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\\nPlease also note that by default only the object owner gets full controls. If you are using cross account\\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\\nread the logs.\"},\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\\ndestination. Please also note that you cannot use AWS keys to deliver logs.\"},\"enable_encryption\":{\"$ref\":\"#/$defs/bool\",\"description\":\"(Optional) Flag to enable server side encryption, `false` by default.\"},\"encryption_type\":{\"$ref\":\"#/$defs/string\",\"description\":\"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\\nencryption is enabled and the default type is `sse-s3`.\"},\"endpoint\":{\"$ref\":\"#/$defs/string\",\"description\":\"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\\nIf both are set, endpoint will be used.\"},\"kms_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`.\"},\"region\":{\"$ref\":\"#/$defs/string\",\"description\":\"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\\nendpoint will be used.\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.VolumesStorageInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"Unity Catalog Volumes file destination, e.g. `/Volumes/my-init.sh`\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.WorkloadType\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"clients\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClientsTypes\",\"description\":\" defined what type of clients can use the cluster. E.g. Notebooks, Jobs\"}},\"additionalProperties\":false,\"required\":[\"clients\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.WorkspaceStorageInfo\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination\":{\"$ref\":\"#/$defs/string\",\"description\":\"workspace files destination, e.g. `/Users/[email protected]/my-init.sh`\"}},\"additionalProperties\":false,\"required\":[\"destination\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"dashboards.LifecycleState\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"ACTIVE\",\"TRASHED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.CleanRoomsNotebookTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"clean_room_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The clean room that the notebook belongs to.\"},\"etag\":{\"$ref\":\"#/$defs/string\",\"description\":\"Checksum to validate the freshness of the notebook resource (i.e. the notebook being run is the latest version).\\nIt can be fetched by calling the :method:cleanroomassets/get API.\"},\"notebook_base_parameters\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Base parameters to be used for the clean room notebook job.\"},\"notebook_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the notebook being run.\"}},\"additionalProperties\":false,\"required\":[\"clean_room_name\",\"notebook_name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Condition\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"ANY_UPDATED\",\"ALL_UPDATED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.ConditionTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"left\":{\"$ref\":\"#/$defs/string\",\"description\":\"The left operand of the condition task. Can be either a string value or a job state or parameter reference.\"},\"op\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTaskOp\",\"description\":\"* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `\\u201c12.0\\u201d == \\u201c12\\u201d` will evaluate to `false`.\\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `\\u201c12.0\\u201d >= \\u201c12\\u201d` will evaluate to `true`, `\\u201c10.0\\u201d >= \\u201c12\\u201d` will evaluate to `false`.\\n\\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `\\u201ctrue\\u201d` or `\\u201cfalse\\u201d` for the comparison.\"},\"right\":{\"$ref\":\"#/$defs/string\",\"description\":\"The right operand of the condition task. Can be either a string value or a job state or parameter reference.\"}},\"additionalProperties\":false,\"required\":[\"left\",\"op\",\"right\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.ConditionTaskOp\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `\\u201c12.0\\u201d == \\u201c12\\u201d` will evaluate to `false`.\\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `\\u201c12.0\\u201d >= \\u201c12\\u201d` will evaluate to `true`, `\\u201c10.0\\u201d >= \\u201c12\\u201d` will evaluate to `false`.\\n\\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `\\u201ctrue\\u201d` or `\\u201cfalse\\u201d` for the comparison.\",\"enum\":[\"EQUAL_TO\",\"GREATER_THAN\",\"GREATER_THAN_OR_EQUAL\",\"LESS_THAN\",\"LESS_THAN_OR_EQUAL\",\"NOT_EQUAL\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Continuous\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"pause_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus\",\"description\":\"Indicate whether the continuous execution of the job is paused or not. Defaults to UNPAUSED.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.CronSchedule\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"pause_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus\",\"description\":\"Indicate whether this schedule is paused or not.\"},\"quartz_cron_expression\":{\"$ref\":\"#/$defs/string\",\"description\":\"A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required.\"},\"timezone_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required.\"}},\"additionalProperties\":false,\"required\":[\"quartz_cron_expression\",\"timezone_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.DbtTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks >= 1.1.1.\"},\"commands\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided.\"},\"profiles_directory\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used.\"},\"project_directory\":{\"$ref\":\"#/$defs/string\",\"description\":\"Path to the project directory. Optional for Git sourced tasks, in which\\ncase if no value is provided, the root of the Git repository is used.\"},\"schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used.\"},\"source\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source\",\"description\":\"Optional location type of the project directory. When set to `WORKSPACE`, the project will be retrieved\\nfrom the local Databricks workspace. When set to `GIT`, the project will be retrieved from a Git repository\\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\\n\\n* `WORKSPACE`: Project is located in Databricks workspace.\\n* `GIT`: Project is located in cloud Git provider.\"},\"warehouse_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument.\"}},\"additionalProperties\":false,\"required\":[\"commands\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.FileArrivalTriggerConfiguration\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"min_time_between_triggers_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"If set, the trigger starts a run only after the specified amount of time passed since\\nthe last time the trigger fired. The minimum allowed value is 60 seconds\"},\"url\":{\"$ref\":\"#/$defs/string\",\"description\":\"URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location.\"},\"wait_after_last_change_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"If set, the trigger starts a run only after no file activity has occurred for the specified amount of time.\\nThis makes it possible to wait for a batch of incoming files to arrive before triggering a run. The\\nminimum allowed value is 60 seconds.\"}},\"additionalProperties\":false,\"required\":[\"url\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.ForEachTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"concurrency\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional maximum allowed number of concurrent runs of the task.\\nSet this value if you want to be able to execute multiple runs of the task concurrently.\"},\"inputs\":{\"$ref\":\"#/$defs/string\",\"description\":\"Array for task to iterate on. This can be a JSON string or a reference to\\nan array parameter.\"},\"task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task\",\"description\":\"Configuration for the task that will be run for each element in the array\"}},\"additionalProperties\":false,\"required\":[\"inputs\",\"task\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Format\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"SINGLE_TASK\",\"MULTI_TASK\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.GitProvider\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"gitHub\",\"bitbucketCloud\",\"azureDevOpsServices\",\"gitHubEnterprise\",\"bitbucketServer\",\"gitLab\",\"gitLabEnterpriseEdition\",\"awsCodeCommit\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.GitSnapshot\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"Read-only state of the remote repository at the time the job was run. This field is only included on job runs.\",\"properties\":{\"used_commit\":{\"$ref\":\"#/$defs/string\",\"description\":\"Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.GitSource\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\\n\\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\\n\\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.\",\"properties\":{\"git_branch\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the branch to be checked out and used by this job. This field cannot be specified in conjunction with git_tag or git_commit.\"},\"git_commit\":{\"$ref\":\"#/$defs/string\",\"description\":\"Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.\"},\"git_provider\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitProvider\",\"description\":\"Unique identifier of the service used to host the Git repository. The value is case insensitive.\"},\"git_tag\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the tag to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_commit.\"},\"git_url\":{\"$ref\":\"#/$defs/string\",\"description\":\"URL of the repository to be cloned by this job.\"}},\"additionalProperties\":false,\"required\":[\"git_provider\",\"git_url\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobCluster\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"job_cluster_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"A unique name for the job cluster. This field is required and must be unique within the job.\\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution.\"},\"new_cluster\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec\",\"description\":\"If new_cluster, a description of a cluster that is created for each task.\"}},\"additionalProperties\":false,\"required\":[\"job_cluster_key\",\"new_cluster\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobDeployment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"kind\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind\",\"description\":\"The kind of deployment that manages the job.\\n\\n* `BUNDLE`: The job is managed by Databricks Asset Bundle.\"},\"metadata_file_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"Path of the file that contains deployment metadata.\"}},\"additionalProperties\":false,\"required\":[\"kind\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobDeploymentKind\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"* `BUNDLE`: The job is managed by Databricks Asset Bundle.\",\"enum\":[\"BUNDLE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobEditMode\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Edit mode of the job.\\n\\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\\n* `EDITABLE`: The job is in an editable state and can be modified.\",\"enum\":[\"UI_LOCKED\",\"EDITABLE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobEmailNotifications\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"no_alert_for_skipped_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send email to recipients specified in `on_failure` if the run is skipped.\\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.\"},\"on_duration_warning_threshold_exceeded\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.\"},\"on_failure\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.\"},\"on_start\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.\"},\"on_streaming_backlog_exceeded\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\"},\"on_success\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobEnvironment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"environment_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The key of an environment. It has to be unique within a job.\"},\"spec\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment\"}},\"additionalProperties\":false,\"required\":[\"environment_key\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobNotificationSettings\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"no_alert_for_canceled_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.\"},\"no_alert_for_skipped_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobParameterDefinition\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/$defs/string\",\"description\":\"Default value of the parameter.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`\"}},\"additionalProperties\":false,\"required\":[\"default\",\"name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobRunAs\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\\n\\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.\",\"properties\":{\"service_principal_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.\"},\"user_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The email of an active workspace user. Non-admin users can only set this field to their own email.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobSource\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"The source of the job specification in the remote repository when the job is source controlled.\",\"properties\":{\"dirty_state\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState\",\"description\":\"Dirty state indicates the job is not fully synced with the job specification in the remote repository.\\n\\nPossible values are:\\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.\"},\"import_from_git_branch\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the branch which the job is imported from.\"},\"job_config_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"Path of the job YAML file that contains the job specification.\"}},\"additionalProperties\":false,\"required\":[\"import_from_git_branch\",\"job_config_path\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobSourceDirtyState\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Dirty state indicates the job is not fully synced with the job specification\\nin the remote repository.\\n\\nPossible values are:\\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.\",\"enum\":[\"NOT_SYNCED\",\"DISCONNECTED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobsHealthMetric\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Specifies the health metric that is being evaluated for a particular health rule.\\n\\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.\",\"enum\":[\"RUN_DURATION_SECONDS\",\"STREAMING_BACKLOG_BYTES\",\"STREAMING_BACKLOG_RECORDS\",\"STREAMING_BACKLOG_SECONDS\",\"STREAMING_BACKLOG_FILES\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobsHealthOperator\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Specifies the operator used to compare the health metric value with the specified threshold.\",\"enum\":[\"GREATER_THAN\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobsHealthRule\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"metric\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric\"},\"op\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator\"},\"value\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Specifies the threshold value that the health metric should obey to satisfy the health rule.\"}},\"additionalProperties\":false,\"required\":[\"metric\",\"op\",\"value\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobsHealthRules\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"An optional set of health rules that can be defined for this job.\",\"properties\":{\"rules\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.NotebookTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"base_parameters\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Base parameters to be used for each run of this job. If the run is initiated by a call to :method:jobs/run\\nNow with parameters specified, the two parameters maps are merged. If the same key is specified in\\n`base_parameters` and in `run-now`, the value from `run-now` is used.\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\\n\\nIf the notebook takes a parameter that is not specified in the job\\u2019s `base_parameters` or the `run-now` override parameters,\\nthe default value from the notebook is used.\\n\\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\\n\\nThe JSON representation of this field cannot exceed 1MB.\"},\"notebook_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The path of the notebook to be run in the Databricks workspace or remote repository.\\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\\nFor notebooks stored in a remote repository, the path must be relative. This field is required.\"},\"source\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source\",\"description\":\"Optional location type of the notebook. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository\\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\\n* `WORKSPACE`: Notebook is located in Databricks workspace.\\n* `GIT`: Notebook is located in cloud Git provider.\"},\"warehouse_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional `warehouse_id` to run the notebook on a SQL warehouse. Classic SQL warehouses are NOT supported, please use serverless or pro SQL warehouses.\\n\\nNote that SQL warehouses only support SQL cells; if the notebook contains non-SQL cells, the run will fail.\"}},\"additionalProperties\":false,\"required\":[\"notebook_path\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PauseStatus\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"UNPAUSED\",\"PAUSED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PeriodicTriggerConfiguration\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"interval\":{\"$ref\":\"#/$defs/int\",\"description\":\"The interval at which the trigger should run.\"},\"unit\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfigurationTimeUnit\",\"description\":\"The unit of time for the interval.\"}},\"additionalProperties\":false,\"required\":[\"interval\",\"unit\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PeriodicTriggerConfigurationTimeUnit\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"HOURS\",\"DAYS\",\"WEEKS\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PipelineParams\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"full_refresh\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, triggers a full refresh on the delta live table.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PipelineTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"full_refresh\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, triggers a full refresh on the delta live table.\"},\"pipeline_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The full name of the pipeline task to execute.\"}},\"additionalProperties\":false,\"required\":[\"pipeline_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.PythonWheelTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"entry_point\":{\"$ref\":\"#/$defs/string\",\"description\":\"Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`\"},\"named_parameters\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Command-line parameters passed to Python wheel task in the form of `[\\\"--name=task\\\", \\\"--data=dbfs:/path/to/data.json\\\"]`. Leave it empty if `parameters` is not null.\"},\"package_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Name of the package to execute\"},\"parameters\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.\"}},\"additionalProperties\":false,\"required\":[\"entry_point\",\"package_name\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.QueueSettings\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, enable queueing for the job. This is a required field.\"}},\"additionalProperties\":false,\"required\":[\"enabled\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.RunIf\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`.\\n\\nPossible values are:\\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\\n* `ALL_DONE`: All dependencies have been completed\\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\\n* `ALL_FAILED`: ALl dependencies have failed\",\"enum\":[\"ALL_SUCCESS\",\"ALL_DONE\",\"NONE_FAILED\",\"AT_LEAST_ONE_SUCCESS\",\"ALL_FAILED\",\"AT_LEAST_ONE_FAILED\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.RunJobTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"dbt_commands\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"An array of commands to execute for jobs with the dbt task, for example `\\\"dbt_commands\\\": [\\\"dbt deps\\\", \\\"dbt seed\\\", \\\"dbt deps\\\", \\\"dbt seed\\\", \\\"dbt run\\\"]`\"},\"jar_params\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of parameters for jobs with Spark JAR tasks, for example `\\\"jar_params\\\": [\\\"john doe\\\", \\\"35\\\"]`.\\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\\nIf not specified upon `run-now`, it defaults to an empty list.\\njar_params cannot be specified in conjunction with notebook_params.\\nThe JSON representation of this field (for example `{\\\"jar_params\\\":[\\\"john doe\\\",\\\"35\\\"]}`) cannot exceed 10,000 bytes.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\"},\"job_id\":{\"$ref\":\"#/$defs/int64\",\"description\":\"ID of the job to trigger.\"},\"job_parameters\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Job-level parameters used to trigger the job.\"},\"notebook_params\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"A map from keys to values for jobs with notebook task, for example `\\\"notebook_params\\\": {\\\"name\\\": \\\"john doe\\\", \\\"age\\\": \\\"35\\\"}`.\\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\\n\\nIf not specified upon `run-now`, the triggered run uses the job\\u2019s base parameters.\\n\\nnotebook_params cannot be specified in conjunction with jar_params.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\\n\\nThe JSON representation of this field (for example `{\\\"notebook_params\\\":{\\\"name\\\":\\\"john doe\\\",\\\"age\\\":\\\"35\\\"}}`) cannot exceed 10,000 bytes.\"},\"pipeline_params\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams\",\"description\":\"Controls whether the pipeline should perform a full refresh\"},\"python_named_params\":{\"$ref\":\"#/$defs/map/string\"},\"python_params\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of parameters for jobs with Python tasks, for example `\\\"python_params\\\": [\\\"john doe\\\", \\\"35\\\"]`.\\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\\nthe parameters specified in job setting. The JSON representation of this field (for example `{\\\"python_params\\\":[\\\"john doe\\\",\\\"35\\\"]}`)\\ncannot exceed 10,000 bytes.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\\n\\nImportant\\n\\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.\"},\"spark_submit_params\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of parameters for jobs with spark submit task, for example `\\\"spark_submit_params\\\": [\\\"--class\\\", \\\"org.apache.spark.examples.SparkPi\\\"]`.\\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\\nparameters specified in job setting. The JSON representation of this field (for example `{\\\"python_params\\\":[\\\"john doe\\\",\\\"35\\\"]}`)\\ncannot exceed 10,000 bytes.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs\\n\\nImportant\\n\\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.\"},\"sql_params\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"A map from keys to values for jobs with SQL task, for example `\\\"sql_params\\\": {\\\"name\\\": \\\"john doe\\\", \\\"age\\\": \\\"35\\\"}`. The SQL alert task does not support custom parameters.\"}},\"additionalProperties\":false,\"required\":[\"job_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Source\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\\\\\\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\\n\\n* `WORKSPACE`: SQL file is located in Databricks workspace.\\n* `GIT`: SQL file is located in cloud Git provider.\",\"enum\":[\"WORKSPACE\",\"GIT\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SparkJarTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"jar_uri\":{\"$ref\":\"#/$defs/string\",\"description\":\"Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create.\"},\"main_class_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\\n\\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail.\"},\"parameters\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Parameters passed to the main method.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SparkPythonTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"parameters\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Command line parameters passed to the Python file.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\"},\"python_file\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.\"},\"source\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source\",\"description\":\"Optional location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local\\nDatabricks workspace or cloud location (if the `python_file` has a URI format). When set to `GIT`,\\nthe Python file will be retrieved from a Git repository defined in `git_source`.\\n\\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\\n* `GIT`: The Python file is located in a remote Git repository.\"}},\"additionalProperties\":false,\"required\":[\"python_file\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SparkSubmitTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"parameters\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Command-line parameters passed to spark submit.\\n\\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTask\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"alert\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskAlert\",\"description\":\"If alert, indicates that this job must refresh a SQL alert.\"},\"dashboard\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskDashboard\",\"description\":\"If dashboard, indicates that this job must refresh a SQL dashboard.\"},\"file\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskFile\",\"description\":\"If file, indicates that this job runs a SQL file in a remote Git repository.\"},\"parameters\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.\"},\"query\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskQuery\",\"description\":\"If query, indicates that this job must execute a SQL query.\"},\"warehouse_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs.\"}},\"additionalProperties\":false,\"required\":[\"warehouse_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskAlert\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"alert_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The canonical identifier of the SQL alert.\"},\"pause_subscriptions\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, the alert notifications are not sent to subscribers.\"},\"subscriptions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription\",\"description\":\"If specified, alert notifications are sent to subscribers.\"}},\"additionalProperties\":false,\"required\":[\"alert_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskDashboard\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"custom_subject\":{\"$ref\":\"#/$defs/string\",\"description\":\"Subject of the email sent to subscribers of this task.\"},\"dashboard_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The canonical identifier of the SQL dashboard.\"},\"pause_subscriptions\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, the dashboard snapshot is not taken, and emails are not sent to subscribers.\"},\"subscriptions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription\",\"description\":\"If specified, dashboard snapshots are sent to subscriptions.\"}},\"additionalProperties\":false,\"required\":[\"dashboard_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskFile\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"path\":{\"$ref\":\"#/$defs/string\",\"description\":\"Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths.\"},\"source\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source\",\"description\":\"Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\\n\\n* `WORKSPACE`: SQL file is located in Databricks workspace.\\n* `GIT`: SQL file is located in cloud Git provider.\"}},\"additionalProperties\":false,\"required\":[\"path\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskQuery\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"query_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The canonical identifier of the SQL query.\"}},\"additionalProperties\":false,\"required\":[\"query_id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskSubscription\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The canonical identifier of the destination to receive email notification. This parameter is mutually exclusive with user_name. You cannot set both destination_id and user_name for subscription notifications.\"},\"user_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The user name to receive the subscription email. This parameter is mutually exclusive with destination_id. You cannot set both destination_id and user_name for subscription notifications.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TableUpdateTriggerConfiguration\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"condition\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Condition\",\"description\":\"The table(s) condition based on which to trigger a job run.\"},\"min_time_between_triggers_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"If set, the trigger starts a run only after the specified amount of time has passed since\\nthe last time the trigger fired. The minimum allowed value is 60 seconds.\"},\"table_names\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of Delta tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`.\"},\"wait_after_last_change_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"If set, the trigger starts a run only after no table updates have occurred for the specified time\\nand can be used to wait for a series of table updates before triggering a run. The\\nminimum allowed value is 60 seconds.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Task\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"clean_rooms_notebook_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask\",\"description\":\"The task runs a [clean rooms](https://docs.databricks.com/en/clean-rooms/index.html) notebook\\nwhen the `clean_rooms_notebook_task` field is present.\"},\"condition_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTask\",\"description\":\"The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\\nThe condition task does not require a cluster to execute and does not support retries or notifications.\"},\"dbt_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtTask\",\"description\":\"The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.\"},\"depends_on\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency\",\"description\":\"An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete before executing this task. The task will run only if the `run_if` condition is true.\\nThe key is `task_key`, and the value is the name assigned to the dependent task.\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"An optional description for this task.\"},\"disable_auto_optimization\":{\"$ref\":\"#/$defs/bool\",\"description\":\"An option to disable auto optimization in serverless\"},\"email_notifications\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications\",\"description\":\"An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails.\"},\"environment_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute.\"},\"existing_cluster_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"If existing_cluster_id, the ID of an existing cluster that is used for all runs.\\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\\ngreater reliability\"},\"for_each_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ForEachTask\",\"description\":\"The task executes a nested task for every input provided when the `for_each_task` field is present.\"},\"health\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules\"},\"job_cluster_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.\"},\"libraries\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library\",\"description\":\"An optional list of libraries to be installed on the cluster.\\nThe default value is an empty list.\"},\"max_retries\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.\"},\"min_retry_interval_millis\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\"},\"new_cluster\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec\",\"description\":\"If new_cluster, a description of a new cluster that is created for each run.\"},\"notebook_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask\",\"description\":\"The task runs a notebook when the `notebook_task` field is present.\"},\"notification_settings\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskNotificationSettings\",\"description\":\"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task.\"},\"pipeline_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask\",\"description\":\"The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported.\"},\"python_wheel_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask\",\"description\":\"The task runs a Python wheel when the `python_wheel_task` field is present.\"},\"retry_on_timeout\":{\"$ref\":\"#/$defs/bool\",\"description\":\"An optional policy to specify whether to retry a job when it times out. The default behavior\\nis to not retry on timeout.\"},\"run_if\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunIf\",\"description\":\"An optional value specifying the condition determining whether the task is run once its dependencies have been completed.\\n\\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\\n* `ALL_DONE`: All dependencies have been completed\\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\\n* `ALL_FAILED`: ALl dependencies have failed\"},\"run_job_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask\",\"description\":\"The task triggers another job when the `run_job_task` field is present.\"},\"spark_jar_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask\",\"description\":\"The task runs a JAR when the `spark_jar_task` field is present.\"},\"spark_python_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkPythonTask\",\"description\":\"The task runs a Python file when the `spark_python_task` field is present.\"},\"spark_submit_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkSubmitTask\",\"description\":\"(Legacy) The task runs the spark-submit script when the `spark_submit_task` field is present. This task can run only on new clusters and is not compatible with serverless compute.\\n\\nIn the `new_cluster` specification, `libraries` and `spark_conf` are not supported. Instead, use `--jars` and `--py-files` to add Java and Python libraries and `--conf` to set the Spark configurations.\\n\\n`master`, `deploy-mode`, and `executor-cores` are automatically configured by Databricks; you _cannot_ specify them in parameters.\\n\\nBy default, the Spark submit job uses all available memory (excluding reserved memory for Databricks services). You can set `--driver-memory`, and `--executor-memory` to a smaller value to leave some room for off-heap usage.\\n\\nThe `--jars`, `--py-files`, `--files` arguments support DBFS and S3 paths.\"},\"sql_task\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTask\",\"description\":\"The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present.\"},\"task_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"A unique name for the task. This field is used to refer to this task from other tasks.\\nThis field is required and must be unique within its parent job.\\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.\"},\"timeout_seconds\":{\"$ref\":\"#/$defs/int\",\"description\":\"An optional timeout applied to each run of this job task. A value of `0` means no timeout.\"},\"webhook_notifications\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications\",\"description\":\"A collection of system notification IDs to notify when runs of this task begin or complete. The default behavior is to not send any system notifications.\"}},\"additionalProperties\":false,\"required\":[\"task_key\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TaskDependency\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"outcome\":{\"$ref\":\"#/$defs/string\",\"description\":\"Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run.\"},\"task_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the task this task depends on.\"}},\"additionalProperties\":false,\"required\":[\"task_key\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TaskEmailNotifications\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"no_alert_for_skipped_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send email to recipients specified in `on_failure` if the run is skipped.\\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.\"},\"on_duration_warning_threshold_exceeded\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.\"},\"on_failure\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.\"},\"on_start\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.\"},\"on_streaming_backlog_exceeded\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\"},\"on_success\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TaskNotificationSettings\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"alert_on_last_attempt\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send notifications to recipients specified in `on_start` for the retried runs and do not send notifications to recipients specified in `on_failure` until the last retry of the run.\"},\"no_alert_for_canceled_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.\"},\"no_alert_for_skipped_runs\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TriggerSettings\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"file_arrival\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration\",\"description\":\"File arrival trigger settings.\"},\"pause_status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus\",\"description\":\"Whether this trigger is paused or not.\"},\"periodic\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration\",\"description\":\"Periodic trigger settings.\"},\"table\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration\",\"description\":\"Old table trigger settings name. Deprecated in favor of `table_update`.\"},\"table_update\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Webhook\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false,\"required\":[\"id\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.WebhookNotifications\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"on_duration_warning_threshold_exceeded\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\",\"description\":\"An optional list of system notification IDs to call when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. A maximum of 3 destinations can be specified for the `on_duration_warning_threshold_exceeded` property.\"},\"on_failure\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\",\"description\":\"An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property.\"},\"on_start\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\",\"description\":\"An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property.\"},\"on_streaming_backlog_exceeded\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\",\"description\":\"An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.\"},\"on_success\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\",\"description\":\"An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ExperimentTag\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag key.\"},\"value\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag value.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelTag\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag key.\"},\"value\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag value.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelVersion\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"creation_timestamp\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Timestamp recorded when this `model_version` was created.\"},\"current_stage\":{\"$ref\":\"#/$defs/string\",\"description\":\"Current stage for this `model_version`.\"},\"description\":{\"$ref\":\"#/$defs/string\",\"description\":\"Description of this `model_version`.\"},\"last_updated_timestamp\":{\"$ref\":\"#/$defs/int64\",\"description\":\"Timestamp recorded when metadata for this `model_version` was last updated.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Unique name of the model\"},\"run_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"MLflow run ID used when creating `model_version`, if `source` was generated by an\\nexperiment run stored in MLflow tracking server.\"},\"run_link\":{\"$ref\":\"#/$defs/string\",\"description\":\"Run Link: Direct link to the run that generated this version\"},\"source\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI indicating the location of the source model artifacts, used when creating `model_version`\"},\"status\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionStatus\",\"description\":\"Current status of `model_version`\"},\"status_message\":{\"$ref\":\"#/$defs/string\",\"description\":\"Details on current `status`, if it is pending or failed.\"},\"tags\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionTag\",\"description\":\"Tags: Additional metadata key-value pairs for this `model_version`.\"},\"user_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"User that created this `model_version`.\"},\"version\":{\"$ref\":\"#/$defs/string\",\"description\":\"Model's version number.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelVersionStatus\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Current status of `model_version`\",\"enum\":[\"PENDING_REGISTRATION\",\"FAILED_REGISTRATION\",\"READY\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelVersionTag\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag key.\"},\"value\":{\"$ref\":\"#/$defs/string\",\"description\":\"The tag value.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.CronTrigger\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"quartz_cron_schedule\":{\"$ref\":\"#/$defs/string\"},\"timezone_id\":{\"$ref\":\"#/$defs/string\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.DayOfWeek\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\\nIf not specified all days of the week will be used.\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.DeploymentKind\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The deployment method that manages the pipeline:\\n- BUNDLE: The pipeline is managed by a Databricks Asset Bundle.\\n\",\"enum\":[\"BUNDLE\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.FileLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The absolute path of the file.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.Filters\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"exclude\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Paths to exclude.\"},\"include\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Paths to include.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.IngestionConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"report\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec\",\"description\":\"Select a specific source report.\"},\"schema\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec\",\"description\":\"Select all tables from a specific source schema.\"},\"table\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec\",\"description\":\"Select a specific source table.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.IngestionGatewayPipelineDefinition\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"connection_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.\"},\"connection_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.\"},\"gateway_storage_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required, Immutable. The name of the catalog for the gateway pipeline's storage location.\"},\"gateway_storage_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional. The Unity Catalog-compatible name for the gateway storage location.\\nThis is the destination to use for the data that is extracted by the gateway.\\nDelta Live Tables system will automatically create the storage location under the catalog and schema.\\n\"},\"gateway_storage_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required, Immutable. The name of the schema for the gateway pipelines's storage location.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.IngestionPipelineDefinition\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"connection_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"Immutable. The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with connectors for applications like Salesforce, Workday, and so on.\"},\"ingestion_gateway_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Immutable. Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with connectors to databases like SQL Server.\"},\"objects\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig\",\"description\":\"Required. Settings specifying tables to replicate and the destination for the replicated tables.\"},\"table_configuration\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig\",\"description\":\"Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.ManualTrigger\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.NotebookLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The absolute path of the notebook.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.Notifications\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"alerts\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of alerts that trigger the sending of notifications to the configured\\ndestinations. The supported alerts are:\\n\\n* `on-update-success`: A pipeline update completes successfully.\\n* `on-update-failure`: Each time a pipeline update fails.\\n* `on-update-fatal-failure`: A pipeline update fails with a non-retryable (fatal) error.\\n* `on-flow-failure`: A single data flow fails.\\n\"},\"email_recipients\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"A list of email addresses notified when a configured alert is triggered.\\n\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineCluster\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"apply_policy_default_values\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Note: This field won't be persisted. Only API users will check this field.\"},\"autoscale\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscale\",\"description\":\"Parameters needed in order to automatically scale clusters up and down based on load.\\nNote: autoscaling works best with DB runtime versions 3.0 or later.\"},\"aws_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes\",\"description\":\"Attributes related to clusters running on Amazon Web Services.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"azure_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes\",\"description\":\"Attributes related to clusters running on Microsoft Azure.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"cluster_log_conf\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf\",\"description\":\"The configuration for delivering spark logs to a long-term storage destination.\\nOnly dbfs destinations are supported. Only one destination can be specified\\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\\nthe destination of executor logs is `$destination/$clusterId/executor`.\\n\"},\"custom_tags\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\\n\\n- Currently, Databricks allows at most 45 custom tags\\n\\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags\"},\"driver_instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool for the driver of the cluster belongs.\\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\\nassigned.\"},\"driver_node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The node type of the Spark driver.\\nNote that this field is optional; if unset, the driver node type will be set as the same value\\nas `node_type_id` defined above.\"},\"enable_local_disk_encryption\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to enable local disk encryption for the cluster.\"},\"gcp_attributes\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes\",\"description\":\"Attributes related to clusters running on Google Cloud Platform.\\nIf not specified at cluster creation, a set of default values will be used.\"},\"init_scripts\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo\",\"description\":\"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`.\"},\"instance_pool_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The optional ID of the instance pool to which the cluster belongs.\"},\"label\":{\"$ref\":\"#/$defs/string\",\"description\":\"A label for the cluster specification, either `default` to configure the default cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`.\"},\"node_type_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field encodes, through a single value, the resources available to each of\\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\\nand optimized for memory or compute intensive workloads. A list of available node\\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\\n\"},\"num_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\\n\\nNote: When reading the properties of a cluster, this field reflects the desired number\\nof workers rather than the actual current number of workers. For instance, if a cluster\\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\\nincrease from 5 to 10 as the new nodes are provisioned.\"},\"policy_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The ID of the cluster policy used to create the cluster if applicable.\"},\"spark_conf\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified Spark configuration key-value pairs.\\nSee :method:clusters/create for more details.\\n\"},\"spark_env_vars\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified environment variable key-value pairs.\\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\\n`export X='Y'`) while launching the driver and workers.\\n\\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\\ndefault databricks managed environmental variables are included as well.\\n\\nExample Spark environment variables:\\n`{\\\"SPARK_WORKER_MEMORY\\\": \\\"28000m\\\", \\\"SPARK_LOCAL_DIRS\\\": \\\"/local_disk0\\\"}` or\\n`{\\\"SPARK_DAEMON_JAVA_OPTS\\\": \\\"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\\\"}`\"},\"ssh_public_keys\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"SSH public key contents that will be added to each Spark node in this cluster. The\\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\\nUp to 10 keys can be specified.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineClusterAutoscale\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"max_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`.\"},\"min_workers\":{\"$ref\":\"#/$defs/int\",\"description\":\"The minimum number of workers the cluster can scale down to when underutilized.\\nIt is also the initial number of workers the cluster will have after creation.\"},\"mode\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscaleMode\",\"description\":\"Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\\nallocating cluster resources based on workload volume, with minimal impact to\\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\\nclusters.\\n\"}},\"additionalProperties\":false,\"required\":[\"max_workers\",\"min_workers\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineClusterAutoscaleMode\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\\nallocating cluster resources based on workload volume, with minimal impact to\\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\\nclusters.\\n\",\"enum\":[\"ENHANCED\",\"LEGACY\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineDeployment\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"kind\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind\",\"description\":\"The deployment method that manages the pipeline.\"},\"metadata_file_path\":{\"$ref\":\"#/$defs/string\",\"description\":\"The path to the file containing metadata about the deployment.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineLibrary\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"file\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary\",\"description\":\"The path to a file that defines a pipeline and is stored in the Databricks Repos.\\n\"},\"jar\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI of the jar to be installed. Currently only DBFS is supported.\\n\"},\"maven\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary\",\"description\":\"Specification of a maven library to be installed.\\n\"},\"notebook\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary\",\"description\":\"The path to a notebook that defines a pipeline and is stored in the Databricks workspace.\\n\"},\"whl\":{\"$ref\":\"#/$defs/string\",\"description\":\"URI of the whl to be installed.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineTrigger\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cron\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger\"},\"manual\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.ReportSpec\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination catalog to store table.\"},\"destination_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination schema to store table.\"},\"destination_table\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination table name. The pipeline fails if a table with that name already exists.\"},\"source_url\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Report URL in the source system.\"},\"table_configuration\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig\",\"description\":\"Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.RestartWindow\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"days_of_week\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek\",\"description\":\"Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\\nIf not specified all days of the week will be used.\"},\"start_hour\":{\"$ref\":\"#/$defs/int\",\"description\":\"An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.\"},\"time_zone_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\\nIf not specified, UTC will be used.\"}},\"additionalProperties\":false,\"required\":[\"start_hour\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.SchemaSpec\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination catalog to store tables.\"},\"destination_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.\"},\"source_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"The source catalog name. Might be optional depending on the type of source.\"},\"source_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Schema name in the source database.\"},\"table_configuration\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig\",\"description\":\"Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.TableSpec\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"destination_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination catalog to store table.\"},\"destination_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Destination schema to store table.\"},\"destination_table\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.\"},\"source_catalog\":{\"$ref\":\"#/$defs/string\",\"description\":\"Source catalog name. Might be optional depending on the type of source.\"},\"source_schema\":{\"$ref\":\"#/$defs/string\",\"description\":\"Schema name in the source database. Might be optional depending on the type of source.\"},\"source_table\":{\"$ref\":\"#/$defs/string\",\"description\":\"Required. Table name in the source database.\"},\"table_configuration\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig\",\"description\":\"Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.TableSpecificConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"primary_keys\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The primary key of the table used to apply changes.\"},\"salesforce_include_formula_fields\":{\"$ref\":\"#/$defs/bool\",\"description\":\"If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector\"},\"scd_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType\",\"description\":\"The SCD type to use to ingest the table.\"},\"sequence_by\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The column names specifying the logical order of events in the source data. Delta Live Tables uses this sequencing to handle change events that arrive out of order.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.TableSpecificConfigScdType\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The SCD type to use to ingest the table.\",\"enum\":[\"SCD_TYPE_1\",\"SCD_TYPE_2\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.Ai21LabsConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"ai21labs_api_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for an AI21 Labs API key. If you prefer to paste your API key directly, see `ai21labs_api_key_plaintext`. You must provide an API key using one of the following fields: `ai21labs_api_key` or `ai21labs_api_key_plaintext`.\"},\"ai21labs_api_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"An AI21 Labs API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `ai21labs_api_key`. You must provide an API key using one of the following fields: `ai21labs_api_key` or `ai21labs_api_key_plaintext`.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"guardrails\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails\",\"description\":\"Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.\"},\"inference_table_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig\",\"description\":\"Configuration for payload logging using inference tables. Use these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.\"},\"rate_limits\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit\",\"description\":\"Configuration for rate limits which can be set to limit endpoint traffic.\"},\"usage_tracking_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig\",\"description\":\"Configuration to enable usage tracking using system tables. These tables allow you to monitor operational usage on endpoints and their associated costs.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayGuardrailParameters\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"invalid_keywords\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.\"},\"pii\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior\",\"description\":\"Configuration for guardrail PII filter.\"},\"safety\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Indicates whether the safety filter is enabled.\"},\"valid_topics\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayGuardrailPiiBehavior\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"behavior\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior\",\"description\":\"Behavior for PII filter. Currently only 'BLOCK' is supported. If 'BLOCK' is set for the input guardrail and the request contains PII, the request is not sent to the model server and 400 status code is returned; if 'BLOCK' is set for the output guardrail and the model response contains PII, the PII info in the response is redacted and 400 status code is returned.\"}},\"additionalProperties\":false,\"required\":[\"behavior\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayGuardrailPiiBehaviorBehavior\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Behavior for PII filter. Currently only 'BLOCK' is supported. If 'BLOCK' is set for the input guardrail and the request contains PII, the request is not sent to the model server and 400 status code is returned; if 'BLOCK' is set for the output guardrail and the model response contains PII, the PII info in the response is redacted and 400 status code is returned.\",\"enum\":[\"NONE\",\"BLOCK\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayGuardrails\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"input\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters\",\"description\":\"Configuration for input guardrail filters.\"},\"output\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters\",\"description\":\"Configuration for output guardrail filters.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayInferenceTableConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the catalog in Unity Catalog. Required when enabling inference tables. NOTE: On update, you have to disable inference table first in order to change the catalog name.\"},\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Indicates whether the inference table is enabled.\"},\"schema_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the schema in Unity Catalog. Required when enabling inference tables. NOTE: On update, you have to disable inference table first in order to change the schema name.\"},\"table_name_prefix\":{\"$ref\":\"#/$defs/string\",\"description\":\"The prefix of the table in Unity Catalog. NOTE: On update, you have to disable inference table first in order to change the prefix name.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayRateLimit\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"calls\":{\"$ref\":\"#/$defs/int\",\"description\":\"Used to specify how many calls are allowed for a key within the renewal_period.\"},\"key\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey\",\"description\":\"Key field for a rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.\"},\"renewal_period\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod\",\"description\":\"Renewal period field for a rate limit. Currently, only 'minute' is supported.\"}},\"additionalProperties\":false,\"required\":[\"calls\",\"renewal_period\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayRateLimitKey\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Key field for a rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.\",\"enum\":[\"user\",\"endpoint\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayRateLimitRenewalPeriod\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Renewal period field for a rate limit. Currently, only 'minute' is supported.\",\"enum\":[\"minute\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayUsageTrackingConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether to enable usage tracking.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AmazonBedrockConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"aws_access_key_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for an AWS access key ID with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see `aws_access_key_id`. You must provide an API key using one of the following fields: `aws_access_key_id` or `aws_access_key_id_plaintext`.\"},\"aws_access_key_id_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"An AWS access key ID with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `aws_access_key_id`. You must provide an API key using one of the following fields: `aws_access_key_id` or `aws_access_key_id_plaintext`.\"},\"aws_region\":{\"$ref\":\"#/$defs/string\",\"description\":\"The AWS region to use. Bedrock has to be enabled there.\"},\"aws_secret_access_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for an AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see `aws_secret_access_key_plaintext`. You must provide an API key using one of the following fields: `aws_secret_access_key` or `aws_secret_access_key_plaintext`.\"},\"aws_secret_access_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"An AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `aws_secret_access_key`. You must provide an API key using one of the following fields: `aws_secret_access_key` or `aws_secret_access_key_plaintext`.\"},\"bedrock_provider\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedrockProvider\",\"description\":\"The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.\"}},\"additionalProperties\":false,\"required\":[\"aws_region\",\"bedrock_provider\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AmazonBedrockConfigBedrockProvider\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.\",\"enum\":[\"anthropic\",\"cohere\",\"ai21labs\",\"amazon\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AnthropicConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"anthropic_api_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for an Anthropic API key. If you prefer to paste your API key directly, see `anthropic_api_key_plaintext`. You must provide an API key using one of the following fields: `anthropic_api_key` or `anthropic_api_key_plaintext`.\"},\"anthropic_api_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Anthropic API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `anthropic_api_key`. You must provide an API key using one of the following fields: `anthropic_api_key` or `anthropic_api_key_plaintext`.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AutoCaptureConfigInput\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"catalog_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if the inference table is already enabled.\"},\"enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Indicates whether the inference table is enabled.\"},\"schema_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if the inference table is already enabled.\"},\"table_name_prefix\":{\"$ref\":\"#/$defs/string\",\"description\":\"The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if the inference table is already enabled.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.CohereConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cohere_api_base\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is an optional field to provide a customized base URL for the Cohere API. \\nIf left unspecified, the standard Cohere base URL is used.\\n\"},\"cohere_api_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for a Cohere API key. If you prefer to paste your API key directly, see `cohere_api_key_plaintext`. You must provide an API key using one of the following fields: `cohere_api_key` or `cohere_api_key_plaintext`.\"},\"cohere_api_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Cohere API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `cohere_api_key`. You must provide an API key using one of the following fields: `cohere_api_key` or `cohere_api_key_plaintext`.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.DatabricksModelServingConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"databricks_api_token\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for a Databricks API token that corresponds to a user or service\\nprincipal with Can Query access to the model serving endpoint pointed to by this external model.\\nIf you prefer to paste your API key directly, see `databricks_api_token_plaintext`.\\nYou must provide an API key using one of the following fields: `databricks_api_token` or `databricks_api_token_plaintext`.\\n\"},\"databricks_api_token_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks API token that corresponds to a user or service\\nprincipal with Can Query access to the model serving endpoint pointed to by this external model provided as a plaintext string.\\nIf you prefer to reference your key using Databricks Secrets, see `databricks_api_token`.\\nYou must provide an API key using one of the following fields: `databricks_api_token` or `databricks_api_token_plaintext`.\\n\"},\"databricks_workspace_url\":{\"$ref\":\"#/$defs/string\",\"description\":\"The URL of the Databricks workspace containing the model serving endpoint pointed to by this external model.\\n\"}},\"additionalProperties\":false,\"required\":[\"databricks_workspace_url\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.EndpointCoreConfigInput\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"auto_capture_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AutoCaptureConfigInput\",\"description\":\"Configuration for Inference Tables which automatically logs requests and responses to Unity Catalog.\"},\"served_entities\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput\",\"description\":\"A list of served entities for the endpoint to serve. A serving endpoint can have up to 15 served entities.\"},\"served_models\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput\",\"description\":\"(Deprecated, use served_entities instead) A list of served models for the endpoint to serve. A serving endpoint can have up to 15 served models.\"},\"traffic_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig\",\"description\":\"The traffic config defining how invocations to the serving endpoint should be routed.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.EndpointTag\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"key\":{\"$ref\":\"#/$defs/string\",\"description\":\"Key field for a serving endpoint tag.\"},\"value\":{\"$ref\":\"#/$defs/string\",\"description\":\"Optional value field for a serving endpoint tag.\"}},\"additionalProperties\":false,\"required\":[\"key\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ExternalModel\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"ai21labs_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig\",\"description\":\"AI21Labs Config. Only required if the provider is 'ai21labs'.\"},\"amazon_bedrock_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfig\",\"description\":\"Amazon Bedrock Config. Only required if the provider is 'amazon-bedrock'.\"},\"anthropic_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig\",\"description\":\"Anthropic Config. Only required if the provider is 'anthropic'.\"},\"cohere_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CohereConfig\",\"description\":\"Cohere Config. Only required if the provider is 'cohere'.\"},\"databricks_model_serving_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.DatabricksModelServingConfig\",\"description\":\"Databricks Model Serving Config. Only required if the provider is 'databricks-model-serving'.\"},\"google_cloud_vertex_ai_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.GoogleCloudVertexAiConfig\",\"description\":\"Google Cloud Vertex AI Config. Only required if the provider is 'google-cloud-vertex-ai'.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the external model.\"},\"openai_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.OpenAiConfig\",\"description\":\"OpenAI Config. Only required if the provider is 'openai'.\"},\"palm_config\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.PaLmConfig\",\"description\":\"PaLM Config. Only required if the provider is 'palm'.\"},\"provider\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider\",\"description\":\"The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic',\\n'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', and 'palm'.\\\",\\n\"},\"task\":{\"$ref\":\"#/$defs/string\",\"description\":\"The task type of the external model.\"}},\"additionalProperties\":false,\"required\":[\"name\",\"provider\",\"task\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ExternalModelProvider\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic',\\n'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', and 'palm'.\\\",\\n\",\"enum\":[\"ai21labs\",\"anthropic\",\"amazon-bedrock\",\"cohere\",\"databricks-model-serving\",\"google-cloud-vertex-ai\",\"openai\",\"palm\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.GoogleCloudVertexAiConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"private_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for a private key for the service account which has access to the Google Cloud Vertex AI Service. See [Best practices for managing service account keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys). If you prefer to paste your API key directly, see `private_key_plaintext`. You must provide an API key using one of the following fields: `private_key` or `private_key_plaintext`\"},\"private_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The private key for the service account which has access to the Google Cloud Vertex AI Service provided as a plaintext secret. See [Best practices for managing service account keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys). If you prefer to reference your key using Databricks Secrets, see `private_key`. You must provide an API key using one of the following fields: `private_key` or `private_key_plaintext`.\"},\"project_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is the Google Cloud project id that the service account is associated with.\"},\"region\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is the region for the Google Cloud Vertex AI Service. See [supported regions](https://cloud.google.com/vertex-ai/docs/general/locations) for more details. Some models are only available in specific regions.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.OpenAiConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"microsoft_entra_client_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field is only required for Azure AD OpenAI and is the Microsoft Entra Client ID.\\n\"},\"microsoft_entra_client_secret\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for a client secret used for Microsoft Entra ID authentication.\\nIf you prefer to paste your client secret directly, see `microsoft_entra_client_secret_plaintext`.\\nYou must provide an API key using one of the following fields: `microsoft_entra_client_secret` or `microsoft_entra_client_secret_plaintext`.\\n\"},\"microsoft_entra_client_secret_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The client secret used for Microsoft Entra ID authentication provided as a plaintext string.\\nIf you prefer to reference your key using Databricks Secrets, see `microsoft_entra_client_secret`.\\nYou must provide an API key using one of the following fields: `microsoft_entra_client_secret` or `microsoft_entra_client_secret_plaintext`.\\n\"},\"microsoft_entra_tenant_id\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field is only required for Azure AD OpenAI and is the Microsoft Entra Tenant ID.\\n\"},\"openai_api_base\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is a field to provide a customized base URl for the OpenAI API.\\nFor Azure OpenAI, this field is required, and is the base URL for the Azure OpenAI API service\\nprovided by Azure.\\nFor other OpenAI API types, this field is optional, and if left unspecified, the standard OpenAI base URL is used.\\n\"},\"openai_api_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for an OpenAI API key using the OpenAI or Azure service. If you prefer to paste your API key directly, see `openai_api_key_plaintext`. You must provide an API key using one of the following fields: `openai_api_key` or `openai_api_key_plaintext`.\"},\"openai_api_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The OpenAI API key using the OpenAI or Azure service provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `openai_api_key`. You must provide an API key using one of the following fields: `openai_api_key` or `openai_api_key_plaintext`.\"},\"openai_api_type\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is an optional field to specify the type of OpenAI API to use.\\nFor Azure OpenAI, this field is required, and adjust this parameter to represent the preferred security\\naccess validation protocol. For access token validation, use azure. For authentication using Azure Active\\nDirectory (Azure AD) use, azuread.\\n\"},\"openai_api_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is an optional field to specify the OpenAI API version.\\nFor Azure OpenAI, this field is required, and is the version of the Azure OpenAI service to\\nutilize, specified by a date.\\n\"},\"openai_deployment_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"This field is only required for Azure OpenAI and is the name of the deployment resource for the\\nAzure OpenAI service.\\n\"},\"openai_organization\":{\"$ref\":\"#/$defs/string\",\"description\":\"This is an optional field to specify the organization in OpenAI or Azure OpenAI.\\n\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.PaLmConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"palm_api_key\":{\"$ref\":\"#/$defs/string\",\"description\":\"The Databricks secret key reference for a PaLM API key. If you prefer to paste your API key directly, see `palm_api_key_plaintext`. You must provide an API key using one of the following fields: `palm_api_key` or `palm_api_key_plaintext`.\"},\"palm_api_key_plaintext\":{\"$ref\":\"#/$defs/string\",\"description\":\"The PaLM API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `palm_api_key`. You must provide an API key using one of the following fields: `palm_api_key` or `palm_api_key_plaintext`.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.RateLimit\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"calls\":{\"$ref\":\"#/$defs/int\",\"description\":\"Used to specify how many calls are allowed for a key within the renewal_period.\"},\"key\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey\",\"description\":\"Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.\"},\"renewal_period\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod\",\"description\":\"Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported.\"}},\"additionalProperties\":false,\"required\":[\"calls\",\"renewal_period\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.RateLimitKey\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.\",\"enum\":[\"user\",\"endpoint\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.RateLimitRenewalPeriod\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported.\",\"enum\":[\"minute\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.Route\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"served_model_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the served model this route configures traffic for.\"},\"traffic_percentage\":{\"$ref\":\"#/$defs/int\",\"description\":\"The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive.\"}},\"additionalProperties\":false,\"required\":[\"served_model_name\",\"traffic_percentage\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedEntityInput\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"entity_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC),\\nor a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of\\n__catalog_name__.__schema_name__.__model_name__.\\n\"},\"entity_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"The version of the model in Databricks Model Registry to be served or empty if the entity is a FEATURE_SPEC.\"},\"environment_vars\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity.\\nNote: this is an experimental feature and subject to change. \\nExample entity environment variables that refer to Databricks secrets: `{\\\"OPENAI_API_KEY\\\": \\\"{{secrets/my_scope/my_key}}\\\", \\\"DATABRICKS_TOKEN\\\": \\\"{{secrets/my_scope2/my_key2}}\\\"}`\"},\"external_model\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModel\",\"description\":\"The external model to be served. NOTE: Only one of external_model and (entity_name, entity_version, workload_size, workload_type, and scale_to_zero_enabled)\\ncan be specified with the latter set being used for custom model serving for a Databricks registered model. For an existing endpoint with external_model,\\nit cannot be updated to an endpoint without external_model. If the endpoint is created without external_model, users cannot update it to add external_model later.\\nThe task type of all external models within an endpoint must be the same.\\n\"},\"instance_profile_arn\":{\"$ref\":\"#/$defs/string\",\"description\":\"ARN of the instance profile that the served entity uses to access AWS resources.\"},\"max_provisioned_throughput\":{\"$ref\":\"#/$defs/int\",\"description\":\"The maximum tokens per second that the endpoint can scale up to.\"},\"min_provisioned_throughput\":{\"$ref\":\"#/$defs/int\",\"description\":\"The minimum tokens per second that the endpoint can scale down to.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores.\\nIf not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other\\nentities, it defaults to <entity-name>-<entity-version>.\\n\"},\"scale_to_zero_enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether the compute resources for the served entity should scale down to zero.\"},\"workload_size\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between.\\nA single unit of provisioned concurrency can process one request at a time.\\nValid workload sizes are \\\"Small\\\" (4 - 4 provisioned concurrency), \\\"Medium\\\" (8 - 16 provisioned concurrency), and \\\"Large\\\" (16 - 64 provisioned concurrency).\\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0.\\n\"},\"workload_type\":{\"$ref\":\"#/$defs/string\",\"description\":\"The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\\n\\\"CPU\\\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\\n\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedModelInput\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"environment_vars\":{\"$ref\":\"#/$defs/map/string\",\"description\":\"An object containing a set of optional, user-specified environment variable key-value pairs used for serving this model.\\nNote: this is an experimental feature and subject to change. \\nExample model environment variables that refer to Databricks secrets: `{\\\"OPENAI_API_KEY\\\": \\\"{{secrets/my_scope/my_key}}\\\", \\\"DATABRICKS_TOKEN\\\": \\\"{{secrets/my_scope2/my_key2}}\\\"}`\"},\"instance_profile_arn\":{\"$ref\":\"#/$defs/string\",\"description\":\"ARN of the instance profile that the served model will use to access AWS resources.\"},\"max_provisioned_throughput\":{\"$ref\":\"#/$defs/int\",\"description\":\"The maximum tokens per second that the endpoint can scale up to.\"},\"min_provisioned_throughput\":{\"$ref\":\"#/$defs/int\",\"description\":\"The minimum tokens per second that the endpoint can scale down to.\"},\"model_name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of the model in Databricks Model Registry to be served or if the model resides in Unity Catalog, the full name of model,\\nin the form of __catalog_name__.__schema_name__.__model_name__.\\n\"},\"model_version\":{\"$ref\":\"#/$defs/string\",\"description\":\"The version of the model in Databricks Model Registry or Unity Catalog to be served.\"},\"name\":{\"$ref\":\"#/$defs/string\",\"description\":\"The name of a served model. It must be unique across an endpoint. If not specified, this field will default to <model-name>-<model-version>.\\nA served model name can consist of alphanumeric characters, dashes, and underscores.\\n\"},\"scale_to_zero_enabled\":{\"$ref\":\"#/$defs/bool\",\"description\":\"Whether the compute resources for the served model should scale down to zero.\"},\"workload_size\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadSize\",\"description\":\"The workload size of the served model. The workload size corresponds to a range of provisioned concurrency that the compute will autoscale between.\\nA single unit of provisioned concurrency can process one request at a time.\\nValid workload sizes are \\\"Small\\\" (4 - 4 provisioned concurrency), \\\"Medium\\\" (8 - 16 provisioned concurrency), and \\\"Large\\\" (16 - 64 provisioned concurrency).\\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size will be 0.\\n\"},\"workload_type\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadType\",\"description\":\"The workload type of the served model. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\\n\\\"CPU\\\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\\n\"}},\"additionalProperties\":false,\"required\":[\"model_name\",\"model_version\",\"scale_to_zero_enabled\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedModelInputWorkloadSize\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The workload size of the served model. The workload size corresponds to a range of provisioned concurrency that the compute will autoscale between.\\nA single unit of provisioned concurrency can process one request at a time.\\nValid workload sizes are \\\"Small\\\" (4 - 4 provisioned concurrency), \\\"Medium\\\" (8 - 16 provisioned concurrency), and \\\"Large\\\" (16 - 64 provisioned concurrency).\\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size will be 0.\\n\",\"enum\":[\"Small\",\"Medium\",\"Large\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedModelInputWorkloadType\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"The workload type of the served model. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\\n\\\"CPU\\\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\\n\",\"enum\":[\"CPU\",\"GPU_SMALL\",\"GPU_MEDIUM\",\"GPU_LARGE\",\"MULTIGPU_MEDIUM\"]},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.TrafficConfig\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"routes\":{\"$ref\":\"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.Route\",\"description\":\"The list of routes that define traffic to each served entity.\"}},\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}}}}},\"int\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(resources(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(bundle(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(workspace(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(artifacts(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"int64\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(resources(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(bundle(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(workspace(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(artifacts(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"interface\":{},\"map\":{\"github.com\":{\"databricks\":{\"cli\":{\"bundle\":{\"config\":{\"resources.App\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.App\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Cluster\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Cluster\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Dashboard\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Dashboard\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Job\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Job\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.MlflowExperiment\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowExperiment\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.MlflowModel\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowModel\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.ModelServingEndpoint\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Pipeline\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Pipeline\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.QualityMonitor\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.QualityMonitor\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.RegisteredModel\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.RegisteredModel\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Schema\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Schema\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Volume\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Volume\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"variable.TargetVariable\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.TargetVariable\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"variable.Variable\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/variable.Variable\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}},\"config.Artifact\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Artifact\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Command\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Command\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"config.Target\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Target\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}}}}},\"interface\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/interface\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"string\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/string\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}},\"slice\":{\"github.com\":{\"databricks\":{\"cli\":{\"bundle\":{\"config\":{\"resources.Grant\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Grant\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"resources.Permission\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config/resources.Permission\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}},\"config.ArtifactFile\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.ArtifactFile\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}}},\"databricks-sdk-go\":{\"service\":{\"apps.AppResource\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResource\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"catalog.MonitorMetric\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.InitScriptInfo\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"compute.Library\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Library\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobCluster\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobEnvironment\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobParameterDefinition\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.JobsHealthRule\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.SqlTaskSubscription\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Task\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.TaskDependency\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"jobs.Webhook\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Webhook\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ExperimentTag\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelTag\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelTag\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelVersion\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersion\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"ml.ModelVersionTag\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionTag\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.DayOfWeek\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.IngestionConfig\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.Notifications\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineCluster\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"pipelines.PipelineLibrary\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.AiGatewayRateLimit\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.EndpointTag\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.RateLimit\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimit\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.Route\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Route\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedEntityInput\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]},\"serving.ServedModelInput\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}}}}},\"string\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/string\"}},{\"type\":\"string\",\"pattern\":\"\\\\$\\\\{(var(\\\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\\\[[0-9]+\\\\])*)+)\\\\}\"}]}},\"string\":{\"type\":\"string\"}},\"type\":\"object\",\"properties\":{\"artifacts\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config.Artifact\",\"description\":\"Defines the attributes to build an artifact\"},\"bundle\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Bundle\",\"description\":\"The attributes of the bundle.\",\"markdownDescription\":\"The attributes of the bundle. See [bundle](https://docs.databricks.com/dev-tools/bundles/settings.html#bundle)\"},\"experimental\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Experimental\",\"description\":\"Defines attributes for experimental features.\"},\"include\":{\"$ref\":\"#/$defs/slice/string\",\"description\":\"Specifies a list of path globs that contain configuration files to include within the bundle.\",\"markdownDescription\":\"Specifies a list of path globs that contain configuration files to include within the bundle. See [include](https://docs.databricks.com/dev-tools/bundles/settings.html#include)\"},\"permissions\":{\"$ref\":\"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission\",\"description\":\"Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle\",\"markdownDescription\":\"Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [permissions](https://docs.databricks.com/dev-tools/bundles/settings.html#permissions) and [link](https://docs.databricks.com/dev-tools/bundles/permissions.html).\"},\"presets\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Presets\",\"description\":\"Defines bundle deployment presets.\",\"markdownDescription\":\"Defines bundle deployment presets. See [presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#presets).\"},\"resources\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Resources\",\"description\":\"Specifies information about the Databricks resources used by the bundle\",\"markdownDescription\":\"Specifies information about the Databricks resources used by the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/resources.html).\"},\"run_as\":{\"$ref\":\"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs\",\"description\":\"The identity to use to run the bundle.\"},\"sync\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Sync\",\"description\":\"The files and file paths to include or exclude in the bundle.\",\"markdownDescription\":\"The files and file paths to include or exclude in the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/)\"},\"targets\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config.Target\",\"description\":\"Defines deployment targets for the bundle.\"},\"variables\":{\"$ref\":\"#/$defs/map/github.com/databricks/cli/bundle/config/variable.Variable\",\"description\":\"A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.\"},\"workspace\":{\"$ref\":\"#/$defs/github.com/databricks/cli/bundle/config.Workspace\",\"description\":\"Defines the Databricks workspace for the bundle.\"}},\"additionalProperties\":{}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"databricks-asset-bundles\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/databricks-asset-bundles.json","$defs":{"bool":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"\\$\\{(resources(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(bundle(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(workspace(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(artifacts(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"float64":{"oneOf":[{"type":"number"},{"type":"string","pattern":"\\$\\{(resources(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(bundle(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(workspace(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(artifacts(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"github.com":{"databricks":{"cli":{"bundle":{"config":{"resources.App":{"oneOf":[{"type":"object","properties":{"active_deployment":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeployment"},"app_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ApplicationStatus"},"compute_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeStatus"},"config":{"$ref":"#/$defs/map/interface"},"create_time":{"$ref":"#/$defs/string"},"creator":{"$ref":"#/$defs/string"},"default_source_code_path":{"$ref":"#/$defs/string"},"description":{"$ref":"#/$defs/string"},"name":{"$ref":"#/$defs/string"},"pending_deployment":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeployment"},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"resources":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource"},"service_principal_client_id":{"$ref":"#/$defs/string"},"service_principal_id":{"$ref":"#/$defs/int64"},"service_principal_name":{"$ref":"#/$defs/string"},"source_code_path":{"$ref":"#/$defs/string"},"update_time":{"$ref":"#/$defs/string"},"updater":{"$ref":"#/$defs/string"},"url":{"$ref":"#/$defs/string"}},"additionalProperties":false,"required":["source_code_path","name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Cluster":{"oneOf":[{"type":"object","properties":{"apply_policy_default_values":{"$ref":"#/$defs/bool","description":"When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied."},"autoscale":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale","description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later."},"autotermination_minutes":{"$ref":"#/$defs/int","description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."},"aws_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes","description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used."},"azure_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes","description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used."},"cluster_log_conf":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf","description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`."},"cluster_name":{"$ref":"#/$defs/string","description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"},"custom_tags":{"$ref":"#/$defs/map/string","description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags"},"data_security_mode":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode"},"docker_image":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage"},"driver_instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."},"driver_node_type_id":{"$ref":"#/$defs/string","description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"},"enable_elastic_disk":{"$ref":"#/$defs/bool","description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."},"enable_local_disk_encryption":{"$ref":"#/$defs/bool","description":"Whether to enable LUKS on cluster VMs' local disks"},"gcp_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes","description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used."},"init_scripts":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo","description":"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`."},"instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool to which the cluster belongs."},"is_single_node":{"$ref":"#/$defs/bool","description":"This field can only be used with `kind`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`\n"},"kind":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind"},"node_type_id":{"$ref":"#/$defs/string","description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"},"num_workers":{"$ref":"#/$defs/int","description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"policy_id":{"$ref":"#/$defs/string","description":"The ID of the cluster policy used to create the cluster if applicable."},"runtime_engine":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine"},"single_user_name":{"$ref":"#/$defs/string","description":"Single user name if data_security_mode is `SINGLE_USER`"},"spark_conf":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n"},"spark_env_vars":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`"},"spark_version":{"$ref":"#/$defs/string","description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"},"ssh_public_keys":{"$ref":"#/$defs/slice/string","description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified."},"use_ml_runtime":{"$ref":"#/$defs/bool","description":"This field can only be used with `kind`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.\n"},"workload_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Dashboard":{"oneOf":[{"type":"object","properties":{"create_time":{"$ref":"#/$defs/string","description":"The timestamp of when the dashboard was created."},"dashboard_id":{"$ref":"#/$defs/string","description":"UUID identifying the dashboard."},"display_name":{"$ref":"#/$defs/string","description":"The display name of the dashboard."},"embed_credentials":{"$ref":"#/$defs/bool"},"etag":{"$ref":"#/$defs/string","description":"The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses."},"file_path":{"$ref":"#/$defs/string"},"lifecycle_state":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/dashboards.LifecycleState","description":"The state of the dashboard resource. Used for tracking trashed status."},"parent_path":{"$ref":"#/$defs/string","description":"The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses."},"path":{"$ref":"#/$defs/string","description":"The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"serialized_dashboard":{"$ref":"#/$defs/interface","description":"The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components."},"update_time":{"$ref":"#/$defs/string","description":"The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses."},"warehouse_id":{"$ref":"#/$defs/string","description":"The warehouse ID used to run the dashboard."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Grant":{"oneOf":[{"type":"object","properties":{"principal":{"$ref":"#/$defs/string","description":"The name of the principal that will be granted privileges"},"privileges":{"$ref":"#/$defs/slice/string","description":"The privileges to grant to the specified entity"}},"additionalProperties":false,"required":["privileges","principal"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Job":{"oneOf":[{"type":"object","properties":{"budget_policy_id":{"$ref":"#/$defs/string","description":"The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload."},"continuous":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Continuous","description":"An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used."},"description":{"$ref":"#/$defs/string","description":"An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding."},"email_notifications":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications","description":"An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted."},"environments":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment","description":"A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nAn environment is required to be present for serverless tasks.\nFor serverless notebook tasks, the environment is accessible in the notebook environment panel.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings."},"git_source":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitSource","description":"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job."},"health":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules"},"job_clusters":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster","description":"A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.\nIf more than 100 job clusters are available, you can paginate through them using :method:jobs/get."},"max_concurrent_runs":{"$ref":"#/$defs/int","description":"An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job\u2019s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won\u2019t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped."},"name":{"$ref":"#/$defs/string","description":"An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding."},"notification_settings":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobNotificationSettings","description":"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job."},"parameters":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition","description":"Job-level parameter definitions"},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"queue":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings","description":"The queue settings of the job."},"run_as":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs"},"schedule":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronSchedule","description":"An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking \u201cRun Now\u201d in the Jobs UI or sending an API request to `runNow`."},"tags":{"$ref":"#/$defs/map/string","description":"A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job."},"tasks":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Task","description":"A list of task specifications to be executed by this job.\nIf more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available."},"timeout_seconds":{"$ref":"#/$defs/int","description":"An optional timeout applied to each run of this job. A value of `0` means no timeout."},"trigger":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings","description":"A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking \u201cRun Now\u201d in the Jobs UI or sending an API request to `runNow`."},"webhook_notifications":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications","description":"A collection of system notification IDs to notify when runs of this job begin or complete."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.MlflowExperiment":{"oneOf":[{"type":"object","properties":{"artifact_location":{"$ref":"#/$defs/string","description":"Location where artifacts for the experiment are stored."},"creation_time":{"$ref":"#/$defs/int64","description":"Creation time"},"experiment_id":{"$ref":"#/$defs/string","description":"Unique identifier for the experiment."},"last_update_time":{"$ref":"#/$defs/int64","description":"Last update time"},"lifecycle_stage":{"$ref":"#/$defs/string","description":"Current life cycle stage of the experiment: \"active\" or \"deleted\".\nDeleted experiments are not returned by APIs."},"name":{"$ref":"#/$defs/string","description":"Human readable name that identifies the experiment."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"tags":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag","description":"Tags: Additional metadata key-value pairs."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.MlflowModel":{"oneOf":[{"type":"object","properties":{"creation_timestamp":{"$ref":"#/$defs/int64","description":"Timestamp recorded when this `registered_model` was created."},"description":{"$ref":"#/$defs/string","description":"Description of this `registered_model`."},"last_updated_timestamp":{"$ref":"#/$defs/int64","description":"Timestamp recorded when metadata for this `registered_model` was last updated."},"latest_versions":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelVersion","description":"Collection of latest model versions for each stage.\nOnly contains models with current `READY` status."},"name":{"$ref":"#/$defs/string","description":"Unique name for the model."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"tags":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag","description":"Tags: Additional metadata key-value pairs for this `registered_model`."},"user_id":{"$ref":"#/$defs/string","description":"User that created this `registered_model`"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.ModelServingEndpoint":{"oneOf":[{"type":"object","properties":{"ai_gateway":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig","description":"The AI Gateway configuration for the serving endpoint. NOTE: only external model endpoints are supported as of now."},"config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointCoreConfigInput","description":"The core config of the serving endpoint."},"name":{"$ref":"#/$defs/string","description":"The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.\n"},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"rate_limits":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.RateLimit","description":"Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits."},"route_optimized":{"$ref":"#/$defs/bool","description":"Enable route optimization for the serving endpoint."},"tags":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag","description":"Tags to be attached to the serving endpoint and automatically propagated to billing logs."}},"additionalProperties":false,"required":["config","name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Permission":{"oneOf":[{"type":"object","properties":{"group_name":{"$ref":"#/$defs/string","description":"The name of the group that has the permission set in level."},"level":{"$ref":"#/$defs/string","description":"The allowed permission for user, group, service principal defined for this permission."},"service_principal_name":{"$ref":"#/$defs/string","description":"The name of the service principal that has the permission set in level."},"user_name":{"$ref":"#/$defs/string","description":"The name of the user that has the permission set in level."}},"additionalProperties":false,"required":["level"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Pipeline":{"oneOf":[{"type":"object","properties":{"budget_policy_id":{"$ref":"#/$defs/string","description":"Budget policy of this pipeline."},"catalog":{"$ref":"#/$defs/string","description":"A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog."},"channel":{"$ref":"#/$defs/string","description":"DLT Release Channel that specifies which version to use."},"clusters":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster","description":"Cluster settings for this pipeline deployment."},"configuration":{"$ref":"#/$defs/map/string","description":"String-String configuration for this pipeline execution."},"continuous":{"$ref":"#/$defs/bool","description":"Whether the pipeline is continuous or triggered. This replaces `trigger`."},"deployment":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment","description":"Deployment type of this pipeline."},"development":{"$ref":"#/$defs/bool","description":"Whether the pipeline is in Development mode. Defaults to false."},"edition":{"$ref":"#/$defs/string","description":"Pipeline product edition."},"filters":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters","description":"Filters on which Pipeline packages to include in the deployed graph."},"gateway_definition":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition","description":"The definition of a gateway pipeline to support change data capture."},"id":{"$ref":"#/$defs/string","description":"Unique identifier for this pipeline."},"ingestion_definition":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition","description":"The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'target' or 'catalog' settings."},"libraries":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary","description":"Libraries or code needed by this deployment."},"name":{"$ref":"#/$defs/string","description":"Friendly identifier for this pipeline."},"notifications":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications","description":"List of notification settings for this pipeline."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"},"photon":{"$ref":"#/$defs/bool","description":"Whether Photon is enabled for this pipeline."},"restart_window":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow","description":"Restart window of this pipeline."},"schema":{"$ref":"#/$defs/string","description":"The default schema (database) where tables are read from or published to. The presence of this field implies that the pipeline is in direct publishing mode."},"serverless":{"$ref":"#/$defs/bool","description":"Whether serverless compute is enabled for this pipeline."},"storage":{"$ref":"#/$defs/string","description":"DBFS root directory for storing checkpoints and tables."},"target":{"$ref":"#/$defs/string","description":"Target schema (database) to add tables in this pipeline to. If not specified, no data is published to the Hive metastore or Unity Catalog. To publish to Unity Catalog, also specify `catalog`."},"trigger":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTrigger","description":"Which pipeline trigger to use. Deprecated: Use `continuous` instead."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.QualityMonitor":{"oneOf":[{"type":"object","properties":{"assets_dir":{"$ref":"#/$defs/string","description":"The directory to store monitoring assets (e.g. dashboard, metric tables)."},"baseline_table_name":{"$ref":"#/$defs/string","description":"Name of the baseline table from which drift metrics are computed from.\nColumns in the monitored table should also be present in the baseline table.\n"},"custom_metrics":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric","description":"Custom metrics to compute on the monitored table. These can be aggregate metrics, derived\nmetrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time\nwindows).\n"},"data_classification_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig","description":"The data classification config for the monitor."},"inference_log":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog","description":"Configuration for monitoring inference logs."},"notifications":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications","description":"The notification settings for the monitor."},"output_schema_name":{"$ref":"#/$defs/string","description":"Schema where output metric tables are created."},"schedule":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedule","description":"The schedule for automatically updating and refreshing metric tables."},"skip_builtin_dashboard":{"$ref":"#/$defs/bool","description":"Whether to skip creating a default dashboard summarizing data quality metrics."},"slicing_exprs":{"$ref":"#/$defs/slice/string","description":"List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.\n"},"snapshot":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot","description":"Configuration for monitoring snapshot tables."},"table_name":{"$ref":"#/$defs/string"},"time_series":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries","description":"Configuration for monitoring time series tables."},"warehouse_id":{"$ref":"#/$defs/string","description":"Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.\n"}},"additionalProperties":false,"required":["table_name","assets_dir","output_schema_name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.RegisteredModel":{"oneOf":[{"type":"object","properties":{"catalog_name":{"$ref":"#/$defs/string","description":"The name of the catalog where the schema and the registered model reside"},"comment":{"$ref":"#/$defs/string","description":"The comment attached to the registered model"},"grants":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant"},"name":{"$ref":"#/$defs/string","description":"The name of the registered model"},"schema_name":{"$ref":"#/$defs/string","description":"The name of the schema where the registered model resides"},"storage_location":{"$ref":"#/$defs/string","description":"The storage location on the cloud under which model version data files are stored"}},"additionalProperties":false,"required":["catalog_name","name","schema_name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Schema":{"oneOf":[{"type":"object","properties":{"catalog_name":{"$ref":"#/$defs/string","description":"Name of parent catalog."},"comment":{"$ref":"#/$defs/string","description":"User-provided free-form text description."},"grants":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant"},"name":{"$ref":"#/$defs/string","description":"Name of schema, relative to parent catalog."},"properties":{"$ref":"#/$defs/map/string"},"storage_root":{"$ref":"#/$defs/string","description":"Storage root URL for managed tables within schema."}},"additionalProperties":false,"required":["catalog_name","name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Volume":{"oneOf":[{"type":"object","properties":{"catalog_name":{"$ref":"#/$defs/string","description":"The name of the catalog where the schema and the volume are"},"comment":{"$ref":"#/$defs/string","description":"The comment attached to the volume"},"grants":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Grant"},"name":{"$ref":"#/$defs/string","description":"The name of the volume"},"schema_name":{"$ref":"#/$defs/string","description":"The name of the schema where the volume is"},"storage_location":{"$ref":"#/$defs/string","description":"The storage location on the cloud"},"volume_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType"}},"additionalProperties":false,"required":["catalog_name","name","schema_name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"variable.Lookup":{"oneOf":[{"type":"object","properties":{"alert":{"$ref":"#/$defs/string"},"cluster":{"$ref":"#/$defs/string"},"cluster_policy":{"$ref":"#/$defs/string"},"dashboard":{"$ref":"#/$defs/string"},"instance_pool":{"$ref":"#/$defs/string"},"job":{"$ref":"#/$defs/string"},"metastore":{"$ref":"#/$defs/string"},"notification_destination":{"$ref":"#/$defs/string"},"pipeline":{"$ref":"#/$defs/string"},"query":{"$ref":"#/$defs/string"},"service_principal":{"$ref":"#/$defs/string"},"warehouse":{"$ref":"#/$defs/string"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"variable.TargetVariable":{"anyOf":[{"type":"object","properties":{"default":{"$ref":"#/$defs/interface"},"description":{"$ref":"#/$defs/string","description":"The description of the variable."},"lookup":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup","description":"The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID."},"type":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType","description":"The type of the variable."}},"additionalProperties":false},{}]},"variable.Variable":{"type":"object","properties":{"default":{"$ref":"#/$defs/interface"},"description":{"$ref":"#/$defs/string","description":"The description of the variable"},"lookup":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup","description":"The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.","markdownDescription":"The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID.\""},"type":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType","description":"The type of the variable."}},"additionalProperties":false},"variable.VariableType":{"type":"string"}},"config.Artifact":{"oneOf":[{"type":"object","properties":{"build":{"$ref":"#/$defs/string","description":"An optional set of non-default build commands that you want to run locally before deployment.\n\nFor Python wheel builds, the Databricks CLI assumes that it can find a local install of the Python wheel package to run builds, and it runs the command python setup.py bdist_wheel by default during each bundle deployment.\n\nTo specify multiple build commands, separate each command with double-ampersand (&&) characters."},"executable":{"$ref":"#/$defs/github.com/databricks/cli/libs/exec.ExecutableType","description":"The executable type."},"files":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile","description":"The source files for the artifact.","markdownDescription":"The source files for the artifact, defined as an [artifact_file](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact_file)."},"path":{"$ref":"#/$defs/string","description":"The location where the built artifact will be saved."},"type":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.ArtifactType","description":"The type of the artifact.","markdownDescription":"The type of the artifact. Valid values are `wheel` or `jar`"}},"additionalProperties":false,"required":["type"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.ArtifactFile":{"oneOf":[{"type":"object","properties":{"source":{"$ref":"#/$defs/string","description":"The path of the files used to build the artifact."}},"additionalProperties":false,"required":["source"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.ArtifactType":{"type":"string"},"config.Bundle":{"oneOf":[{"type":"object","properties":{"cluster_id":{"$ref":"#/$defs/string","description":"The ID of a cluster to use to run the bundle.","markdownDescription":"The ID of a cluster to use to run the bundle. See [cluster_id](https://docs.databricks.com/dev-tools/bundles/settings.html#cluster_id)."},"compute_id":{"$ref":"#/$defs/string"},"databricks_cli_version":{"$ref":"#/$defs/string","description":"The Databricks CLI version to use for the bundle.","markdownDescription":"The Databricks CLI version to use for the bundle. See [databricks_cli_version](https://docs.databricks.com/dev-tools/bundles/settings.html#databricks_cli_version)."},"deployment":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Deployment","description":"The definition of the bundle deployment","markdownDescription":"The definition of the bundle deployment. For supported attributes, see [deployment](https://docs.databricks.com/dev-tools/bundles/reference.html#deployment) and [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html)."},"git":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Git","description":"The Git version control details that are associated with your bundle.","markdownDescription":"The Git version control details that are associated with your bundle. For supported attributes, see [git](https://docs.databricks.com/dev-tools/bundles/reference.html#git) and [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git)."},"name":{"$ref":"#/$defs/string","description":"The name of the bundle."},"uuid":{"$ref":"#/$defs/string","description":"Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the `databricks bundle init` command)."}},"additionalProperties":false,"required":["name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Command":{"type":"string"},"config.Deployment":{"oneOf":[{"type":"object","properties":{"fail_on_active_runs":{"$ref":"#/$defs/bool","description":"Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted."},"lock":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Lock","description":"The deployment lock attributes.","markdownDescription":"The deployment lock attributes. See [lock](https://docs.databricks.com/dev-tools/bundles/reference.html#lock)."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Experimental":{"oneOf":[{"type":"object","properties":{"pydabs":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.PyDABs","description":"The PyDABs configuration."},"python":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Python","description":"Configures loading of Python code defined with 'databricks-bundles' package."},"python_wheel_wrapper":{"$ref":"#/$defs/bool","description":"Whether to use a Python wheel wrapper"},"scripts":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config.Command","description":"The commands to run"},"use_legacy_run_as":{"$ref":"#/$defs/bool","description":"Whether to use the legacy run_as behavior"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Git":{"oneOf":[{"type":"object","properties":{"branch":{"$ref":"#/$defs/string","description":"The Git branch name.","markdownDescription":"The Git branch name. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git)."},"origin_url":{"$ref":"#/$defs/string","description":"The origin URL of the repository.","markdownDescription":"The origin URL of the repository. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git)."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Lock":{"oneOf":[{"type":"object","properties":{"enabled":{"$ref":"#/$defs/bool","description":"Whether this lock is enabled."},"force":{"$ref":"#/$defs/bool","description":"Whether to force this lock if it is enabled."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Mode":{"type":"string"},"config.Presets":{"oneOf":[{"type":"object","properties":{"jobs_max_concurrent_runs":{"$ref":"#/$defs/int","description":"The maximum concurrent runs for a job."},"name_prefix":{"$ref":"#/$defs/string","description":"The prefix for job runs of the bundle."},"pipelines_development":{"$ref":"#/$defs/bool","description":"Whether pipeline deployments should be locked in development mode."},"source_linked_deployment":{"$ref":"#/$defs/bool","description":"Whether to link the deployment to the bundle source."},"tags":{"$ref":"#/$defs/map/string","description":"The tags for the bundle deployment."},"trigger_pause_status":{"$ref":"#/$defs/string","description":"A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.PyDABs":{"oneOf":[{"type":"object","properties":{"enabled":{"$ref":"#/$defs/bool","description":"Whether or not PyDABs (Private Preview) is enabled"},"import":{"$ref":"#/$defs/slice/string","description":"The PyDABs project to import to discover resources, resource generator and mutators"},"venv_path":{"$ref":"#/$defs/string","description":"The Python virtual environment path"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Python":{"oneOf":[{"type":"object","properties":{"mutators":{"$ref":"#/$defs/slice/string","description":"Mutators contains a list of fully qualified function paths to mutator functions.\n\nExample: [\"my_project.mutators:add_default_cluster\"]"},"resources":{"$ref":"#/$defs/slice/string","description":"Resources contains a list of fully qualified function paths to load resources\ndefined in Python code.\n\nExample: [\"my_project.resources:load_resources\"]"},"venv_path":{"$ref":"#/$defs/string","description":"VEnvPath is path to the virtual environment.\n\nIf enabled, Python code will execute within this environment. If disabled,\nit defaults to using the Python interpreter available in the current shell."}},"additionalProperties":false,"required":["resources","mutators"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Resources":{"oneOf":[{"type":"object","properties":{"apps":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.App"},"clusters":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster","description":"The cluster definitions for the bundle.","markdownDescription":"The cluster definitions for the bundle. See [cluster](https://docs.databricks.com/dev-tools/bundles/resources.html#cluster)"},"dashboards":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard","description":"The dashboard definitions for the bundle.","markdownDescription":"The dashboard definitions for the bundle. See [dashboard](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboard)"},"experiments":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment","description":"The experiment definitions for the bundle.","markdownDescription":"The experiment definitions for the bundle. See [experiment](https://docs.databricks.com/dev-tools/bundles/resources.html#experiment)"},"jobs":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job","description":"The job definitions for the bundle.","markdownDescription":"The job definitions for the bundle. See [job](https://docs.databricks.com/dev-tools/bundles/resources.html#job)"},"model_serving_endpoints":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint","description":"The model serving endpoint definitions for the bundle.","markdownDescription":"The model serving endpoint definitions for the bundle. See [model_serving_endpoint](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoint)"},"models":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel","description":"The model definitions for the bundle.","markdownDescription":"The model definitions for the bundle. See [model](https://docs.databricks.com/dev-tools/bundles/resources.html#model)"},"pipelines":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline","description":"The pipeline definitions for the bundle.","markdownDescription":"The pipeline definitions for the bundle. See [pipeline](https://docs.databricks.com/dev-tools/bundles/resources.html#pipeline)"},"quality_monitors":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor","description":"The quality monitor definitions for the bundle.","markdownDescription":"The quality monitor definitions for the bundle. See [quality_monitor](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitor)"},"registered_models":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel","description":"The registered model definitions for the bundle.","markdownDescription":"The registered model definitions for the bundle. See [registered_model](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_model)"},"schemas":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema","description":"The schema definitions for the bundle.","markdownDescription":"The schema definitions for the bundle. See [schema](https://docs.databricks.com/dev-tools/bundles/resources.html#schema)"},"volumes":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Sync":{"oneOf":[{"type":"object","properties":{"exclude":{"$ref":"#/$defs/slice/string","description":"A list of files or folders to exclude from the bundle."},"include":{"$ref":"#/$defs/slice/string","description":"A list of files or folders to include in the bundle."},"paths":{"$ref":"#/$defs/slice/string","description":"The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Target":{"oneOf":[{"type":"object","properties":{"artifacts":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config.Artifact","description":"The artifacts to include in the target deployment.","markdownDescription":"The artifacts to include in the target deployment. See [artifact](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact)"},"bundle":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Bundle","description":"The name of the bundle when deploying to this target."},"cluster_id":{"$ref":"#/$defs/string","description":"The ID of the cluster to use for this target."},"compute_id":{"$ref":"#/$defs/string","description":"Deprecated. The ID of the compute to use for this target."},"default":{"$ref":"#/$defs/bool","description":"Whether this target is the default target."},"git":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Git","description":"The Git version control settings for the target.","markdownDescription":"The Git version control settings for the target. See [git](https://docs.databricks.com/dev-tools/bundles/reference.html#git)."},"mode":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Mode","description":"The deployment mode for the target.","markdownDescription":"The deployment mode for the target. Valid values are `development` or `production`. See [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html)."},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission","description":"The permissions for deploying and running the bundle in the target.","markdownDescription":"The permissions for deploying and running the bundle in the target. See [permission](https://docs.databricks.com/dev-tools/bundles/reference.html#permission)."},"presets":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Presets","description":"The deployment presets for the target.","markdownDescription":"The deployment presets for the target. See [preset](https://docs.databricks.com/dev-tools/bundles/reference.html#preset)."},"resources":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Resources","description":"The resource definitions for the target.","markdownDescription":"The resource definitions for the target. See [resources](https://docs.databricks.com/dev-tools/bundles/reference.html#resources)."},"run_as":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs","description":"The identity to use to run the bundle.","markdownDescription":"The identity to use to run the bundle. See [job_run_as](https://docs.databricks.com/dev-tools/bundles/reference.html#job_run_as) and [link](https://docs.databricks.com/dev-tools/bundles/run_as.html)."},"sync":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Sync","description":"The local paths to sync to the target workspace when a bundle is run or deployed.","markdownDescription":"The local paths to sync to the target workspace when a bundle is run or deployed. See [sync](https://docs.databricks.com/dev-tools/bundles/reference.html#sync)."},"variables":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable","description":"The custom variable definitions for the target.","markdownDescription":"The custom variable definitions for the target. See [variables](https://docs.databricks.com/dev-tools/bundles/settings.html#variables) and [link](https://docs.databricks.com/dev-tools/bundles/variables.html)."},"workspace":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Workspace","description":"The Databricks workspace for the target.","markdownDescription":"The Databricks workspace for the target. [workspace](https://docs.databricks.com/dev-tools/bundles/reference.html#workspace)"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Workspace":{"oneOf":[{"type":"object","properties":{"artifact_path":{"$ref":"#/$defs/string","description":"The artifact path to use within the workspace for both deployments and workflow runs"},"auth_type":{"$ref":"#/$defs/string","description":"The authentication type."},"azure_client_id":{"$ref":"#/$defs/string","description":"The Azure client ID"},"azure_environment":{"$ref":"#/$defs/string","description":"The Azure environment"},"azure_login_app_id":{"$ref":"#/$defs/string","description":"The Azure login app ID"},"azure_tenant_id":{"$ref":"#/$defs/string","description":"The Azure tenant ID"},"azure_use_msi":{"$ref":"#/$defs/bool","description":"Whether to use MSI for Azure"},"azure_workspace_resource_id":{"$ref":"#/$defs/string","description":"The Azure workspace resource ID"},"client_id":{"$ref":"#/$defs/string","description":"The client ID for the workspace"},"file_path":{"$ref":"#/$defs/string","description":"The file path to use within the workspace for both deployments and workflow runs"},"google_service_account":{"$ref":"#/$defs/string","description":"The Google service account name"},"host":{"$ref":"#/$defs/string","description":"The Databricks workspace host URL"},"profile":{"$ref":"#/$defs/string","description":"The Databricks workspace profile name"},"resource_path":{"$ref":"#/$defs/string","description":"The workspace resource path"},"root_path":{"$ref":"#/$defs/string","description":"The Databricks workspace root path"},"state_path":{"$ref":"#/$defs/string","description":"The workspace state path"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}},"libs":{"exec.ExecutableType":{"type":"string"}}},"databricks-sdk-go":{"service":{"apps.AppDeployment":{"oneOf":[{"type":"object","properties":{"create_time":{"$ref":"#/$defs/string"},"creator":{"$ref":"#/$defs/string"},"deployment_artifacts":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentArtifacts"},"deployment_id":{"$ref":"#/$defs/string"},"mode":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode"},"source_code_path":{"$ref":"#/$defs/string"},"status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentStatus"},"update_time":{"$ref":"#/$defs/string"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppDeploymentArtifacts":{"oneOf":[{"type":"object","properties":{"source_code_path":{"$ref":"#/$defs/string"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppDeploymentMode":{"oneOf":[{"type":"string","enum":["SNAPSHOT","AUTO_SYNC"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppDeploymentState":{"oneOf":[{"type":"string","enum":["SUCCEEDED","FAILED","IN_PROGRESS","CANCELLED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppDeploymentStatus":{"oneOf":[{"type":"object","properties":{"message":{"$ref":"#/$defs/string"},"state":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentState"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResource":{"oneOf":[{"type":"object","properties":{"description":{"$ref":"#/$defs/string"},"job":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob"},"name":{"$ref":"#/$defs/string"},"secret":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret"},"serving_endpoint":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint"},"sql_warehouse":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse"}},"additionalProperties":false,"required":["name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceJob":{"oneOf":[{"type":"object","properties":{"id":{"$ref":"#/$defs/string"},"permission":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission"}},"additionalProperties":false,"required":["id","permission"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceJobJobPermission":{"oneOf":[{"type":"string","enum":["CAN_MANAGE","IS_OWNER","CAN_MANAGE_RUN","CAN_VIEW"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceSecret":{"oneOf":[{"type":"object","properties":{"key":{"$ref":"#/$defs/string"},"permission":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission"},"scope":{"$ref":"#/$defs/string"}},"additionalProperties":false,"required":["key","permission","scope"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceSecretSecretPermission":{"oneOf":[{"type":"string","description":"Permission to grant on the secret scope. Supported permissions are: \"READ\", \"WRITE\", \"MANAGE\".","enum":["READ","WRITE","MANAGE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceServingEndpoint":{"oneOf":[{"type":"object","properties":{"name":{"$ref":"#/$defs/string"},"permission":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission"}},"additionalProperties":false,"required":["name","permission"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceServingEndpointServingEndpointPermission":{"oneOf":[{"type":"string","enum":["CAN_MANAGE","CAN_QUERY","CAN_VIEW"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceSqlWarehouse":{"oneOf":[{"type":"object","properties":{"id":{"$ref":"#/$defs/string"},"permission":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission"}},"additionalProperties":false,"required":["id","permission"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.AppResourceSqlWarehouseSqlWarehousePermission":{"oneOf":[{"type":"string","enum":["CAN_MANAGE","CAN_USE","IS_OWNER"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.ApplicationState":{"oneOf":[{"type":"string","enum":["DEPLOYING","RUNNING","CRASHED","UNAVAILABLE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.ApplicationStatus":{"oneOf":[{"type":"object","properties":{"message":{"$ref":"#/$defs/string"},"state":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ApplicationState"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.ComputeState":{"oneOf":[{"type":"string","enum":["ERROR","DELETING","STARTING","STOPPING","UPDATING","STOPPED","ACTIVE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"apps.ComputeStatus":{"oneOf":[{"type":"object","properties":{"message":{"$ref":"#/$defs/string"},"state":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeState"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorCronSchedule":{"oneOf":[{"type":"object","properties":{"pause_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedulePauseStatus","description":"Read only field that indicates whether a schedule is paused or not."},"quartz_cron_expression":{"$ref":"#/$defs/string","description":"The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).\n"},"timezone_id":{"$ref":"#/$defs/string","description":"The timezone id (e.g., ``\"PST\"``) in which to evaluate the quartz expression.\n"}},"additionalProperties":false,"required":["quartz_cron_expression","timezone_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorCronSchedulePauseStatus":{"oneOf":[{"type":"string","description":"Read only field that indicates whether a schedule is paused or not.","enum":["UNPAUSED","PAUSED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorDataClassificationConfig":{"oneOf":[{"type":"object","properties":{"enabled":{"$ref":"#/$defs/bool","description":"Whether data classification is enabled."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorDestination":{"oneOf":[{"type":"object","properties":{"email_addresses":{"$ref":"#/$defs/slice/string","description":"The list of email addresses to send the notification to. A maximum of 5 email addresses is supported."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorInferenceLog":{"oneOf":[{"type":"object","properties":{"granularities":{"$ref":"#/$defs/slice/string","description":"Granularities for aggregating data into time windows based on their timestamp. Currently the following static\ngranularities are supported:\n{``\"5 minutes\"``, ``\"30 minutes\"``, ``\"1 hour\"``, ``\"1 day\"``, ``\"<n> week(s)\"``, ``\"1 month\"``, ``\"1 year\"``}.\n"},"label_col":{"$ref":"#/$defs/string","description":"Optional column that contains the ground truth for the prediction."},"model_id_col":{"$ref":"#/$defs/string","description":"Column that contains the id of the model generating the predictions. Metrics will be computed per model id by\ndefault, and also across all model ids.\n"},"prediction_col":{"$ref":"#/$defs/string","description":"Column that contains the output/prediction from the model."},"prediction_proba_col":{"$ref":"#/$defs/string","description":"Optional column that contains the prediction probabilities for each class in a classification problem type.\nThe values in this column should be a map, mapping each class label to the prediction probability for a given\nsample. The map should be of PySpark MapType().\n"},"problem_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLogProblemType","description":"Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed."},"timestamp_col":{"$ref":"#/$defs/string","description":"Column that contains the timestamps of requests. The column must be one of the following:\n- A ``TimestampType`` column\n- A column whose values can be converted to timestamps through the pyspark\n ``to_timestamp`` [function](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html).\n"}},"additionalProperties":false,"required":["granularities","model_id_col","prediction_col","problem_type","timestamp_col"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorInferenceLogProblemType":{"oneOf":[{"type":"string","description":"Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed.","enum":["PROBLEM_TYPE_CLASSIFICATION","PROBLEM_TYPE_REGRESSION"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorMetric":{"oneOf":[{"type":"object","properties":{"definition":{"$ref":"#/$defs/string","description":"Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)."},"input_columns":{"$ref":"#/$defs/slice/string","description":"A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.\n"},"name":{"$ref":"#/$defs/string","description":"Name of the metric in the output tables."},"output_data_type":{"$ref":"#/$defs/string","description":"The output type of the custom metric."},"type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetricType","description":"Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or ``\"CUSTOM_METRIC_TYPE_DRIFT\"``.\nThe ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics\nare computed on a single table, whereas the ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics\n"}},"additionalProperties":false,"required":["definition","input_columns","name","output_data_type","type"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorMetricType":{"oneOf":[{"type":"string","description":"Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or ``\"CUSTOM_METRIC_TYPE_DRIFT\"``.\nThe ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics\nare computed on a single table, whereas the ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics\n","enum":["CUSTOM_METRIC_TYPE_AGGREGATE","CUSTOM_METRIC_TYPE_DERIVED","CUSTOM_METRIC_TYPE_DRIFT"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorNotifications":{"oneOf":[{"type":"object","properties":{"on_failure":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination","description":"Who to send notifications to on monitor failure."},"on_new_classification_tag_detected":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination","description":"Who to send notifications to when new data classification tags are detected."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorSnapshot":{"oneOf":[{"type":"object","additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorTimeSeries":{"oneOf":[{"type":"object","properties":{"granularities":{"$ref":"#/$defs/slice/string","description":"Granularities for aggregating data into time windows based on their timestamp. Currently the following static\ngranularities are supported:\n{``\"5 minutes\"``, ``\"30 minutes\"``, ``\"1 hour\"``, ``\"1 day\"``, ``\"<n> week(s)\"``, ``\"1 month\"``, ``\"1 year\"``}.\n"},"timestamp_col":{"$ref":"#/$defs/string","description":"Column that contains the timestamps of requests. The column must be one of the following:\n- A ``TimestampType`` column\n- A column whose values can be converted to timestamps through the pyspark\n ``to_timestamp`` [function](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html).\n"}},"additionalProperties":false,"required":["granularities","timestamp_col"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.VolumeType":{"oneOf":[{"type":"string","enum":["EXTERNAL","MANAGED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.Adlsgen2Info":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"abfss destination, e.g. `abfss://<container-name>@<storage-account-name>.dfs.core.windows.net/<directory-name>`."}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.AutoScale":{"oneOf":[{"type":"object","properties":{"max_workers":{"$ref":"#/$defs/int","description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."},"min_workers":{"$ref":"#/$defs/int","description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.AwsAttributes":{"oneOf":[{"type":"object","properties":{"availability":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability"},"ebs_volume_count":{"$ref":"#/$defs/int","description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."},"ebs_volume_iops":{"$ref":"#/$defs/int","description":"If using gp3 volumes, what IOPS to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used."},"ebs_volume_size":{"$ref":"#/$defs/int","description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."},"ebs_volume_throughput":{"$ref":"#/$defs/int","description":"If using gp3 volumes, what throughput to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used."},"ebs_volume_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType"},"first_on_demand":{"$ref":"#/$defs/int","description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."},"instance_profile_arn":{"$ref":"#/$defs/string","description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nomitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is omitted, we will pull in the default from the conf if it exists."},"spot_bid_price_percent":{"$ref":"#/$defs/int","description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."},"zone_id":{"$ref":"#/$defs/string","description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.AwsAvailability":{"oneOf":[{"type":"string","description":"Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.\n","enum":["SPOT","ON_DEMAND","SPOT_WITH_FALLBACK"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.AzureAttributes":{"oneOf":[{"type":"object","properties":{"availability":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability"},"first_on_demand":{"$ref":"#/$defs/int","description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."},"log_analytics_info":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo","description":"Defines values necessary to configure and run Azure Log Analytics agent"},"spot_bid_max_price":{"$ref":"#/$defs/float64","description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should > 0 or -1."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.AzureAvailability":{"oneOf":[{"type":"string","description":"Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero (which only happens on pool clusters), this availability\ntype will be used for the entire cluster.","enum":["SPOT_AZURE","ON_DEMAND_AZURE","SPOT_WITH_FALLBACK_AZURE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.ClientsTypes":{"oneOf":[{"type":"object","properties":{"jobs":{"$ref":"#/$defs/bool","description":"With jobs set, the cluster can be used for jobs"},"notebooks":{"$ref":"#/$defs/bool","description":"With notebooks set, this cluster can be used for notebooks"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.ClusterLogConf":{"oneOf":[{"type":"object","properties":{"dbfs":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo","description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`"},"s3":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo","description":"destination and either the region or endpoint need to be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.ClusterSpec":{"oneOf":[{"type":"object","properties":{"apply_policy_default_values":{"$ref":"#/$defs/bool","description":"When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied."},"autoscale":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale","description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later."},"autotermination_minutes":{"$ref":"#/$defs/int","description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."},"aws_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes","description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used."},"azure_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes","description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used."},"cluster_log_conf":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf","description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`."},"cluster_name":{"$ref":"#/$defs/string","description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"},"custom_tags":{"$ref":"#/$defs/map/string","description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags"},"data_security_mode":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode"},"docker_image":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage"},"driver_instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."},"driver_node_type_id":{"$ref":"#/$defs/string","description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"},"enable_elastic_disk":{"$ref":"#/$defs/bool","description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."},"enable_local_disk_encryption":{"$ref":"#/$defs/bool","description":"Whether to enable LUKS on cluster VMs' local disks"},"gcp_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes","description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used."},"init_scripts":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo","description":"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`."},"instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool to which the cluster belongs."},"is_single_node":{"$ref":"#/$defs/bool","description":"This field can only be used with `kind`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`\n"},"kind":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind"},"node_type_id":{"$ref":"#/$defs/string","description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"},"num_workers":{"$ref":"#/$defs/int","description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."},"policy_id":{"$ref":"#/$defs/string","description":"The ID of the cluster policy used to create the cluster if applicable."},"runtime_engine":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine"},"single_user_name":{"$ref":"#/$defs/string","description":"Single user name if data_security_mode is `SINGLE_USER`"},"spark_conf":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n"},"spark_env_vars":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`"},"spark_version":{"$ref":"#/$defs/string","description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"},"ssh_public_keys":{"$ref":"#/$defs/slice/string","description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified."},"use_ml_runtime":{"$ref":"#/$defs/bool","description":"This field can only be used with `kind`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.\n"},"workload_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.DataSecurityMode":{"oneOf":[{"type":"string","description":"Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used with `kind`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn\u2019t have UC nor passthrough enabled.\n","enum":["DATA_SECURITY_MODE_AUTO","DATA_SECURITY_MODE_STANDARD","DATA_SECURITY_MODE_DEDICATED","NONE","SINGLE_USER","USER_ISOLATION","LEGACY_TABLE_ACL","LEGACY_PASSTHROUGH","LEGACY_SINGLE_USER","LEGACY_SINGLE_USER_STANDARD"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.DbfsStorageInfo":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"dbfs destination, e.g. `dbfs:/my/path`"}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.DockerBasicAuth":{"oneOf":[{"type":"object","properties":{"password":{"$ref":"#/$defs/string","description":"Password of the user"},"username":{"$ref":"#/$defs/string","description":"Name of the user"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.DockerImage":{"oneOf":[{"type":"object","properties":{"basic_auth":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth"},"url":{"$ref":"#/$defs/string","description":"URL of the docker image."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.EbsVolumeType":{"oneOf":[{"type":"string","description":"The type of EBS volumes that will be launched with this cluster.","enum":["GENERAL_PURPOSE_SSD","THROUGHPUT_OPTIMIZED_HDD"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.Environment":{"oneOf":[{"type":"object","description":"The environment entity used to preserve serverless environment side panel and jobs' environment for non-notebook task.\nIn this minimal environment spec, only pip dependencies are supported.","properties":{"client":{"$ref":"#/$defs/string","description":"Client version used by the environment\nThe client is the user-facing environment of the runtime.\nEach client comes with a specific set of pre-installed libraries.\nThe version is a string, consisting of the major client version."},"dependencies":{"$ref":"#/$defs/slice/string","description":"List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be <requirement specifier>, <archive url/path>, <local project path>(WSFS or Volumes in Databricks), <vcs project url>\nE.g. dependencies: [\"foo==0.0.1\", \"-r /Workspace/test/requirements.txt\"]"}},"additionalProperties":false,"required":["client"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.GcpAttributes":{"oneOf":[{"type":"object","properties":{"availability":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability"},"boot_disk_size":{"$ref":"#/$defs/int","description":"boot disk size in GB"},"google_service_account":{"$ref":"#/$defs/string","description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."},"local_ssd_count":{"$ref":"#/$defs/int","description":"If provided, each node (workers and driver) in the cluster will have this number of local SSDs attached. Each local SSD is 375GB in size. Refer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds) for the supported number of local SSDs for each instance type."},"use_preemptible_executors":{"$ref":"#/$defs/bool","description":"This field determines whether the spark executors will be scheduled to run on preemptible VMs (when set to true) versus standard compute engine VMs (when set to false; default).\nNote: Soon to be deprecated, use the availability field instead."},"zone_id":{"$ref":"#/$defs/string","description":"Identifier for the availability zone in which the cluster resides.\nThis can be one of the following:\n- \"HA\" => High availability, spread nodes across availability zones for a Databricks deployment region [default]\n- \"AUTO\" => Databricks picks an availability zone to schedule the cluster on.\n- A GCP availability zone => Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.GcpAvailability":{"oneOf":[{"type":"string","description":"This field determines whether the instance pool will contain preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.","enum":["PREEMPTIBLE_GCP","ON_DEMAND_GCP","PREEMPTIBLE_WITH_FALLBACK_GCP"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.GcsStorageInfo":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"GCS destination/URI, e.g. `gs://my-bucket/some-prefix`"}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.InitScriptInfo":{"oneOf":[{"type":"object","properties":{"abfss":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info","description":"destination needs to be provided. e.g.\n`{ \"abfss\" : { \"destination\" : \"abfss://<container-name>@<storage-account-name>.dfs.core.windows.net/<directory-name>\" } }"},"dbfs":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo","description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`"},"file":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LocalFileInfo","description":"destination needs to be provided. e.g.\n`{ \"file\" : { \"destination\" : \"file:/my/local/file.sh\" } }`"},"gcs":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcsStorageInfo","description":"destination needs to be provided. e.g.\n`{ \"gcs\": { \"destination\": \"gs://my-bucket/file.sh\" } }`"},"s3":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo","description":"destination and either the region or endpoint need to be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination."},"volumes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo","description":"destination needs to be provided. e.g.\n`{ \"volumes\" : { \"destination\" : \"/Volumes/my-init.sh\" } }`"},"workspace":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkspaceStorageInfo","description":"destination needs to be provided. e.g.\n`{ \"workspace\" : { \"destination\" : \"/Users/[email protected]/my-init.sh\" } }`"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.Kind":{"type":"string"},"compute.Library":{"oneOf":[{"type":"object","properties":{"cran":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RCranLibrary","description":"Specification of a CRAN library to be installed as part of the library"},"egg":{"$ref":"#/$defs/string","description":"Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above."},"jar":{"$ref":"#/$defs/string","description":"URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"jar\": \"/Workspace/path/to/library.jar\" }`, `{ \"jar\" : \"/Volumes/path/to/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."},"maven":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary","description":"Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`"},"pypi":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.PythonPyPiLibrary","description":"Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`"},"requirements":{"$ref":"#/$defs/string","description":"URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`"},"whl":{"$ref":"#/$defs/string","description":"URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"whl\": \"/Workspace/path/to/library.whl\" }`, `{ \"whl\" : \"/Volumes/path/to/library.whl\" }` or\n`{ \"whl\": \"s3://my-bucket/library.whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.LocalFileInfo":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"local file destination, e.g. `file:/my/local/file.sh`"}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.LogAnalyticsInfo":{"oneOf":[{"type":"object","properties":{"log_analytics_primary_key":{"$ref":"#/$defs/string","description":"<needs content added>"},"log_analytics_workspace_id":{"$ref":"#/$defs/string","description":"<needs content added>"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.MavenLibrary":{"oneOf":[{"type":"object","properties":{"coordinates":{"$ref":"#/$defs/string","description":"Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\"."},"exclusions":{"$ref":"#/$defs/slice/string","description":"List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html."},"repo":{"$ref":"#/$defs/string","description":"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched."}},"additionalProperties":false,"required":["coordinates"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.PythonPyPiLibrary":{"oneOf":[{"type":"object","properties":{"package":{"$ref":"#/$defs/string","description":"The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\"."},"repo":{"$ref":"#/$defs/string","description":"The repository where the package can be found. If not specified, the default pip index is\nused."}},"additionalProperties":false,"required":["package"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.RCranLibrary":{"oneOf":[{"type":"object","properties":{"package":{"$ref":"#/$defs/string","description":"The name of the CRAN package to install."},"repo":{"$ref":"#/$defs/string","description":"The repository where the package can be found. If not specified, the default CRAN repo is used."}},"additionalProperties":false,"required":["package"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.RuntimeEngine":{"oneOf":[{"type":"string","description":"Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.\n","enum":["NULL","STANDARD","PHOTON"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.S3StorageInfo":{"oneOf":[{"type":"object","properties":{"canned_acl":{"$ref":"#/$defs/string","description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."},"destination":{"$ref":"#/$defs/string","description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."},"enable_encryption":{"$ref":"#/$defs/bool","description":"(Optional) Flag to enable server side encryption, `false` by default."},"encryption_type":{"$ref":"#/$defs/string","description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."},"endpoint":{"$ref":"#/$defs/string","description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."},"kms_key":{"$ref":"#/$defs/string","description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."},"region":{"$ref":"#/$defs/string","description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.VolumesStorageInfo":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"Unity Catalog Volumes file destination, e.g. `/Volumes/my-init.sh`"}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.WorkloadType":{"oneOf":[{"type":"object","properties":{"clients":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClientsTypes","description":" defined what type of clients can use the cluster. E.g. Notebooks, Jobs"}},"additionalProperties":false,"required":["clients"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.WorkspaceStorageInfo":{"oneOf":[{"type":"object","properties":{"destination":{"$ref":"#/$defs/string","description":"workspace files destination, e.g. `/Users/[email protected]/my-init.sh`"}},"additionalProperties":false,"required":["destination"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"dashboards.LifecycleState":{"oneOf":[{"type":"string","enum":["ACTIVE","TRASHED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.CleanRoomsNotebookTask":{"oneOf":[{"type":"object","properties":{"clean_room_name":{"$ref":"#/$defs/string","description":"The clean room that the notebook belongs to."},"etag":{"$ref":"#/$defs/string","description":"Checksum to validate the freshness of the notebook resource (i.e. the notebook being run is the latest version).\nIt can be fetched by calling the :method:cleanroomassets/get API."},"notebook_base_parameters":{"$ref":"#/$defs/map/string","description":"Base parameters to be used for the clean room notebook job."},"notebook_name":{"$ref":"#/$defs/string","description":"Name of the notebook being run."}},"additionalProperties":false,"required":["clean_room_name","notebook_name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Condition":{"oneOf":[{"type":"string","enum":["ANY_UPDATED","ALL_UPDATED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.ConditionTask":{"oneOf":[{"type":"object","properties":{"left":{"$ref":"#/$defs/string","description":"The left operand of the condition task. Can be either a string value or a job state or parameter reference."},"op":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTaskOp","description":"* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `\u201c12.0\u201d == \u201c12\u201d` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `\u201c12.0\u201d >= \u201c12\u201d` will evaluate to `true`, `\u201c10.0\u201d >= \u201c12\u201d` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `\u201ctrue\u201d` or `\u201cfalse\u201d` for the comparison."},"right":{"$ref":"#/$defs/string","description":"The right operand of the condition task. Can be either a string value or a job state or parameter reference."}},"additionalProperties":false,"required":["left","op","right"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.ConditionTaskOp":{"oneOf":[{"type":"string","description":"* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `\u201c12.0\u201d == \u201c12\u201d` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `\u201c12.0\u201d >= \u201c12\u201d` will evaluate to `true`, `\u201c10.0\u201d >= \u201c12\u201d` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `\u201ctrue\u201d` or `\u201cfalse\u201d` for the comparison.","enum":["EQUAL_TO","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","NOT_EQUAL"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Continuous":{"oneOf":[{"type":"object","properties":{"pause_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus","description":"Indicate whether the continuous execution of the job is paused or not. Defaults to UNPAUSED."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.CronSchedule":{"oneOf":[{"type":"object","properties":{"pause_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus","description":"Indicate whether this schedule is paused or not."},"quartz_cron_expression":{"$ref":"#/$defs/string","description":"A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required."},"timezone_id":{"$ref":"#/$defs/string","description":"A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required."}},"additionalProperties":false,"required":["quartz_cron_expression","timezone_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.DbtTask":{"oneOf":[{"type":"object","properties":{"catalog":{"$ref":"#/$defs/string","description":"Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks >= 1.1.1."},"commands":{"$ref":"#/$defs/slice/string","description":"A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided."},"profiles_directory":{"$ref":"#/$defs/string","description":"Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used."},"project_directory":{"$ref":"#/$defs/string","description":"Path to the project directory. Optional for Git sourced tasks, in which\ncase if no value is provided, the root of the Git repository is used."},"schema":{"$ref":"#/$defs/string","description":"Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used."},"source":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source","description":"Optional location type of the project directory. When set to `WORKSPACE`, the project will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the project will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: Project is located in Databricks workspace.\n* `GIT`: Project is located in cloud Git provider."},"warehouse_id":{"$ref":"#/$defs/string","description":"ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument."}},"additionalProperties":false,"required":["commands"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.FileArrivalTriggerConfiguration":{"oneOf":[{"type":"object","properties":{"min_time_between_triggers_seconds":{"$ref":"#/$defs/int","description":"If set, the trigger starts a run only after the specified amount of time passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds"},"url":{"$ref":"#/$defs/string","description":"URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location."},"wait_after_last_change_seconds":{"$ref":"#/$defs/int","description":"If set, the trigger starts a run only after no file activity has occurred for the specified amount of time.\nThis makes it possible to wait for a batch of incoming files to arrive before triggering a run. The\nminimum allowed value is 60 seconds."}},"additionalProperties":false,"required":["url"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.ForEachTask":{"oneOf":[{"type":"object","properties":{"concurrency":{"$ref":"#/$defs/int","description":"An optional maximum allowed number of concurrent runs of the task.\nSet this value if you want to be able to execute multiple runs of the task concurrently."},"inputs":{"$ref":"#/$defs/string","description":"Array for task to iterate on. This can be a JSON string or a reference to\nan array parameter."},"task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task","description":"Configuration for the task that will be run for each element in the array"}},"additionalProperties":false,"required":["inputs","task"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Format":{"oneOf":[{"type":"string","enum":["SINGLE_TASK","MULTI_TASK"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.GitProvider":{"oneOf":[{"type":"string","enum":["gitHub","bitbucketCloud","azureDevOpsServices","gitHubEnterprise","bitbucketServer","gitLab","gitLabEnterpriseEdition","awsCodeCommit"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.GitSnapshot":{"oneOf":[{"type":"object","description":"Read-only state of the remote repository at the time the job was run. This field is only included on job runs.","properties":{"used_commit":{"$ref":"#/$defs/string","description":"Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.GitSource":{"oneOf":[{"type":"object","description":"An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.","properties":{"git_branch":{"$ref":"#/$defs/string","description":"Name of the branch to be checked out and used by this job. This field cannot be specified in conjunction with git_tag or git_commit."},"git_commit":{"$ref":"#/$defs/string","description":"Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag."},"git_provider":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitProvider","description":"Unique identifier of the service used to host the Git repository. The value is case insensitive."},"git_tag":{"$ref":"#/$defs/string","description":"Name of the tag to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_commit."},"git_url":{"$ref":"#/$defs/string","description":"URL of the repository to be cloned by this job."}},"additionalProperties":false,"required":["git_provider","git_url"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobCluster":{"oneOf":[{"type":"object","properties":{"job_cluster_key":{"$ref":"#/$defs/string","description":"A unique name for the job cluster. This field is required and must be unique within the job.\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution."},"new_cluster":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec","description":"If new_cluster, a description of a cluster that is created for each task."}},"additionalProperties":false,"required":["job_cluster_key","new_cluster"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobDeployment":{"oneOf":[{"type":"object","properties":{"kind":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind","description":"The kind of deployment that manages the job.\n\n* `BUNDLE`: The job is managed by Databricks Asset Bundle."},"metadata_file_path":{"$ref":"#/$defs/string","description":"Path of the file that contains deployment metadata."}},"additionalProperties":false,"required":["kind"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobDeploymentKind":{"oneOf":[{"type":"string","description":"* `BUNDLE`: The job is managed by Databricks Asset Bundle.","enum":["BUNDLE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobEditMode":{"oneOf":[{"type":"string","description":"Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.","enum":["UI_LOCKED","EDITABLE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobEmailNotifications":{"oneOf":[{"type":"object","properties":{"no_alert_for_skipped_runs":{"$ref":"#/$defs/bool","description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field."},"on_duration_warning_threshold_exceeded":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent."},"on_failure":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent."},"on_start":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent."},"on_streaming_backlog_exceeded":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes."},"on_success":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobEnvironment":{"oneOf":[{"type":"object","properties":{"environment_key":{"$ref":"#/$defs/string","description":"The key of an environment. It has to be unique within a job."},"spec":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment"}},"additionalProperties":false,"required":["environment_key"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobNotificationSettings":{"oneOf":[{"type":"object","properties":{"no_alert_for_canceled_runs":{"$ref":"#/$defs/bool","description":"If true, do not send notifications to recipients specified in `on_failure` if the run is canceled."},"no_alert_for_skipped_runs":{"$ref":"#/$defs/bool","description":"If true, do not send notifications to recipients specified in `on_failure` if the run is skipped."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobParameterDefinition":{"oneOf":[{"type":"object","properties":{"default":{"$ref":"#/$defs/string","description":"Default value of the parameter."},"name":{"$ref":"#/$defs/string","description":"The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`"}},"additionalProperties":false,"required":["default","name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobRunAs":{"oneOf":[{"type":"object","description":"Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.","properties":{"service_principal_name":{"$ref":"#/$defs/string","description":"Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role."},"user_name":{"$ref":"#/$defs/string","description":"The email of an active workspace user. Non-admin users can only set this field to their own email."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobSource":{"oneOf":[{"type":"object","description":"The source of the job specification in the remote repository when the job is source controlled.","properties":{"dirty_state":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState","description":"Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced."},"import_from_git_branch":{"$ref":"#/$defs/string","description":"Name of the branch which the job is imported from."},"job_config_path":{"$ref":"#/$defs/string","description":"Path of the job YAML file that contains the job specification."}},"additionalProperties":false,"required":["import_from_git_branch","job_config_path"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobSourceDirtyState":{"oneOf":[{"type":"string","description":"Dirty state indicates the job is not fully synced with the job specification\nin the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.","enum":["NOT_SYNCED","DISCONNECTED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobsHealthMetric":{"oneOf":[{"type":"string","description":"Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.","enum":["RUN_DURATION_SECONDS","STREAMING_BACKLOG_BYTES","STREAMING_BACKLOG_RECORDS","STREAMING_BACKLOG_SECONDS","STREAMING_BACKLOG_FILES"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobsHealthOperator":{"oneOf":[{"type":"string","description":"Specifies the operator used to compare the health metric value with the specified threshold.","enum":["GREATER_THAN"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobsHealthRule":{"oneOf":[{"type":"object","properties":{"metric":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric"},"op":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator"},"value":{"$ref":"#/$defs/int64","description":"Specifies the threshold value that the health metric should obey to satisfy the health rule."}},"additionalProperties":false,"required":["metric","op","value"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobsHealthRules":{"oneOf":[{"type":"object","description":"An optional set of health rules that can be defined for this job.","properties":{"rules":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.NotebookTask":{"oneOf":[{"type":"object","properties":{"base_parameters":{"$ref":"#/$defs/map/string","description":"Base parameters to be used for each run of this job. If the run is initiated by a call to :method:jobs/run\nNow with parameters specified, the two parameters maps are merged. If the same key is specified in\n`base_parameters` and in `run-now`, the value from `run-now` is used.\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nIf the notebook takes a parameter that is not specified in the job\u2019s `base_parameters` or the `run-now` override parameters,\nthe default value from the notebook is used.\n\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\n\nThe JSON representation of this field cannot exceed 1MB."},"notebook_path":{"$ref":"#/$defs/string","description":"The path of the notebook to be run in the Databricks workspace or remote repository.\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\nFor notebooks stored in a remote repository, the path must be relative. This field is required."},"source":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source","description":"Optional location type of the notebook. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Notebook is located in Databricks workspace.\n* `GIT`: Notebook is located in cloud Git provider."},"warehouse_id":{"$ref":"#/$defs/string","description":"Optional `warehouse_id` to run the notebook on a SQL warehouse. Classic SQL warehouses are NOT supported, please use serverless or pro SQL warehouses.\n\nNote that SQL warehouses only support SQL cells; if the notebook contains non-SQL cells, the run will fail."}},"additionalProperties":false,"required":["notebook_path"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PauseStatus":{"oneOf":[{"type":"string","enum":["UNPAUSED","PAUSED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PeriodicTriggerConfiguration":{"oneOf":[{"type":"object","properties":{"interval":{"$ref":"#/$defs/int","description":"The interval at which the trigger should run."},"unit":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfigurationTimeUnit","description":"The unit of time for the interval."}},"additionalProperties":false,"required":["interval","unit"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PeriodicTriggerConfigurationTimeUnit":{"oneOf":[{"type":"string","enum":["HOURS","DAYS","WEEKS"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PipelineParams":{"oneOf":[{"type":"object","properties":{"full_refresh":{"$ref":"#/$defs/bool","description":"If true, triggers a full refresh on the delta live table."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PipelineTask":{"oneOf":[{"type":"object","properties":{"full_refresh":{"$ref":"#/$defs/bool","description":"If true, triggers a full refresh on the delta live table."},"pipeline_id":{"$ref":"#/$defs/string","description":"The full name of the pipeline task to execute."}},"additionalProperties":false,"required":["pipeline_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.PythonWheelTask":{"oneOf":[{"type":"object","properties":{"entry_point":{"$ref":"#/$defs/string","description":"Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`"},"named_parameters":{"$ref":"#/$defs/map/string","description":"Command-line parameters passed to Python wheel task in the form of `[\"--name=task\", \"--data=dbfs:/path/to/data.json\"]`. Leave it empty if `parameters` is not null."},"package_name":{"$ref":"#/$defs/string","description":"Name of the package to execute"},"parameters":{"$ref":"#/$defs/slice/string","description":"Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null."}},"additionalProperties":false,"required":["entry_point","package_name"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.QueueSettings":{"oneOf":[{"type":"object","properties":{"enabled":{"$ref":"#/$defs/bool","description":"If true, enable queueing for the job. This is a required field."}},"additionalProperties":false,"required":["enabled"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.RunIf":{"oneOf":[{"type":"string","description":"An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`.\n\nPossible values are:\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed","enum":["ALL_SUCCESS","ALL_DONE","NONE_FAILED","AT_LEAST_ONE_SUCCESS","ALL_FAILED","AT_LEAST_ONE_FAILED"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.RunJobTask":{"oneOf":[{"type":"object","properties":{"dbt_commands":{"$ref":"#/$defs/slice/string","description":"An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`"},"jar_params":{"$ref":"#/$defs/slice/string","description":"A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs."},"job_id":{"$ref":"#/$defs/int64","description":"ID of the job to trigger."},"job_parameters":{"$ref":"#/$defs/map/string","description":"Job-level parameters used to trigger the job."},"notebook_params":{"$ref":"#/$defs/map/string","description":"A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job\u2019s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes."},"pipeline_params":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams","description":"Controls whether the pipeline should perform a full refresh"},"python_named_params":{"$ref":"#/$defs/map/string"},"python_params":{"$ref":"#/$defs/slice/string","description":"A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis."},"spark_submit_params":{"$ref":"#/$defs/slice/string","description":"A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis."},"sql_params":{"$ref":"#/$defs/map/string","description":"A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters."}},"additionalProperties":false,"required":["job_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Source":{"oneOf":[{"type":"string","description":"Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\\\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider.","enum":["WORKSPACE","GIT"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SparkJarTask":{"oneOf":[{"type":"object","properties":{"jar_uri":{"$ref":"#/$defs/string","description":"Deprecated since 04/2016. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create."},"main_class_name":{"$ref":"#/$defs/string","description":"The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\n\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail."},"parameters":{"$ref":"#/$defs/slice/string","description":"Parameters passed to the main method.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SparkPythonTask":{"oneOf":[{"type":"object","properties":{"parameters":{"$ref":"#/$defs/slice/string","description":"Command line parameters passed to the Python file.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs."},"python_file":{"$ref":"#/$defs/string","description":"The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required."},"source":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source","description":"Optional location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local\nDatabricks workspace or cloud location (if the `python_file` has a URI format). When set to `GIT`,\nthe Python file will be retrieved from a Git repository defined in `git_source`.\n\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository."}},"additionalProperties":false,"required":["python_file"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SparkSubmitTask":{"oneOf":[{"type":"object","properties":{"parameters":{"$ref":"#/$defs/slice/string","description":"Command-line parameters passed to spark submit.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTask":{"oneOf":[{"type":"object","properties":{"alert":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskAlert","description":"If alert, indicates that this job must refresh a SQL alert."},"dashboard":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskDashboard","description":"If dashboard, indicates that this job must refresh a SQL dashboard."},"file":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskFile","description":"If file, indicates that this job runs a SQL file in a remote Git repository."},"parameters":{"$ref":"#/$defs/map/string","description":"Parameters to be used for each run of this job. The SQL alert task does not support custom parameters."},"query":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskQuery","description":"If query, indicates that this job must execute a SQL query."},"warehouse_id":{"$ref":"#/$defs/string","description":"The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs."}},"additionalProperties":false,"required":["warehouse_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskAlert":{"oneOf":[{"type":"object","properties":{"alert_id":{"$ref":"#/$defs/string","description":"The canonical identifier of the SQL alert."},"pause_subscriptions":{"$ref":"#/$defs/bool","description":"If true, the alert notifications are not sent to subscribers."},"subscriptions":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription","description":"If specified, alert notifications are sent to subscribers."}},"additionalProperties":false,"required":["alert_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskDashboard":{"oneOf":[{"type":"object","properties":{"custom_subject":{"$ref":"#/$defs/string","description":"Subject of the email sent to subscribers of this task."},"dashboard_id":{"$ref":"#/$defs/string","description":"The canonical identifier of the SQL dashboard."},"pause_subscriptions":{"$ref":"#/$defs/bool","description":"If true, the dashboard snapshot is not taken, and emails are not sent to subscribers."},"subscriptions":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription","description":"If specified, dashboard snapshots are sent to subscriptions."}},"additionalProperties":false,"required":["dashboard_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskFile":{"oneOf":[{"type":"object","properties":{"path":{"$ref":"#/$defs/string","description":"Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths."},"source":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source","description":"Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider."}},"additionalProperties":false,"required":["path"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskQuery":{"oneOf":[{"type":"object","properties":{"query_id":{"$ref":"#/$defs/string","description":"The canonical identifier of the SQL query."}},"additionalProperties":false,"required":["query_id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskSubscription":{"oneOf":[{"type":"object","properties":{"destination_id":{"$ref":"#/$defs/string","description":"The canonical identifier of the destination to receive email notification. This parameter is mutually exclusive with user_name. You cannot set both destination_id and user_name for subscription notifications."},"user_name":{"$ref":"#/$defs/string","description":"The user name to receive the subscription email. This parameter is mutually exclusive with destination_id. You cannot set both destination_id and user_name for subscription notifications."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TableUpdateTriggerConfiguration":{"oneOf":[{"type":"object","properties":{"condition":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Condition","description":"The table(s) condition based on which to trigger a job run."},"min_time_between_triggers_seconds":{"$ref":"#/$defs/int","description":"If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds."},"table_names":{"$ref":"#/$defs/slice/string","description":"A list of Delta tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`."},"wait_after_last_change_seconds":{"$ref":"#/$defs/int","description":"If set, the trigger starts a run only after no table updates have occurred for the specified time\nand can be used to wait for a series of table updates before triggering a run. The\nminimum allowed value is 60 seconds."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Task":{"oneOf":[{"type":"object","properties":{"clean_rooms_notebook_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask","description":"The task runs a [clean rooms](https://docs.databricks.com/en/clean-rooms/index.html) notebook\nwhen the `clean_rooms_notebook_task` field is present."},"condition_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTask","description":"The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications."},"dbt_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtTask","description":"The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse."},"depends_on":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency","description":"An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete before executing this task. The task will run only if the `run_if` condition is true.\nThe key is `task_key`, and the value is the name assigned to the dependent task."},"description":{"$ref":"#/$defs/string","description":"An optional description for this task."},"disable_auto_optimization":{"$ref":"#/$defs/bool","description":"An option to disable auto optimization in serverless"},"email_notifications":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications","description":"An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails."},"environment_key":{"$ref":"#/$defs/string","description":"The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute."},"existing_cluster_id":{"$ref":"#/$defs/string","description":"If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability"},"for_each_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ForEachTask","description":"The task executes a nested task for every input provided when the `for_each_task` field is present."},"health":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules"},"job_cluster_key":{"$ref":"#/$defs/string","description":"If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`."},"libraries":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library","description":"An optional list of libraries to be installed on the cluster.\nThe default value is an empty list."},"max_retries":{"$ref":"#/$defs/int","description":"An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry."},"min_retry_interval_millis":{"$ref":"#/$defs/int","description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried."},"new_cluster":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec","description":"If new_cluster, a description of a new cluster that is created for each run."},"notebook_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask","description":"The task runs a notebook when the `notebook_task` field is present."},"notification_settings":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskNotificationSettings","description":"Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task."},"pipeline_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask","description":"The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported."},"python_wheel_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask","description":"The task runs a Python wheel when the `python_wheel_task` field is present."},"retry_on_timeout":{"$ref":"#/$defs/bool","description":"An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout."},"run_if":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunIf","description":"An optional value specifying the condition determining whether the task is run once its dependencies have been completed.\n\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed"},"run_job_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask","description":"The task triggers another job when the `run_job_task` field is present."},"spark_jar_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask","description":"The task runs a JAR when the `spark_jar_task` field is present."},"spark_python_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkPythonTask","description":"The task runs a Python file when the `spark_python_task` field is present."},"spark_submit_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkSubmitTask","description":"(Legacy) The task runs the spark-submit script when the `spark_submit_task` field is present. This task can run only on new clusters and is not compatible with serverless compute.\n\nIn the `new_cluster` specification, `libraries` and `spark_conf` are not supported. Instead, use `--jars` and `--py-files` to add Java and Python libraries and `--conf` to set the Spark configurations.\n\n`master`, `deploy-mode`, and `executor-cores` are automatically configured by Databricks; you _cannot_ specify them in parameters.\n\nBy default, the Spark submit job uses all available memory (excluding reserved memory for Databricks services). You can set `--driver-memory`, and `--executor-memory` to a smaller value to leave some room for off-heap usage.\n\nThe `--jars`, `--py-files`, `--files` arguments support DBFS and S3 paths."},"sql_task":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTask","description":"The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present."},"task_key":{"$ref":"#/$defs/string","description":"A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset."},"timeout_seconds":{"$ref":"#/$defs/int","description":"An optional timeout applied to each run of this job task. A value of `0` means no timeout."},"webhook_notifications":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications","description":"A collection of system notification IDs to notify when runs of this task begin or complete. The default behavior is to not send any system notifications."}},"additionalProperties":false,"required":["task_key"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TaskDependency":{"oneOf":[{"type":"object","properties":{"outcome":{"$ref":"#/$defs/string","description":"Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run."},"task_key":{"$ref":"#/$defs/string","description":"The name of the task this task depends on."}},"additionalProperties":false,"required":["task_key"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TaskEmailNotifications":{"oneOf":[{"type":"object","properties":{"no_alert_for_skipped_runs":{"$ref":"#/$defs/bool","description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field."},"on_duration_warning_threshold_exceeded":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent."},"on_failure":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent."},"on_start":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent."},"on_streaming_backlog_exceeded":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes."},"on_success":{"$ref":"#/$defs/slice/string","description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TaskNotificationSettings":{"oneOf":[{"type":"object","properties":{"alert_on_last_attempt":{"$ref":"#/$defs/bool","description":"If true, do not send notifications to recipients specified in `on_start` for the retried runs and do not send notifications to recipients specified in `on_failure` until the last retry of the run."},"no_alert_for_canceled_runs":{"$ref":"#/$defs/bool","description":"If true, do not send notifications to recipients specified in `on_failure` if the run is canceled."},"no_alert_for_skipped_runs":{"$ref":"#/$defs/bool","description":"If true, do not send notifications to recipients specified in `on_failure` if the run is skipped."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TriggerSettings":{"oneOf":[{"type":"object","properties":{"file_arrival":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration","description":"File arrival trigger settings."},"pause_status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus","description":"Whether this trigger is paused or not."},"periodic":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration","description":"Periodic trigger settings."},"table":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration","description":"Old table trigger settings name. Deprecated in favor of `table_update`."},"table_update":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Webhook":{"oneOf":[{"type":"object","properties":{"id":{"$ref":"#/$defs/string"}},"additionalProperties":false,"required":["id"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.WebhookNotifications":{"oneOf":[{"type":"object","properties":{"on_duration_warning_threshold_exceeded":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook","description":"An optional list of system notification IDs to call when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. A maximum of 3 destinations can be specified for the `on_duration_warning_threshold_exceeded` property."},"on_failure":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook","description":"An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property."},"on_start":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook","description":"An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property."},"on_streaming_backlog_exceeded":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook","description":"An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property."},"on_success":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook","description":"An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ExperimentTag":{"oneOf":[{"type":"object","properties":{"key":{"$ref":"#/$defs/string","description":"The tag key."},"value":{"$ref":"#/$defs/string","description":"The tag value."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelTag":{"oneOf":[{"type":"object","properties":{"key":{"$ref":"#/$defs/string","description":"The tag key."},"value":{"$ref":"#/$defs/string","description":"The tag value."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelVersion":{"oneOf":[{"type":"object","properties":{"creation_timestamp":{"$ref":"#/$defs/int64","description":"Timestamp recorded when this `model_version` was created."},"current_stage":{"$ref":"#/$defs/string","description":"Current stage for this `model_version`."},"description":{"$ref":"#/$defs/string","description":"Description of this `model_version`."},"last_updated_timestamp":{"$ref":"#/$defs/int64","description":"Timestamp recorded when metadata for this `model_version` was last updated."},"name":{"$ref":"#/$defs/string","description":"Unique name of the model"},"run_id":{"$ref":"#/$defs/string","description":"MLflow run ID used when creating `model_version`, if `source` was generated by an\nexperiment run stored in MLflow tracking server."},"run_link":{"$ref":"#/$defs/string","description":"Run Link: Direct link to the run that generated this version"},"source":{"$ref":"#/$defs/string","description":"URI indicating the location of the source model artifacts, used when creating `model_version`"},"status":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionStatus","description":"Current status of `model_version`"},"status_message":{"$ref":"#/$defs/string","description":"Details on current `status`, if it is pending or failed."},"tags":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionTag","description":"Tags: Additional metadata key-value pairs for this `model_version`."},"user_id":{"$ref":"#/$defs/string","description":"User that created this `model_version`."},"version":{"$ref":"#/$defs/string","description":"Model's version number."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelVersionStatus":{"oneOf":[{"type":"string","description":"Current status of `model_version`","enum":["PENDING_REGISTRATION","FAILED_REGISTRATION","READY"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelVersionTag":{"oneOf":[{"type":"object","properties":{"key":{"$ref":"#/$defs/string","description":"The tag key."},"value":{"$ref":"#/$defs/string","description":"The tag value."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.CronTrigger":{"oneOf":[{"type":"object","properties":{"quartz_cron_schedule":{"$ref":"#/$defs/string"},"timezone_id":{"$ref":"#/$defs/string"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.DayOfWeek":{"oneOf":[{"type":"string","description":"Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.DeploymentKind":{"oneOf":[{"type":"string","description":"The deployment method that manages the pipeline:\n- BUNDLE: The pipeline is managed by a Databricks Asset Bundle.\n","enum":["BUNDLE"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.FileLibrary":{"oneOf":[{"type":"object","properties":{"path":{"$ref":"#/$defs/string","description":"The absolute path of the file."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.Filters":{"oneOf":[{"type":"object","properties":{"exclude":{"$ref":"#/$defs/slice/string","description":"Paths to exclude."},"include":{"$ref":"#/$defs/slice/string","description":"Paths to include."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.IngestionConfig":{"oneOf":[{"type":"object","properties":{"report":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec","description":"Select a specific source report."},"schema":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec","description":"Select all tables from a specific source schema."},"table":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec","description":"Select a specific source table."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.IngestionGatewayPipelineDefinition":{"oneOf":[{"type":"object","properties":{"connection_id":{"$ref":"#/$defs/string","description":"[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source."},"connection_name":{"$ref":"#/$defs/string","description":"Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source."},"gateway_storage_catalog":{"$ref":"#/$defs/string","description":"Required, Immutable. The name of the catalog for the gateway pipeline's storage location."},"gateway_storage_name":{"$ref":"#/$defs/string","description":"Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nDelta Live Tables system will automatically create the storage location under the catalog and schema.\n"},"gateway_storage_schema":{"$ref":"#/$defs/string","description":"Required, Immutable. The name of the schema for the gateway pipelines's storage location."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.IngestionPipelineDefinition":{"oneOf":[{"type":"object","properties":{"connection_name":{"$ref":"#/$defs/string","description":"Immutable. The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with connectors for applications like Salesforce, Workday, and so on."},"ingestion_gateway_id":{"$ref":"#/$defs/string","description":"Immutable. Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with connectors to databases like SQL Server."},"objects":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig","description":"Required. Settings specifying tables to replicate and the destination for the replicated tables."},"table_configuration":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig","description":"Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.ManualTrigger":{"oneOf":[{"type":"object","additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.NotebookLibrary":{"oneOf":[{"type":"object","properties":{"path":{"$ref":"#/$defs/string","description":"The absolute path of the notebook."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.Notifications":{"oneOf":[{"type":"object","properties":{"alerts":{"$ref":"#/$defs/slice/string","description":"A list of alerts that trigger the sending of notifications to the configured\ndestinations. The supported alerts are:\n\n* `on-update-success`: A pipeline update completes successfully.\n* `on-update-failure`: Each time a pipeline update fails.\n* `on-update-fatal-failure`: A pipeline update fails with a non-retryable (fatal) error.\n* `on-flow-failure`: A single data flow fails.\n"},"email_recipients":{"$ref":"#/$defs/slice/string","description":"A list of email addresses notified when a configured alert is triggered.\n"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineCluster":{"oneOf":[{"type":"object","properties":{"apply_policy_default_values":{"$ref":"#/$defs/bool","description":"Note: This field won't be persisted. Only API users will check this field."},"autoscale":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscale","description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later."},"aws_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes","description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used."},"azure_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes","description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used."},"cluster_log_conf":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf","description":"The configuration for delivering spark logs to a long-term storage destination.\nOnly dbfs destinations are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.\n"},"custom_tags":{"$ref":"#/$defs/map/string","description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags"},"driver_instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."},"driver_node_type_id":{"$ref":"#/$defs/string","description":"The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above."},"enable_local_disk_encryption":{"$ref":"#/$defs/bool","description":"Whether to enable local disk encryption for the cluster."},"gcp_attributes":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes","description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used."},"init_scripts":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo","description":"The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`."},"instance_pool_id":{"$ref":"#/$defs/string","description":"The optional ID of the instance pool to which the cluster belongs."},"label":{"$ref":"#/$defs/string","description":"A label for the cluster specification, either `default` to configure the default cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`."},"node_type_id":{"$ref":"#/$defs/string","description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"},"num_workers":{"$ref":"#/$defs/int","description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."},"policy_id":{"$ref":"#/$defs/string","description":"The ID of the cluster policy used to create the cluster if applicable."},"spark_conf":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nSee :method:clusters/create for more details.\n"},"spark_env_vars":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`"},"ssh_public_keys":{"$ref":"#/$defs/slice/string","description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineClusterAutoscale":{"oneOf":[{"type":"object","properties":{"max_workers":{"$ref":"#/$defs/int","description":"The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`."},"min_workers":{"$ref":"#/$defs/int","description":"The minimum number of workers the cluster can scale down to when underutilized.\nIt is also the initial number of workers the cluster will have after creation."},"mode":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscaleMode","description":"Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.\n"}},"additionalProperties":false,"required":["max_workers","min_workers"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineClusterAutoscaleMode":{"oneOf":[{"type":"string","description":"Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.\n","enum":["ENHANCED","LEGACY"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineDeployment":{"oneOf":[{"type":"object","properties":{"kind":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind","description":"The deployment method that manages the pipeline."},"metadata_file_path":{"$ref":"#/$defs/string","description":"The path to the file containing metadata about the deployment."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineLibrary":{"oneOf":[{"type":"object","properties":{"file":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary","description":"The path to a file that defines a pipeline and is stored in the Databricks Repos.\n"},"jar":{"$ref":"#/$defs/string","description":"URI of the jar to be installed. Currently only DBFS is supported.\n"},"maven":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary","description":"Specification of a maven library to be installed.\n"},"notebook":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary","description":"The path to a notebook that defines a pipeline and is stored in the Databricks workspace.\n"},"whl":{"$ref":"#/$defs/string","description":"URI of the whl to be installed."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineTrigger":{"oneOf":[{"type":"object","properties":{"cron":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger"},"manual":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.ReportSpec":{"oneOf":[{"type":"object","properties":{"destination_catalog":{"$ref":"#/$defs/string","description":"Required. Destination catalog to store table."},"destination_schema":{"$ref":"#/$defs/string","description":"Required. Destination schema to store table."},"destination_table":{"$ref":"#/$defs/string","description":"Required. Destination table name. The pipeline fails if a table with that name already exists."},"source_url":{"$ref":"#/$defs/string","description":"Required. Report URL in the source system."},"table_configuration":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig","description":"Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.RestartWindow":{"oneOf":[{"type":"object","properties":{"days_of_week":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek","description":"Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used."},"start_hour":{"$ref":"#/$defs/int","description":"An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour."},"time_zone_id":{"$ref":"#/$defs/string","description":"Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used."}},"additionalProperties":false,"required":["start_hour"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.SchemaSpec":{"oneOf":[{"type":"object","properties":{"destination_catalog":{"$ref":"#/$defs/string","description":"Required. Destination catalog to store tables."},"destination_schema":{"$ref":"#/$defs/string","description":"Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists."},"source_catalog":{"$ref":"#/$defs/string","description":"The source catalog name. Might be optional depending on the type of source."},"source_schema":{"$ref":"#/$defs/string","description":"Required. Schema name in the source database."},"table_configuration":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig","description":"Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.TableSpec":{"oneOf":[{"type":"object","properties":{"destination_catalog":{"$ref":"#/$defs/string","description":"Required. Destination catalog to store table."},"destination_schema":{"$ref":"#/$defs/string","description":"Required. Destination schema to store table."},"destination_table":{"$ref":"#/$defs/string","description":"Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used."},"source_catalog":{"$ref":"#/$defs/string","description":"Source catalog name. Might be optional depending on the type of source."},"source_schema":{"$ref":"#/$defs/string","description":"Schema name in the source database. Might be optional depending on the type of source."},"source_table":{"$ref":"#/$defs/string","description":"Required. Table name in the source database."},"table_configuration":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig","description":"Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.TableSpecificConfig":{"oneOf":[{"type":"object","properties":{"primary_keys":{"$ref":"#/$defs/slice/string","description":"The primary key of the table used to apply changes."},"salesforce_include_formula_fields":{"$ref":"#/$defs/bool","description":"If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector"},"scd_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType","description":"The SCD type to use to ingest the table."},"sequence_by":{"$ref":"#/$defs/slice/string","description":"The column names specifying the logical order of events in the source data. Delta Live Tables uses this sequencing to handle change events that arrive out of order."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.TableSpecificConfigScdType":{"oneOf":[{"type":"string","description":"The SCD type to use to ingest the table.","enum":["SCD_TYPE_1","SCD_TYPE_2"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.Ai21LabsConfig":{"oneOf":[{"type":"object","properties":{"ai21labs_api_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for an AI21 Labs API key. If you prefer to paste your API key directly, see `ai21labs_api_key_plaintext`. You must provide an API key using one of the following fields: `ai21labs_api_key` or `ai21labs_api_key_plaintext`."},"ai21labs_api_key_plaintext":{"$ref":"#/$defs/string","description":"An AI21 Labs API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `ai21labs_api_key`. You must provide an API key using one of the following fields: `ai21labs_api_key` or `ai21labs_api_key_plaintext`."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayConfig":{"oneOf":[{"type":"object","properties":{"guardrails":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails","description":"Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses."},"inference_table_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig","description":"Configuration for payload logging using inference tables. Use these tables to monitor and audit data being sent to and received from model APIs and to improve model quality."},"rate_limits":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit","description":"Configuration for rate limits which can be set to limit endpoint traffic."},"usage_tracking_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig","description":"Configuration to enable usage tracking using system tables. These tables allow you to monitor operational usage on endpoints and their associated costs."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayGuardrailParameters":{"oneOf":[{"type":"object","properties":{"invalid_keywords":{"$ref":"#/$defs/slice/string","description":"List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content."},"pii":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior","description":"Configuration for guardrail PII filter."},"safety":{"$ref":"#/$defs/bool","description":"Indicates whether the safety filter is enabled."},"valid_topics":{"$ref":"#/$defs/slice/string","description":"The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayGuardrailPiiBehavior":{"oneOf":[{"type":"object","properties":{"behavior":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior","description":"Behavior for PII filter. Currently only 'BLOCK' is supported. If 'BLOCK' is set for the input guardrail and the request contains PII, the request is not sent to the model server and 400 status code is returned; if 'BLOCK' is set for the output guardrail and the model response contains PII, the PII info in the response is redacted and 400 status code is returned."}},"additionalProperties":false,"required":["behavior"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayGuardrailPiiBehaviorBehavior":{"oneOf":[{"type":"string","description":"Behavior for PII filter. Currently only 'BLOCK' is supported. If 'BLOCK' is set for the input guardrail and the request contains PII, the request is not sent to the model server and 400 status code is returned; if 'BLOCK' is set for the output guardrail and the model response contains PII, the PII info in the response is redacted and 400 status code is returned.","enum":["NONE","BLOCK"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayGuardrails":{"oneOf":[{"type":"object","properties":{"input":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters","description":"Configuration for input guardrail filters."},"output":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters","description":"Configuration for output guardrail filters."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayInferenceTableConfig":{"oneOf":[{"type":"object","properties":{"catalog_name":{"$ref":"#/$defs/string","description":"The name of the catalog in Unity Catalog. Required when enabling inference tables. NOTE: On update, you have to disable inference table first in order to change the catalog name."},"enabled":{"$ref":"#/$defs/bool","description":"Indicates whether the inference table is enabled."},"schema_name":{"$ref":"#/$defs/string","description":"The name of the schema in Unity Catalog. Required when enabling inference tables. NOTE: On update, you have to disable inference table first in order to change the schema name."},"table_name_prefix":{"$ref":"#/$defs/string","description":"The prefix of the table in Unity Catalog. NOTE: On update, you have to disable inference table first in order to change the prefix name."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayRateLimit":{"oneOf":[{"type":"object","properties":{"calls":{"$ref":"#/$defs/int","description":"Used to specify how many calls are allowed for a key within the renewal_period."},"key":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey","description":"Key field for a rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified."},"renewal_period":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod","description":"Renewal period field for a rate limit. Currently, only 'minute' is supported."}},"additionalProperties":false,"required":["calls","renewal_period"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayRateLimitKey":{"oneOf":[{"type":"string","description":"Key field for a rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.","enum":["user","endpoint"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayRateLimitRenewalPeriod":{"oneOf":[{"type":"string","description":"Renewal period field for a rate limit. Currently, only 'minute' is supported.","enum":["minute"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayUsageTrackingConfig":{"oneOf":[{"type":"object","properties":{"enabled":{"$ref":"#/$defs/bool","description":"Whether to enable usage tracking."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AmazonBedrockConfig":{"oneOf":[{"type":"object","properties":{"aws_access_key_id":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for an AWS access key ID with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see `aws_access_key_id`. You must provide an API key using one of the following fields: `aws_access_key_id` or `aws_access_key_id_plaintext`."},"aws_access_key_id_plaintext":{"$ref":"#/$defs/string","description":"An AWS access key ID with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `aws_access_key_id`. You must provide an API key using one of the following fields: `aws_access_key_id` or `aws_access_key_id_plaintext`."},"aws_region":{"$ref":"#/$defs/string","description":"The AWS region to use. Bedrock has to be enabled there."},"aws_secret_access_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for an AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services. If you prefer to paste your API key directly, see `aws_secret_access_key_plaintext`. You must provide an API key using one of the following fields: `aws_secret_access_key` or `aws_secret_access_key_plaintext`."},"aws_secret_access_key_plaintext":{"$ref":"#/$defs/string","description":"An AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `aws_secret_access_key`. You must provide an API key using one of the following fields: `aws_secret_access_key` or `aws_secret_access_key_plaintext`."},"bedrock_provider":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedrockProvider","description":"The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon."}},"additionalProperties":false,"required":["aws_region","bedrock_provider"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AmazonBedrockConfigBedrockProvider":{"oneOf":[{"type":"string","description":"The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: Anthropic, Cohere, AI21Labs, Amazon.","enum":["anthropic","cohere","ai21labs","amazon"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AnthropicConfig":{"oneOf":[{"type":"object","properties":{"anthropic_api_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for an Anthropic API key. If you prefer to paste your API key directly, see `anthropic_api_key_plaintext`. You must provide an API key using one of the following fields: `anthropic_api_key` or `anthropic_api_key_plaintext`."},"anthropic_api_key_plaintext":{"$ref":"#/$defs/string","description":"The Anthropic API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `anthropic_api_key`. You must provide an API key using one of the following fields: `anthropic_api_key` or `anthropic_api_key_plaintext`."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AutoCaptureConfigInput":{"oneOf":[{"type":"object","properties":{"catalog_name":{"$ref":"#/$defs/string","description":"The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if the inference table is already enabled."},"enabled":{"$ref":"#/$defs/bool","description":"Indicates whether the inference table is enabled."},"schema_name":{"$ref":"#/$defs/string","description":"The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if the inference table is already enabled."},"table_name_prefix":{"$ref":"#/$defs/string","description":"The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if the inference table is already enabled."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.CohereConfig":{"oneOf":[{"type":"object","properties":{"cohere_api_base":{"$ref":"#/$defs/string","description":"This is an optional field to provide a customized base URL for the Cohere API. \nIf left unspecified, the standard Cohere base URL is used.\n"},"cohere_api_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for a Cohere API key. If you prefer to paste your API key directly, see `cohere_api_key_plaintext`. You must provide an API key using one of the following fields: `cohere_api_key` or `cohere_api_key_plaintext`."},"cohere_api_key_plaintext":{"$ref":"#/$defs/string","description":"The Cohere API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `cohere_api_key`. You must provide an API key using one of the following fields: `cohere_api_key` or `cohere_api_key_plaintext`."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.DatabricksModelServingConfig":{"oneOf":[{"type":"object","properties":{"databricks_api_token":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for a Databricks API token that corresponds to a user or service\nprincipal with Can Query access to the model serving endpoint pointed to by this external model.\nIf you prefer to paste your API key directly, see `databricks_api_token_plaintext`.\nYou must provide an API key using one of the following fields: `databricks_api_token` or `databricks_api_token_plaintext`.\n"},"databricks_api_token_plaintext":{"$ref":"#/$defs/string","description":"The Databricks API token that corresponds to a user or service\nprincipal with Can Query access to the model serving endpoint pointed to by this external model provided as a plaintext string.\nIf you prefer to reference your key using Databricks Secrets, see `databricks_api_token`.\nYou must provide an API key using one of the following fields: `databricks_api_token` or `databricks_api_token_plaintext`.\n"},"databricks_workspace_url":{"$ref":"#/$defs/string","description":"The URL of the Databricks workspace containing the model serving endpoint pointed to by this external model.\n"}},"additionalProperties":false,"required":["databricks_workspace_url"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.EndpointCoreConfigInput":{"oneOf":[{"type":"object","properties":{"auto_capture_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AutoCaptureConfigInput","description":"Configuration for Inference Tables which automatically logs requests and responses to Unity Catalog."},"served_entities":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput","description":"A list of served entities for the endpoint to serve. A serving endpoint can have up to 15 served entities."},"served_models":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput","description":"(Deprecated, use served_entities instead) A list of served models for the endpoint to serve. A serving endpoint can have up to 15 served models."},"traffic_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig","description":"The traffic config defining how invocations to the serving endpoint should be routed."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.EndpointTag":{"oneOf":[{"type":"object","properties":{"key":{"$ref":"#/$defs/string","description":"Key field for a serving endpoint tag."},"value":{"$ref":"#/$defs/string","description":"Optional value field for a serving endpoint tag."}},"additionalProperties":false,"required":["key"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ExternalModel":{"oneOf":[{"type":"object","properties":{"ai21labs_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig","description":"AI21Labs Config. Only required if the provider is 'ai21labs'."},"amazon_bedrock_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfig","description":"Amazon Bedrock Config. Only required if the provider is 'amazon-bedrock'."},"anthropic_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig","description":"Anthropic Config. Only required if the provider is 'anthropic'."},"cohere_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CohereConfig","description":"Cohere Config. Only required if the provider is 'cohere'."},"databricks_model_serving_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.DatabricksModelServingConfig","description":"Databricks Model Serving Config. Only required if the provider is 'databricks-model-serving'."},"google_cloud_vertex_ai_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.GoogleCloudVertexAiConfig","description":"Google Cloud Vertex AI Config. Only required if the provider is 'google-cloud-vertex-ai'."},"name":{"$ref":"#/$defs/string","description":"The name of the external model."},"openai_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.OpenAiConfig","description":"OpenAI Config. Only required if the provider is 'openai'."},"palm_config":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.PaLmConfig","description":"PaLM Config. Only required if the provider is 'palm'."},"provider":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider","description":"The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic',\n'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', and 'palm'.\",\n"},"task":{"$ref":"#/$defs/string","description":"The task type of the external model."}},"additionalProperties":false,"required":["name","provider","task"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ExternalModelProvider":{"oneOf":[{"type":"string","description":"The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic',\n'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', and 'palm'.\",\n","enum":["ai21labs","anthropic","amazon-bedrock","cohere","databricks-model-serving","google-cloud-vertex-ai","openai","palm"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.GoogleCloudVertexAiConfig":{"oneOf":[{"type":"object","properties":{"private_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for a private key for the service account which has access to the Google Cloud Vertex AI Service. See [Best practices for managing service account keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys). If you prefer to paste your API key directly, see `private_key_plaintext`. You must provide an API key using one of the following fields: `private_key` or `private_key_plaintext`"},"private_key_plaintext":{"$ref":"#/$defs/string","description":"The private key for the service account which has access to the Google Cloud Vertex AI Service provided as a plaintext secret. See [Best practices for managing service account keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys). If you prefer to reference your key using Databricks Secrets, see `private_key`. You must provide an API key using one of the following fields: `private_key` or `private_key_plaintext`."},"project_id":{"$ref":"#/$defs/string","description":"This is the Google Cloud project id that the service account is associated with."},"region":{"$ref":"#/$defs/string","description":"This is the region for the Google Cloud Vertex AI Service. See [supported regions](https://cloud.google.com/vertex-ai/docs/general/locations) for more details. Some models are only available in specific regions."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.OpenAiConfig":{"oneOf":[{"type":"object","properties":{"microsoft_entra_client_id":{"$ref":"#/$defs/string","description":"This field is only required for Azure AD OpenAI and is the Microsoft Entra Client ID.\n"},"microsoft_entra_client_secret":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for a client secret used for Microsoft Entra ID authentication.\nIf you prefer to paste your client secret directly, see `microsoft_entra_client_secret_plaintext`.\nYou must provide an API key using one of the following fields: `microsoft_entra_client_secret` or `microsoft_entra_client_secret_plaintext`.\n"},"microsoft_entra_client_secret_plaintext":{"$ref":"#/$defs/string","description":"The client secret used for Microsoft Entra ID authentication provided as a plaintext string.\nIf you prefer to reference your key using Databricks Secrets, see `microsoft_entra_client_secret`.\nYou must provide an API key using one of the following fields: `microsoft_entra_client_secret` or `microsoft_entra_client_secret_plaintext`.\n"},"microsoft_entra_tenant_id":{"$ref":"#/$defs/string","description":"This field is only required for Azure AD OpenAI and is the Microsoft Entra Tenant ID.\n"},"openai_api_base":{"$ref":"#/$defs/string","description":"This is a field to provide a customized base URl for the OpenAI API.\nFor Azure OpenAI, this field is required, and is the base URL for the Azure OpenAI API service\nprovided by Azure.\nFor other OpenAI API types, this field is optional, and if left unspecified, the standard OpenAI base URL is used.\n"},"openai_api_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for an OpenAI API key using the OpenAI or Azure service. If you prefer to paste your API key directly, see `openai_api_key_plaintext`. You must provide an API key using one of the following fields: `openai_api_key` or `openai_api_key_plaintext`."},"openai_api_key_plaintext":{"$ref":"#/$defs/string","description":"The OpenAI API key using the OpenAI or Azure service provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `openai_api_key`. You must provide an API key using one of the following fields: `openai_api_key` or `openai_api_key_plaintext`."},"openai_api_type":{"$ref":"#/$defs/string","description":"This is an optional field to specify the type of OpenAI API to use.\nFor Azure OpenAI, this field is required, and adjust this parameter to represent the preferred security\naccess validation protocol. For access token validation, use azure. For authentication using Azure Active\nDirectory (Azure AD) use, azuread.\n"},"openai_api_version":{"$ref":"#/$defs/string","description":"This is an optional field to specify the OpenAI API version.\nFor Azure OpenAI, this field is required, and is the version of the Azure OpenAI service to\nutilize, specified by a date.\n"},"openai_deployment_name":{"$ref":"#/$defs/string","description":"This field is only required for Azure OpenAI and is the name of the deployment resource for the\nAzure OpenAI service.\n"},"openai_organization":{"$ref":"#/$defs/string","description":"This is an optional field to specify the organization in OpenAI or Azure OpenAI.\n"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.PaLmConfig":{"oneOf":[{"type":"object","properties":{"palm_api_key":{"$ref":"#/$defs/string","description":"The Databricks secret key reference for a PaLM API key. If you prefer to paste your API key directly, see `palm_api_key_plaintext`. You must provide an API key using one of the following fields: `palm_api_key` or `palm_api_key_plaintext`."},"palm_api_key_plaintext":{"$ref":"#/$defs/string","description":"The PaLM API key provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see `palm_api_key`. You must provide an API key using one of the following fields: `palm_api_key` or `palm_api_key_plaintext`."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.RateLimit":{"oneOf":[{"type":"object","properties":{"calls":{"$ref":"#/$defs/int","description":"Used to specify how many calls are allowed for a key within the renewal_period."},"key":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey","description":"Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified."},"renewal_period":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod","description":"Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported."}},"additionalProperties":false,"required":["calls","renewal_period"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.RateLimitKey":{"oneOf":[{"type":"string","description":"Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.","enum":["user","endpoint"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.RateLimitRenewalPeriod":{"oneOf":[{"type":"string","description":"Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported.","enum":["minute"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.Route":{"oneOf":[{"type":"object","properties":{"served_model_name":{"$ref":"#/$defs/string","description":"The name of the served model this route configures traffic for."},"traffic_percentage":{"$ref":"#/$defs/int","description":"The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive."}},"additionalProperties":false,"required":["served_model_name","traffic_percentage"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedEntityInput":{"oneOf":[{"type":"object","properties":{"entity_name":{"$ref":"#/$defs/string","description":"The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC),\nor a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of\n__catalog_name__.__schema_name__.__model_name__.\n"},"entity_version":{"$ref":"#/$defs/string","description":"The version of the model in Databricks Model Registry to be served or empty if the entity is a FEATURE_SPEC."},"environment_vars":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity.\nNote: this is an experimental feature and subject to change. \nExample entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`"},"external_model":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModel","description":"The external model to be served. NOTE: Only one of external_model and (entity_name, entity_version, workload_size, workload_type, and scale_to_zero_enabled)\ncan be specified with the latter set being used for custom model serving for a Databricks registered model. For an existing endpoint with external_model,\nit cannot be updated to an endpoint without external_model. If the endpoint is created without external_model, users cannot update it to add external_model later.\nThe task type of all external models within an endpoint must be the same.\n"},"instance_profile_arn":{"$ref":"#/$defs/string","description":"ARN of the instance profile that the served entity uses to access AWS resources."},"max_provisioned_throughput":{"$ref":"#/$defs/int","description":"The maximum tokens per second that the endpoint can scale up to."},"min_provisioned_throughput":{"$ref":"#/$defs/int","description":"The minimum tokens per second that the endpoint can scale down to."},"name":{"$ref":"#/$defs/string","description":"The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores.\nIf not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other\nentities, it defaults to <entity-name>-<entity-version>.\n"},"scale_to_zero_enabled":{"$ref":"#/$defs/bool","description":"Whether the compute resources for the served entity should scale down to zero."},"workload_size":{"$ref":"#/$defs/string","description":"The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between.\nA single unit of provisioned concurrency can process one request at a time.\nValid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency).\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0.\n"},"workload_type":{"$ref":"#/$defs/string","description":"The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\n\"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\n"}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedModelInput":{"oneOf":[{"type":"object","properties":{"environment_vars":{"$ref":"#/$defs/map/string","description":"An object containing a set of optional, user-specified environment variable key-value pairs used for serving this model.\nNote: this is an experimental feature and subject to change. \nExample model environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`"},"instance_profile_arn":{"$ref":"#/$defs/string","description":"ARN of the instance profile that the served model will use to access AWS resources."},"max_provisioned_throughput":{"$ref":"#/$defs/int","description":"The maximum tokens per second that the endpoint can scale up to."},"min_provisioned_throughput":{"$ref":"#/$defs/int","description":"The minimum tokens per second that the endpoint can scale down to."},"model_name":{"$ref":"#/$defs/string","description":"The name of the model in Databricks Model Registry to be served or if the model resides in Unity Catalog, the full name of model,\nin the form of __catalog_name__.__schema_name__.__model_name__.\n"},"model_version":{"$ref":"#/$defs/string","description":"The version of the model in Databricks Model Registry or Unity Catalog to be served."},"name":{"$ref":"#/$defs/string","description":"The name of a served model. It must be unique across an endpoint. If not specified, this field will default to <model-name>-<model-version>.\nA served model name can consist of alphanumeric characters, dashes, and underscores.\n"},"scale_to_zero_enabled":{"$ref":"#/$defs/bool","description":"Whether the compute resources for the served model should scale down to zero."},"workload_size":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadSize","description":"The workload size of the served model. The workload size corresponds to a range of provisioned concurrency that the compute will autoscale between.\nA single unit of provisioned concurrency can process one request at a time.\nValid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency).\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size will be 0.\n"},"workload_type":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadType","description":"The workload type of the served model. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\n\"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\n"}},"additionalProperties":false,"required":["model_name","model_version","scale_to_zero_enabled"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedModelInputWorkloadSize":{"oneOf":[{"type":"string","description":"The workload size of the served model. The workload size corresponds to a range of provisioned concurrency that the compute will autoscale between.\nA single unit of provisioned concurrency can process one request at a time.\nValid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency).\nIf scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size will be 0.\n","enum":["Small","Medium","Large"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedModelInputWorkloadType":{"oneOf":[{"type":"string","description":"The workload type of the served model. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is\n\"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others.\nSee the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\n","enum":["CPU","GPU_SMALL","GPU_MEDIUM","GPU_LARGE","MULTIGPU_MEDIUM"]},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.TrafficConfig":{"oneOf":[{"type":"object","properties":{"routes":{"$ref":"#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.Route","description":"The list of routes that define traffic to each served entity."}},"additionalProperties":false},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}}}}},"int":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"\\$\\{(resources(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(bundle(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(workspace(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(artifacts(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"int64":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"\\$\\{(resources(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(bundle(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(workspace(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(artifacts(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"interface":{},"map":{"github.com":{"databricks":{"cli":{"bundle":{"config":{"resources.App":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.App"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Cluster":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Cluster"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Dashboard":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Dashboard"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Job":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Job"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.MlflowExperiment":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowExperiment"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.MlflowModel":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowModel"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.ModelServingEndpoint":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Pipeline":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Pipeline"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.QualityMonitor":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.QualityMonitor"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.RegisteredModel":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.RegisteredModel"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Schema":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Schema"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Volume":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Volume"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"variable.TargetVariable":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.TargetVariable"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"variable.Variable":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/variable.Variable"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}},"config.Artifact":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Artifact"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Command":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Command"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"config.Target":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Target"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}}}}},"interface":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/interface"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"string":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/$defs/string"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}},"slice":{"github.com":{"databricks":{"cli":{"bundle":{"config":{"resources.Grant":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Grant"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"resources.Permission":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config/resources.Permission"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}},"config.ArtifactFile":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.ArtifactFile"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}}},"databricks-sdk-go":{"service":{"apps.AppResource":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResource"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"catalog.MonitorMetric":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.InitScriptInfo":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"compute.Library":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Library"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobCluster":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobEnvironment":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobParameterDefinition":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.JobsHealthRule":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.SqlTaskSubscription":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Task":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.TaskDependency":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"jobs.Webhook":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Webhook"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ExperimentTag":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelTag":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelTag"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelVersion":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersion"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"ml.ModelVersionTag":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelVersionTag"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.DayOfWeek":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.IngestionConfig":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.Notifications":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineCluster":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"pipelines.PipelineLibrary":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.AiGatewayRateLimit":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.EndpointTag":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.RateLimit":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimit"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.Route":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Route"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedEntityInput":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]},"serving.ServedModelInput":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}}}}},"string":{"oneOf":[{"type":"array","items":{"$ref":"#/$defs/string"}},{"type":"string","pattern":"\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}"}]}},"string":{"type":"string"}},"type":"object","properties":{"artifacts":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config.Artifact","description":"Defines the attributes to build an artifact"},"bundle":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Bundle","description":"The attributes of the bundle.","markdownDescription":"The attributes of the bundle. See [bundle](https://docs.databricks.com/dev-tools/bundles/settings.html#bundle)"},"experimental":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Experimental","description":"Defines attributes for experimental features."},"include":{"$ref":"#/$defs/slice/string","description":"Specifies a list of path globs that contain configuration files to include within the bundle.","markdownDescription":"Specifies a list of path globs that contain configuration files to include within the bundle. See [include](https://docs.databricks.com/dev-tools/bundles/settings.html#include)"},"permissions":{"$ref":"#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission","description":"Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle","markdownDescription":"Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [permissions](https://docs.databricks.com/dev-tools/bundles/settings.html#permissions) and [link](https://docs.databricks.com/dev-tools/bundles/permissions.html)."},"presets":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Presets","description":"Defines bundle deployment presets.","markdownDescription":"Defines bundle deployment presets. See [presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#presets)."},"resources":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Resources","description":"Specifies information about the Databricks resources used by the bundle","markdownDescription":"Specifies information about the Databricks resources used by the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/resources.html)."},"run_as":{"$ref":"#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs","description":"The identity to use to run the bundle."},"sync":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Sync","description":"The files and file paths to include or exclude in the bundle.","markdownDescription":"The files and file paths to include or exclude in the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/)"},"targets":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config.Target","description":"Defines deployment targets for the bundle."},"variables":{"$ref":"#/$defs/map/github.com/databricks/cli/bundle/config/variable.Variable","description":"A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable."},"workspace":{"$ref":"#/$defs/github.com/databricks/cli/bundle/config.Workspace","description":"Defines the Databricks workspace for the bundle."}},"additionalProperties":{}}
|
Provide a JSON object that satisfies the schema "databricks-asset-bundles". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
databricks-asset-bundles
|
schema-store
|
schema_store_241
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"DataContractSpecification\",\"properties\":{\"dataContractSpecification\":{\"type\":\"string\",\"title\":\"DataContractSpecificationVersion\",\"enum\":[\"1.1.0\",\"0.9.3\",\"0.9.2\",\"0.9.1\",\"0.9.0\"],\"description\":\"Specifies the Data Contract Specification being used.\"},\"id\":{\"type\":\"string\",\"description\":\"Specifies the identifier of the data contract.\"},\"info\":{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"The title of the data contract.\"},\"version\":{\"type\":\"string\",\"description\":\"The version of the data contract document (which is distinct from the Data Contract Specification version or the Data Product implementation version).\"},\"status\":{\"type\":\"string\",\"description\":\"The status of the data contract. Can be proposed, in development, active, retired.\",\"examples\":[\"proposed\",\"in development\",\"active\",\"deprecated\",\"retired\"]},\"description\":{\"type\":\"string\",\"description\":\"A description of the data contract.\"},\"owner\":{\"type\":\"string\",\"description\":\"The owner or team responsible for managing the data contract and providing the data.\"},\"contact\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The identifying name of the contact person/organization.\"},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The URL pointing to the contact information. This MUST be in the form of a URL.\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address of the contact person/organization. This MUST be in the form of an email address.\"}},\"description\":\"Contact information for the data contract.\",\"additionalProperties\":true}},\"additionalProperties\":true,\"required\":[\"title\",\"version\"],\"description\":\"Metadata and life cycle information about the data contract.\"},\"servers\":{\"type\":\"object\",\"description\":\"Information about the servers.\",\"additionalProperties\":{\"$ref\":\"#/$defs/BaseServer\",\"allOf\":[{\"if\":{\"properties\":{\"type\":{\"const\":\"bigquery\"}}},\"then\":{\"$ref\":\"#/$defs/BigQueryServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"postgres\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/PostgresServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"s3\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/S3Server\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"sftp\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/SftpServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"redshift\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/RedshiftServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"azure\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/AzureServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"sqlserver\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/SqlserverServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"snowflake\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/SnowflakeServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"databricks\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/DatabricksServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"dataframe\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/DataframeServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"glue\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/GlueServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"postgres\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/PostgresServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"oracle\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/OracleServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"kafka\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/KafkaServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"pubsub\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/PubSubServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"kinesis\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/KinesisDataStreamsServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"trino\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/TrinoServer\"}},{\"if\":{\"properties\":{\"type\":{\"const\":\"local\"}},\"required\":[\"type\"]},\"then\":{\"$ref\":\"#/$defs/LocalServer\"}}]}},\"terms\":{\"type\":\"object\",\"description\":\"The terms and conditions of the data contract.\",\"properties\":{\"usage\":{\"type\":\"string\",\"description\":\"The usage describes the way the data is expected to be used. Can contain business and technical information.\"},\"limitations\":{\"type\":\"string\",\"description\":\"The limitations describe the restrictions on how the data can be used, can be technical or restrictions on what the data may not be used for.\"},\"policies\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of the policy.\",\"examples\":[\"privacy\",\"security\",\"retention\",\"compliance\"]},\"description\":{\"type\":\"string\",\"description\":\"A description of the policy.\"},\"url\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"A URL to the policy document.\"}},\"additionalProperties\":true},\"description\":\"The limitations describe the restrictions on how the data can be used, can be technical or restrictions on what the data may not be used for.\"},\"billing\":{\"type\":\"string\",\"description\":\"The billing describes the pricing model for using the data, such as whether it's free, having a monthly fee, or metered pay-per-use.\"},\"noticePeriod\":{\"type\":\"string\",\"description\":\"The period of time that must be given by either party to terminate or modify a data usage agreement. Uses ISO-8601 period format, e.g., 'P3M' for a period of three months.\"}},\"additionalProperties\":true},\"models\":{\"description\":\"Specifies the logical data model. Use the models name (e.g., the table name) as the key.\",\"type\":\"object\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"additionalProperties\":{\"type\":\"object\",\"title\":\"Model\",\"properties\":{\"description\":{\"type\":\"string\"},\"type\":{\"description\":\"The type of the model. Examples: table, view, object. Default: table.\",\"type\":\"string\",\"title\":\"ModelType\",\"default\":\"table\",\"enum\":[\"table\",\"view\",\"object\"]},\"title\":{\"type\":\"string\",\"description\":\"An optional string providing a human readable name for the model. Especially useful if the model name is cryptic or contains abbreviations.\",\"examples\":[\"Purchase Orders\",\"Air Shipments\"]},\"fields\":{\"description\":\"Specifies a field in the data model. Use the field name (e.g., the column name) as the key.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"title\":\"Field\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the semantic of the data in this field.\"},\"title\":{\"type\":\"string\",\"description\":\"An optional string providing a human readable name for the field. Especially useful if the field name is cryptic or contains abbreviations.\"},\"type\":{\"$ref\":\"#/$defs/FieldType\"},\"required\":{\"type\":\"boolean\",\"default\":false,\"description\":\"An indication, if this field must contain a value and may not be null.\"},\"fields\":{\"description\":\"The nested fields (e.g. columns) of the object, record, or struct.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"}},\"items\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"keys\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"values\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"primary\":{\"type\":\"boolean\",\"deprecationMessage\":\"Use the primaryKey field instead.\"},\"primaryKey\":{\"type\":\"boolean\",\"default\":false,\"description\":\"If this field is a primary key.\"},\"references\":{\"type\":\"string\",\"description\":\"The reference to a field in another model. E.g. use 'orders.order_id' to reference the order_id field of the model orders. Think of defining a foreign key relationship.\",\"examples\":[\"orders.order_id\",\"model.nested_field.field\"]},\"unique\":{\"type\":\"boolean\",\"default\":false,\"description\":\"An indication, if the value must be unique within the model.\"},\"enum\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true,\"description\":\"A value must be equal to one of the elements in this array value. Only evaluated if the value is not null.\"},\"minLength\":{\"type\":\"integer\",\"description\":\"A value must greater than, or equal to, the value of this. Only applies to string types.\"},\"maxLength\":{\"type\":\"integer\",\"description\":\"A value must less than, or equal to, the value of this. Only applies to string types.\"},\"format\":{\"type\":\"string\",\"description\":\"A specific format the value must comply with (e.g., 'email', 'uri', 'uuid').\",\"examples\":[\"email\",\"uri\",\"uuid\"]},\"precision\":{\"type\":\"number\",\"examples\":[38],\"description\":\"The maximum number of digits in a number. Only applies to numeric values. Defaults to 38.\"},\"scale\":{\"type\":\"number\",\"examples\":[0],\"description\":\"The maximum number of decimal places in a number. Only applies to numeric values. Defaults to 0.\"},\"pattern\":{\"type\":\"string\",\"description\":\"A regular expression the value must match. Only applies to string types.\",\"examples\":[\"^[a-zA-Z0-9_-]+$\"]},\"minimum\":{\"type\":\"number\",\"description\":\"A value of a number must greater than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"exclusiveMinimum\":{\"type\":\"number\",\"description\":\"A value of a number must greater than the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"maximum\":{\"type\":\"number\",\"description\":\"A value of a number must less than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"exclusiveMaximum\":{\"type\":\"number\",\"description\":\"A value of a number must less than the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"example\":{\"type\":\"string\",\"description\":\"An example value for this field.\",\"deprecationMessage\":\"Use the examples field instead.\"},\"examples\":{\"type\":\"array\",\"description\":\"A examples value for this field.\"},\"pii\":{\"type\":\"boolean\",\"description\":\"An indication, if this field contains Personal Identifiable Information (PII).\"},\"classification\":{\"type\":\"string\",\"description\":\"The data class defining the sensitivity level for this field, according to the organization's classification scheme.\",\"examples\":[\"sensitive\",\"restricted\",\"internal\",\"public\"]},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Custom metadata to provide additional context.\"},\"links\":{\"type\":\"object\",\"description\":\"Links to external resources.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"additionalProperties\":{\"type\":\"string\",\"title\":\"Link\",\"description\":\"A URL to an external resource.\",\"format\":\"uri\",\"examples\":[\"https://example.com\"]}},\"$ref\":{\"type\":\"string\",\"description\":\"A reference URI to a definition in the specification, internally or externally. Properties will be inherited from the definition.\"},\"quality\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Quality\"}},\"lineage\":{\"$ref\":\"#/$defs/Lineage\"},\"config\":{\"type\":\"object\",\"description\":\"Additional metadata for field configuration.\",\"additionalProperties\":{\"type\":[\"string\",\"number\",\"boolean\",\"object\",\"array\",\"null\"]},\"properties\":{\"avroType\":{\"type\":\"string\",\"description\":\"Specify the field type to use when exporting the data model to Apache Avro.\"},\"avroLogicalType\":{\"type\":\"string\",\"description\":\"Specify the logical field type to use when exporting the data model to Apache Avro.\"},\"bigqueryType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in a BigQuery table, e.g., `NUMERIC(5, 2)`.\"},\"snowflakeType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in a Snowflake table, e.g., `TIMESTAMP_LTZ`.\"},\"redshiftType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in a Redshift table, e.g., `SMALLINT`.\"},\"sqlserverType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in a SQL Server table, e.g., `DATETIME2`.\"},\"databricksType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in a Databricks Unity Catalog table.\"},\"glueType\":{\"type\":\"string\",\"description\":\"Specify the physical column type that is used in an AWS Glue Data Catalog table.\"}}}}}},\"primaryKey\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"The compound primary key of the model.\"},\"quality\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/Quality\"}},\"examples\":{\"type\":\"array\"},\"config\":{\"type\":\"object\",\"description\":\"Additional metadata for model configuration.\",\"additionalProperties\":{\"type\":[\"string\",\"number\",\"boolean\",\"object\",\"array\",\"null\"]},\"properties\":{\"avroNamespace\":{\"type\":\"string\",\"description\":\"The namespace to use when importing and exporting the data model from / to Apache Avro.\"}}}}}},\"definitions\":{\"description\":\"Clear and concise explanations of syntax, semantic, and classification of business objects in a given domain.\",\"type\":\"object\",\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9/_-]+$\"},\"additionalProperties\":{\"type\":\"object\",\"title\":\"Definition\",\"properties\":{\"domain\":{\"type\":\"string\",\"description\":\"The domain in which this definition is valid.\",\"default\":\"global\",\"deprecationMessage\":\"This field is deprecated. Encode the domain into the ID using slashes.\"},\"name\":{\"type\":\"string\",\"description\":\"The technical name of this definition.\",\"deprecationMessage\":\"This field is deprecated. Encode the name into the ID using slashes.\"},\"title\":{\"type\":\"string\",\"description\":\"The business name of this definition.\"},\"description\":{\"type\":\"string\",\"description\":\"Clear and concise explanations related to the domain.\"},\"type\":{\"$ref\":\"#/$defs/FieldType\"},\"fields\":{\"description\":\"The nested fields (e.g. columns) of the object, record, or struct.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"}},\"items\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"keys\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"values\":{\"$ref\":\"#/properties/models/additionalProperties/properties/fields/additionalProperties\"},\"minLength\":{\"type\":\"integer\",\"description\":\"A value must be greater than or equal to this value. Applies only to string types.\"},\"maxLength\":{\"type\":\"integer\",\"description\":\"A value must be less than or equal to this value. Applies only to string types.\"},\"format\":{\"type\":\"string\",\"description\":\"Specific format requirements for the value (e.g., 'email', 'uri', 'uuid').\"},\"precision\":{\"type\":\"integer\",\"examples\":[38],\"description\":\"The maximum number of digits in a number. Only applies to numeric values. Defaults to 38.\"},\"scale\":{\"type\":\"integer\",\"examples\":[0],\"description\":\"The maximum number of decimal places in a number. Only applies to numeric values. Defaults to 0.\"},\"pattern\":{\"type\":\"string\",\"description\":\"A regular expression pattern the value must match. Applies only to string types.\"},\"minimum\":{\"type\":\"number\",\"description\":\"A value of a number must greater than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"exclusiveMinimum\":{\"type\":\"number\",\"description\":\"A value of a number must greater than the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"maximum\":{\"type\":\"number\",\"description\":\"A value of a number must less than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"exclusiveMaximum\":{\"type\":\"number\",\"description\":\"A value of a number must less than the value of this. Only evaluated if the value is not null. Only applies to numeric values.\"},\"example\":{\"type\":\"string\",\"description\":\"An example value.\",\"deprecationMessage\":\"Use the examples field instead.\"},\"examples\":{\"type\":\"array\",\"description\":\"Example value.\"},\"pii\":{\"type\":\"boolean\",\"description\":\"Indicates if the field contains Personal Identifiable Information (PII).\"},\"classification\":{\"type\":\"string\",\"description\":\"The data class defining the sensitivity level for this field.\"},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Custom metadata to provide additional context.\"},\"links\":{\"type\":\"object\",\"description\":\"Links to external resources.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"additionalProperties\":{\"type\":\"string\",\"title\":\"Link\",\"description\":\"A URL to an external resource.\",\"format\":\"uri\",\"examples\":[\"https://example.com\"]}}},\"required\":[\"type\"]}},\"servicelevels\":{\"type\":\"object\",\"description\":\"Specifies the service level agreements for the provided data, including availability, data retention policies, latency requirements, data freshness, update frequency, support availability, and backup policies.\",\"properties\":{\"availability\":{\"type\":\"object\",\"description\":\"Availability refers to the promise or guarantee by the service provider about the uptime of the system that provides the data.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the availability service level.\",\"example\":\"The server is available during support hours\"},\"percentage\":{\"type\":\"string\",\"description\":\"An optional string describing the guaranteed uptime in percent (e.g., `99.9%`)\",\"pattern\":\"^\\\\d+(\\\\.\\\\d+)?%$\",\"example\":\"99.9%\"}}},\"retention\":{\"type\":\"object\",\"description\":\"Retention covers the period how long data will be available.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the retention service level.\",\"example\":\"Data is retained for one year.\"},\"period\":{\"type\":\"string\",\"description\":\"An optional period of time, how long data is available. Supported formats: Simple duration (e.g., `1 year`, `30d`) and ISO 8601 duration (e.g, `P1Y`).\",\"example\":\"P1Y\"},\"unlimited\":{\"type\":\"boolean\",\"description\":\"An optional indicator that data is kept forever.\",\"example\":false},\"timestampField\":{\"type\":\"string\",\"description\":\"An optional reference to the field that contains the timestamp that the period refers to.\",\"example\":\"orders.order_timestamp\"}}},\"latency\":{\"type\":\"object\",\"description\":\"Latency refers to the maximum amount of time from the source to its destination.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the latency service level.\",\"example\":\"Data is available within 25 hours after the order was placed.\"},\"threshold\":{\"type\":\"string\",\"description\":\"An optional maximum duration between the source timestamp and the processed timestamp. Supported formats: Simple duration (e.g., `24 hours`, `5s`) and ISO 8601 duration (e.g, `PT24H`).\",\"example\":\"25h\"},\"sourceTimestampField\":{\"type\":\"string\",\"description\":\"An optional reference to the field that contains the timestamp when the data was provided at the source.\",\"example\":\"orders.order_timestamp\"},\"processedTimestampField\":{\"type\":\"string\",\"description\":\"An optional reference to the field that contains the processing timestamp, which denotes when the data is made available to consumers of this data contract.\",\"example\":\"orders.processed_timestamp\"}}},\"freshness\":{\"type\":\"object\",\"description\":\"The maximum age of the youngest row in a table.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the freshness service level.\",\"example\":\"The age of the youngest row in a table is within 25 hours.\"},\"threshold\":{\"type\":\"string\",\"description\":\"An optional maximum age of the youngest entry. Supported formats: Simple duration (e.g., `24 hours`, `5s`) and ISO 8601 duration (e.g., `PT24H`).\",\"example\":\"25h\"},\"timestampField\":{\"type\":\"string\",\"description\":\"An optional reference to the field that contains the timestamp that the threshold refers to.\",\"example\":\"orders.order_timestamp\"}}},\"frequency\":{\"type\":\"object\",\"description\":\"Frequency describes how often data is updated.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the frequency service level.\",\"example\":\"Data is delivered once a day.\"},\"type\":{\"type\":\"string\",\"enum\":[\"batch\",\"micro-batching\",\"streaming\",\"manual\"],\"description\":\"The method of data processing.\",\"example\":\"batch\"},\"interval\":{\"type\":\"string\",\"description\":\"Optional. Only for batch: How often the pipeline is triggered, e.g., `daily`.\",\"example\":\"daily\"},\"cron\":{\"type\":\"string\",\"description\":\"Optional. Only for batch: A cron expression when the pipelines is triggered. E.g., `0 0 * * *`.\",\"example\":\"0 0 * * *\"}}},\"support\":{\"type\":\"object\",\"description\":\"Support describes the times when support will be available for contact.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the support service level.\",\"example\":\"The data is available during typical business hours at headquarters.\"},\"time\":{\"type\":\"string\",\"description\":\"An optional string describing the times when support will be available for contact such as `24/7` or `business hours only`.\",\"example\":\"9am to 5pm in EST on business days\"},\"responseTime\":{\"type\":\"string\",\"description\":\"An optional string describing the time it takes for the support team to acknowledge a request. This does not mean the issue will be resolved immediately, but it assures users that their request has been received and will be dealt with.\",\"example\":\"24 hours\"}}},\"backup\":{\"type\":\"object\",\"description\":\"Backup specifies details about data backup procedures.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the backup service level.\",\"example\":\"Data is backed up once a week, every Sunday at 0:00 UTC.\"},\"interval\":{\"type\":\"string\",\"description\":\"An optional interval that defines how often data will be backed up, e.g., `daily`.\",\"example\":\"weekly\"},\"cron\":{\"type\":\"string\",\"description\":\"An optional cron expression when data will be backed up, e.g., `0 0 * * *`.\",\"example\":\"0 0 * * 0\"},\"recoveryTime\":{\"type\":\"string\",\"description\":\"An optional Recovery Time Objective (RTO) specifies the maximum amount of time allowed to restore data from a backup after a failure or loss event (e.g., 4 hours, 24 hours).\",\"example\":\"24 hours\"},\"recoveryPoint\":{\"type\":\"string\",\"description\":\"An optional Recovery Point Objective (RPO) defines the maximum acceptable age of files that must be recovered from backup storage for normal operations to resume after a disaster or data loss event. This essentially measures how much data you can afford to lose, measured in time (e.g., 4 hours, 24 hours).\",\"example\":\"1 week\"}}}}},\"links\":{\"type\":\"object\",\"description\":\"Links to external resources.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"additionalProperties\":{\"type\":\"string\",\"title\":\"Link\",\"description\":\"A URL to an external resource.\",\"format\":\"uri\",\"examples\":[\"https://example.com\"]}},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Tags to facilitate searching and filtering.\",\"examples\":[\"databricks\",\"pii\",\"sensitive\"]},\"description\":\"Tags to facilitate searching and filtering.\"}},\"required\":[\"dataContractSpecification\",\"id\",\"info\"],\"$defs\":{\"FieldType\":{\"type\":\"string\",\"title\":\"FieldType\",\"description\":\"The logical data type of the field.\",\"enum\":[\"number\",\"decimal\",\"numeric\",\"int\",\"integer\",\"long\",\"bigint\",\"float\",\"double\",\"string\",\"text\",\"varchar\",\"boolean\",\"timestamp\",\"timestamp_tz\",\"timestamp_ntz\",\"date\",\"array\",\"map\",\"object\",\"record\",\"struct\",\"bytes\",\"null\"]},\"BaseServer\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"An optional string describing the servers.\"},\"environment\":{\"type\":\"string\",\"description\":\"The environment in which the servers are running. Examples: prod, sit, stg.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the data product technology that implements the data contract.\",\"enum\":[\"bigquery\",\"BigQuery\",\"s3\",\"sftp\",\"redshift\",\"azure\",\"sqlserver\",\"snowflake\",\"databricks\",\"dataframe\",\"glue\",\"postgres\",\"oracle\",\"kafka\",\"pubsub\",\"kinesis\",\"trino\",\"local\"]},\"roles\":{\"description\":\" An optional array of roles that are available and can be requested to access the server for role-based access control. E.g. separate roles for different regions or sensitive data.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the role.\"},\"description\":{\"type\":\"string\",\"description\":\"A description of the role and what access the role provides.\"}},\"required\":[\"name\"]}}},\"additionalProperties\":true,\"required\":[\"type\"]},\"BigQueryServer\":{\"type\":\"object\",\"title\":\"BigQueryServer\",\"properties\":{\"project\":{\"type\":\"string\",\"description\":\"The GCP project name.\"},\"dataset\":{\"type\":\"string\",\"description\":\"The GCP dataset name.\"}},\"required\":[\"project\",\"dataset\"]},\"S3Server\":{\"type\":\"object\",\"title\":\"S3Server\",\"properties\":{\"location\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"S3 URL, starting with `s3://`\",\"examples\":[\"s3://datacontract-example-orders-latest/data/{model}/*.json\"]},\"endpointUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The server endpoint for S3-compatible servers.\",\"examples\":[\"https://minio.example.com\"]},\"format\":{\"type\":\"string\",\"enum\":[\"parquet\",\"delta\",\"json\",\"csv\"],\"description\":\"File format.\"},\"delimiter\":{\"type\":\"string\",\"enum\":[\"new_line\",\"array\"],\"description\":\"Only for format = json. How multiple json documents are delimited within one file\"}},\"required\":[\"location\"]},\"SftpServer\":{\"type\":\"object\",\"title\":\"SftpServer\",\"properties\":{\"location\":{\"type\":\"string\",\"format\":\"uri\",\"pattern\":\"^sftp://.*\",\"description\":\"SFTP URL, starting with `sftp://`\",\"examples\":[\"sftp://123.123.12.123/{model}/*.json\"]},\"format\":{\"type\":\"string\",\"enum\":[\"parquet\",\"delta\",\"json\",\"csv\"],\"description\":\"File format.\"},\"delimiter\":{\"type\":\"string\",\"enum\":[\"new_line\",\"array\"],\"description\":\"Only for format = json. How multiple json documents are delimited within one file\"}},\"required\":[\"location\"]},\"RedshiftServer\":{\"type\":\"object\",\"title\":\"RedshiftServer\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"},\"host\":{\"type\":\"string\",\"description\":\"An optional string describing the host name.\"},\"database\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"},\"schema\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"},\"clusterIdentifier\":{\"type\":\"string\",\"description\":\"An optional string describing the cluster's identifier.\",\"examples\":[\"redshift-prod-eu\",\"analytics-cluster\"]},\"port\":{\"type\":\"integer\",\"description\":\"An optional string describing the cluster's port.\",\"examples\":[5439]},\"endpoint\":{\"type\":\"string\",\"description\":\"An optional string describing the cluster's endpoint.\",\"examples\":[\"analytics-cluster.example.eu-west-1.redshift.amazonaws.com:5439/analytics\"]}},\"additionalProperties\":true,\"required\":[\"account\",\"database\",\"schema\"]},\"AzureServer\":{\"type\":\"object\",\"title\":\"AzureServer\",\"properties\":{\"location\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"Path to Azure Blob Storage or Azure Data Lake Storage (ADLS), supports globs. Recommended pattern is 'abfss://<container_name>/<path>'\",\"examples\":[\"abfss://my_container_name/path\",\"abfss://my_container_name/path/*.json\",\"az://my_storage_account_name.blob.core.windows.net/my_container/path/*.parquet\",\"abfss://my_storage_account_name.dfs.core.windows.net/my_container_name/path/*.parquet\"]},\"format\":{\"type\":\"string\",\"enum\":[\"parquet\",\"delta\",\"json\",\"csv\"],\"description\":\"File format.\"},\"delimiter\":{\"type\":\"string\",\"enum\":[\"new_line\",\"array\"],\"description\":\"Only for format = json. How multiple json documents are delimited within one file\"}},\"required\":[\"location\",\"format\"]},\"SqlserverServer\":{\"type\":\"object\",\"title\":\"SqlserverServer\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The host to the database server\",\"examples\":[\"localhost\"]},\"port\":{\"type\":\"integer\",\"description\":\"The port to the database server.\",\"default\":1433,\"examples\":[1433]},\"database\":{\"type\":\"string\",\"description\":\"The name of the database.\",\"examples\":[\"database\"]},\"schema\":{\"type\":\"string\",\"description\":\"The name of the schema in the database.\",\"examples\":[\"dbo\"]}},\"required\":[\"host\",\"database\",\"schema\"]},\"SnowflakeServer\":{\"type\":\"object\",\"title\":\"SnowflakeServer\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"},\"database\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"},\"schema\":{\"type\":\"string\",\"description\":\"An optional string describing the server.\"}},\"required\":[\"account\",\"database\",\"schema\"]},\"DatabricksServer\":{\"type\":\"object\",\"title\":\"DatabricksServer\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The Databricks host\",\"examples\":[\"dbc-abcdefgh-1234.cloud.databricks.com\"]},\"catalog\":{\"type\":\"string\",\"description\":\"The name of the Hive or Unity catalog\"},\"schema\":{\"type\":\"string\",\"description\":\"The schema name in the catalog\"}},\"required\":[\"catalog\",\"schema\"]},\"DataframeServer\":{\"type\":\"object\",\"title\":\"DataframeServer\",\"required\":[\"type\"]},\"GlueServer\":{\"type\":\"object\",\"title\":\"GlueServer\",\"properties\":{\"account\":{\"type\":\"string\",\"description\":\"The AWS Glue account\",\"examples\":[\"1234-5678-9012\"]},\"database\":{\"type\":\"string\",\"description\":\"The AWS Glue database name\",\"examples\":[\"my_database\"]},\"location\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The AWS S3 path. Must be in the form of a URL.\",\"examples\":[\"s3://datacontract-example-orders-latest/data/{model}\"]},\"format\":{\"type\":\"string\",\"description\":\"The format of the files\",\"examples\":[\"parquet\",\"csv\",\"json\",\"delta\"]}},\"required\":[\"account\",\"database\"]},\"PostgresServer\":{\"type\":\"object\",\"title\":\"PostgresServer\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The host to the database server\",\"examples\":[\"localhost\"]},\"port\":{\"type\":\"integer\",\"description\":\"The port to the database server.\"},\"database\":{\"type\":\"string\",\"description\":\"The name of the database.\",\"examples\":[\"postgres\"]},\"schema\":{\"type\":\"string\",\"description\":\"The name of the schema in the database.\",\"examples\":[\"public\"]}},\"required\":[\"host\",\"port\",\"database\",\"schema\"]},\"OracleServer\":{\"type\":\"object\",\"title\":\"OracleServer\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The host to the oracle server\",\"examples\":[\"localhost\"]},\"port\":{\"type\":\"integer\",\"description\":\"The port to the oracle server.\",\"examples\":[1523]},\"serviceName\":{\"type\":\"string\",\"description\":\"The name of the service.\",\"examples\":[\"service\"]}},\"required\":[\"host\",\"port\",\"serviceName\"]},\"KafkaServer\":{\"type\":\"object\",\"title\":\"KafkaServer\",\"description\":\"Kafka Server\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The bootstrap server of the kafka cluster.\"},\"topic\":{\"type\":\"string\",\"description\":\"The topic name.\"},\"format\":{\"type\":\"string\",\"description\":\"The format of the message. Examples: json, avro, protobuf.\",\"default\":\"json\"}},\"required\":[\"host\",\"topic\"]},\"PubSubServer\":{\"type\":\"object\",\"title\":\"PubSubServer\",\"properties\":{\"project\":{\"type\":\"string\",\"description\":\"The GCP project name.\"},\"topic\":{\"type\":\"string\",\"description\":\"The topic name.\"}},\"required\":[\"project\",\"topic\"]},\"KinesisDataStreamsServer\":{\"type\":\"object\",\"title\":\"KinesisDataStreamsServer\",\"description\":\"Kinesis Data Streams Server\",\"properties\":{\"stream\":{\"type\":\"string\",\"description\":\"The name of the Kinesis data stream.\"},\"region\":{\"type\":\"string\",\"description\":\"AWS region.\",\"examples\":[\"eu-west-1\"]},\"format\":{\"type\":\"string\",\"description\":\"The format of the record\",\"examples\":[\"json\",\"avro\",\"protobuf\"]}},\"required\":[\"stream\"]},\"TrinoServer\":{\"type\":\"object\",\"title\":\"TrinoServer\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The Trino host URL.\",\"examples\":[\"localhost\"]},\"port\":{\"type\":\"integer\",\"description\":\"The Trino port.\"},\"catalog\":{\"type\":\"string\",\"description\":\"The name of the catalog.\",\"examples\":[\"hive\"]},\"schema\":{\"type\":\"string\",\"description\":\"The name of the schema in the database.\",\"examples\":[\"my_schema\"]}},\"required\":[\"host\",\"port\",\"catalog\",\"schema\"]},\"LocalServer\":{\"type\":\"object\",\"title\":\"LocalServer\",\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"The relative or absolute path to the data file(s).\",\"examples\":[\"./folder/data.parquet\",\"./folder/*.parquet\"]},\"format\":{\"type\":\"string\",\"description\":\"The format of the file(s)\",\"examples\":[\"json\",\"parquet\",\"delta\",\"csv\"]}},\"required\":[\"path\",\"format\"]},\"Quality\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of quality check\",\"enum\":[\"text\",\"library\",\"sql\",\"custom\"]},\"description\":{\"type\":\"string\",\"description\":\"A plain text describing the quality attribute in natural language.\"}}},{\"if\":{\"properties\":{\"type\":{\"const\":\"text\"}}},\"then\":{\"required\":[\"description\"]}},{\"if\":{\"properties\":{\"type\":{\"const\":\"sql\"}}},\"then\":{\"properties\":{\"query\":{\"type\":\"string\",\"description\":\"A SQL query that returns a single number to compare with the threshold.\"},\"dialect\":{\"type\":\"string\",\"description\":\"The SQL dialect that is used for the query. Should be compatible to the server.type.\",\"examples\":[\"athena\",\"bigquery\",\"redshift\",\"snowflake\",\"trino\",\"postgres\",\"oracle\"]},\"mustBe\":{\"type\":\"number\"},\"mustNotBe\":{\"type\":\"number\"},\"mustBeGreaterThan\":{\"type\":\"number\"},\"mustBeGreaterThanOrEqualTo\":{\"type\":\"number\"},\"mustBeLessThan\":{\"type\":\"number\"},\"mustBeLessThanOrEqualTo\":{\"type\":\"number\"},\"mustBeBetween\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"minItems\":2,\"maxItems\":2},\"mustNotBeBetween\":{\"type\":\"array\",\"items\":{\"type\":\"number\"},\"minItems\":2,\"maxItems\":2}},\"required\":[\"query\"]}},{\"if\":{\"properties\":{\"type\":{\"const\":\"library\"}}},\"then\":{\"properties\":{\"rule\":{\"type\":\"string\",\"description\":\"Define a data quality check based on the predefined rules as per ODCS.\",\"examples\":[\"duplicateCount\",\"validValues\",\"rowCount\"]},\"mustBe\":{\"description\":\"Must be equal to the value to be valid. When using numbers, it is equivalent to '='.\"},\"mustNotBe\":{\"description\":\"Must not be equal to the value to be valid. When using numbers, it is equivalent to '!='.\"},\"mustBeGreaterThan\":{\"type\":\"number\",\"description\":\"Must be greater than the value to be valid. It is equivalent to '>'.\"},\"mustBeGreaterOrEqualTo\":{\"type\":\"number\",\"description\":\"Must be greater than or equal to the value to be valid. It is equivalent to '>='.\"},\"mustBeLessThan\":{\"type\":\"number\",\"description\":\"Must be less than the value to be valid. It is equivalent to '<'.\"},\"mustBeLessOrEqualTo\":{\"type\":\"number\",\"description\":\"Must be less than or equal to the value to be valid. It is equivalent to '<='.\"},\"mustBeBetween\":{\"type\":\"array\",\"description\":\"Must be between the two numbers to be valid. Smallest number first in the array.\",\"minItems\":2,\"maxItems\":2,\"uniqueItems\":true,\"items\":{\"type\":\"number\"}},\"mustNotBeBetween\":{\"type\":\"array\",\"description\":\"Must not be between the two numbers to be valid. Smallest number first in the array.\",\"minItems\":2,\"maxItems\":2,\"uniqueItems\":true,\"items\":{\"type\":\"number\"}}},\"required\":[\"rule\"]}},{\"if\":{\"properties\":{\"type\":{\"const\":\"custom\"}}},\"then\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A plain text describing the quality attribute in natural language.\"},\"engine\":{\"type\":\"string\",\"examples\":[\"soda\",\"great-expectations\"],\"description\":\"The engine used for custom quality checks.\"},\"implementation\":{\"type\":[\"object\",\"array\",\"string\"],\"description\":\"Engine-specific quality checks and expectations.\"}},\"required\":[\"engine\"]}}]},\"Lineage\":{\"type\":\"object\",\"properties\":{\"inputFields\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"namespace\":{\"type\":\"string\",\"description\":\"The input dataset namespace\"},\"name\":{\"type\":\"string\",\"description\":\"The input dataset name\"},\"field\":{\"type\":\"string\",\"description\":\"The input field\"},\"transformations\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The type of the transformation. Allowed values are: DIRECT, INDIRECT\",\"type\":\"string\"},\"subtype\":{\"type\":\"string\",\"description\":\"The subtype of the transformation\"},\"description\":{\"type\":\"string\",\"description\":\"a string representation of the transformation applied\"},\"masking\":{\"type\":\"boolean\",\"description\":\"is transformation masking the data or not\"}},\"required\":[\"type\"],\"additionalProperties\":true}}},\"additionalProperties\":true,\"required\":[\"namespace\",\"name\",\"field\"]}},\"transformationDescription\":{\"type\":\"string\",\"description\":\"a string representation of the transformation applied\",\"deprecated\":true},\"transformationType\":{\"type\":\"string\",\"description\":\"IDENTITY|MASKED reflects a clearly defined behavior. IDENTITY: exact same as input; MASKED: no original data available (like a hash of PII for example)\",\"deprecated\":true}},\"additionalProperties\":true,\"required\":[\"inputFields\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DataContractSpecification\". Here are the required top‑level fields: dataContractSpecification, id, info. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"DataContractSpecification","properties":{"dataContractSpecification":{"type":"string","title":"DataContractSpecificationVersion","enum":["1.1.0","0.9.3","0.9.2","0.9.1","0.9.0"],"description":"Specifies the Data Contract Specification being used."},"id":{"type":"string","description":"Specifies the identifier of the data contract."},"info":{"type":"object","properties":{"title":{"type":"string","description":"The title of the data contract."},"version":{"type":"string","description":"The version of the data contract document (which is distinct from the Data Contract Specification version or the Data Product implementation version)."},"status":{"type":"string","description":"The status of the data contract. Can be proposed, in development, active, retired.","examples":["proposed","in development","active","deprecated","retired"]},"description":{"type":"string","description":"A description of the data contract."},"owner":{"type":"string","description":"The owner or team responsible for managing the data contract and providing the data."},"contact":{"type":"object","properties":{"name":{"type":"string","description":"The identifying name of the contact person/organization."},"url":{"type":"string","format":"uri","description":"The URL pointing to the contact information. This MUST be in the form of a URL."},"email":{"type":"string","format":"email","description":"The email address of the contact person/organization. This MUST be in the form of an email address."}},"description":"Contact information for the data contract.","additionalProperties":true}},"additionalProperties":true,"required":["title","version"],"description":"Metadata and life cycle information about the data contract."},"servers":{"type":"object","description":"Information about the servers.","additionalProperties":{"$ref":"#/$defs/BaseServer","allOf":[{"if":{"properties":{"type":{"const":"bigquery"}}},"then":{"$ref":"#/$defs/BigQueryServer"}},{"if":{"properties":{"type":{"const":"postgres"}},"required":["type"]},"then":{"$ref":"#/$defs/PostgresServer"}},{"if":{"properties":{"type":{"const":"s3"}},"required":["type"]},"then":{"$ref":"#/$defs/S3Server"}},{"if":{"properties":{"type":{"const":"sftp"}},"required":["type"]},"then":{"$ref":"#/$defs/SftpServer"}},{"if":{"properties":{"type":{"const":"redshift"}},"required":["type"]},"then":{"$ref":"#/$defs/RedshiftServer"}},{"if":{"properties":{"type":{"const":"azure"}},"required":["type"]},"then":{"$ref":"#/$defs/AzureServer"}},{"if":{"properties":{"type":{"const":"sqlserver"}},"required":["type"]},"then":{"$ref":"#/$defs/SqlserverServer"}},{"if":{"properties":{"type":{"const":"snowflake"}},"required":["type"]},"then":{"$ref":"#/$defs/SnowflakeServer"}},{"if":{"properties":{"type":{"const":"databricks"}},"required":["type"]},"then":{"$ref":"#/$defs/DatabricksServer"}},{"if":{"properties":{"type":{"const":"dataframe"}},"required":["type"]},"then":{"$ref":"#/$defs/DataframeServer"}},{"if":{"properties":{"type":{"const":"glue"}},"required":["type"]},"then":{"$ref":"#/$defs/GlueServer"}},{"if":{"properties":{"type":{"const":"postgres"}},"required":["type"]},"then":{"$ref":"#/$defs/PostgresServer"}},{"if":{"properties":{"type":{"const":"oracle"}},"required":["type"]},"then":{"$ref":"#/$defs/OracleServer"}},{"if":{"properties":{"type":{"const":"kafka"}},"required":["type"]},"then":{"$ref":"#/$defs/KafkaServer"}},{"if":{"properties":{"type":{"const":"pubsub"}},"required":["type"]},"then":{"$ref":"#/$defs/PubSubServer"}},{"if":{"properties":{"type":{"const":"kinesis"}},"required":["type"]},"then":{"$ref":"#/$defs/KinesisDataStreamsServer"}},{"if":{"properties":{"type":{"const":"trino"}},"required":["type"]},"then":{"$ref":"#/$defs/TrinoServer"}},{"if":{"properties":{"type":{"const":"local"}},"required":["type"]},"then":{"$ref":"#/$defs/LocalServer"}}]}},"terms":{"type":"object","description":"The terms and conditions of the data contract.","properties":{"usage":{"type":"string","description":"The usage describes the way the data is expected to be used. Can contain business and technical information."},"limitations":{"type":"string","description":"The limitations describe the restrictions on how the data can be used, can be technical or restrictions on what the data may not be used for."},"policies":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the policy.","examples":["privacy","security","retention","compliance"]},"description":{"type":"string","description":"A description of the policy."},"url":{"type":"string","format":"uri","description":"A URL to the policy document."}},"additionalProperties":true},"description":"The limitations describe the restrictions on how the data can be used, can be technical or restrictions on what the data may not be used for."},"billing":{"type":"string","description":"The billing describes the pricing model for using the data, such as whether it's free, having a monthly fee, or metered pay-per-use."},"noticePeriod":{"type":"string","description":"The period of time that must be given by either party to terminate or modify a data usage agreement. Uses ISO-8601 period format, e.g., 'P3M' for a period of three months."}},"additionalProperties":true},"models":{"description":"Specifies the logical data model. Use the models name (e.g., the table name) as the key.","type":"object","minProperties":1,"propertyNames":{"pattern":"^[a-zA-Z0-9_-]+$"},"additionalProperties":{"type":"object","title":"Model","properties":{"description":{"type":"string"},"type":{"description":"The type of the model. Examples: table, view, object. Default: table.","type":"string","title":"ModelType","default":"table","enum":["table","view","object"]},"title":{"type":"string","description":"An optional string providing a human readable name for the model. Especially useful if the model name is cryptic or contains abbreviations.","examples":["Purchase Orders","Air Shipments"]},"fields":{"description":"Specifies a field in the data model. Use the field name (e.g., the column name) as the key.","type":"object","additionalProperties":{"type":"object","title":"Field","properties":{"description":{"type":"string","description":"An optional string describing the semantic of the data in this field."},"title":{"type":"string","description":"An optional string providing a human readable name for the field. Especially useful if the field name is cryptic or contains abbreviations."},"type":{"$ref":"#/$defs/FieldType"},"required":{"type":"boolean","default":false,"description":"An indication, if this field must contain a value and may not be null."},"fields":{"description":"The nested fields (e.g. columns) of the object, record, or struct.","type":"object","additionalProperties":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"}},"items":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"keys":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"values":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"primary":{"type":"boolean","deprecationMessage":"Use the primaryKey field instead."},"primaryKey":{"type":"boolean","default":false,"description":"If this field is a primary key."},"references":{"type":"string","description":"The reference to a field in another model. E.g. use 'orders.order_id' to reference the order_id field of the model orders. Think of defining a foreign key relationship.","examples":["orders.order_id","model.nested_field.field"]},"unique":{"type":"boolean","default":false,"description":"An indication, if the value must be unique within the model."},"enum":{"type":"array","items":{"type":"string"},"uniqueItems":true,"description":"A value must be equal to one of the elements in this array value. Only evaluated if the value is not null."},"minLength":{"type":"integer","description":"A value must greater than, or equal to, the value of this. Only applies to string types."},"maxLength":{"type":"integer","description":"A value must less than, or equal to, the value of this. Only applies to string types."},"format":{"type":"string","description":"A specific format the value must comply with (e.g., 'email', 'uri', 'uuid').","examples":["email","uri","uuid"]},"precision":{"type":"number","examples":[38],"description":"The maximum number of digits in a number. Only applies to numeric values. Defaults to 38."},"scale":{"type":"number","examples":[0],"description":"The maximum number of decimal places in a number. Only applies to numeric values. Defaults to 0."},"pattern":{"type":"string","description":"A regular expression the value must match. Only applies to string types.","examples":["^[a-zA-Z0-9_-]+$"]},"minimum":{"type":"number","description":"A value of a number must greater than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"exclusiveMinimum":{"type":"number","description":"A value of a number must greater than the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"maximum":{"type":"number","description":"A value of a number must less than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"exclusiveMaximum":{"type":"number","description":"A value of a number must less than the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"example":{"type":"string","description":"An example value for this field.","deprecationMessage":"Use the examples field instead."},"examples":{"type":"array","description":"A examples value for this field."},"pii":{"type":"boolean","description":"An indication, if this field contains Personal Identifiable Information (PII)."},"classification":{"type":"string","description":"The data class defining the sensitivity level for this field, according to the organization's classification scheme.","examples":["sensitive","restricted","internal","public"]},"tags":{"type":"array","items":{"type":"string"},"description":"Custom metadata to provide additional context."},"links":{"type":"object","description":"Links to external resources.","minProperties":1,"propertyNames":{"pattern":"^[a-zA-Z0-9_-]+$"},"additionalProperties":{"type":"string","title":"Link","description":"A URL to an external resource.","format":"uri","examples":["https://example.com"]}},"$ref":{"type":"string","description":"A reference URI to a definition in the specification, internally or externally. Properties will be inherited from the definition."},"quality":{"type":"array","items":{"$ref":"#/$defs/Quality"}},"lineage":{"$ref":"#/$defs/Lineage"},"config":{"type":"object","description":"Additional metadata for field configuration.","additionalProperties":{"type":["string","number","boolean","object","array","null"]},"properties":{"avroType":{"type":"string","description":"Specify the field type to use when exporting the data model to Apache Avro."},"avroLogicalType":{"type":"string","description":"Specify the logical field type to use when exporting the data model to Apache Avro."},"bigqueryType":{"type":"string","description":"Specify the physical column type that is used in a BigQuery table, e.g., `NUMERIC(5, 2)`."},"snowflakeType":{"type":"string","description":"Specify the physical column type that is used in a Snowflake table, e.g., `TIMESTAMP_LTZ`."},"redshiftType":{"type":"string","description":"Specify the physical column type that is used in a Redshift table, e.g., `SMALLINT`."},"sqlserverType":{"type":"string","description":"Specify the physical column type that is used in a SQL Server table, e.g., `DATETIME2`."},"databricksType":{"type":"string","description":"Specify the physical column type that is used in a Databricks Unity Catalog table."},"glueType":{"type":"string","description":"Specify the physical column type that is used in an AWS Glue Data Catalog table."}}}}}},"primaryKey":{"type":"array","items":{"type":"string"},"description":"The compound primary key of the model."},"quality":{"type":"array","items":{"$ref":"#/$defs/Quality"}},"examples":{"type":"array"},"config":{"type":"object","description":"Additional metadata for model configuration.","additionalProperties":{"type":["string","number","boolean","object","array","null"]},"properties":{"avroNamespace":{"type":"string","description":"The namespace to use when importing and exporting the data model from / to Apache Avro."}}}}}},"definitions":{"description":"Clear and concise explanations of syntax, semantic, and classification of business objects in a given domain.","type":"object","propertyNames":{"pattern":"^[a-zA-Z0-9/_-]+$"},"additionalProperties":{"type":"object","title":"Definition","properties":{"domain":{"type":"string","description":"The domain in which this definition is valid.","default":"global","deprecationMessage":"This field is deprecated. Encode the domain into the ID using slashes."},"name":{"type":"string","description":"The technical name of this definition.","deprecationMessage":"This field is deprecated. Encode the name into the ID using slashes."},"title":{"type":"string","description":"The business name of this definition."},"description":{"type":"string","description":"Clear and concise explanations related to the domain."},"type":{"$ref":"#/$defs/FieldType"},"fields":{"description":"The nested fields (e.g. columns) of the object, record, or struct.","type":"object","additionalProperties":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"}},"items":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"keys":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"values":{"$ref":"#/properties/models/additionalProperties/properties/fields/additionalProperties"},"minLength":{"type":"integer","description":"A value must be greater than or equal to this value. Applies only to string types."},"maxLength":{"type":"integer","description":"A value must be less than or equal to this value. Applies only to string types."},"format":{"type":"string","description":"Specific format requirements for the value (e.g., 'email', 'uri', 'uuid')."},"precision":{"type":"integer","examples":[38],"description":"The maximum number of digits in a number. Only applies to numeric values. Defaults to 38."},"scale":{"type":"integer","examples":[0],"description":"The maximum number of decimal places in a number. Only applies to numeric values. Defaults to 0."},"pattern":{"type":"string","description":"A regular expression pattern the value must match. Applies only to string types."},"minimum":{"type":"number","description":"A value of a number must greater than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"exclusiveMinimum":{"type":"number","description":"A value of a number must greater than the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"maximum":{"type":"number","description":"A value of a number must less than, or equal to, the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"exclusiveMaximum":{"type":"number","description":"A value of a number must less than the value of this. Only evaluated if the value is not null. Only applies to numeric values."},"example":{"type":"string","description":"An example value.","deprecationMessage":"Use the examples field instead."},"examples":{"type":"array","description":"Example value."},"pii":{"type":"boolean","description":"Indicates if the field contains Personal Identifiable Information (PII)."},"classification":{"type":"string","description":"The data class defining the sensitivity level for this field."},"tags":{"type":"array","items":{"type":"string"},"description":"Custom metadata to provide additional context."},"links":{"type":"object","description":"Links to external resources.","minProperties":1,"propertyNames":{"pattern":"^[a-zA-Z0-9_-]+$"},"additionalProperties":{"type":"string","title":"Link","description":"A URL to an external resource.","format":"uri","examples":["https://example.com"]}}},"required":["type"]}},"servicelevels":{"type":"object","description":"Specifies the service level agreements for the provided data, including availability, data retention policies, latency requirements, data freshness, update frequency, support availability, and backup policies.","properties":{"availability":{"type":"object","description":"Availability refers to the promise or guarantee by the service provider about the uptime of the system that provides the data.","properties":{"description":{"type":"string","description":"An optional string describing the availability service level.","example":"The server is available during support hours"},"percentage":{"type":"string","description":"An optional string describing the guaranteed uptime in percent (e.g., `99.9%`)","pattern":"^\\d+(\\.\\d+)?%$","example":"99.9%"}}},"retention":{"type":"object","description":"Retention covers the period how long data will be available.","properties":{"description":{"type":"string","description":"An optional string describing the retention service level.","example":"Data is retained for one year."},"period":{"type":"string","description":"An optional period of time, how long data is available. Supported formats: Simple duration (e.g., `1 year`, `30d`) and ISO 8601 duration (e.g, `P1Y`).","example":"P1Y"},"unlimited":{"type":"boolean","description":"An optional indicator that data is kept forever.","example":false},"timestampField":{"type":"string","description":"An optional reference to the field that contains the timestamp that the period refers to.","example":"orders.order_timestamp"}}},"latency":{"type":"object","description":"Latency refers to the maximum amount of time from the source to its destination.","properties":{"description":{"type":"string","description":"An optional string describing the latency service level.","example":"Data is available within 25 hours after the order was placed."},"threshold":{"type":"string","description":"An optional maximum duration between the source timestamp and the processed timestamp. Supported formats: Simple duration (e.g., `24 hours`, `5s`) and ISO 8601 duration (e.g, `PT24H`).","example":"25h"},"sourceTimestampField":{"type":"string","description":"An optional reference to the field that contains the timestamp when the data was provided at the source.","example":"orders.order_timestamp"},"processedTimestampField":{"type":"string","description":"An optional reference to the field that contains the processing timestamp, which denotes when the data is made available to consumers of this data contract.","example":"orders.processed_timestamp"}}},"freshness":{"type":"object","description":"The maximum age of the youngest row in a table.","properties":{"description":{"type":"string","description":"An optional string describing the freshness service level.","example":"The age of the youngest row in a table is within 25 hours."},"threshold":{"type":"string","description":"An optional maximum age of the youngest entry. Supported formats: Simple duration (e.g., `24 hours`, `5s`) and ISO 8601 duration (e.g., `PT24H`).","example":"25h"},"timestampField":{"type":"string","description":"An optional reference to the field that contains the timestamp that the threshold refers to.","example":"orders.order_timestamp"}}},"frequency":{"type":"object","description":"Frequency describes how often data is updated.","properties":{"description":{"type":"string","description":"An optional string describing the frequency service level.","example":"Data is delivered once a day."},"type":{"type":"string","enum":["batch","micro-batching","streaming","manual"],"description":"The method of data processing.","example":"batch"},"interval":{"type":"string","description":"Optional. Only for batch: How often the pipeline is triggered, e.g., `daily`.","example":"daily"},"cron":{"type":"string","description":"Optional. Only for batch: A cron expression when the pipelines is triggered. E.g., `0 0 * * *`.","example":"0 0 * * *"}}},"support":{"type":"object","description":"Support describes the times when support will be available for contact.","properties":{"description":{"type":"string","description":"An optional string describing the support service level.","example":"The data is available during typical business hours at headquarters."},"time":{"type":"string","description":"An optional string describing the times when support will be available for contact such as `24/7` or `business hours only`.","example":"9am to 5pm in EST on business days"},"responseTime":{"type":"string","description":"An optional string describing the time it takes for the support team to acknowledge a request. This does not mean the issue will be resolved immediately, but it assures users that their request has been received and will be dealt with.","example":"24 hours"}}},"backup":{"type":"object","description":"Backup specifies details about data backup procedures.","properties":{"description":{"type":"string","description":"An optional string describing the backup service level.","example":"Data is backed up once a week, every Sunday at 0:00 UTC."},"interval":{"type":"string","description":"An optional interval that defines how often data will be backed up, e.g., `daily`.","example":"weekly"},"cron":{"type":"string","description":"An optional cron expression when data will be backed up, e.g., `0 0 * * *`.","example":"0 0 * * 0"},"recoveryTime":{"type":"string","description":"An optional Recovery Time Objective (RTO) specifies the maximum amount of time allowed to restore data from a backup after a failure or loss event (e.g., 4 hours, 24 hours).","example":"24 hours"},"recoveryPoint":{"type":"string","description":"An optional Recovery Point Objective (RPO) defines the maximum acceptable age of files that must be recovered from backup storage for normal operations to resume after a disaster or data loss event. This essentially measures how much data you can afford to lose, measured in time (e.g., 4 hours, 24 hours).","example":"1 week"}}}}},"links":{"type":"object","description":"Links to external resources.","minProperties":1,"propertyNames":{"pattern":"^[a-zA-Z0-9_-]+$"},"additionalProperties":{"type":"string","title":"Link","description":"A URL to an external resource.","format":"uri","examples":["https://example.com"]}},"tags":{"type":"array","items":{"type":"string","description":"Tags to facilitate searching and filtering.","examples":["databricks","pii","sensitive"]},"description":"Tags to facilitate searching and filtering."}},"required":["dataContractSpecification","id","info"],"$defs":{"FieldType":{"type":"string","title":"FieldType","description":"The logical data type of the field.","enum":["number","decimal","numeric","int","integer","long","bigint","float","double","string","text","varchar","boolean","timestamp","timestamp_tz","timestamp_ntz","date","array","map","object","record","struct","bytes","null"]},"BaseServer":{"type":"object","properties":{"description":{"type":"string","description":"An optional string describing the servers."},"environment":{"type":"string","description":"The environment in which the servers are running. Examples: prod, sit, stg."},"type":{"type":"string","description":"The type of the data product technology that implements the data contract.","enum":["bigquery","BigQuery","s3","sftp","redshift","azure","sqlserver","snowflake","databricks","dataframe","glue","postgres","oracle","kafka","pubsub","kinesis","trino","local"]},"roles":{"description":" An optional array of roles that are available and can be requested to access the server for role-based access control. E.g. separate roles for different regions or sensitive data.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role."},"description":{"type":"string","description":"A description of the role and what access the role provides."}},"required":["name"]}}},"additionalProperties":true,"required":["type"]},"BigQueryServer":{"type":"object","title":"BigQueryServer","properties":{"project":{"type":"string","description":"The GCP project name."},"dataset":{"type":"string","description":"The GCP dataset name."}},"required":["project","dataset"]},"S3Server":{"type":"object","title":"S3Server","properties":{"location":{"type":"string","format":"uri","description":"S3 URL, starting with `s3://`","examples":["s3://datacontract-example-orders-latest/data/{model}/*.json"]},"endpointUrl":{"type":"string","format":"uri","description":"The server endpoint for S3-compatible servers.","examples":["https://minio.example.com"]},"format":{"type":"string","enum":["parquet","delta","json","csv"],"description":"File format."},"delimiter":{"type":"string","enum":["new_line","array"],"description":"Only for format = json. How multiple json documents are delimited within one file"}},"required":["location"]},"SftpServer":{"type":"object","title":"SftpServer","properties":{"location":{"type":"string","format":"uri","pattern":"^sftp://.*","description":"SFTP URL, starting with `sftp://`","examples":["sftp://123.123.12.123/{model}/*.json"]},"format":{"type":"string","enum":["parquet","delta","json","csv"],"description":"File format."},"delimiter":{"type":"string","enum":["new_line","array"],"description":"Only for format = json. How multiple json documents are delimited within one file"}},"required":["location"]},"RedshiftServer":{"type":"object","title":"RedshiftServer","properties":{"account":{"type":"string","description":"An optional string describing the server."},"host":{"type":"string","description":"An optional string describing the host name."},"database":{"type":"string","description":"An optional string describing the server."},"schema":{"type":"string","description":"An optional string describing the server."},"clusterIdentifier":{"type":"string","description":"An optional string describing the cluster's identifier.","examples":["redshift-prod-eu","analytics-cluster"]},"port":{"type":"integer","description":"An optional string describing the cluster's port.","examples":[5439]},"endpoint":{"type":"string","description":"An optional string describing the cluster's endpoint.","examples":["analytics-cluster.example.eu-west-1.redshift.amazonaws.com:5439/analytics"]}},"additionalProperties":true,"required":["account","database","schema"]},"AzureServer":{"type":"object","title":"AzureServer","properties":{"location":{"type":"string","format":"uri","description":"Path to Azure Blob Storage or Azure Data Lake Storage (ADLS), supports globs. Recommended pattern is 'abfss://<container_name>/<path>'","examples":["abfss://my_container_name/path","abfss://my_container_name/path/*.json","az://my_storage_account_name.blob.core.windows.net/my_container/path/*.parquet","abfss://my_storage_account_name.dfs.core.windows.net/my_container_name/path/*.parquet"]},"format":{"type":"string","enum":["parquet","delta","json","csv"],"description":"File format."},"delimiter":{"type":"string","enum":["new_line","array"],"description":"Only for format = json. How multiple json documents are delimited within one file"}},"required":["location","format"]},"SqlserverServer":{"type":"object","title":"SqlserverServer","properties":{"host":{"type":"string","description":"The host to the database server","examples":["localhost"]},"port":{"type":"integer","description":"The port to the database server.","default":1433,"examples":[1433]},"database":{"type":"string","description":"The name of the database.","examples":["database"]},"schema":{"type":"string","description":"The name of the schema in the database.","examples":["dbo"]}},"required":["host","database","schema"]},"SnowflakeServer":{"type":"object","title":"SnowflakeServer","properties":{"account":{"type":"string","description":"An optional string describing the server."},"database":{"type":"string","description":"An optional string describing the server."},"schema":{"type":"string","description":"An optional string describing the server."}},"required":["account","database","schema"]},"DatabricksServer":{"type":"object","title":"DatabricksServer","properties":{"host":{"type":"string","description":"The Databricks host","examples":["dbc-abcdefgh-1234.cloud.databricks.com"]},"catalog":{"type":"string","description":"The name of the Hive or Unity catalog"},"schema":{"type":"string","description":"The schema name in the catalog"}},"required":["catalog","schema"]},"DataframeServer":{"type":"object","title":"DataframeServer","required":["type"]},"GlueServer":{"type":"object","title":"GlueServer","properties":{"account":{"type":"string","description":"The AWS Glue account","examples":["1234-5678-9012"]},"database":{"type":"string","description":"The AWS Glue database name","examples":["my_database"]},"location":{"type":"string","format":"uri","description":"The AWS S3 path. Must be in the form of a URL.","examples":["s3://datacontract-example-orders-latest/data/{model}"]},"format":{"type":"string","description":"The format of the files","examples":["parquet","csv","json","delta"]}},"required":["account","database"]},"PostgresServer":{"type":"object","title":"PostgresServer","properties":{"host":{"type":"string","description":"The host to the database server","examples":["localhost"]},"port":{"type":"integer","description":"The port to the database server."},"database":{"type":"string","description":"The name of the database.","examples":["postgres"]},"schema":{"type":"string","description":"The name of the schema in the database.","examples":["public"]}},"required":["host","port","database","schema"]},"OracleServer":{"type":"object","title":"OracleServer","properties":{"host":{"type":"string","description":"The host to the oracle server","examples":["localhost"]},"port":{"type":"integer","description":"The port to the oracle server.","examples":[1523]},"serviceName":{"type":"string","description":"The name of the service.","examples":["service"]}},"required":["host","port","serviceName"]},"KafkaServer":{"type":"object","title":"KafkaServer","description":"Kafka Server","properties":{"host":{"type":"string","description":"The bootstrap server of the kafka cluster."},"topic":{"type":"string","description":"The topic name."},"format":{"type":"string","description":"The format of the message. Examples: json, avro, protobuf.","default":"json"}},"required":["host","topic"]},"PubSubServer":{"type":"object","title":"PubSubServer","properties":{"project":{"type":"string","description":"The GCP project name."},"topic":{"type":"string","description":"The topic name."}},"required":["project","topic"]},"KinesisDataStreamsServer":{"type":"object","title":"KinesisDataStreamsServer","description":"Kinesis Data Streams Server","properties":{"stream":{"type":"string","description":"The name of the Kinesis data stream."},"region":{"type":"string","description":"AWS region.","examples":["eu-west-1"]},"format":{"type":"string","description":"The format of the record","examples":["json","avro","protobuf"]}},"required":["stream"]},"TrinoServer":{"type":"object","title":"TrinoServer","properties":{"host":{"type":"string","description":"The Trino host URL.","examples":["localhost"]},"port":{"type":"integer","description":"The Trino port."},"catalog":{"type":"string","description":"The name of the catalog.","examples":["hive"]},"schema":{"type":"string","description":"The name of the schema in the database.","examples":["my_schema"]}},"required":["host","port","catalog","schema"]},"LocalServer":{"type":"object","title":"LocalServer","properties":{"path":{"type":"string","description":"The relative or absolute path to the data file(s).","examples":["./folder/data.parquet","./folder/*.parquet"]},"format":{"type":"string","description":"The format of the file(s)","examples":["json","parquet","delta","csv"]}},"required":["path","format"]},"Quality":{"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"The type of quality check","enum":["text","library","sql","custom"]},"description":{"type":"string","description":"A plain text describing the quality attribute in natural language."}}},{"if":{"properties":{"type":{"const":"text"}}},"then":{"required":["description"]}},{"if":{"properties":{"type":{"const":"sql"}}},"then":{"properties":{"query":{"type":"string","description":"A SQL query that returns a single number to compare with the threshold."},"dialect":{"type":"string","description":"The SQL dialect that is used for the query. Should be compatible to the server.type.","examples":["athena","bigquery","redshift","snowflake","trino","postgres","oracle"]},"mustBe":{"type":"number"},"mustNotBe":{"type":"number"},"mustBeGreaterThan":{"type":"number"},"mustBeGreaterThanOrEqualTo":{"type":"number"},"mustBeLessThan":{"type":"number"},"mustBeLessThanOrEqualTo":{"type":"number"},"mustBeBetween":{"type":"array","items":{"type":"number"},"minItems":2,"maxItems":2},"mustNotBeBetween":{"type":"array","items":{"type":"number"},"minItems":2,"maxItems":2}},"required":["query"]}},{"if":{"properties":{"type":{"const":"library"}}},"then":{"properties":{"rule":{"type":"string","description":"Define a data quality check based on the predefined rules as per ODCS.","examples":["duplicateCount","validValues","rowCount"]},"mustBe":{"description":"Must be equal to the value to be valid. When using numbers, it is equivalent to '='."},"mustNotBe":{"description":"Must not be equal to the value to be valid. When using numbers, it is equivalent to '!='."},"mustBeGreaterThan":{"type":"number","description":"Must be greater than the value to be valid. It is equivalent to '>'."},"mustBeGreaterOrEqualTo":{"type":"number","description":"Must be greater than or equal to the value to be valid. It is equivalent to '>='."},"mustBeLessThan":{"type":"number","description":"Must be less than the value to be valid. It is equivalent to '<'."},"mustBeLessOrEqualTo":{"type":"number","description":"Must be less than or equal to the value to be valid. It is equivalent to '<='."},"mustBeBetween":{"type":"array","description":"Must be between the two numbers to be valid. Smallest number first in the array.","minItems":2,"maxItems":2,"uniqueItems":true,"items":{"type":"number"}},"mustNotBeBetween":{"type":"array","description":"Must not be between the two numbers to be valid. Smallest number first in the array.","minItems":2,"maxItems":2,"uniqueItems":true,"items":{"type":"number"}}},"required":["rule"]}},{"if":{"properties":{"type":{"const":"custom"}}},"then":{"properties":{"description":{"type":"string","description":"A plain text describing the quality attribute in natural language."},"engine":{"type":"string","examples":["soda","great-expectations"],"description":"The engine used for custom quality checks."},"implementation":{"type":["object","array","string"],"description":"Engine-specific quality checks and expectations."}},"required":["engine"]}}]},"Lineage":{"type":"object","properties":{"inputFields":{"type":"array","items":{"type":"object","properties":{"namespace":{"type":"string","description":"The input dataset namespace"},"name":{"type":"string","description":"The input dataset name"},"field":{"type":"string","description":"The input field"},"transformations":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The type of the transformation. Allowed values are: DIRECT, INDIRECT","type":"string"},"subtype":{"type":"string","description":"The subtype of the transformation"},"description":{"type":"string","description":"a string representation of the transformation applied"},"masking":{"type":"boolean","description":"is transformation masking the data or not"}},"required":["type"],"additionalProperties":true}}},"additionalProperties":true,"required":["namespace","name","field"]}},"transformationDescription":{"type":"string","description":"a string representation of the transformation applied","deprecated":true},"transformationType":{"type":"string","description":"IDENTITY|MASKED reflects a clearly defined behavior. IDENTITY: exact same as input; MASKED: no original data available (like a hash of PII for example)","deprecated":true}},"additionalProperties":true,"required":["inputFields"]}}}
|
Provide a JSON object that satisfies the schema "DataContractSpecification". Here are the required top‑level fields: dataContractSpecification, id, info. Return only the valid JSON object.
|
DataContractSpecification
|
schema-store
|
schema_store_242
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/datalogic-scan2deploy-android.json\",\"definitions\":{},\"description\":\"Schema to validate Android JSON files given as input to DL-Config to generate Scan2Deploy barcodes\",\"properties\":{\"layout\":{\"$id\":\"#/properties/layout\",\"type\":\"object\",\"title\":\"Layout Schema\",\"properties\":{\"description\":{\"$id\":\"#/properties/layout/properties/description\",\"type\":\"string\",\"title\":\"Description Schema\",\"default\":\"none\",\"examples\":[\"This is for our Android devices\"],\"maxLength\":350},\"enroll\":{\"$id\":\"#/properties/layout/properties/enroll\",\"type\":\"boolean\",\"title\":\"Enroll Schema\",\"default\":false,\"examples\":[true]}}},\"padlock\":{\"$id\":\"#/properties/padlock\",\"type\":\"object\",\"title\":\"Padlock Schema\",\"description\":\"Section used to configure the staging locking feature\",\"properties\":{\"valid-until\":{\"$id\":\"#/properties/padlock/properties/valid-until\",\"type\":\"string\",\"title\":\"Valid-Until Schema\",\"description\":\"Specifies the expiration date of the barcode sequence. Device date must be synchronized/configured for expiration date to work properly.\",\"default\":\"20991231235959\",\"examples\":[\"20991231235959\"]},\"key\":{\"$id\":\"#/properties/padlock/properties/key\",\"type\":\"string\",\"title\":\"Key Schema\",\"description\":\"Padlock key to be used. If value doesn't match the device, the barcode is rejected. Empty string means no key.\",\"default\":\"\",\"examples\":[\"ihavenomouthandimustscream\"]},\"state\":{\"$id\":\"#/properties/padlock/properties/state\",\"type\":\"string\",\"enum\":[\"locked\",\"unlocked\"],\"title\":\"State Schema\",\"description\":\"Configures the padlock state\",\"default\":\"undefined\",\"examples\":[\"locked\"]},\"hide-from-launcher\":{\"$id\":\"#/properties/padlock/properties/hide-from-launcher\",\"type\":\"boolean\",\"title\":\"Hide-From-Launcher Schema\",\"description\":\"Indicates if Scan2Deploy should be disabled after staging is complete. Once disabled, factory reset required to re-enable.\",\"default\":false,\"examples\":[false]}}},\"global\":{\"$id\":\"#/properties/global\",\"type\":\"object\",\"title\":\"Global Schema\",\"description\":\"Section used to configure application scoped settings\",\"properties\":{\"target-path\":{\"$id\":\"#/properties/global/properties/target-path\",\"type\":\"string\",\"title\":\"Target-Path Schema\",\"description\":\"Base destination folder where any archive/fill will be inflated/written. Default is device internal SD-card root\",\"examples\":[\"/mnt/sdcard/airwatch\"]},\"install-path\":{\"$id\":\"#/properties/global/properties/install-path\",\"type\":\"string\",\"title\":\"Install-Path Schema\",\"description\":\"Folder where the application expects auto-installed/auto-updated APKs to be found. Default is value specified in 'target path'.\",\"examples\":[\"/mnt/sdcard/airwatch\"]},\"update-path\":{\"$id\":\"#/properties/global/properties/update-path\",\"type\":\"string\",\"title\":\"Update-Path Schema\",\"description\":\"Folder where the application expects auto-updated OTA packages to be found. Default is value specified in 'target path'.\",\"examples\":[\"/mnt/sdcard/airwatch\"]},\"purge-target-path\":{\"$id\":\"#/properties/global/properties/purge-target-path\",\"type\":\"boolean\",\"title\":\"Purge-Target-Path Schema\",\"description\":\"Indicates if target specified in 'target-path' needs to be purged (deleted) prior to inflation of the deployment archive\",\"default\":true,\"examples\":[true]},\"auto-scan\":{\"$id\":\"#/properties/global/properties/auto-scan\",\"type\":\"boolean\",\"title\":\"Auto-Scan Schema\",\"description\":\"Enables/Disables the auto-update of APKs and OTA packages\",\"default\":false,\"examples\":[true]},\"download-preinstalled\":{\"$id\":\"#/properties/global/properties/download-preinstalled\",\"type\":\"boolean\",\"title\":\"Download-Preinstalled Schema\",\"description\":\"Used to force the downgrade of pre-installed application (even System app), if required\",\"default\":false,\"examples\":[false]},\"script\":{\"$id\":\"#/properties/global/properties/script\",\"type\":[\"string\",\"array\"],\"title\":\"Script Schema\",\"description\":\"A string specifying the absolute/relative path of a file, or a JSON array of strings describing the file content line-by-line. The script file will be interpreted last in staging process.\",\"items\":{\"$id\":\"#/properties/global/properties/script/items\",\"type\":\"string\",\"title\":\"Items Schema\",\"default\":\"\",\"examples\":[\"[Install]\",\"INSTALL /sdcard/Download/fa.apk\",\"[Post-Install]\",\"SHELL am start -a android.intent.action.MAIN -n com.example.mchew.fakeapp/.MainActivity\"]},\"default\":\"\",\"examples\":[\"setup.s\"]},\"action\":{\"$id\":\"#/properties/global/properties/action\",\"type\":\"string\",\"enum\":[\"none\",\"close\",\"enterprise-reset\",\"factory-reset\",\"reset\"],\"title\":\"Action Schema\",\"description\":\"Specifies the final action performed by the application at the end of the staging process.\",\"default\":\"none\",\"examples\":[\"close\"]},\"backup-to-enterprise\":{\"$id\":\"#/properties/global/properties/backup-to-enterprise\",\"type\":\"boolean\",\"title\":\"Backup-To-Enterprise Schema\",\"description\":\"Activates the enterprise backup persistence for the staging data, resulting in both the staging script and archive being copied to the enterprise partition\",\"default\":false,\"examples\":[true]}}},\"settings\":{\"$id\":\"#/properties/settings\",\"type\":\"object\",\"title\":\"Settings Schema\",\"description\":\"Section used to control inner device settings that typically need to be changed from the Android defaults\",\"properties\":{\"date-time\":{\"$id\":\"#/properties/settings/properties/date-time\",\"type\":\"string\",\"title\":\"Date-Time Schema\",\"description\":\"String representation in RFC-1123 format of the date to be set\",\"default\":\"null\",\"examples\":[\"Thu, 19 Apr 2018 07:51:37 GMT\"]},\"auto-time\":{\"$id\":\"#/properties/settings/properties/auto-time\",\"type\":\"boolean\",\"title\":\"Auto-Time Schema\",\"description\":\"Controls the 'Date & Time' automatic date-time adjustment setting\",\"default\":true,\"examples\":[false]},\"auto-time-zone\":{\"$id\":\"#/properties/settings/properties/auto-time-zone\",\"type\":\"boolean\",\"title\":\"Auto-Time-Zone Schema\",\"description\":\"Controls the 'Date & Time' automatic time-zone adjustment setting\",\"default\":true,\"examples\":[false]},\"auto-time-server\":{\"$id\":\"#/properties/settings/properties/auto-time-server\",\"type\":\"string\",\"title\":\"Auto-Time-Server Schema\",\"description\":\"Address of the NTP server to be used for date-time synchronization\",\"default\":\"null\",\"examples\":[\"pool.ntp.org\"]},\"debug-bridge\":{\"$id\":\"#/properties/settings/properties/debug-bridge\",\"type\":\"boolean\",\"title\":\"Debug-Bridge Schema\",\"description\":\"Controls the state of 'Android Debug Bridge'\",\"default\":true,\"examples\":[false]},\"lock-screen\":{\"$id\":\"#/properties/settings/properties/lock-screen\",\"type\":\"boolean\",\"title\":\" Lock-Screen Schema\",\"description\":\"Controls the state of Android's lock-screen, requiring the user to swipe the display to unlock the device\",\"default\":true,\"examples\":[false]},\"status-bar\":{\"$id\":\"#/properties/settings/properties/status-bar\",\"type\":\"boolean\",\"title\":\"Status-Bar Schema\",\"description\":\"Controls the display of the top status-bar. Note: hiding the status-bar will make notification disappear.\",\"default\":true,\"examples\":[false]},\"navigation-bar\":{\"$id\":\"#/properties/settings/properties/navigation-bar\",\"type\":\"boolean\",\"title\":\"Navigation-Bar Schema\",\"description\":\"Controls the display of the bottom navigation-bar\",\"default\":true,\"examples\":[true]},\"charge-threshold\":{\"$id\":\"#/properties/settings/properties/charge-threshold\",\"type\":\"integer\",\"title\":\"Charge-Threshold Schema\",\"description\":\"Indicates the charge threshold a battery exhausted device needs to reach to automatically boot when recharging\",\"default\":5,\"examples\":[0],\"minimum\":0,\"maximum\":100},\"usb-profile\":{\"$id\":\"#/properties/settings/properties/usb-profile\",\"type\":\"string\",\"enum\":[\"NONE\",\"BOTH\",\"DATA\",\"CHARGE\"],\"title\":\"Usb-Profile Schema\",\"description\":\"USB communication profile in use\",\"default\":\"BOTH\",\"examples\":[\"NONE\"]},\"usb-function\":{\"$id\":\"#/properties/settings/properties/usb-function\",\"type\":\"string\",\"enum\":[\"MTP\",\"PTP\",\"CHARGING\"],\"title\":\"Usb-Function Schema\",\"description\":\"USB communication function in use\",\"default\":\"CHARGING\",\"examples\":[\"CHARGING\"]}}},\"network\":{\"$id\":\"#/properties/network\",\"type\":\"object\",\"title\":\"Network Schema\",\"description\":\"Section used to configure the device Wi-Fi network\",\"properties\":{\"essid\":{\"$id\":\"#/properties/network/properties/essid\",\"type\":\"string\",\"title\":\"Essid Schema\",\"description\":\"Wireless network ESSID\",\"default\":\"tsunami\",\"examples\":[\"TESTTKIP\"]},\"hidden\":{\"$id\":\"#/properties/network/properties/hidden\",\"type\":\"boolean\",\"title\":\"Hidden Schema\",\"description\":\"Indicates if the wireless network is using a hidden ESSID\",\"default\":false,\"examples\":[false]},\"mode\":{\"$id\":\"#/properties/network/properties/mode\",\"type\":\"string\",\"enum\":[\"open\",\"wep-40\",\"wep-104\",\"wpa-psk\",\"wpa2-psk\",\"wpa-eap\",\"wpa2-eap\"],\"title\":\"Mode Schema\",\"description\":\"Wireless connection mode\",\"default\":\"open\",\"examples\":[\"wpa-psk\"]},\"mode-key\":{\"$id\":\"#/properties/network/properties/mode-key\",\"type\":\"string\",\"title\":\"Mode-Key Schema\",\"description\":\"Wireless network key, if needed\",\"default\":\"\",\"examples\":[\"datalogic\"]},\"mode-key-encrypted\":{\"$id\":\"#/properties/network/properties/mode-key-encrypted\",\"type\":\"boolean\",\"title\":\"Mode-Key-Encrypted Schema\",\"description\":\"Indicates if 'mode-key' is written in plain-text or encrypted with a custom encryption algorithm\",\"default\":false,\"examples\":[false]},\"eap-method\":{\"$id\":\"#/properties/network/properties/eap-method\",\"type\":\"string\",\"enum\":[\"none\",\"peap\",\"tls\",\"ttls\",\"pwd\",\"sim\",\"aka\",\"aka-prime\"],\"title\":\"Eap-Method Schema\",\"description\":\"Configures the EAP authentication method\",\"default\":\"none\",\"examples\":[\"none\"]},\"eap-phase2\":{\"$id\":\"#/properties/network/properties/eap-phase2\",\"type\":\"string\",\"enum\":[\"none\",\"pap\",\"mschap\",\"mschapv2\",\"gtc\"],\"title\":\"Eap-Phase2 Schema\",\"description\":\"Configures the EAP phase 2 authentication method\",\"default\":\"none\",\"examples\":[\"none\"]},\"eap-identity\":{\"$id\":\"#/properties/network/properties/eap-identity\",\"type\":\"string\",\"title\":\"Eap-Identity Schema\",\"description\":\"Indicates the EAP identity\",\"default\":\"\",\"examples\":[\"\"]},\"eap-anonymous-identity\":{\"$id\":\"#/properties/network/properties/eap-anonymous-identity\",\"type\":\"string\",\"title\":\"Eap-Anonymous-Identity Schema\",\"description\":\"Indicates the EAP anonymous identity, used as the unencrypted identity with certain EAP types\",\"default\":\"\",\"examples\":[\"\"]},\"eap-password\":{\"$id\":\"#/properties/network/properties/eap-password\",\"type\":\"string\",\"title\":\"Eap-Password Schema\",\"description\":\"EAP password, if needed\",\"default\":\"\",\"examples\":[\"\"]},\"eap-password-encrypted\":{\"$id\":\"#/properties/network/properties/eap-password-encrypted\",\"type\":\"boolean\",\"title\":\"Eap-Password-Encrypted Schema\",\"description\":\"Indicates if the 'eap-password' is encrypted with a custom encryption algorithm\",\"default\":false,\"examples\":[false]},\"eap-certificate\":{\"$id\":\"#/properties/network/properties/eap-certificate\",\"type\":\"string\",\"title\":\"Eap-Certificate Schema\",\"description\":\"Base64 representation of the EAP certificate to use\",\"default\":\"\",\"examples\":[\"\"]},\"proxy-host\":{\"$id\":\"#/properties/network/properties/proxy-host\",\"type\":\"string\",\"title\":\"Proxy-Host Schema\",\"description\":\"Server name or IP address of the proxy to be used for HTTP/HTTPS communications\",\"default\":\"\",\"examples\":[\"\"]},\"proxy-port\":{\"$id\":\"#/properties/network/properties/proxy-port\",\"type\":\"integer\",\"title\":\"Proxy-Port Schema\",\"description\":\"Server IP port of the proxy for HTTP/HTTPS communications\",\"default\":0,\"examples\":[0],\"minimum\":0,\"maximum\":65535},\"purge\":{\"$id\":\"#/properties/network/properties/purge\",\"type\":\"boolean\",\"title\":\"Purge Schema\",\"description\":\"Indicates if any currently configured wireless network needs to be removed. Can be useful to avoid profile roaming.\",\"default\":true,\"examples\":[true]},\"reconfigure\":{\"$id\":\"#/properties/network/properties/reconfigure\",\"type\":\"boolean\",\"title\":\"Reconfigure Schema\",\"description\":\"If true, will reconfigure any existing and matching network. If false, will leave existing network untouched. Setting used when 'purge' is set to false.\",\"default\":true,\"examples\":[false]},\"sleep-policy\":{\"$id\":\"#/properties/network/properties/sleep-policy\",\"type\":\"integer\",\"title\":\"Sleep-Policy Schema\",\"description\":\"Wireless sleep policy for Android's Settings.Global parameter (0-WIFI_SLEEP_POLICY_DEFAULT, 1-WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED, 2-WIFI_SLEEP_POLICY_NEVER)\",\"default\":2,\"examples\":[2],\"minimum\":0,\"maximum\":2},\"frequency-band\":{\"$id\":\"#/properties/network/properties/frequency-band\",\"type\":\"string\",\"enum\":[\"auto\",\"5ghz\",\"2ghz\"],\"title\":\"Frequency-Band Schema\",\"description\":\"Controls the frequency bands supported by the device\",\"default\":\"auto\",\"examples\":[\"auto\"]},\"save-to-file\":{\"$id\":\"#/properties/network/properties/save-to-file\",\"type\":\"string\",\"title\":\"Save-To-File Schema\",\"description\":\"Absolute path to the file where the current network configuration will be saved, empty string indicates network configuration won't be serialized to a file\",\"default\":\"\",\"examples\":[\"\"]},\"ephemeral\":{\"$id\":\"#/properties/network/properties/ephemeral\",\"type\":\"boolean\",\"title\":\"Ephemeral Schema\",\"description\":\"If true, wireless connection profile will be used during staging process, then deleted after staging. If false, wireless connection profile will still be present after staging process.\",\"default\":true,\"examples\":[false]},\"wait-for-connection\":{\"$id\":\"#/properties/network/properties/wait-for-connection\",\"type\":\"boolean\",\"title\":\"Wait-For-Connection Schema\",\"description\":\"Indicates whether a valid Wi-Fi connection has to be waited once the network configuration is complete. Can be useful when device needs to be configured but a valid Wi-Fi connection is not ready yet.\",\"default\":true,\"examples\":[true]}},\"if\":{\"properties\":{\"mode\":{\"enum\":[\"wpa-psk\",\"wpa2-psk\",\"wep-40\",\"wep-104\"]}}},\"then\":{\"required\":[\"mode-key\"]}},\"deployment\":{\"$id\":\"#/properties/deployment\",\"type\":\"object\",\"title\":\"Deployment Schema\",\"description\":\"Section can be used to download a ZIP archive from a server and inflate it to the 'target-path' folder\",\"properties\":{\"scheme\":{\"$id\":\"#/properties/deployment/properties/scheme\",\"type\":\"string\",\"enum\":[\"http\",\"https\"],\"title\":\"Scheme Schema\",\"description\":\"Deployment download scheme to use\",\"default\":\"http\",\"examples\":[\"http\"]},\"host\":{\"$id\":\"#/properties/deployment/properties/host\",\"type\":\"string\",\"title\":\"Host Schema\",\"description\":\"Host-name or internet-protocol address of the server from which the resource is to be fetched\",\"examples\":[\"172.19.0.77\"]},\"port\":{\"$id\":\"#/properties/deployment/properties/port\",\"type\":\"integer\",\"title\":\"Port Schema\",\"description\":\"TCP/IP port to be used to contact the server\",\"default\":80,\"examples\":[8080],\"minimum\":0,\"maximum\":65535},\"path\":{\"$id\":\"#/properties/deployment/properties/path\",\"type\":\"string\",\"title\":\"Path Schema\",\"description\":\"Path to the server resource to download, complete with query string if needed\",\"default\":\"\",\"examples\":[\"/airwatch.zip\"]},\"fetch-timeout\":{\"$id\":\"#/properties/deployment/properties/fetch-timeout\",\"type\":\"integer\",\"title\":\"Fetch-Timeout Schema\",\"description\":\"The timeout value used when fetching resource from host\",\"default\":60000,\"examples\":[60000]},\"check-timeout\":{\"$id\":\"#/properties/deployment/properties/check-timeout\",\"type\":\"integer\",\"title\":\"Check-Timeout Schema\",\"description\":\"The timeout value used when attempting to reach the host server\",\"default\":1000,\"examples\":[1000]},\"working-archive\":{\"$id\":\"#/properties/deployment/properties/working-archive\",\"type\":\"string\",\"title\":\"Working-Archive Schema\",\"description\":\"String representation of the archive path-file name, once downloaded\",\"default\":\"/mnt/sdcard/scan2deploy.archive\",\"examples\":[\"/mnt/sdcard/target.zip\"]},\"skip-inflation\":{\"$id\":\"#/properties/deployment/properties/skip-inflation\",\"type\":\"boolean\",\"title\":\"Skip-Inflation Schema\",\"description\":\"Instructs the application not to inflate the deployment archive once downloaded, can be useful to speed the OTA update process up\",\"default\":false,\"examples\":[true]}},\"required\":[\"host\"]},\"blobs\":{\"$id\":\"#/properties/blobs\",\"type\":\"array\",\"title\":\"Blobs Schema\",\"description\":\"Section used to transfer binary data to newly created file on device\",\"items\":{\"$id\":\"#/properties/blobs/items\",\"type\":\"object\",\"title\":\"Items Schema\",\"required\":[\"file\",\"content\"],\"properties\":{\"file\":{\"$id\":\"#/properties/blobs/items/properties/file\",\"type\":\"string\",\"title\":\"File Schema\",\"description\":\"Path to the file to be created. Can be either absolute or relative to the global/target-path parameter value. During file de-serialization, any required (parent) path is automatically created.\",\"examples\":[\"/mnt/sdcard/airwatch/credentials.bin\"]},\"content\":{\"$id\":\"#/properties/blobs/items/properties/content\",\"type\":\"string\",\"title\":\"Content Schema\",\"description\":\"Base64 representation of the actual file content\",\"examples\":[\"fd09B1iL/k4jRWrjrP0/sO44teY+B3UafBLsMsCEqd1KOv6b6JYBXLVv70FmHdZhIVoEOQvHu7O4PUJStpZQ+4PYjPqCO+NQr81M7GOF421Ke8L2u4EYyqDE5qXfLy2shEgaRwRpr2f35/38WZkh6edyiWZQJjyLeZcuI7WiaJPpw7Jcw7ye7mb7Rl+ePNFmfvUrpeRFtN+5kUsx/SbB1v0gDyOOuoep\"]}}}}},\"title\":\"Android-Scan2Deploy Schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Android-Scan2Deploy Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/datalogic-scan2deploy-android.json","definitions":{},"description":"Schema to validate Android JSON files given as input to DL-Config to generate Scan2Deploy barcodes","properties":{"layout":{"$id":"#/properties/layout","type":"object","title":"Layout Schema","properties":{"description":{"$id":"#/properties/layout/properties/description","type":"string","title":"Description Schema","default":"none","examples":["This is for our Android devices"],"maxLength":350},"enroll":{"$id":"#/properties/layout/properties/enroll","type":"boolean","title":"Enroll Schema","default":false,"examples":[true]}}},"padlock":{"$id":"#/properties/padlock","type":"object","title":"Padlock Schema","description":"Section used to configure the staging locking feature","properties":{"valid-until":{"$id":"#/properties/padlock/properties/valid-until","type":"string","title":"Valid-Until Schema","description":"Specifies the expiration date of the barcode sequence. Device date must be synchronized/configured for expiration date to work properly.","default":"20991231235959","examples":["20991231235959"]},"key":{"$id":"#/properties/padlock/properties/key","type":"string","title":"Key Schema","description":"Padlock key to be used. If value doesn't match the device, the barcode is rejected. Empty string means no key.","default":"","examples":["ihavenomouthandimustscream"]},"state":{"$id":"#/properties/padlock/properties/state","type":"string","enum":["locked","unlocked"],"title":"State Schema","description":"Configures the padlock state","default":"undefined","examples":["locked"]},"hide-from-launcher":{"$id":"#/properties/padlock/properties/hide-from-launcher","type":"boolean","title":"Hide-From-Launcher Schema","description":"Indicates if Scan2Deploy should be disabled after staging is complete. Once disabled, factory reset required to re-enable.","default":false,"examples":[false]}}},"global":{"$id":"#/properties/global","type":"object","title":"Global Schema","description":"Section used to configure application scoped settings","properties":{"target-path":{"$id":"#/properties/global/properties/target-path","type":"string","title":"Target-Path Schema","description":"Base destination folder where any archive/fill will be inflated/written. Default is device internal SD-card root","examples":["/mnt/sdcard/airwatch"]},"install-path":{"$id":"#/properties/global/properties/install-path","type":"string","title":"Install-Path Schema","description":"Folder where the application expects auto-installed/auto-updated APKs to be found. Default is value specified in 'target path'.","examples":["/mnt/sdcard/airwatch"]},"update-path":{"$id":"#/properties/global/properties/update-path","type":"string","title":"Update-Path Schema","description":"Folder where the application expects auto-updated OTA packages to be found. Default is value specified in 'target path'.","examples":["/mnt/sdcard/airwatch"]},"purge-target-path":{"$id":"#/properties/global/properties/purge-target-path","type":"boolean","title":"Purge-Target-Path Schema","description":"Indicates if target specified in 'target-path' needs to be purged (deleted) prior to inflation of the deployment archive","default":true,"examples":[true]},"auto-scan":{"$id":"#/properties/global/properties/auto-scan","type":"boolean","title":"Auto-Scan Schema","description":"Enables/Disables the auto-update of APKs and OTA packages","default":false,"examples":[true]},"download-preinstalled":{"$id":"#/properties/global/properties/download-preinstalled","type":"boolean","title":"Download-Preinstalled Schema","description":"Used to force the downgrade of pre-installed application (even System app), if required","default":false,"examples":[false]},"script":{"$id":"#/properties/global/properties/script","type":["string","array"],"title":"Script Schema","description":"A string specifying the absolute/relative path of a file, or a JSON array of strings describing the file content line-by-line. The script file will be interpreted last in staging process.","items":{"$id":"#/properties/global/properties/script/items","type":"string","title":"Items Schema","default":"","examples":["[Install]","INSTALL /sdcard/Download/fa.apk","[Post-Install]","SHELL am start -a android.intent.action.MAIN -n com.example.mchew.fakeapp/.MainActivity"]},"default":"","examples":["setup.s"]},"action":{"$id":"#/properties/global/properties/action","type":"string","enum":["none","close","enterprise-reset","factory-reset","reset"],"title":"Action Schema","description":"Specifies the final action performed by the application at the end of the staging process.","default":"none","examples":["close"]},"backup-to-enterprise":{"$id":"#/properties/global/properties/backup-to-enterprise","type":"boolean","title":"Backup-To-Enterprise Schema","description":"Activates the enterprise backup persistence for the staging data, resulting in both the staging script and archive being copied to the enterprise partition","default":false,"examples":[true]}}},"settings":{"$id":"#/properties/settings","type":"object","title":"Settings Schema","description":"Section used to control inner device settings that typically need to be changed from the Android defaults","properties":{"date-time":{"$id":"#/properties/settings/properties/date-time","type":"string","title":"Date-Time Schema","description":"String representation in RFC-1123 format of the date to be set","default":"null","examples":["Thu, 19 Apr 2018 07:51:37 GMT"]},"auto-time":{"$id":"#/properties/settings/properties/auto-time","type":"boolean","title":"Auto-Time Schema","description":"Controls the 'Date & Time' automatic date-time adjustment setting","default":true,"examples":[false]},"auto-time-zone":{"$id":"#/properties/settings/properties/auto-time-zone","type":"boolean","title":"Auto-Time-Zone Schema","description":"Controls the 'Date & Time' automatic time-zone adjustment setting","default":true,"examples":[false]},"auto-time-server":{"$id":"#/properties/settings/properties/auto-time-server","type":"string","title":"Auto-Time-Server Schema","description":"Address of the NTP server to be used for date-time synchronization","default":"null","examples":["pool.ntp.org"]},"debug-bridge":{"$id":"#/properties/settings/properties/debug-bridge","type":"boolean","title":"Debug-Bridge Schema","description":"Controls the state of 'Android Debug Bridge'","default":true,"examples":[false]},"lock-screen":{"$id":"#/properties/settings/properties/lock-screen","type":"boolean","title":" Lock-Screen Schema","description":"Controls the state of Android's lock-screen, requiring the user to swipe the display to unlock the device","default":true,"examples":[false]},"status-bar":{"$id":"#/properties/settings/properties/status-bar","type":"boolean","title":"Status-Bar Schema","description":"Controls the display of the top status-bar. Note: hiding the status-bar will make notification disappear.","default":true,"examples":[false]},"navigation-bar":{"$id":"#/properties/settings/properties/navigation-bar","type":"boolean","title":"Navigation-Bar Schema","description":"Controls the display of the bottom navigation-bar","default":true,"examples":[true]},"charge-threshold":{"$id":"#/properties/settings/properties/charge-threshold","type":"integer","title":"Charge-Threshold Schema","description":"Indicates the charge threshold a battery exhausted device needs to reach to automatically boot when recharging","default":5,"examples":[0],"minimum":0,"maximum":100},"usb-profile":{"$id":"#/properties/settings/properties/usb-profile","type":"string","enum":["NONE","BOTH","DATA","CHARGE"],"title":"Usb-Profile Schema","description":"USB communication profile in use","default":"BOTH","examples":["NONE"]},"usb-function":{"$id":"#/properties/settings/properties/usb-function","type":"string","enum":["MTP","PTP","CHARGING"],"title":"Usb-Function Schema","description":"USB communication function in use","default":"CHARGING","examples":["CHARGING"]}}},"network":{"$id":"#/properties/network","type":"object","title":"Network Schema","description":"Section used to configure the device Wi-Fi network","properties":{"essid":{"$id":"#/properties/network/properties/essid","type":"string","title":"Essid Schema","description":"Wireless network ESSID","default":"tsunami","examples":["TESTTKIP"]},"hidden":{"$id":"#/properties/network/properties/hidden","type":"boolean","title":"Hidden Schema","description":"Indicates if the wireless network is using a hidden ESSID","default":false,"examples":[false]},"mode":{"$id":"#/properties/network/properties/mode","type":"string","enum":["open","wep-40","wep-104","wpa-psk","wpa2-psk","wpa-eap","wpa2-eap"],"title":"Mode Schema","description":"Wireless connection mode","default":"open","examples":["wpa-psk"]},"mode-key":{"$id":"#/properties/network/properties/mode-key","type":"string","title":"Mode-Key Schema","description":"Wireless network key, if needed","default":"","examples":["datalogic"]},"mode-key-encrypted":{"$id":"#/properties/network/properties/mode-key-encrypted","type":"boolean","title":"Mode-Key-Encrypted Schema","description":"Indicates if 'mode-key' is written in plain-text or encrypted with a custom encryption algorithm","default":false,"examples":[false]},"eap-method":{"$id":"#/properties/network/properties/eap-method","type":"string","enum":["none","peap","tls","ttls","pwd","sim","aka","aka-prime"],"title":"Eap-Method Schema","description":"Configures the EAP authentication method","default":"none","examples":["none"]},"eap-phase2":{"$id":"#/properties/network/properties/eap-phase2","type":"string","enum":["none","pap","mschap","mschapv2","gtc"],"title":"Eap-Phase2 Schema","description":"Configures the EAP phase 2 authentication method","default":"none","examples":["none"]},"eap-identity":{"$id":"#/properties/network/properties/eap-identity","type":"string","title":"Eap-Identity Schema","description":"Indicates the EAP identity","default":"","examples":[""]},"eap-anonymous-identity":{"$id":"#/properties/network/properties/eap-anonymous-identity","type":"string","title":"Eap-Anonymous-Identity Schema","description":"Indicates the EAP anonymous identity, used as the unencrypted identity with certain EAP types","default":"","examples":[""]},"eap-password":{"$id":"#/properties/network/properties/eap-password","type":"string","title":"Eap-Password Schema","description":"EAP password, if needed","default":"","examples":[""]},"eap-password-encrypted":{"$id":"#/properties/network/properties/eap-password-encrypted","type":"boolean","title":"Eap-Password-Encrypted Schema","description":"Indicates if the 'eap-password' is encrypted with a custom encryption algorithm","default":false,"examples":[false]},"eap-certificate":{"$id":"#/properties/network/properties/eap-certificate","type":"string","title":"Eap-Certificate Schema","description":"Base64 representation of the EAP certificate to use","default":"","examples":[""]},"proxy-host":{"$id":"#/properties/network/properties/proxy-host","type":"string","title":"Proxy-Host Schema","description":"Server name or IP address of the proxy to be used for HTTP/HTTPS communications","default":"","examples":[""]},"proxy-port":{"$id":"#/properties/network/properties/proxy-port","type":"integer","title":"Proxy-Port Schema","description":"Server IP port of the proxy for HTTP/HTTPS communications","default":0,"examples":[0],"minimum":0,"maximum":65535},"purge":{"$id":"#/properties/network/properties/purge","type":"boolean","title":"Purge Schema","description":"Indicates if any currently configured wireless network needs to be removed. Can be useful to avoid profile roaming.","default":true,"examples":[true]},"reconfigure":{"$id":"#/properties/network/properties/reconfigure","type":"boolean","title":"Reconfigure Schema","description":"If true, will reconfigure any existing and matching network. If false, will leave existing network untouched. Setting used when 'purge' is set to false.","default":true,"examples":[false]},"sleep-policy":{"$id":"#/properties/network/properties/sleep-policy","type":"integer","title":"Sleep-Policy Schema","description":"Wireless sleep policy for Android's Settings.Global parameter (0-WIFI_SLEEP_POLICY_DEFAULT, 1-WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED, 2-WIFI_SLEEP_POLICY_NEVER)","default":2,"examples":[2],"minimum":0,"maximum":2},"frequency-band":{"$id":"#/properties/network/properties/frequency-band","type":"string","enum":["auto","5ghz","2ghz"],"title":"Frequency-Band Schema","description":"Controls the frequency bands supported by the device","default":"auto","examples":["auto"]},"save-to-file":{"$id":"#/properties/network/properties/save-to-file","type":"string","title":"Save-To-File Schema","description":"Absolute path to the file where the current network configuration will be saved, empty string indicates network configuration won't be serialized to a file","default":"","examples":[""]},"ephemeral":{"$id":"#/properties/network/properties/ephemeral","type":"boolean","title":"Ephemeral Schema","description":"If true, wireless connection profile will be used during staging process, then deleted after staging. If false, wireless connection profile will still be present after staging process.","default":true,"examples":[false]},"wait-for-connection":{"$id":"#/properties/network/properties/wait-for-connection","type":"boolean","title":"Wait-For-Connection Schema","description":"Indicates whether a valid Wi-Fi connection has to be waited once the network configuration is complete. Can be useful when device needs to be configured but a valid Wi-Fi connection is not ready yet.","default":true,"examples":[true]}},"if":{"properties":{"mode":{"enum":["wpa-psk","wpa2-psk","wep-40","wep-104"]}}},"then":{"required":["mode-key"]}},"deployment":{"$id":"#/properties/deployment","type":"object","title":"Deployment Schema","description":"Section can be used to download a ZIP archive from a server and inflate it to the 'target-path' folder","properties":{"scheme":{"$id":"#/properties/deployment/properties/scheme","type":"string","enum":["http","https"],"title":"Scheme Schema","description":"Deployment download scheme to use","default":"http","examples":["http"]},"host":{"$id":"#/properties/deployment/properties/host","type":"string","title":"Host Schema","description":"Host-name or internet-protocol address of the server from which the resource is to be fetched","examples":["172.19.0.77"]},"port":{"$id":"#/properties/deployment/properties/port","type":"integer","title":"Port Schema","description":"TCP/IP port to be used to contact the server","default":80,"examples":[8080],"minimum":0,"maximum":65535},"path":{"$id":"#/properties/deployment/properties/path","type":"string","title":"Path Schema","description":"Path to the server resource to download, complete with query string if needed","default":"","examples":["/airwatch.zip"]},"fetch-timeout":{"$id":"#/properties/deployment/properties/fetch-timeout","type":"integer","title":"Fetch-Timeout Schema","description":"The timeout value used when fetching resource from host","default":60000,"examples":[60000]},"check-timeout":{"$id":"#/properties/deployment/properties/check-timeout","type":"integer","title":"Check-Timeout Schema","description":"The timeout value used when attempting to reach the host server","default":1000,"examples":[1000]},"working-archive":{"$id":"#/properties/deployment/properties/working-archive","type":"string","title":"Working-Archive Schema","description":"String representation of the archive path-file name, once downloaded","default":"/mnt/sdcard/scan2deploy.archive","examples":["/mnt/sdcard/target.zip"]},"skip-inflation":{"$id":"#/properties/deployment/properties/skip-inflation","type":"boolean","title":"Skip-Inflation Schema","description":"Instructs the application not to inflate the deployment archive once downloaded, can be useful to speed the OTA update process up","default":false,"examples":[true]}},"required":["host"]},"blobs":{"$id":"#/properties/blobs","type":"array","title":"Blobs Schema","description":"Section used to transfer binary data to newly created file on device","items":{"$id":"#/properties/blobs/items","type":"object","title":"Items Schema","required":["file","content"],"properties":{"file":{"$id":"#/properties/blobs/items/properties/file","type":"string","title":"File Schema","description":"Path to the file to be created. Can be either absolute or relative to the global/target-path parameter value. During file de-serialization, any required (parent) path is automatically created.","examples":["/mnt/sdcard/airwatch/credentials.bin"]},"content":{"$id":"#/properties/blobs/items/properties/content","type":"string","title":"Content Schema","description":"Base64 representation of the actual file content","examples":["fd09B1iL/k4jRWrjrP0/sO44teY+B3UafBLsMsCEqd1KOv6b6JYBXLVv70FmHdZhIVoEOQvHu7O4PUJStpZQ+4PYjPqCO+NQr81M7GOF421Ke8L2u4EYyqDE5qXfLy2shEgaRwRpr2f35/38WZkh6edyiWZQJjyLeZcuI7WiaJPpw7Jcw7ye7mb7Rl+ePNFmfvUrpeRFtN+5kUsx/SbB1v0gDyOOuoep"]}}}}},"title":"Android-Scan2Deploy Schema","type":"object"}
|
Provide a JSON object that satisfies the schema "Android-Scan2Deploy Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Android-Scan2Deploy Schema
|
schema-store
|
schema_store_243
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/datalogic-scan2deploy-ce.json\",\"definitions\":{},\"description\":\"Schema to validate Windows CE JSON files given as input to DL-Config to generate Scan2Deploy barcodes\",\"properties\":{\"layout\":{\"$id\":\"#/properties/layout\",\"type\":\"object\",\"title\":\"Layout Schema\",\"properties\":{\"description\":{\"$id\":\"#/properties/layout/properties/description\",\"type\":\"string\",\"title\":\"Description Schema\",\"default\":\"none\",\"examples\":[\"This is for our WEC7 devices\"],\"maxLength\":350}}},\"global\":{\"$id\":\"#/properties/global\",\"type\":\"object\",\"title\":\"Global-Section Schema\",\"description\":\"Section used to configure application scoped settings\",\"properties\":{\"target-path\":{\"$id\":\"#/properties/global/properties/target-path\",\"type\":\"string\",\"title\":\"Target-Path Schema\",\"description\":\"Base destination folder where archive/folder will be inflated\",\"default\":\"\\\\FlashDisk\",\"examples\":[\"\\\\FlashDisk\"]},\"action\":{\"$id\":\"#/properties/global/properties/action\",\"type\":\"string\",\"enum\":[\"stay\",\"close\",\"warm-boot\",\"cold-boot\",\"clean-boot\"],\"title\":\"Action Schema\",\"description\":\"Specifies final action performed by the application at the end of the staging process\",\"default\":\"cold-boot\",\"examples\":[\"warm-boot\"]},\"ping-timeout\":{\"$id\":\"#/properties/global/properties/ping-timeout\",\"type\":\"integer\",\"title\":\"Ping-Timeout Schema\",\"description\":\"The timeout value used when attempting to reach the host server\",\"default\":1000,\"examples\":[1000],\"minimum\":1,\"maximum\":4000}}},\"settings\":{\"$id\":\"#/properties/settings\",\"type\":\"object\",\"title\":\"Settings-Section Schema\",\"description\":\"Section used to configure inner device settings\",\"properties\":{\"usb-function\":{\"$id\":\"#/properties/settings/properties/usb-function\",\"type\":\"string\",\"enum\":[\"active-sync-usb\",\"active-sync-com\",\"usblan\",\"mass-storage\"],\"title\":\"USB-Function Schema\",\"description\":\"USB communication function to use\",\"default\":\"active-sync-usb\",\"examples\":[\"usblan\"]}}},\"network\":{\"$id\":\"#/properties/network\",\"type\":\"object\",\"title\":\"Network-Section Schema\",\"description\":\"Section used to configure device Wi-Fi network\",\"properties\":{\"profile\":{\"$id\":\"#/properties/network/properties/profile\",\"type\":\"string\",\"title\":\"Profile Schema\",\"description\":\"\\\"Friendly\\\" name to associate with the network connection\",\"default\":\"datalogic\",\"examples\":[\"my_fast\"]},\"essid\":{\"$id\":\"#/properties/network/properties/essid\",\"type\":\"string\",\"title\":\"Essid Schema\",\"description\":\"Wireless network ESSID\",\"default\":\"tsunami\",\"examples\":[\"eapfast\"]},\"mode\":{\"$id\":\"#/properties/network/properties/mode\",\"type\":\"string\",\"enum\":[\"open\",\"wep-40\",\"wep-104\",\"wpa-psk\",\"wpa2-psk\",\"wpa-tkip\",\"wpa2-aes\"],\"title\":\"Mode Schema\",\"description\":\"Wireless connection mode\",\"default\":\"open\",\"examples\":[\"wpa2-aes\"]},\"mode-key\":{\"$id\":\"#/properties/network/properties/mode-key\",\"type\":\"string\",\"title\":\"Mode-Key Schema\",\"description\":\"Wireless network key for 'wep-40', 'wep-104', 'wpa-psk', and 'wpa2-psk' networks\",\"default\":\"\",\"examples\":[\"0123456789\"],\"minLength\":5,\"maxLength\":63},\"index\":{\"$id\":\"#/properties/network/properties/index\",\"type\":\"integer\",\"title\":\"Index Schema\",\"description\":\"Wireless network key index for 'wep-40' and 'wep-104' networks\",\"default\":1,\"examples\":[1],\"minimum\":1,\"maximum\":4},\"eap-method\":{\"$id\":\"#/properties/network/properties/eap-method\",\"type\":\"string\",\"enum\":[\"none\",\"peap\",\"tls\",\"ttls\",\"fast\",\"leap\"],\"title\":\"Eap-Method Schema\",\"description\":\"Configures the EAP authentication method\",\"default\":\"none\",\"examples\":[\"fast\"]},\"eap-username\":{\"$id\":\"#/properties/network/properties/eap-username\",\"type\":\"string\",\"title\":\"Eap-Username Schema\",\"description\":\"Username for the EAP method\",\"default\":\"\",\"examples\":[\"eapfast\"]},\"eap-password\":{\"$id\":\"#/properties/network/properties/eap-password\",\"type\":\"string\",\"title\":\"Eap-Password Schema\",\"description\":\"Password for EAP method\",\"default\":\"\",\"examples\":[\"1234567890\"]},\"credentials-type\":{\"$id\":\"#/properties/network/properties/credentials-type\",\"type\":\"string\",\"enum\":[\"password\",\"token\",\"certificate\",\"unknown\"],\"title\":\"Credentials-Type Schema\",\"description\":\"Indicates the EAP credentials type\",\"default\":\"password\",\"examples\":[\"password\"]},\"credentials-source\":{\"$id\":\"#/properties/network/properties/credentials-source\",\"type\":\"string\",\"enum\":[\"user\",\"logon\",\"profile\",\"auto\",\"unknown\"],\"title\":\"Credentials-Source Schema\",\"description\":\"Indicates the EAP credentials source\",\"default\":\"user\",\"examples\":[\"profile\"]},\"validate-server\":{\"$id\":\"#/properties/network/properties/validate-server\",\"type\":\"boolean\",\"title\":\"Validate-Server Schema\",\"description\":\"Indicates if the server certificate should be validated\",\"default\":false,\"examples\":[false]},\"connect-to-server\":{\"$id\":\"#/properties/network/properties/connect-to-server\",\"type\":\"boolean\",\"title\":\"Connect-To-Server Schema\",\"description\":\"Indicates if only the servers listed in the 'connect-to-server-names' list should be connected to\",\"default\":false,\"examples\":[false]},\"connect-to-server-names\":{\"$id\":\"#/properties/network/properties/connect-to-server-names\",\"type\":\"string\",\"title\":\"Connect-To-Server-Names Schema\",\"description\":\"Semi-colon separated list of servers that are valid to connect to during server certificate validation\",\"default\":\"\",\"examples\":[\"\"]},\"server-cert-name\":{\"$id\":\"#/properties/network/properties/server-cert-name\",\"type\":\"string\",\"title\":\"Server-Cert-Name Schema\",\"description\":\"\\\"Friendly\\\" name of the server digital certificate that should be validated\",\"default\":\"\",\"examples\":[\"\"]},\"outer-identity\":{\"$id\":\"#/properties/network/properties/outer-identity\",\"type\":\"string\",\"title\":\"Outer-Identity Schema\",\"description\":\"The outer-identity of the EAP method\",\"default\":\"\",\"examples\":[\"\"]},\"fast-reconnect\":{\"$id\":\"#/properties/network/properties/fast-reconnect\",\"type\":\"boolean\",\"title\":\"Fast-Reconnect Schema\",\"description\":\"Indicate if fast reconnect should be enabled\",\"default\":false,\"examples\":[false]},\"inner-method\":{\"$id\":\"#/properties/network/properties/inner-method\",\"type\":\"string\",\"enum\":[\"eap-tls\",\"eap-MsChapV2\",\"eap-gtc\"],\"title\":\"Inner-Method Schema\",\"description\":\"Inner EAP authentication method to use\",\"default\":\"eap-tls\",\"examples\":[\"eap-MsChapV2\"]},\"auto-pac\":{\"$id\":\"#/properties/network/properties/auto-pac\",\"type\":\"boolean\",\"title\":\"Auto-Pac Schema\",\"description\":\"Indicates if automatic PAC provisioning is used for an EAP-FAST network\",\"default\":false,\"examples\":[true]},\"pac-file-path\":{\"$id\":\"#/properties/network/properties/pac-file-path\",\"type\":\"string\",\"title\":\"Pac-File-Path Schema\",\"description\":\"Full path to the PAC file for manual PAC provisioning\",\"default\":\"\",\"examples\":[\"\"]},\"pac-aid-info\":{\"$id\":\"#/properties/network/properties/pac-aid-info\",\"type\":\"string\",\"title\":\"Pac-Aid-Info Schema\",\"description\":\"PAC authority identity (AID) information used to select PAC from a list of PACs on the device\",\"default\":\"\",\"examples\":[\"\"]}},\"if\":{\"properties\":{\"mode\":{\"enum\":[\"wpa-psk\",\"wpa2-psk\",\"wep-40\",\"wep-104\"]}}},\"then\":{\"required\":[\"mode-key\"]}},\"deployment\":{\"$id\":\"#/properties/deployment\",\"type\":\"object\",\"title\":\"Deployment-Section Schema\",\"description\":\"Section used to download a ZIP archive from a server and inflate it to the 'target-path' folder\",\"properties\":{\"scheme\":{\"$id\":\"#/properties/deployment/properties/scheme\",\"type\":\"string\",\"enum\":[\"http\",\"https\"],\"title\":\"Scheme Schema\",\"description\":\"Deployment download scheme to use\",\"default\":\"http\",\"examples\":[\"http\"]},\"host\":{\"$id\":\"#/properties/deployment/properties/host\",\"type\":\"string\",\"title\":\"Host Schema\",\"description\":\"Host name or internet protocol address of the server from which the resource is to be fetched\",\"default\":\"\",\"examples\":[\"10.1.20.123\"]},\"port\":{\"$id\":\"#/properties/deployment/properties/port\",\"type\":\"integer\",\"title\":\"Port Schema\",\"description\":\"TCP/IP port to be used to contact the server\",\"default\":80,\"examples\":[8080],\"minimum\":0,\"maximum\":65535},\"path\":{\"$id\":\"#/properties/deployment/properties/path\",\"type\":\"string\",\"title\":\"Path Schema\",\"description\":\"Path to server resource to download, complete with query string if needed\",\"default\":\"\",\"examples\":[\"target.zip\"]}},\"required\":[\"host\"]},\"shell\":{\"$id\":\"#/properties/shell\",\"type\":\"object\",\"title\":\"Shell-Section Schema\",\"description\":\"Section for executable shell commands to be performed in the final staging phase\",\"required\":[\"cmds\"],\"properties\":{\"cmds\":{\"$id\":\"#/properties/shell/properties/cmds\",\"type\":\"array\",\"title\":\"Cmds Schema\",\"description\":\"Each object in 'cmds' is a shell command to execute in the final phase of staging\",\"items\":{\"$id\":\"#/properties/shell/properties/cmds/items\",\"type\":\"object\",\"title\":\"Items Schema\",\"required\":[\"app-name\"],\"properties\":{\"app-name\":{\"$id\":\"#/properties/shell/properties/cmds/items/properties/app-name\",\"type\":\"string\",\"title\":\"App-Name Schema\",\"description\":\"Full path to the application to be executed\",\"default\":\"\",\"examples\":[\"\\\\windows\\\\dldxu.exe\"]},\"args\":{\"$id\":\"#/properties/shell/properties/cmds/items/properties/args\",\"type\":\"string\",\"title\":\"Args Schema\",\"description\":\"Command line arguments\",\"default\":\"\",\"examples\":[\"\\\\FlashDisk\\\\target\\\\config.dxu\"]}}}}}}},\"title\":\"CE-Scan2Deploy Schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CE-Scan2Deploy Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/datalogic-scan2deploy-ce.json","definitions":{},"description":"Schema to validate Windows CE JSON files given as input to DL-Config to generate Scan2Deploy barcodes","properties":{"layout":{"$id":"#/properties/layout","type":"object","title":"Layout Schema","properties":{"description":{"$id":"#/properties/layout/properties/description","type":"string","title":"Description Schema","default":"none","examples":["This is for our WEC7 devices"],"maxLength":350}}},"global":{"$id":"#/properties/global","type":"object","title":"Global-Section Schema","description":"Section used to configure application scoped settings","properties":{"target-path":{"$id":"#/properties/global/properties/target-path","type":"string","title":"Target-Path Schema","description":"Base destination folder where archive/folder will be inflated","default":"\\FlashDisk","examples":["\\FlashDisk"]},"action":{"$id":"#/properties/global/properties/action","type":"string","enum":["stay","close","warm-boot","cold-boot","clean-boot"],"title":"Action Schema","description":"Specifies final action performed by the application at the end of the staging process","default":"cold-boot","examples":["warm-boot"]},"ping-timeout":{"$id":"#/properties/global/properties/ping-timeout","type":"integer","title":"Ping-Timeout Schema","description":"The timeout value used when attempting to reach the host server","default":1000,"examples":[1000],"minimum":1,"maximum":4000}}},"settings":{"$id":"#/properties/settings","type":"object","title":"Settings-Section Schema","description":"Section used to configure inner device settings","properties":{"usb-function":{"$id":"#/properties/settings/properties/usb-function","type":"string","enum":["active-sync-usb","active-sync-com","usblan","mass-storage"],"title":"USB-Function Schema","description":"USB communication function to use","default":"active-sync-usb","examples":["usblan"]}}},"network":{"$id":"#/properties/network","type":"object","title":"Network-Section Schema","description":"Section used to configure device Wi-Fi network","properties":{"profile":{"$id":"#/properties/network/properties/profile","type":"string","title":"Profile Schema","description":"\"Friendly\" name to associate with the network connection","default":"datalogic","examples":["my_fast"]},"essid":{"$id":"#/properties/network/properties/essid","type":"string","title":"Essid Schema","description":"Wireless network ESSID","default":"tsunami","examples":["eapfast"]},"mode":{"$id":"#/properties/network/properties/mode","type":"string","enum":["open","wep-40","wep-104","wpa-psk","wpa2-psk","wpa-tkip","wpa2-aes"],"title":"Mode Schema","description":"Wireless connection mode","default":"open","examples":["wpa2-aes"]},"mode-key":{"$id":"#/properties/network/properties/mode-key","type":"string","title":"Mode-Key Schema","description":"Wireless network key for 'wep-40', 'wep-104', 'wpa-psk', and 'wpa2-psk' networks","default":"","examples":["0123456789"],"minLength":5,"maxLength":63},"index":{"$id":"#/properties/network/properties/index","type":"integer","title":"Index Schema","description":"Wireless network key index for 'wep-40' and 'wep-104' networks","default":1,"examples":[1],"minimum":1,"maximum":4},"eap-method":{"$id":"#/properties/network/properties/eap-method","type":"string","enum":["none","peap","tls","ttls","fast","leap"],"title":"Eap-Method Schema","description":"Configures the EAP authentication method","default":"none","examples":["fast"]},"eap-username":{"$id":"#/properties/network/properties/eap-username","type":"string","title":"Eap-Username Schema","description":"Username for the EAP method","default":"","examples":["eapfast"]},"eap-password":{"$id":"#/properties/network/properties/eap-password","type":"string","title":"Eap-Password Schema","description":"Password for EAP method","default":"","examples":["1234567890"]},"credentials-type":{"$id":"#/properties/network/properties/credentials-type","type":"string","enum":["password","token","certificate","unknown"],"title":"Credentials-Type Schema","description":"Indicates the EAP credentials type","default":"password","examples":["password"]},"credentials-source":{"$id":"#/properties/network/properties/credentials-source","type":"string","enum":["user","logon","profile","auto","unknown"],"title":"Credentials-Source Schema","description":"Indicates the EAP credentials source","default":"user","examples":["profile"]},"validate-server":{"$id":"#/properties/network/properties/validate-server","type":"boolean","title":"Validate-Server Schema","description":"Indicates if the server certificate should be validated","default":false,"examples":[false]},"connect-to-server":{"$id":"#/properties/network/properties/connect-to-server","type":"boolean","title":"Connect-To-Server Schema","description":"Indicates if only the servers listed in the 'connect-to-server-names' list should be connected to","default":false,"examples":[false]},"connect-to-server-names":{"$id":"#/properties/network/properties/connect-to-server-names","type":"string","title":"Connect-To-Server-Names Schema","description":"Semi-colon separated list of servers that are valid to connect to during server certificate validation","default":"","examples":[""]},"server-cert-name":{"$id":"#/properties/network/properties/server-cert-name","type":"string","title":"Server-Cert-Name Schema","description":"\"Friendly\" name of the server digital certificate that should be validated","default":"","examples":[""]},"outer-identity":{"$id":"#/properties/network/properties/outer-identity","type":"string","title":"Outer-Identity Schema","description":"The outer-identity of the EAP method","default":"","examples":[""]},"fast-reconnect":{"$id":"#/properties/network/properties/fast-reconnect","type":"boolean","title":"Fast-Reconnect Schema","description":"Indicate if fast reconnect should be enabled","default":false,"examples":[false]},"inner-method":{"$id":"#/properties/network/properties/inner-method","type":"string","enum":["eap-tls","eap-MsChapV2","eap-gtc"],"title":"Inner-Method Schema","description":"Inner EAP authentication method to use","default":"eap-tls","examples":["eap-MsChapV2"]},"auto-pac":{"$id":"#/properties/network/properties/auto-pac","type":"boolean","title":"Auto-Pac Schema","description":"Indicates if automatic PAC provisioning is used for an EAP-FAST network","default":false,"examples":[true]},"pac-file-path":{"$id":"#/properties/network/properties/pac-file-path","type":"string","title":"Pac-File-Path Schema","description":"Full path to the PAC file for manual PAC provisioning","default":"","examples":[""]},"pac-aid-info":{"$id":"#/properties/network/properties/pac-aid-info","type":"string","title":"Pac-Aid-Info Schema","description":"PAC authority identity (AID) information used to select PAC from a list of PACs on the device","default":"","examples":[""]}},"if":{"properties":{"mode":{"enum":["wpa-psk","wpa2-psk","wep-40","wep-104"]}}},"then":{"required":["mode-key"]}},"deployment":{"$id":"#/properties/deployment","type":"object","title":"Deployment-Section Schema","description":"Section used to download a ZIP archive from a server and inflate it to the 'target-path' folder","properties":{"scheme":{"$id":"#/properties/deployment/properties/scheme","type":"string","enum":["http","https"],"title":"Scheme Schema","description":"Deployment download scheme to use","default":"http","examples":["http"]},"host":{"$id":"#/properties/deployment/properties/host","type":"string","title":"Host Schema","description":"Host name or internet protocol address of the server from which the resource is to be fetched","default":"","examples":["10.1.20.123"]},"port":{"$id":"#/properties/deployment/properties/port","type":"integer","title":"Port Schema","description":"TCP/IP port to be used to contact the server","default":80,"examples":[8080],"minimum":0,"maximum":65535},"path":{"$id":"#/properties/deployment/properties/path","type":"string","title":"Path Schema","description":"Path to server resource to download, complete with query string if needed","default":"","examples":["target.zip"]}},"required":["host"]},"shell":{"$id":"#/properties/shell","type":"object","title":"Shell-Section Schema","description":"Section for executable shell commands to be performed in the final staging phase","required":["cmds"],"properties":{"cmds":{"$id":"#/properties/shell/properties/cmds","type":"array","title":"Cmds Schema","description":"Each object in 'cmds' is a shell command to execute in the final phase of staging","items":{"$id":"#/properties/shell/properties/cmds/items","type":"object","title":"Items Schema","required":["app-name"],"properties":{"app-name":{"$id":"#/properties/shell/properties/cmds/items/properties/app-name","type":"string","title":"App-Name Schema","description":"Full path to the application to be executed","default":"","examples":["\\windows\\dldxu.exe"]},"args":{"$id":"#/properties/shell/properties/cmds/items/properties/args","type":"string","title":"Args Schema","description":"Command line arguments","default":"","examples":["\\FlashDisk\\target\\config.dxu"]}}}}}}},"title":"CE-Scan2Deploy Schema","type":"object"}
|
Provide a JSON object that satisfies the schema "CE-Scan2Deploy Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
CE-Scan2Deploy Schema
|
schema-store
|
schema_store_244
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"DataProductSpecification\",\"description\":\"Data product description, including the output ports. It is based on the [Data Product Specification](https://dataproduct-specification.com/).\",\"required\":[\"id\",\"info\"],\"properties\":{\"dataProductSpecification\":{\"type\":\"string\",\"title\":\"DataProductSpecificationVersion\",\"enum\":[\"0.0.1\"],\"description\":\"Specifies the Data Product Specification being used.\"},\"id\":{\"type\":\"string\",\"description\":\"An organizational unique technical identifier for this data product, such as an UUID, URN, string, number. Format must be a valid path parameter for GET and DELETE requests, so no URI or '/' allowed.\",\"example\":\"search-queries-all\"},\"info\":{\"type\":\"object\",\"description\":\"Information about the data product\",\"required\":[\"title\",\"owner\"],\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"The display name of this data product\",\"example\":\"Search Queries all\"},\"owner\":{\"type\":\"string\",\"description\":\"The technical id of the team that owns the data product\",\"example\":\"search-team\"},\"domain\":{\"type\":\"string\",\"description\":\"The technical id of the domain\",\"example\":\"ecommerce\"},\"description\":{\"type\":\"string\",\"example\":\"All search queries with user interactions\"},\"status\":{\"type\":\"string\",\"x-extensible-enum\":[\"proposed\",\"in development\",\"active\",\"retired\"],\"example\":\"active\"},\"archetype\":{\"type\":\"string\",\"description\":\"The domain data archetype of the data product, such as consumer-aligned, aggregate, source-aligned.\",\"x-extensible-enum\":[\"consumer-aligned\",\"aggregate\",\"source-aligned\"],\"example\":\"consumer-aligned\"},\"maturity\":{\"type\":\"string\",\"description\":\"The maturity level of the data product.\",\"x-extensible-enum\":[\"raw\",\"defined\",\"managed\"],\"example\":\"managed\",\"deprecationMessage\":\"Use the description field instead for now or the archetype.\"}}},\"inputPorts\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"name\",\"sourceSystemId\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"A technical identifier for this input port, such as an UUID, URN, string, number.\",\"example\":\"kafka_search_topic\"},\"name\":{\"type\":\"string\",\"description\":\"The display name for this input port.\",\"example\":\"kafka_search_topic\"},\"description\":{\"type\":\"string\",\"description\":\"The description for this input port.\",\"example\":\"Kafka Topic with search events\"},\"sourceSystemId\":{\"type\":\"string\",\"description\":\"A technical identifier for the source system connected to this input port\",\"example\":\"search-service\"},\"type\":{\"type\":\"string\",\"description\":\"The technical type of the output port\",\"example\":\"Kafka\"},\"location\":{\"type\":\"string\",\"description\":\"The location with the actual data\",\"example\":\"search topic\"},\"links\":{\"type\":\"object\",\"description\":\"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.\",\"additionalProperties\":{\"type\":\"string\"},\"example\":{\"schema\":\"https://catalog.example.com/search/search-queries\",\"catalog\":\"https://catalog.example.com/search/search-queries/\"}},\"custom\":{\"type\":\"object\",\"description\":\"Custom fields can be used to add additional information to the input port.\",\"additionalProperties\":{\"type\":\"string\"}},\"tags\":{\"type\":\"array\",\"description\":\"Tags are used to categorize input ports.\",\"items\":{\"type\":\"string\",\"example\":\"kafka\"},\"example\":[\"kafka\",\"search\"]}}}},\"outputPorts\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"A technical identifier for this output port, such as an UUID, URN, string, number.\",\"example\":\"snowflake_search_queries_all_npii_v1\"},\"name\":{\"type\":\"string\",\"description\":\"The display name for this output port.\",\"example\":\"snowflake_search_queries_all_npii_v1\"},\"description\":{\"type\":\"string\",\"description\":\"The description for this output port.\",\"example\":\"All search queries and result sets with PII removed.\"},\"type\":{\"type\":\"string\",\"description\":\"The technical type of the output port\",\"x-extensible-enum\":[\"snowflake\",\"kafka\",\"bigquery\",\"s3\",\"postgres\",\"redshift\"],\"example\":\"snowflake\"},\"status\":{\"type\":\"string\",\"description\":\"The status of the output port implementation. The allowed status values might be customized for your organization.\",\"x-extensible-enum\":[\"proposed\",\"in development\",\"active\",\"retired\"],\"example\":\"active\"},\"location\":{\"type\":\"string\",\"description\":\"DEPRECATED. Use the appropriate fields in server instead.\",\"example\":\"SEARCH_DB.SEARCH_QUERIES_ALL_NPII_V1\",\"deprecated\":true},\"server\":{\"type\":\"object\",\"properties\":{\"project\":{\"type\":\"string\",\"description\":\"The project name (bigquery)\",\"example\":\"dp-search\"},\"dataset\":{\"type\":\"string\",\"description\":\"The dataset name (bigquery)\",\"example\":\"search-queries\"},\"account\":{\"type\":\"string\",\"description\":\"The account name (snowflake)\",\"example\":\"https://acme-test_aws_us_east_2.snowflakecomputing.com\"},\"database\":{\"type\":\"string\",\"description\":\"The database name (snowflake,postgres)\",\"example\":\"SEARCH_DB\"},\"schema\":{\"type\":\"string\",\"description\":\"The schema name (snowflake,postgres)\",\"example\":\"SEARCH_QUERIES_ALL_NPII_V1\"},\"host\":{\"type\":\"string\",\"description\":\"The host name (kafka)\",\"example\":\"kafka.acme.com\"},\"topic\":{\"type\":\"string\",\"description\":\"The topic name (kafka)\",\"example\":\"search-queries\"},\"location\":{\"type\":\"string\",\"description\":\"The location url (s3)\",\"example\":\"s3://acme-search-queries\"},\"delimiter\":{\"type\":\"string\",\"description\":\"The delimiter (s3)\",\"example\":\"\\\"newline\\\"\"},\"format\":{\"type\":\"string\",\"description\":\"The format of the data, e.g., csv, json, parquet, delta (s3)\",\"example\":\"\\\"json\\\"\"},\"table\":{\"type\":\"string\",\"description\":\"The table name (postgres)\",\"example\":\"search_queries\"},\"view\":{\"type\":\"string\",\"description\":\"The view name (postgres)\",\"example\":\"search_queries\"},\"share\":{\"type\":\"string\",\"description\":\"The share name (databricks)\"},\"additionalProperties\":{\"type\":\"string\"}},\"description\":\"The server contains all connection details to find the actual data. Depending on the output port type, this might be different attributes. The main ones are listed explicitly, but feel free to add your own server info.\"},\"links\":{\"type\":\"object\",\"description\":\"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.\",\"additionalProperties\":{\"type\":\"string\"},\"example\":{\"schema\":\"https://catalog.example.com/search/search-queries\",\"catalog\":\"https://catalog.example.com/search/search-queries/\"}},\"custom\":{\"type\":\"object\",\"description\":\"Custom fields can be used to add additional information to the output port.\",\"additionalProperties\":{\"type\":\"string\"}},\"containsPii\":{\"type\":\"boolean\",\"description\":\"Flag, if this output port contains personally identifiable information (PII)\",\"example\":false,\"default\":false},\"autoApprove\":{\"type\":\"boolean\",\"description\":\"Automatically approve requested data usage agreements towards this output port. You might want to use this for public or internal data that is not sensitive.\",\"example\":false,\"default\":false},\"dataContractId\":{\"type\":\"string\",\"description\":\"The technical identifier of the data contract that is implemented by this output port\",\"example\":\"search-queries-all\"},\"tags\":{\"type\":\"array\",\"description\":\"Tags are used to categorize output ports.\",\"items\":{\"type\":\"string\",\"example\":\"snowflake\"},\"example\":[\"snowflake\",\"search\"]}}}},\"links\":{\"type\":\"object\",\"description\":\"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.\",\"additionalProperties\":{\"type\":\"string\"},\"example\":{\"dataProduct\":\"https://example.com/dataproducts/search-queries\",\"documentation\":\"https://git.example.com/search/search-queries/README.md\",\"catalog\":\"https://catalog.example.com/search/search-queries/\",\"repository\":\"https://git.example.com/search/search-queries\"}},\"custom\":{\"type\":\"object\",\"description\":\"Custom fields can be used to add additional information to the data product.\",\"additionalProperties\":{\"type\":\"string\"}},\"tags\":{\"type\":\"array\",\"description\":\"Tags are used to categorize data products.\",\"items\":{\"type\":\"string\",\"example\":\"high-quality\"},\"example\":[\"high-quality\",\"marketing\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DataProductSpecification\". Here are the required top‑level fields: id, info. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"DataProductSpecification","description":"Data product description, including the output ports. It is based on the [Data Product Specification](https://dataproduct-specification.com/).","required":["id","info"],"properties":{"dataProductSpecification":{"type":"string","title":"DataProductSpecificationVersion","enum":["0.0.1"],"description":"Specifies the Data Product Specification being used."},"id":{"type":"string","description":"An organizational unique technical identifier for this data product, such as an UUID, URN, string, number. Format must be a valid path parameter for GET and DELETE requests, so no URI or '/' allowed.","example":"search-queries-all"},"info":{"type":"object","description":"Information about the data product","required":["title","owner"],"properties":{"title":{"type":"string","description":"The display name of this data product","example":"Search Queries all"},"owner":{"type":"string","description":"The technical id of the team that owns the data product","example":"search-team"},"domain":{"type":"string","description":"The technical id of the domain","example":"ecommerce"},"description":{"type":"string","example":"All search queries with user interactions"},"status":{"type":"string","x-extensible-enum":["proposed","in development","active","retired"],"example":"active"},"archetype":{"type":"string","description":"The domain data archetype of the data product, such as consumer-aligned, aggregate, source-aligned.","x-extensible-enum":["consumer-aligned","aggregate","source-aligned"],"example":"consumer-aligned"},"maturity":{"type":"string","description":"The maturity level of the data product.","x-extensible-enum":["raw","defined","managed"],"example":"managed","deprecationMessage":"Use the description field instead for now or the archetype."}}},"inputPorts":{"type":"array","items":{"type":"object","required":["id","name","sourceSystemId"],"properties":{"id":{"type":"string","description":"A technical identifier for this input port, such as an UUID, URN, string, number.","example":"kafka_search_topic"},"name":{"type":"string","description":"The display name for this input port.","example":"kafka_search_topic"},"description":{"type":"string","description":"The description for this input port.","example":"Kafka Topic with search events"},"sourceSystemId":{"type":"string","description":"A technical identifier for the source system connected to this input port","example":"search-service"},"type":{"type":"string","description":"The technical type of the output port","example":"Kafka"},"location":{"type":"string","description":"The location with the actual data","example":"search topic"},"links":{"type":"object","description":"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.","additionalProperties":{"type":"string"},"example":{"schema":"https://catalog.example.com/search/search-queries","catalog":"https://catalog.example.com/search/search-queries/"}},"custom":{"type":"object","description":"Custom fields can be used to add additional information to the input port.","additionalProperties":{"type":"string"}},"tags":{"type":"array","description":"Tags are used to categorize input ports.","items":{"type":"string","example":"kafka"},"example":["kafka","search"]}}}},"outputPorts":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"A technical identifier for this output port, such as an UUID, URN, string, number.","example":"snowflake_search_queries_all_npii_v1"},"name":{"type":"string","description":"The display name for this output port.","example":"snowflake_search_queries_all_npii_v1"},"description":{"type":"string","description":"The description for this output port.","example":"All search queries and result sets with PII removed."},"type":{"type":"string","description":"The technical type of the output port","x-extensible-enum":["snowflake","kafka","bigquery","s3","postgres","redshift"],"example":"snowflake"},"status":{"type":"string","description":"The status of the output port implementation. The allowed status values might be customized for your organization.","x-extensible-enum":["proposed","in development","active","retired"],"example":"active"},"location":{"type":"string","description":"DEPRECATED. Use the appropriate fields in server instead.","example":"SEARCH_DB.SEARCH_QUERIES_ALL_NPII_V1","deprecated":true},"server":{"type":"object","properties":{"project":{"type":"string","description":"The project name (bigquery)","example":"dp-search"},"dataset":{"type":"string","description":"The dataset name (bigquery)","example":"search-queries"},"account":{"type":"string","description":"The account name (snowflake)","example":"https://acme-test_aws_us_east_2.snowflakecomputing.com"},"database":{"type":"string","description":"The database name (snowflake,postgres)","example":"SEARCH_DB"},"schema":{"type":"string","description":"The schema name (snowflake,postgres)","example":"SEARCH_QUERIES_ALL_NPII_V1"},"host":{"type":"string","description":"The host name (kafka)","example":"kafka.acme.com"},"topic":{"type":"string","description":"The topic name (kafka)","example":"search-queries"},"location":{"type":"string","description":"The location url (s3)","example":"s3://acme-search-queries"},"delimiter":{"type":"string","description":"The delimiter (s3)","example":"\"newline\""},"format":{"type":"string","description":"The format of the data, e.g., csv, json, parquet, delta (s3)","example":"\"json\""},"table":{"type":"string","description":"The table name (postgres)","example":"search_queries"},"view":{"type":"string","description":"The view name (postgres)","example":"search_queries"},"share":{"type":"string","description":"The share name (databricks)"},"additionalProperties":{"type":"string"}},"description":"The server contains all connection details to find the actual data. Depending on the output port type, this might be different attributes. The main ones are listed explicitly, but feel free to add your own server info."},"links":{"type":"object","description":"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.","additionalProperties":{"type":"string"},"example":{"schema":"https://catalog.example.com/search/search-queries","catalog":"https://catalog.example.com/search/search-queries/"}},"custom":{"type":"object","description":"Custom fields can be used to add additional information to the output port.","additionalProperties":{"type":"string"}},"containsPii":{"type":"boolean","description":"Flag, if this output port contains personally identifiable information (PII)","example":false,"default":false},"autoApprove":{"type":"boolean","description":"Automatically approve requested data usage agreements towards this output port. You might want to use this for public or internal data that is not sensitive.","example":false,"default":false},"dataContractId":{"type":"string","description":"The technical identifier of the data contract that is implemented by this output port","example":"search-queries-all"},"tags":{"type":"array","description":"Tags are used to categorize output ports.","items":{"type":"string","example":"snowflake"},"example":["snowflake","search"]}}}},"links":{"type":"object","description":"Links are used to reference external resources, such as schemas or the dataset in a data catalog. You can add any links.","additionalProperties":{"type":"string"},"example":{"dataProduct":"https://example.com/dataproducts/search-queries","documentation":"https://git.example.com/search/search-queries/README.md","catalog":"https://catalog.example.com/search/search-queries/","repository":"https://git.example.com/search/search-queries"}},"custom":{"type":"object","description":"Custom fields can be used to add additional information to the data product.","additionalProperties":{"type":"string"}},"tags":{"type":"array","description":"Tags are used to categorize data products.","items":{"type":"string","example":"high-quality"},"example":["high-quality","marketing"]}}}
|
Provide a JSON object that satisfies the schema "DataProductSpecification". Here are the required top‑level fields: id, info. Return only the valid JSON object.
|
DataProductSpecification
|
schema-store
|
schema_store_245
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"dbt_project\",\"type\":\"object\",\"required\":[\"name\"],\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"properties\":{\"version\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"analysis-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"asset-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"clean-targets\":{\"$ref\":\"#/$defs/array_of_strings\"},\"config-version\":{\"type\":\"integer\",\"default\":2},\"data_tests\":{\"$ref\":\"#/$defs/data_test_configs\"},\"dbt-cloud\":{\"type\":\"object\",\"properties\":{\"project-id\":{\"type\":\"number\"}},\"additionalProperties\":true},\"dispatch\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"macro_namespace\",\"search_order\"],\"properties\":{\"macro_namespace\":{\"type\":\"string\"},\"search_order\":{\"$ref\":\"#/$defs/array_of_strings\"}},\"additionalProperties\":false}},\"docs-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"flags\":{\"type\":\"object\",\"properties\":{\"cache_selected_only\":{\"type\":\"boolean\"},\"debug\":{\"type\":\"boolean\"},\"fail_fast\":{\"type\":\"boolean\"},\"indirect_selection\":{\"type\":\"string\"},\"log_format\":{\"type\":\"string\"},\"log_format_file\":{\"type\":\"string\"},\"log_level\":{\"type\":\"string\"},\"log_level_file\":{\"type\":\"string\"},\"partial_parse\":{\"type\":\"boolean\"},\"populate_cache\":{\"type\":\"boolean\"},\"printer_width\":{\"type\":\"integer\"},\"require_explicit_package_overrides_for_builtin_materializations\":{\"type\":\"boolean\"},\"require_resource_names_without_spaces\":{\"type\":\"boolean\"},\"send_anonymous_usage_stats\":{\"type\":\"boolean\"},\"source_freshness_run_project_hooks\":{\"type\":\"boolean\"},\"static_parser\":{\"type\":\"boolean\"},\"use_colors\":{\"type\":\"boolean\"},\"use_colors_file\":{\"type\":\"boolean\"},\"use_experimental_parser\":{\"type\":\"boolean\"},\"version_check\":{\"type\":\"boolean\"},\"warn_error\":{\"type\":\"boolean\"},\"warn_error_options\":{\"type\":\"object\"},\"write_json\":{\"type\":\"boolean\"}}},\"log-path\":{\"type\":\"string\"},\"macro-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"model-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"models\":{\"$ref\":\"#/$defs/model_configs\"},\"on-run-end\":{\"anyOf\":[{\"$ref\":\"#/$defs/array_of_strings\"},{\"type\":\"string\"}]},\"on-run-start\":{\"anyOf\":[{\"$ref\":\"#/$defs/array_of_strings\"},{\"type\":\"string\"}]},\"packages-install-path\":{\"type\":\"string\"},\"profile\":{\"type\":\"string\"},\"query-comment\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"append\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"comment\":{\"type\":\"string\"},\"job-label\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}},\"additionalProperties\":false}]},\"quoting\":{\"type\":\"object\",\"properties\":{\"database\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"identifier\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"schema\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}}},\"require-dbt-version\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"seed-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"seeds\":{\"$ref\":\"#/$defs/seed_configs\"},\"snapshot-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"snapshots\":{\"$ref\":\"#/$defs/snapshot_configs\"},\"sources\":{\"$ref\":\"#/$defs/source_configs\"},\"target-path\":{\"type\":\"string\"},\"test-paths\":{\"$ref\":\"#/$defs/array_of_strings\"},\"tests\":{\"$ref\":\"#/$defs/data_test_configs\"},\"unit_tests\":{\"$ref\":\"#/$defs/unit_test_configs\"},\"vars\":{\"type\":\"object\"}},\"additionalProperties\":false,\"$defs\":{\"access\":{\"type\":\"string\",\"enum\":[\"private\",\"protected\",\"public\"]},\"alias\":{\"type\":\"string\"},\"array_of_strings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"auto_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"backup\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"boolean_or_jinja_string\":{\"oneOf\":[{\"$ref\":\"#/$defs/jinja_string\"},{\"type\":\"boolean\"}]},\"column_types\":{\"type\":\"object\",\"patternProperties\":{\"\":{\"type\":\"string\"}}},\"contract\":{\"type\":\"object\",\"required\":[\"enforced\"],\"properties\":{\"enforced\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":\"true\"}}},\"data_test_configs\":{\"title\":\"Data 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.\",\"type\":\"object\",\"properties\":{\"+alias\":{\"$ref\":\"#/$defs/alias\"},\"+database\":{\"$ref\":\"#/$defs/database\"},\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+error_if\":{\"$ref\":\"#/$defs/error_if\"},\"+fail_calc\":{\"$ref\":\"#/$defs/fail_calc\"},\"+group\":{\"$ref\":\"#/$defs/group\"},\"+limit\":{\"$ref\":\"#/$defs/limit\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+schema\":{\"$ref\":\"#/$defs/schema\"},\"+severity\":{\"$ref\":\"#/$defs/severity\"},\"+store_failures\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"+warn_if\":{\"$ref\":\"#/$defs/warn_if\"},\"alias\":{\"$ref\":\"#/$defs/alias\"},\"database\":{\"$ref\":\"#/$defs/database\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"error_if\":{\"$ref\":\"#/$defs/error_if\"},\"fail_calc\":{\"$ref\":\"#/$defs/fail_calc\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"limit\":{\"$ref\":\"#/$defs/limit\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"schema\":{\"$ref\":\"#/$defs/schema\"},\"severity\":{\"$ref\":\"#/$defs/severity\"},\"store_failures\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"tags\":{\"$ref\":\"#/$defs/tags\"},\"warn_if\":{\"$ref\":\"#/$defs/warn_if\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/data_test_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"database\":{\"type\":\"string\"},\"docs_config\":{\"title\":\"Docs config\",\"description\":\"Configurations for the appearance of nodes in the dbt documentation.\",\"type\":\"object\",\"properties\":{\"node_color\":{\"description\":\"The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.\",\"type\":\"string\",\"pattern\":\"^(#[a-fA-F0-9]{3}|#[a-fA-F0-9]{6}|[^#][a-zA-Z]*)$\"},\"show\":{\"type\":\"boolean\",\"default\":true}},\"additionalProperties\":false},\"empty_directory\":{\"type\":\"null\"},\"error_if\":{\"type\":\"string\"},\"fail_calc\":{\"type\":\"string\"},\"file_format\":{\"type\":\"string\"},\"grant_access_to\":{\"title\":\"Authorized views\",\"description\":\"Configuration, specific to BigQuery adapter, used to setup authorized views.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dataset\":{\"type\":\"string\"},\"project\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"grants\":{\"description\":\"grant config. each key is a database permission and the value is the grantee of that permission\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"}},\"additionalProperties\":false},\"group\":{\"type\":\"string\"},\"hours_to_expiration\":{\"description\":\"Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.\",\"type\":\"number\"},\"incremental_strategy\":{\"type\":\"string\"},\"invalidate_hard_deletes\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"jinja_string\":{\"type\":\"string\",\"pattern\":\"\\\\{\\\\{.*\\\\}\\\\}\"},\"kms_key_name\":{\"description\":\"Configuration, specific to BigQuery adapter, of the KMS key name used for data encryption.\",\"type\":\"string\"},\"label_configs\":{\"title\":\"Label configs\",\"description\":\"Configurations specific to BigQuery adapter used to add labels and tags to tables & views created by dbt.\",\"type\":\"object\",\"patternProperties\":{\"^[a-z][a-z0-9_-]{0,63}$\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^[a-z0-9_-]{0,64}$\"},{\"$ref\":\"#/$defs/jinja_string\"}]}},\"additionalProperties\":false},\"limit\":{\"type\":\"integer\"},\"location\":{\"type\":\"string\"},\"materialized\":{\"type\":\"string\"},\"meta\":{\"type\":\"object\"},\"model_configs\":{\"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.\",\"type\":\"object\",\"properties\":{\"+access\":{\"$ref\":\"#/$defs/access\"},\"+alias\":{\"$ref\":\"#/$defs/alias\"},\"+auto_refresh\":{\"$ref\":\"#/$defs/auto_refresh\"},\"+backup\":{\"$ref\":\"#/$defs/backup\"},\"+bind\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":false},\"+contract\":{\"$ref\":\"#/$defs/contract\"},\"+copy_grants\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+database\":{\"$ref\":\"#/$defs/database\"},\"+docs\":{\"$ref\":\"#/$defs/docs_config\"},\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+file_format\":{\"$ref\":\"#/$defs/file_format\"},\"+full_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+grant_access_to\":{\"$ref\":\"#/$defs/grant_access_to\"},\"+grants\":{\"$ref\":\"#/$defs/grants\"},\"+group\":{\"$ref\":\"#/$defs/group\"},\"+hours_to_expiration\":{\"$ref\":\"#/$defs/hours_to_expiration\"},\"+incremental_strategy\":{\"$ref\":\"#/$defs/incremental_strategy\"},\"+kms_key_name\":{\"$ref\":\"#/$defs/kms_key_name\"},\"+labels\":{\"$ref\":\"#/$defs/label_configs\"},\"+location\":{\"$ref\":\"#/$defs/location\"},\"+materialized\":{\"$ref\":\"#/$defs/materialized\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+on_configuration_change\":{\"$ref\":\"#/$defs/on_configuration_change\"},\"+on_schema_change\":{\"$ref\":\"#/$defs/on_schema_change\"},\"+persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"+post-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"+pre-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"+schema\":{\"$ref\":\"#/$defs/schema\"},\"+secure\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":false},\"+snowflake_warehouse\":{\"$ref\":\"#/$defs/snowflake_warehouse\"},\"+sql_header\":{\"$ref\":\"#/$defs/sql_header\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"+target_lag\":{\"$ref\":\"#/$defs/target_lag\"},\"+transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"access\":{\"$ref\":\"#/$defs/access\"},\"alias\":{\"$ref\":\"#/$defs/alias\"},\"auto_refresh\":{\"$ref\":\"#/$defs/auto_refresh\"},\"backup\":{\"$ref\":\"#/$defs/backup\"},\"bind\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":false},\"contract\":{\"$ref\":\"#/$defs/contract\"},\"copy_grants\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"database\":{\"$ref\":\"#/$defs/database\"},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"file_format\":{\"$ref\":\"#/$defs/file_format\"},\"full_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"grant_access_to\":{\"$ref\":\"#/$defs/grant_access_to\"},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"hours_to_expiration\":{\"$ref\":\"#/$defs/hours_to_expiration\"},\"incremental_strategy\":{\"$ref\":\"#/$defs/incremental_strategy\"},\"kms_key_name\":{\"$ref\":\"#/$defs/kms_key_name\"},\"labels\":{\"$ref\":\"#/$defs/label_configs\"},\"location\":{\"$ref\":\"#/$defs/location\"},\"materialized\":{\"$ref\":\"#/$defs/materialized\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"on_configuration_change\":{\"$ref\":\"#/$defs/on_configuration_change\"},\"on_schema_change\":{\"$ref\":\"#/$defs/on_schema_change\"},\"persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"post-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"pre-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"schema\":{\"$ref\":\"#/$defs/schema\"},\"secure\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":false},\"snowflake_warehouse\":{\"$ref\":\"#/$defs/snowflake_warehouse\"},\"sql_header\":{\"$ref\":\"#/$defs/sql_header\"},\"tags\":{\"$ref\":\"#/$defs/tags\"},\"target_lag\":{\"$ref\":\"#/$defs/target_lag\"},\"transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/model_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"on_configuration_change\":{\"type\":\"string\",\"enum\":[\"apply\",\"continue\",\"fail\"]},\"on_schema_change\":{\"type\":\"string\",\"enum\":[\"append_new_columns\",\"fail\",\"ignore\",\"sync_all_columns\"]},\"persist_docs_config\":{\"title\":\"Persist docs config\",\"description\":\"Configurations for the persistence of the dbt documentation.\",\"type\":\"object\",\"properties\":{\"columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":true},\"relation\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":true}},\"additionalProperties\":false},\"schema\":{\"type\":[\"null\",\"string\"]},\"seed_configs\":{\"title\":\"Seed configs\",\"type\":\"object\",\"properties\":{\"+column_types\":{\"$ref\":\"#/$defs/column_types\"},\"+copy_grants\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+database\":{\"$ref\":\"#/$defs/database\"},\"+docs\":{\"$ref\":\"#/$defs/docs_config\"},\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+full_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+grants\":{\"$ref\":\"#/$defs/grants\"},\"+group\":{\"$ref\":\"#/$defs/group\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"+post-hook\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"+pre-hook\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"+quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+schema\":{\"$ref\":\"#/$defs/schema\"},\"+snowflake_warehouse\":{\"$ref\":\"#/$defs/snowflake_warehouse\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"+transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"column_types\":{\"$ref\":\"#/$defs/column_types\"},\"copy_grants\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"database\":{\"$ref\":\"#/$defs/database\"},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"full_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"post-hook\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"pre-hook\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"schema\":{\"$ref\":\"#/$defs/schema\"},\"snowflake_warehouse\":{\"$ref\":\"#/$defs/snowflake_warehouse\"},\"tags\":{\"$ref\":\"#/$defs/tags\"},\"transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/seed_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"severity\":{\"oneOf\":[{\"$ref\":\"#/$defs/jinja_string\"},{\"type\":\"string\",\"enum\":[\"error\",\"warn\"]}]},\"snapshot_configs\":{\"title\":\"Snapshot configs\",\"type\":\"object\",\"properties\":{\"+alias\":{\"$ref\":\"#/$defs/alias\"},\"+check_cols\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"+docs\":{\"$ref\":\"#/$defs/docs_config\"},\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+grants\":{\"$ref\":\"#/$defs/grants\"},\"+group\":{\"$ref\":\"#/$defs/group\"},\"+invalidate_hard_deletes\":{\"$ref\":\"#/$defs/invalidate_hard_deletes\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"+post-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"+pre-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"+quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+strategy\":{\"$ref\":\"#/$defs/strategy\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"+target_database\":{\"$ref\":\"#/$defs/target_database\"},\"+target_schema\":{\"$ref\":\"#/$defs/target_schema\"},\"+transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+unique_key\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"+updated_at\":{\"$ref\":\"#/$defs/updated_at\"},\"alias\":{\"$ref\":\"#/$defs/alias\"},\"check_cols\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"invalidate_hard_deletes\":{\"$ref\":\"#/$defs/invalidate_hard_deletes\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"post-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"pre-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"strategy\":{\"$ref\":\"#/$defs/strategy\"},\"tags\":{\"$ref\":\"#/$defs/tags\"},\"target_database\":{\"$ref\":\"#/$defs/target_database\"},\"target_schema\":{\"$ref\":\"#/$defs/target_schema\"},\"transient\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"unique_key\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"updated_at\":{\"$ref\":\"#/$defs/updated_at\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/snapshot_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"snowflake_warehouse\":{\"type\":\"string\"},\"source_configs\":{\"title\":\"Source configs\",\"type\":\"object\",\"properties\":{\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"tags\":{\"$ref\":\"#/$defs/tags\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/source_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"sql_header\":{\"type\":\"string\"},\"strategy\":{\"type\":\"string\"},\"string_or_array_of_strings\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/array_of_strings\"}]},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"target_database\":{\"type\":\"string\"},\"target_lag\":{\"type\":\"string\",\"pattern\":\"^(?:downstream|\\\\d+\\\\s*(?:seconds|minutes|hours|days))$\"},\"target_schema\":{\"type\":\"string\"},\"unit_test_configs\":{\"properties\":{\"+enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"+meta\":{\"$ref\":\"#/$defs/meta\"},\"+tags\":{\"$ref\":\"#/$defs/tags\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"meta\":{\"$ref\":\"#/$defs/meta\"},\"tags\":{\"$ref\":\"#/$defs/tags\"}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/$defs/unit_test_configs\"},{\"$ref\":\"#/$defs/empty_directory\"}]}},\"updated_at\":{\"type\":\"string\"},\"warn_if\":{\"type\":\"string\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dbt_project\". Here are the required top‑level fields: name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"dbt_project","type":"object","required":["name"],"$schema":"http://json-schema.org/draft-07/schema#","properties":{"version":{"type":"string"},"name":{"type":"string"},"analysis-paths":{"$ref":"#/$defs/array_of_strings"},"asset-paths":{"$ref":"#/$defs/array_of_strings"},"clean-targets":{"$ref":"#/$defs/array_of_strings"},"config-version":{"type":"integer","default":2},"data_tests":{"$ref":"#/$defs/data_test_configs"},"dbt-cloud":{"type":"object","properties":{"project-id":{"type":"number"}},"additionalProperties":true},"dispatch":{"type":"array","items":{"type":"object","required":["macro_namespace","search_order"],"properties":{"macro_namespace":{"type":"string"},"search_order":{"$ref":"#/$defs/array_of_strings"}},"additionalProperties":false}},"docs-paths":{"$ref":"#/$defs/array_of_strings"},"flags":{"type":"object","properties":{"cache_selected_only":{"type":"boolean"},"debug":{"type":"boolean"},"fail_fast":{"type":"boolean"},"indirect_selection":{"type":"string"},"log_format":{"type":"string"},"log_format_file":{"type":"string"},"log_level":{"type":"string"},"log_level_file":{"type":"string"},"partial_parse":{"type":"boolean"},"populate_cache":{"type":"boolean"},"printer_width":{"type":"integer"},"require_explicit_package_overrides_for_builtin_materializations":{"type":"boolean"},"require_resource_names_without_spaces":{"type":"boolean"},"send_anonymous_usage_stats":{"type":"boolean"},"source_freshness_run_project_hooks":{"type":"boolean"},"static_parser":{"type":"boolean"},"use_colors":{"type":"boolean"},"use_colors_file":{"type":"boolean"},"use_experimental_parser":{"type":"boolean"},"version_check":{"type":"boolean"},"warn_error":{"type":"boolean"},"warn_error_options":{"type":"object"},"write_json":{"type":"boolean"}}},"log-path":{"type":"string"},"macro-paths":{"$ref":"#/$defs/array_of_strings"},"model-paths":{"$ref":"#/$defs/array_of_strings"},"models":{"$ref":"#/$defs/model_configs"},"on-run-end":{"anyOf":[{"$ref":"#/$defs/array_of_strings"},{"type":"string"}]},"on-run-start":{"anyOf":[{"$ref":"#/$defs/array_of_strings"},{"type":"string"}]},"packages-install-path":{"type":"string"},"profile":{"type":"string"},"query-comment":{"oneOf":[{"type":"string"},{"type":"object","properties":{"append":{"$ref":"#/$defs/boolean_or_jinja_string"},"comment":{"type":"string"},"job-label":{"$ref":"#/$defs/boolean_or_jinja_string"}},"additionalProperties":false}]},"quoting":{"type":"object","properties":{"database":{"$ref":"#/$defs/boolean_or_jinja_string"},"identifier":{"$ref":"#/$defs/boolean_or_jinja_string"},"schema":{"$ref":"#/$defs/boolean_or_jinja_string"}}},"require-dbt-version":{"$ref":"#/$defs/string_or_array_of_strings"},"seed-paths":{"$ref":"#/$defs/array_of_strings"},"seeds":{"$ref":"#/$defs/seed_configs"},"snapshot-paths":{"$ref":"#/$defs/array_of_strings"},"snapshots":{"$ref":"#/$defs/snapshot_configs"},"sources":{"$ref":"#/$defs/source_configs"},"target-path":{"type":"string"},"test-paths":{"$ref":"#/$defs/array_of_strings"},"tests":{"$ref":"#/$defs/data_test_configs"},"unit_tests":{"$ref":"#/$defs/unit_test_configs"},"vars":{"type":"object"}},"additionalProperties":false,"$defs":{"access":{"type":"string","enum":["private","protected","public"]},"alias":{"type":"string"},"array_of_strings":{"type":"array","items":{"type":"string"}},"auto_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"backup":{"$ref":"#/$defs/boolean_or_jinja_string"},"boolean_or_jinja_string":{"oneOf":[{"$ref":"#/$defs/jinja_string"},{"type":"boolean"}]},"column_types":{"type":"object","patternProperties":{"":{"type":"string"}}},"contract":{"type":"object","required":["enforced"],"properties":{"enforced":{"$ref":"#/$defs/boolean_or_jinja_string","default":"true"}}},"data_test_configs":{"title":"Data 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.","type":"object","properties":{"+alias":{"$ref":"#/$defs/alias"},"+database":{"$ref":"#/$defs/database"},"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+error_if":{"$ref":"#/$defs/error_if"},"+fail_calc":{"$ref":"#/$defs/fail_calc"},"+group":{"$ref":"#/$defs/group"},"+limit":{"$ref":"#/$defs/limit"},"+meta":{"$ref":"#/$defs/meta"},"+schema":{"$ref":"#/$defs/schema"},"+severity":{"$ref":"#/$defs/severity"},"+store_failures":{"$ref":"#/$defs/boolean_or_jinja_string"},"+tags":{"$ref":"#/$defs/tags"},"+warn_if":{"$ref":"#/$defs/warn_if"},"alias":{"$ref":"#/$defs/alias"},"database":{"$ref":"#/$defs/database"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"error_if":{"$ref":"#/$defs/error_if"},"fail_calc":{"$ref":"#/$defs/fail_calc"},"group":{"$ref":"#/$defs/group"},"limit":{"$ref":"#/$defs/limit"},"meta":{"$ref":"#/$defs/meta"},"schema":{"$ref":"#/$defs/schema"},"severity":{"$ref":"#/$defs/severity"},"store_failures":{"$ref":"#/$defs/boolean_or_jinja_string"},"tags":{"$ref":"#/$defs/tags"},"warn_if":{"$ref":"#/$defs/warn_if"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/data_test_configs"},{"$ref":"#/$defs/empty_directory"}]}},"database":{"type":"string"},"docs_config":{"title":"Docs config","description":"Configurations for the appearance of nodes in the dbt documentation.","type":"object","properties":{"node_color":{"description":"The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.","type":"string","pattern":"^(#[a-fA-F0-9]{3}|#[a-fA-F0-9]{6}|[^#][a-zA-Z]*)$"},"show":{"type":"boolean","default":true}},"additionalProperties":false},"empty_directory":{"type":"null"},"error_if":{"type":"string"},"fail_calc":{"type":"string"},"file_format":{"type":"string"},"grant_access_to":{"title":"Authorized views","description":"Configuration, specific to BigQuery adapter, used to setup authorized views.","type":"array","items":{"type":"object","properties":{"dataset":{"type":"string"},"project":{"type":"string"}},"additionalProperties":false}},"grants":{"description":"grant config. each key is a database permission and the value is the grantee of that permission","type":"object","patternProperties":{".*":{"$ref":"#/$defs/string_or_array_of_strings"}},"additionalProperties":false},"group":{"type":"string"},"hours_to_expiration":{"description":"Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.","type":"number"},"incremental_strategy":{"type":"string"},"invalidate_hard_deletes":{"$ref":"#/$defs/boolean_or_jinja_string"},"jinja_string":{"type":"string","pattern":"\\{\\{.*\\}\\}"},"kms_key_name":{"description":"Configuration, specific to BigQuery adapter, of the KMS key name used for data encryption.","type":"string"},"label_configs":{"title":"Label configs","description":"Configurations specific to BigQuery adapter used to add labels and tags to tables & views created by dbt.","type":"object","patternProperties":{"^[a-z][a-z0-9_-]{0,63}$":{"oneOf":[{"type":"string","pattern":"^[a-z0-9_-]{0,64}$"},{"$ref":"#/$defs/jinja_string"}]}},"additionalProperties":false},"limit":{"type":"integer"},"location":{"type":"string"},"materialized":{"type":"string"},"meta":{"type":"object"},"model_configs":{"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.","type":"object","properties":{"+access":{"$ref":"#/$defs/access"},"+alias":{"$ref":"#/$defs/alias"},"+auto_refresh":{"$ref":"#/$defs/auto_refresh"},"+backup":{"$ref":"#/$defs/backup"},"+bind":{"$ref":"#/$defs/boolean_or_jinja_string","default":false},"+contract":{"$ref":"#/$defs/contract"},"+copy_grants":{"$ref":"#/$defs/boolean_or_jinja_string"},"+database":{"$ref":"#/$defs/database"},"+docs":{"$ref":"#/$defs/docs_config"},"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+file_format":{"$ref":"#/$defs/file_format"},"+full_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"+grant_access_to":{"$ref":"#/$defs/grant_access_to"},"+grants":{"$ref":"#/$defs/grants"},"+group":{"$ref":"#/$defs/group"},"+hours_to_expiration":{"$ref":"#/$defs/hours_to_expiration"},"+incremental_strategy":{"$ref":"#/$defs/incremental_strategy"},"+kms_key_name":{"$ref":"#/$defs/kms_key_name"},"+labels":{"$ref":"#/$defs/label_configs"},"+location":{"$ref":"#/$defs/location"},"+materialized":{"$ref":"#/$defs/materialized"},"+meta":{"$ref":"#/$defs/meta"},"+on_configuration_change":{"$ref":"#/$defs/on_configuration_change"},"+on_schema_change":{"$ref":"#/$defs/on_schema_change"},"+persist_docs":{"$ref":"#/$defs/persist_docs_config"},"+post-hook":{"$ref":"#/$defs/array_of_strings"},"+pre-hook":{"$ref":"#/$defs/array_of_strings"},"+schema":{"$ref":"#/$defs/schema"},"+secure":{"$ref":"#/$defs/boolean_or_jinja_string","default":false},"+snowflake_warehouse":{"$ref":"#/$defs/snowflake_warehouse"},"+sql_header":{"$ref":"#/$defs/sql_header"},"+tags":{"$ref":"#/$defs/tags"},"+target_lag":{"$ref":"#/$defs/target_lag"},"+transient":{"$ref":"#/$defs/boolean_or_jinja_string"},"access":{"$ref":"#/$defs/access"},"alias":{"$ref":"#/$defs/alias"},"auto_refresh":{"$ref":"#/$defs/auto_refresh"},"backup":{"$ref":"#/$defs/backup"},"bind":{"$ref":"#/$defs/boolean_or_jinja_string","default":false},"contract":{"$ref":"#/$defs/contract"},"copy_grants":{"$ref":"#/$defs/boolean_or_jinja_string"},"database":{"$ref":"#/$defs/database"},"docs":{"$ref":"#/$defs/docs_config"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"file_format":{"$ref":"#/$defs/file_format"},"full_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"grant_access_to":{"$ref":"#/$defs/grant_access_to"},"grants":{"$ref":"#/$defs/grants"},"group":{"$ref":"#/$defs/group"},"hours_to_expiration":{"$ref":"#/$defs/hours_to_expiration"},"incremental_strategy":{"$ref":"#/$defs/incremental_strategy"},"kms_key_name":{"$ref":"#/$defs/kms_key_name"},"labels":{"$ref":"#/$defs/label_configs"},"location":{"$ref":"#/$defs/location"},"materialized":{"$ref":"#/$defs/materialized"},"meta":{"$ref":"#/$defs/meta"},"on_configuration_change":{"$ref":"#/$defs/on_configuration_change"},"on_schema_change":{"$ref":"#/$defs/on_schema_change"},"persist_docs":{"$ref":"#/$defs/persist_docs_config"},"post-hook":{"$ref":"#/$defs/array_of_strings"},"pre-hook":{"$ref":"#/$defs/array_of_strings"},"schema":{"$ref":"#/$defs/schema"},"secure":{"$ref":"#/$defs/boolean_or_jinja_string","default":false},"snowflake_warehouse":{"$ref":"#/$defs/snowflake_warehouse"},"sql_header":{"$ref":"#/$defs/sql_header"},"tags":{"$ref":"#/$defs/tags"},"target_lag":{"$ref":"#/$defs/target_lag"},"transient":{"$ref":"#/$defs/boolean_or_jinja_string"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/model_configs"},{"$ref":"#/$defs/empty_directory"}]}},"on_configuration_change":{"type":"string","enum":["apply","continue","fail"]},"on_schema_change":{"type":"string","enum":["append_new_columns","fail","ignore","sync_all_columns"]},"persist_docs_config":{"title":"Persist docs config","description":"Configurations for the persistence of the dbt documentation.","type":"object","properties":{"columns":{"$ref":"#/$defs/boolean_or_jinja_string","default":true},"relation":{"$ref":"#/$defs/boolean_or_jinja_string","default":true}},"additionalProperties":false},"schema":{"type":["null","string"]},"seed_configs":{"title":"Seed configs","type":"object","properties":{"+column_types":{"$ref":"#/$defs/column_types"},"+copy_grants":{"$ref":"#/$defs/boolean_or_jinja_string"},"+database":{"$ref":"#/$defs/database"},"+docs":{"$ref":"#/$defs/docs_config"},"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+full_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"+grants":{"$ref":"#/$defs/grants"},"+group":{"$ref":"#/$defs/group"},"+meta":{"$ref":"#/$defs/meta"},"+persist_docs":{"$ref":"#/$defs/persist_docs_config"},"+post-hook":{"$ref":"#/$defs/string_or_array_of_strings"},"+pre-hook":{"$ref":"#/$defs/string_or_array_of_strings"},"+quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"+schema":{"$ref":"#/$defs/schema"},"+snowflake_warehouse":{"$ref":"#/$defs/snowflake_warehouse"},"+tags":{"$ref":"#/$defs/tags"},"+transient":{"$ref":"#/$defs/boolean_or_jinja_string"},"column_types":{"$ref":"#/$defs/column_types"},"copy_grants":{"$ref":"#/$defs/boolean_or_jinja_string"},"database":{"$ref":"#/$defs/database"},"docs":{"$ref":"#/$defs/docs_config"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"full_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"grants":{"$ref":"#/$defs/grants"},"group":{"$ref":"#/$defs/group"},"meta":{"$ref":"#/$defs/meta"},"persist_docs":{"$ref":"#/$defs/persist_docs_config"},"post-hook":{"$ref":"#/$defs/string_or_array_of_strings"},"pre-hook":{"$ref":"#/$defs/string_or_array_of_strings"},"quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"schema":{"$ref":"#/$defs/schema"},"snowflake_warehouse":{"$ref":"#/$defs/snowflake_warehouse"},"tags":{"$ref":"#/$defs/tags"},"transient":{"$ref":"#/$defs/boolean_or_jinja_string"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/seed_configs"},{"$ref":"#/$defs/empty_directory"}]}},"severity":{"oneOf":[{"$ref":"#/$defs/jinja_string"},{"type":"string","enum":["error","warn"]}]},"snapshot_configs":{"title":"Snapshot configs","type":"object","properties":{"+alias":{"$ref":"#/$defs/alias"},"+check_cols":{"$ref":"#/$defs/string_or_array_of_strings"},"+docs":{"$ref":"#/$defs/docs_config"},"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+grants":{"$ref":"#/$defs/grants"},"+group":{"$ref":"#/$defs/group"},"+invalidate_hard_deletes":{"$ref":"#/$defs/invalidate_hard_deletes"},"+meta":{"$ref":"#/$defs/meta"},"+persist_docs":{"$ref":"#/$defs/persist_docs_config"},"+post-hook":{"$ref":"#/$defs/array_of_strings"},"+pre-hook":{"$ref":"#/$defs/array_of_strings"},"+quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"+strategy":{"$ref":"#/$defs/strategy"},"+tags":{"$ref":"#/$defs/tags"},"+target_database":{"$ref":"#/$defs/target_database"},"+target_schema":{"$ref":"#/$defs/target_schema"},"+transient":{"$ref":"#/$defs/boolean_or_jinja_string"},"+unique_key":{"$ref":"#/$defs/string_or_array_of_strings"},"+updated_at":{"$ref":"#/$defs/updated_at"},"alias":{"$ref":"#/$defs/alias"},"check_cols":{"$ref":"#/$defs/string_or_array_of_strings"},"docs":{"$ref":"#/$defs/docs_config"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"grants":{"$ref":"#/$defs/grants"},"group":{"$ref":"#/$defs/group"},"invalidate_hard_deletes":{"$ref":"#/$defs/invalidate_hard_deletes"},"meta":{"$ref":"#/$defs/meta"},"persist_docs":{"$ref":"#/$defs/persist_docs_config"},"post-hook":{"$ref":"#/$defs/array_of_strings"},"pre-hook":{"$ref":"#/$defs/array_of_strings"},"quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"strategy":{"$ref":"#/$defs/strategy"},"tags":{"$ref":"#/$defs/tags"},"target_database":{"$ref":"#/$defs/target_database"},"target_schema":{"$ref":"#/$defs/target_schema"},"transient":{"$ref":"#/$defs/boolean_or_jinja_string"},"unique_key":{"$ref":"#/$defs/string_or_array_of_strings"},"updated_at":{"$ref":"#/$defs/updated_at"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/snapshot_configs"},{"$ref":"#/$defs/empty_directory"}]}},"snowflake_warehouse":{"type":"string"},"source_configs":{"title":"Source configs","type":"object","properties":{"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+meta":{"$ref":"#/$defs/meta"},"+tags":{"$ref":"#/$defs/tags"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"meta":{"$ref":"#/$defs/meta"},"tags":{"$ref":"#/$defs/tags"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/source_configs"},{"$ref":"#/$defs/empty_directory"}]}},"sql_header":{"type":"string"},"strategy":{"type":"string"},"string_or_array_of_strings":{"oneOf":[{"type":"string"},{"$ref":"#/$defs/array_of_strings"}]},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"target_database":{"type":"string"},"target_lag":{"type":"string","pattern":"^(?:downstream|\\d+\\s*(?:seconds|minutes|hours|days))$"},"target_schema":{"type":"string"},"unit_test_configs":{"properties":{"+enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"+meta":{"$ref":"#/$defs/meta"},"+tags":{"$ref":"#/$defs/tags"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"meta":{"$ref":"#/$defs/meta"},"tags":{"$ref":"#/$defs/tags"}},"additionalProperties":{"oneOf":[{"$ref":"#/$defs/unit_test_configs"},{"$ref":"#/$defs/empty_directory"}]}},"updated_at":{"type":"string"},"warn_if":{"type":"string"}}}
|
Provide a JSON object that satisfies the schema "dbt_project". Here are the required top‑level fields: name. Return only the valid JSON object.
|
dbt_project
|
schema-store
|
schema_store_246
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"dbt_yml_files\",\"type\":\"object\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"properties\":{\"version\":{\"type\":\"number\",\"const\":2},\"analyses\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"columns\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"data_type\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"config\":{\"type\":\"object\",\"properties\":{\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"}},\"additionalProperties\":false},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"group\":{\"$ref\":\"#/$defs/group\"}}}},\"data_tests\":{\"description\":\"Add descriptions to custom singular tests\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"The name of the singular test\",\"type\":\"string\"},\"description\":{\"description\":\"A description of the test's purpose, how it is implemented, and perhaps what you should do if it starts failing.\",\"type\":\"string\"}},\"additionalProperties\":false}},\"exposures\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"depends_on\",\"name\",\"owner\",\"type\"],\"$comment\":\"NB: depends_on is not strictly required, but is _expected_ according to the documentation\",\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"analysis\",\"application\",\"dashboard\",\"ml\",\"notebook\"]},\"depends_on\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"label\":{\"type\":\"string\",\"$comment\":\"Added in dbt Core v1.3\"},\"maturity\":{\"type\":\"string\",\"enum\":[\"high\",\"low\",\"medium\"]},\"meta\":{\"type\":\"object\"},\"owner\":{\"type\":\"object\",\"anyOf\":[{\"required\":[\"email\"]},{\"required\":[\"name\"]}],\"properties\":{\"name\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"}},\"additionalProperties\":false},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"url\":{\"type\":\"string\"}}}},\"groups\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"owner\"],\"properties\":{\"name\":{\"type\":\"string\"},\"owner\":{\"type\":\"object\",\"minProperties\":1,\"properties\":{\"name\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"}},\"additionalProperties\":true}},\"additionalProperties\":false}},\"macros\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"arguments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"docs\":{\"$ref\":\"#/$defs/docs_config\"}},\"additionalProperties\":false}},\"metrics\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"label\",\"name\",\"type\",\"type_params\"],\"if\":{\"properties\":{\"type\":{\"enum\":[\"SIMPLE\",\"simple\"]}}},\"then\":{\"properties\":{\"type_params\":{\"$ref\":\"#/$defs/simple_metric_type_params\"}}},\"else\":{\"if\":{\"properties\":{\"type\":{\"enum\":[\"derived\",\"DERIVED\"]}}},\"then\":{\"properties\":{\"type_params\":{\"$ref\":\"#/$defs/derived_metric_type_params\"}}},\"else\":{\"if\":{\"properties\":{\"type\":{\"enum\":[\"cumulative\",\"CUMULATIVE\"]}}},\"then\":{\"properties\":{\"type_params\":{\"$ref\":\"#/$defs/cumulative_metric_type_params\"}}},\"else\":{\"if\":{\"properties\":{\"type\":{\"enum\":[\"conversion\",\"CONVERSION\"]}}},\"then\":{\"properties\":{\"type_params\":{\"$ref\":\"#/$defs/conversion_metric_type_params\"}}},\"else\":{\"if\":{\"properties\":{\"type\":{\"enum\":[\"ratio\",\"RATIO\"]}}},\"then\":{\"properties\":{\"type_params\":{\"$ref\":\"#/$defs/ratio_metric_type_params\"}}}}}}},\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"description\":{\"type\":\"string\"},\"type\":{\"enum\":[\"CONVERSION\",\"conversion\",\"CUMULATIVE\",\"cumulative\",\"DERIVED\",\"derived\",\"RATIO\",\"ratio\",\"SIMPLE\",\"simple\"]},\"filter\":{\"type\":\"string\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"label\":{\"type\":\"string\"},\"time_granularity\":{\"type\":\"string\"},\"type_params\":{\"type\":\"object\"}},\"additionalProperties\":false}},\"models\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"access\":{\"type\":\"string\",\"enum\":[\"private\",\"protected\",\"public\"]},\"columns\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/column_properties\"}},\"config\":{\"$ref\":\"#/$defs/model_configs\"},\"constraints\":{\"$ref\":\"#/$defs/constraints\"},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"deprecation_date\":{\"type\":\"string\"},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"latest_version\":{\"type\":\"number\"},\"meta\":{\"type\":\"object\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"time_spine\":{\"type\":\"object\",\"required\":[\"standard_granularity_column\"],\"properties\":{\"standard_granularity_column\":{\"type\":\"string\"}},\"additionalProperties\":false},\"versions\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"v\"],\"properties\":{\"columns\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/$defs/include_exclude\"},{\"$ref\":\"#/$defs/column_properties\"}]}},\"config\":{\"$ref\":\"#/$defs/model_configs\"},\"v\":{\"type\":\"number\"}}}}},\"additionalProperties\":false}},\"saved_queries\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"description\",\"label\",\"name\",\"query_params\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"config\":{\"type\":\"object\",\"properties\":{\"cache\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"default\":false}},\"additionalProperties\":false},\"enabled\":{\"type\":\"boolean\",\"default\":true},\"export_as\":{\"anyOf\":[{\"enum\":[\"table\",\"view\"]},{\"type\":\"null\"}],\"default\":null},\"group\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null},\"meta\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\"}},\"schema\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null}},\"additionalProperties\":true},\"exports\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/export\"}},\"label\":{\"type\":\"string\"},\"query_params\":{\"type\":\"object\",\"properties\":{\"dimensions\":{\"$ref\":\"#/$defs/array_of_strings\"},\"metrics\":{\"$ref\":\"#/$defs/array_of_strings\"},\"where\":{\"$ref\":\"#/$defs/array_of_strings\"},\"additionalProperties\":false}},\"tags\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]}},\"additionalProperties\":false}},\"seeds\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"columns\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/column_properties\"}},\"config\":{\"type\":\"object\",\"properties\":{\"column_types\":{\"type\":\"object\"},\"copy_grants\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"database\":{\"type\":\"string\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"schema\":{\"type\":\"string\"}}},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}}},\"additionalProperties\":false}},\"semantic_models\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"model\",\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"description\":{\"type\":\"string\"},\"defaults\":{\"type\":\"object\",\"properties\":{\"agg_time_dimension\":{\"type\":\"string\"}},\"additionalProperties\":false},\"dimensions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/dimension\"}},\"entities\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/entity\"}},\"measures\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/measure\"}},\"model\":{\"type\":\"string\",\"default\":\"ref('')\"},\"primary_entity\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"snapshots\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"columns\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/column_properties\"}},\"config\":{\"type\":\"object\",\"properties\":{\"alias\":{\"type\":\"string\"},\"check_cols\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"persist_docs\":{\"$ref\":\"#/$defs/persist_docs_config\"},\"post-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"pre-hook\":{\"$ref\":\"#/$defs/array_of_strings\"},\"quote_columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"strategy\":{\"type\":\"string\"},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"target_database\":{\"type\":\"string\"},\"target_schema\":{\"type\":\"string\"},\"unique_key\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"updated_at\":{\"type\":\"string\"}}},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"docs\":{\"$ref\":\"#/$defs/docs_config\"},\"group\":{\"$ref\":\"#/$defs/group\"},\"meta\":{\"type\":\"object\"},\"relation\":{\"description\":\"Required when defining your snapshot in YAML instead of using a legacy snapshot block.\",\"type\":\"string\",\"default\":\"source('', '')\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}}},\"additionalProperties\":false}},\"sources\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"How you will identify the schema in {{ source() }} calls. Unless `schema` is also set, this will be the name of the schema in the database.\",\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"config\":{\"type\":\"object\"},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"database\":{\"type\":\"string\"},\"freshness\":{\"$ref\":\"#/$defs/freshness_definition\"},\"loaded_at_field\":{\"type\":\"string\"},\"loader\":{\"type\":\"string\"},\"meta\":{\"type\":\"object\"},\"overrides\":{\"title\":\"Package to Override\",\"description\":\"The name of another package installed in your project. If that package has a source with the same name as this one, its properties will be applied on top of the base properties of the overridden source. https://docs.getdbt.com/reference/resource-properties/overrides\",\"type\":\"string\"},\"quoting\":{\"type\":\"object\",\"properties\":{\"database\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"identifier\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"schema\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}},\"additionalProperties\":false},\"schema\":{\"description\":\"The schema name as stored in the database. Only needed if you want to use a different `name` than what exists in the database (otherwise `name` is used by default)\",\"type\":\"string\"},\"tables\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"How you will identify the table in {{ source() }} calls. Unless `identifier` is also set, this will be the name of the table in the database.\",\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"columns\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/column_properties\"}},\"config\":{\"type\":\"object\",\"properties\":{\"event_time\":{\"description\":\"The column that represents the actual moment the row's event happened. Contrast with, for example, when it was loaded to the warehouse.\",\"type\":\"string\"},\"additionalProperties\":true}},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"external\":{\"type\":\"object\"},\"freshness\":{\"$ref\":\"#/$defs/freshness_definition\"},\"identifier\":{\"title\":\"Identifier\",\"description\":\"The table name as stored in the database. Only needed if you want to give the source a different name than what exists in the database (otherwise `name` is used by default)\",\"type\":\"string\"},\"loaded_at_field\":{\"description\":\"Which column to check during data freshness tests. Only needed if the table has a different loaded_at_field to the one defined on the source overall.\",\"type\":\"string\"},\"loader\":{\"type\":\"string\"},\"meta\":{\"type\":\"object\"},\"quoting\":{\"type\":\"object\",\"properties\":{\"database\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"identifier\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"schema\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}},\"additionalProperties\":false},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}}},\"additionalProperties\":false}},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}}}}},\"unit_tests\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"expect\",\"model\",\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"config\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"meta\":{\"type\":\"object\"},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"}},\"additionalProperties\":false},\"expect\":{\"type\":\"object\",\"if\":{\"properties\":{\"format\":{\"const\":\"dict\"}}},\"then\":{\"properties\":{\"rows\":{\"description\":\"When `format` is `dict`, each item should be a dictionary containing a key-value pair for each column and its value, e.g. `{id: 1, code: 'ABC'}`\",\"type\":\"array\",\"items\":{\"type\":\"object\"}}}},\"else\":{\"properties\":{\"rows\":{\"description\":\"When `format` is csv or sql, a string containing comma-separated headers and values. Alternatively provide a fixture. Use the pipe character | to create a multi-line string in YAML.\",\"type\":\"string\"}}},\"properties\":{\"fixture\":{\"description\":\"Only relevant when format is csv. Specify the name of a fixture instead of providing `rows`.\",\"type\":\"string\"},\"format\":{\"description\":\"Defaults to `dict` when not specified\",\"type\":\"string\",\"enum\":[\"csv\",\"dict\",\"sql\"]},\"additionalProperties\":false}},\"given\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"if\":{\"properties\":{\"format\":{\"const\":\"dict\"}}},\"then\":{\"properties\":{\"rows\":{\"description\":\"When `format` is `dict`, each item should be a dictionary containing a key-value pair for each column and its value, e.g. `{id: 1, code: 'ABC'}`\",\"type\":\"array\",\"items\":{\"type\":\"object\"}}}},\"else\":{\"properties\":{\"rows\":{\"description\":\"When `format` is csv or sql, a string containing comma-separated headers and values. Alternatively provide a fixture. Use the pipe character | to create a multi-line string in YAML.\",\"type\":\"string\"}}},\"properties\":{\"fixture\":{\"description\":\"Only relevant when format is csv. Specify the name of a fixture instead of providing `rows`.\",\"type\":\"string\"},\"format\":{\"description\":\"Defaults to `dict` when not specified\",\"type\":\"string\",\"enum\":[\"csv\",\"dict\",\"sql\"]},\"input\":{\"description\":\"The relation whose inputs you need to mock. Enclose in ref or source without curly braces\",\"type\":\"string\",\"examples\":[\"ref('model_b')\",\"ref('upstream_project', 'model_b')\",\"source('schema', 'table')\"]},\"additionalProperties\":false}}},\"model\":{\"description\":\"The name of the model whose behaviour you are testing. Does not need to be wrapped in a ref.\",\"type\":\"string\",\"examples\":[\"my_model\"]},\"overrides\":{\"type\":\"object\",\"properties\":{\"env_vars\":{\"type\":\"object\"},\"macros\":{\"type\":\"object\",\"examples\":[{\"is_incremental\":\"true\"}]},\"vars\":{\"type\":\"object\"}},\"additionalProperties\":false},\"additionalProperties\":false},\"additionalProperties\":false}}},\"additionalProperties\":false,\"$defs\":{\"aggregation_type_params\":{\"type\":\"object\",\"properties\":{\"percentile\":{\"type\":\"number\"},\"use_approximate_percentile\":{\"type\":\"boolean\"},\"use_discrete_percentile\":{\"type\":\"boolean\"}},\"additionalProperties\":false},\"array_of_strings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"boolean_or_jinja_string\":{\"oneOf\":[{\"$ref\":\"#/$defs/jinja_string\"},{\"type\":\"boolean\"}],\"additionalProperties\":false},\"column_properties\":{\"type\":\"object\",\"required\":[\"name\"],\"uniqueItems\":true,\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"constraints\":{\"$ref\":\"#/$defs/constraints\"},\"data_tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}},\"data_type\":{\"type\":\"string\"},\"granularity\":{\"enum\":[\"day\",\"hour\",\"microsecond\",\"millisecond\",\"minute\",\"month\",\"nanosecond\",\"quarter\",\"second\",\"week\",\"year\"]},\"meta\":{\"type\":\"object\"},\"policy_tags\":{\"title\":\"Policy tags\",\"description\":\"Configurations, specific to BigQuery adapter, used to set policy tags on specific columns, enabling column-level security. Only relevant when `persist_docs.columns` is true.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"quote\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"tests\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/data_tests\"}}},\"additionalProperties\":false},\"constraints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"columns\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"expression\":{\"type\":\"string\"},\"warn_unenforced\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"warn_unsupported\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}}}},\"conversion_metric_type_params\":{\"type\":\"object\",\"properties\":{\"conversion_type_params\":{\"type\":\"object\",\"required\":[\"base_measure\",\"conversion_measure\",\"entity\"],\"properties\":{\"base_measure\":{\"$ref\":\"#/$defs/metric_input_measure\"},\"calculation\":{\"type\":\"string\",\"default\":\"conversion_rate\",\"enum\":[\"conversion_rate\",\"CONVERSION_RATE\",\"conversions\",\"CONVERSIONS\"]},\"constant_properties\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"base_property\",\"conversion_property\"],\"properties\":{\"base_property\":{\"description\":\"DIMENSION or ENTITY\",\"type\":\"string\"},\"conversion_property\":{\"description\":\"DIMENSION or ENTITY\",\"type\":\"string\"}}}},\"conversion_measure\":{\"$ref\":\"#/$defs/metric_input_measure\"},\"entity\":{\"description\":\"The entity to calculate over\",\"type\":\"string\"},\"window\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"cumulative_metric_type_params\":{\"type\":\"object\",\"properties\":{\"cumulative_type_params\":{\"type\":\"object\",\"properties\":{\"grain_to_date\":{\"type\":\"string\"},\"period_agg\":{\"enum\":[\"average\",\"first\",\"last\"]},\"window\":{\"type\":\"string\"}},\"additionalProperties\":false},\"grain_to_date\":{\"enum\":[\"day\",\"hour\",\"microsecond\",\"millisecond\",\"minute\",\"month\",\"nanosecond\",\"quarter\",\"second\",\"week\",\"year\"]},\"measure\":{\"$ref\":\"#/$defs/metric_input_measure\"},\"window\":{\"type\":\"string\"}},\"additionalProperties\":false},\"data_tests\":{\"anyOf\":[{\"type\":\"string\"},{\"enum\":[\"not_null\",\"unique\"]},{\"title\":\"Relationships Test\",\"type\":\"object\",\"properties\":{\"relationships\":{\"type\":\"object\",\"required\":[\"field\",\"to\"],\"properties\":{\"name\":{\"type\":\"string\"},\"config\":{\"$ref\":\"#/$defs/test_configs\"},\"field\":{\"title\":\"Relationships: Field\",\"description\":\"The foreign key column\",\"type\":\"string\",\"default\":\"<FOREIGN_KEY_COLUMN>\"},\"to\":{\"type\":\"string\",\"default\":\"ref('')\",\"examples\":[\"ref('parent_model')\",\"source('parent_schema', 'parent_table')\"]},\"where\":{\"type\":\"string\"}}}}},{\"title\":\"Accepted Values Test\",\"type\":\"object\",\"properties\":{\"accepted_values\":{\"type\":\"object\",\"required\":[\"values\"],\"properties\":{\"name\":{\"type\":\"string\"},\"config\":{\"$ref\":\"#/$defs/test_configs\"},\"quote\":{\"type\":\"boolean\"},\"values\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"where\":{\"type\":\"string\"}}}}},{\"title\":\"User defined test\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"config\":{\"$ref\":\"#/$defs/test_configs\"},\"where\":{\"type\":\"string\"}}}}}]},\"derived_metric_type_params\":{\"type\":\"object\",\"properties\":{\"expr\":{\"type\":\"string\"},\"metrics\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/metric_input_schema\"}}},\"additionalProperties\":false},\"dimension\":{\"type\":\"object\",\"required\":[\"name\",\"type\"],\"anyOf\":[{\"not\":{\"$ref\":\"#/$defs/is-time-dimension\"}},{\"required\":[\"type_params\"]}],\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"description\":{\"type\":\"string\"},\"type\":{\"enum\":[\"CATEGORICAL\",\"categorical\",\"TIME\",\"time\"]},\"config\":{\"type\":\"object\",\"properties\":{\"meta\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\"}}}},\"expr\":{\"type\":[\"boolean\",\"string\"]},\"is_partition\":{\"type\":\"boolean\"},\"type_params\":{\"$ref\":\"#/$defs/dimension_type_params\"}},\"additionalProperties\":false},\"dimension_type_params\":{\"type\":\"object\",\"required\":[\"time_granularity\"],\"properties\":{\"time_granularity\":{\"enum\":[\"DAY\",\"day\",\"HOUR\",\"hour\",\"MICROSECOND\",\"microsecond\",\"MILLISECOND\",\"millisecond\",\"MINUTE\",\"minute\",\"MONTH\",\"month\",\"NANOSECOND\",\"nanosecond\",\"QUARTER\",\"quarter\",\"SECOND\",\"second\",\"WEEK\",\"week\",\"YEAR\",\"year\"]},\"validity_params\":{\"$ref\":\"#/$defs/validity_params\"}},\"additionalProperties\":false},\"docs_config\":{\"title\":\"Docs config\",\"description\":\"Configurations for the appearance of nodes in the dbt documentation.\",\"type\":\"object\",\"properties\":{\"node_color\":{\"description\":\"The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.\",\"type\":\"string\",\"pattern\":\"^(#[a-fA-F0-9]{3}|#[a-fA-F0-9]{6}|[^#][a-zA-Z]*)$\"},\"show\":{\"type\":\"boolean\",\"default\":true}},\"additionalProperties\":false},\"entity\":{\"type\":\"object\",\"required\":[\"name\",\"type\"],\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"type\":{\"enum\":[\"FOREIGN\",\"foreign\",\"NATURAL\",\"natural\",\"PRIMARY\",\"primary\",\"UNIQUE\",\"unique\"]},\"config\":{\"type\":\"object\",\"properties\":{\"meta\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\"}}}},\"entity\":{\"type\":\"string\"},\"expr\":{\"type\":[\"boolean\",\"string\"]}},\"additionalProperties\":false},\"export\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"config\":{\"type\":\"object\",\"properties\":{\"alias\":{\"type\":\"string\"},\"export_as\":{\"enum\":[\"cache\",\"table\",\"view\"]},\"schema\":{\"type\":\"string\"}},\"additionalProperties\":true}},\"additionalProperties\":false},\"freshness_definition\":{\"default\":{\"error_after\":{\"count\":2,\"period\":\"day\"},\"warn_after\":{\"count\":1,\"period\":\"day\"}},\"oneOf\":[{\"type\":\"object\",\"properties\":{\"error_after\":{\"$ref\":\"#/$defs/freshness_rules\"},\"filter\":{\"type\":\"string\"},\"warn_after\":{\"$ref\":\"#/$defs/freshness_rules\"}},\"additionalProperties\":false},{\"const\":null}]},\"freshness_rules\":{\"type\":\"object\",\"required\":[\"count\",\"period\"],\"properties\":{\"count\":{\"$ref\":\"#/$defs/number_or_jinja_string\"},\"period\":{\"type\":\"string\",\"enum\":[\"day\",\"hour\",\"minute\"]}},\"additionalProperties\":false},\"grants\":{\"description\":\"grant config. each key is a database permission and the value is the grantee of that permission\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"}},\"additionalProperties\":false},\"group\":{\"type\":\"string\"},\"include_exclude\":{\"type\":\"object\",\"properties\":{\"exclude\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"include\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"}}},\"is-time-dimension\":{\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"TIME\",\"time\"]}}},\"jinja_string\":{\"type\":\"string\",\"pattern\":\"\\\\{\\\\{.*\\\\}\\\\}\"},\"measure\":{\"type\":\"object\",\"required\":[\"agg\",\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"description\":{\"type\":\"string\"},\"agg\":{\"enum\":[\"AVERAGE\",\"average\",\"COUNT\",\"count\",\"COUNT_DISTINCT\",\"count_distinct\",\"MAX\",\"max\",\"MEDIAN\",\"median\",\"MIN\",\"min\",\"PERCENTILE\",\"percentile\",\"SUM\",\"sum\",\"SUM_BOOLEAN\",\"sum_boolean\"]},\"agg_params\":{\"$ref\":\"#/$defs/aggregation_type_params\"},\"agg_time_dimension\":{\"type\":\"string\",\"pattern\":\"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$\"},\"config\":{\"type\":\"object\",\"properties\":{\"meta\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\"}}}},\"create_metric\":{\"type\":\"boolean\"},\"create_metric_display_name\":{\"type\":\"string\"},\"expr\":{\"type\":[\"boolean\",\"integer\",\"string\"]},\"label\":{\"type\":\"string\"},\"non_additive_dimension\":{\"$ref\":\"#/$defs/non_additive_dimension\"}},\"additionalProperties\":false},\"metric_input_measure\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"fill_nulls_with\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}]},\"filter\":{\"type\":\"string\"},\"join_to_timespine\":{\"type\":\"boolean\"}},\"additionalProperties\":false}]},\"metric_input_schema\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"alias\":{\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"offset_to_grain\":{\"type\":\"string\"},\"offset_window\":{\"type\":\"string\"}},\"additionalProperties\":false}]},\"model_configs\":{\"type\":\"object\",\"properties\":{\"auto_refresh\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"backup\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"contract\":{\"type\":\"object\",\"properties\":{\"enforced\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"}}},\"event_time\":{\"description\":\"The column that represents the actual moment the row's event happened. Contrast with, for example, when it was loaded to the warehouse.\",\"type\":\"string\"},\"file_format\":{\"type\":\"string\"},\"grant_access_to\":{\"title\":\"Authorized views\",\"description\":\"Configuration, specific to BigQuery adapter, used to setup authorized views.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"database\",\"project\"],\"properties\":{\"database\":{\"type\":\"string\"},\"project\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"grants\":{\"$ref\":\"#/$defs/grants\"},\"hours_to_expiration\":{\"description\":\"Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.\",\"type\":\"number\"},\"kms_key_name\":{\"description\":\"Configuration of the KMS key name, specific to BigQuery adapter.\",\"type\":\"string\",\"pattern\":\"projects/[a-zA-Z0-9_-]*/locations/[a-zA-Z0-9_-]*/keyRings/.*/cryptoKeys/.*\"},\"labels\":{\"title\":\"Label configs\",\"description\":\"Configuration specific to BigQuery adapter used to add labels and tags to tables/views created by dbt.\",\"type\":\"object\",\"patternProperties\":{\"^[a-z][a-z0-9_-]{0,62}$\":{\"type\":\"string\",\"pattern\":\"^[a-z0-9_-]{0,63}$\"}},\"additionalProperties\":false},\"location\":{\"type\":\"string\"},\"materialized\":{\"type\":\"string\"},\"on_configuration_change\":{\"type\":\"string\",\"enum\":[\"apply\",\"continue\",\"fail\"]},\"on_schema_change\":{\"type\":\"string\",\"enum\":[\"append_new_columns\",\"fail\",\"ignore\",\"sync_all_columns\"]},\"snowflake_warehouse\":{\"type\":\"string\"},\"sql_header\":{\"type\":\"string\"},\"target_lag\":{\"type\":\"string\",\"pattern\":\"^(?:downstream|\\\\d+\\\\s*(?:seconds|minutes|hours|days))$\"}}},\"non_additive_dimension\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"window_choice\":{\"enum\":[\"MAX\",\"max\",\"MIN\",\"min\"]},\"window_groupings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"number_or_jinja_string\":{\"oneOf\":[{\"$ref\":\"#/$defs/jinja_string\"},{\"type\":\"number\"}],\"additionalProperties\":false},\"persist_docs_config\":{\"title\":\"Persist docs config\",\"description\":\"Configurations for the persistence of the dbt documentation.\",\"type\":\"object\",\"properties\":{\"columns\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":true},\"relation\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\",\"default\":true}},\"additionalProperties\":false},\"ratio_metric_type_params\":{\"type\":\"object\",\"properties\":{\"denominator\":{\"$ref\":\"#/$defs/metric_input_schema\"},\"filter\":{\"type\":\"string\"},\"numerator\":{\"$ref\":\"#/$defs/metric_input_schema\"}},\"additionalProperties\":false},\"simple_metric_type_params\":{\"type\":\"object\",\"properties\":{\"measure\":{\"$ref\":\"#/$defs/metric_input_measure\"}},\"additionalProperties\":false},\"string_or_array_of_strings\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/array_of_strings\"}]},\"test_configs\":{\"title\":\"Test configs\",\"description\":\"Configurations set here will override configs set in dbt_project.yml.\",\"type\":\"object\",\"properties\":{\"alias\":{\"description\":\"Only relevant when `store_failures` is true\",\"type\":\"string\"},\"database\":{\"description\":\"Only relevant when `store_failures` is true\",\"type\":\"string\"},\"enabled\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"error_if\":{\"type\":\"string\"},\"fail_calc\":{\"type\":\"string\"},\"limit\":{\"type\":\"integer\"},\"schema\":{\"description\":\"Only relevant when `store_failures` is true\",\"type\":\"string\"},\"severity\":{\"oneOf\":[{\"$ref\":\"#/$defs/jinja_string\"},{\"type\":\"string\",\"enum\":[\"error\",\"warn\"]}]},\"store_failures\":{\"$ref\":\"#/$defs/boolean_or_jinja_string\"},\"tags\":{\"$ref\":\"#/$defs/string_or_array_of_strings\"},\"warn_if\":{\"type\":\"string\"}}},\"validity_params\":{\"type\":\"object\",\"properties\":{\"is_end\":{\"type\":\"boolean\"},\"is_start\":{\"type\":\"boolean\"}},\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dbt_yml_files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"dbt_yml_files","type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{"version":{"type":"number","const":2},"analyses":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"columns":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"data_type":{"type":"string"}},"additionalProperties":false}},"config":{"type":"object","properties":{"tags":{"$ref":"#/$defs/string_or_array_of_strings"}},"additionalProperties":false},"docs":{"$ref":"#/$defs/docs_config"},"group":{"$ref":"#/$defs/group"}}}},"data_tests":{"description":"Add descriptions to custom singular tests","type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"description":"The name of the singular test","type":"string"},"description":{"description":"A description of the test's purpose, how it is implemented, and perhaps what you should do if it starts failing.","type":"string"}},"additionalProperties":false}},"exposures":{"type":"array","items":{"type":"object","required":["depends_on","name","owner","type"],"$comment":"NB: depends_on is not strictly required, but is _expected_ according to the documentation","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["analysis","application","dashboard","ml","notebook"]},"depends_on":{"type":"array","items":{"type":"string"}},"label":{"type":"string","$comment":"Added in dbt Core v1.3"},"maturity":{"type":"string","enum":["high","low","medium"]},"meta":{"type":"object"},"owner":{"type":"object","anyOf":[{"required":["email"]},{"required":["name"]}],"properties":{"name":{"type":"string"},"email":{"type":"string"}},"additionalProperties":false},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"url":{"type":"string"}}}},"groups":{"type":"array","items":{"type":"object","required":["name","owner"],"properties":{"name":{"type":"string"},"owner":{"type":"object","minProperties":1,"properties":{"name":{"type":"string"},"email":{"type":"string"}},"additionalProperties":true}},"additionalProperties":false}},"macros":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"arguments":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false}},"docs":{"$ref":"#/$defs/docs_config"}},"additionalProperties":false}},"metrics":{"type":"array","items":{"type":"object","required":["label","name","type","type_params"],"if":{"properties":{"type":{"enum":["SIMPLE","simple"]}}},"then":{"properties":{"type_params":{"$ref":"#/$defs/simple_metric_type_params"}}},"else":{"if":{"properties":{"type":{"enum":["derived","DERIVED"]}}},"then":{"properties":{"type_params":{"$ref":"#/$defs/derived_metric_type_params"}}},"else":{"if":{"properties":{"type":{"enum":["cumulative","CUMULATIVE"]}}},"then":{"properties":{"type_params":{"$ref":"#/$defs/cumulative_metric_type_params"}}},"else":{"if":{"properties":{"type":{"enum":["conversion","CONVERSION"]}}},"then":{"properties":{"type_params":{"$ref":"#/$defs/conversion_metric_type_params"}}},"else":{"if":{"properties":{"type":{"enum":["ratio","RATIO"]}}},"then":{"properties":{"type_params":{"$ref":"#/$defs/ratio_metric_type_params"}}}}}}},"properties":{"name":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"description":{"type":"string"},"type":{"enum":["CONVERSION","conversion","CUMULATIVE","cumulative","DERIVED","derived","RATIO","ratio","SIMPLE","simple"]},"filter":{"type":"string"},"group":{"$ref":"#/$defs/group"},"label":{"type":"string"},"time_granularity":{"type":"string"},"type_params":{"type":"object"}},"additionalProperties":false}},"models":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"access":{"type":"string","enum":["private","protected","public"]},"columns":{"type":"array","items":{"$ref":"#/$defs/column_properties"}},"config":{"$ref":"#/$defs/model_configs"},"constraints":{"$ref":"#/$defs/constraints"},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"deprecation_date":{"type":"string"},"docs":{"$ref":"#/$defs/docs_config"},"group":{"$ref":"#/$defs/group"},"latest_version":{"type":"number"},"meta":{"type":"object"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"time_spine":{"type":"object","required":["standard_granularity_column"],"properties":{"standard_granularity_column":{"type":"string"}},"additionalProperties":false},"versions":{"type":"array","items":{"type":"object","required":["v"],"properties":{"columns":{"type":"array","items":{"anyOf":[{"$ref":"#/$defs/include_exclude"},{"$ref":"#/$defs/column_properties"}]}},"config":{"$ref":"#/$defs/model_configs"},"v":{"type":"number"}}}}},"additionalProperties":false}},"saved_queries":{"type":"array","items":{"type":"object","required":["description","label","name","query_params"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"config":{"type":"object","properties":{"cache":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}},"additionalProperties":false},"enabled":{"type":"boolean","default":true},"export_as":{"anyOf":[{"enum":["table","view"]},{"type":"null"}],"default":null},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"meta":{"type":"object","propertyNames":{"type":"string"}},"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":true},"exports":{"type":"array","items":{"$ref":"#/$defs/export"}},"label":{"type":"string"},"query_params":{"type":"object","properties":{"dimensions":{"$ref":"#/$defs/array_of_strings"},"metrics":{"$ref":"#/$defs/array_of_strings"},"where":{"$ref":"#/$defs/array_of_strings"},"additionalProperties":false}},"tags":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},"additionalProperties":false}},"seeds":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/$defs/column_properties"}},"config":{"type":"object","properties":{"column_types":{"type":"object"},"copy_grants":{"$ref":"#/$defs/boolean_or_jinja_string"},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"database":{"type":"string"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"grants":{"$ref":"#/$defs/grants"},"quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"schema":{"type":"string"}}},"docs":{"$ref":"#/$defs/docs_config"},"group":{"$ref":"#/$defs/group"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}}},"additionalProperties":false}},"semantic_models":{"type":"array","items":{"type":"object","required":["model","name"],"properties":{"name":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"description":{"type":"string"},"defaults":{"type":"object","properties":{"agg_time_dimension":{"type":"string"}},"additionalProperties":false},"dimensions":{"type":"array","items":{"$ref":"#/$defs/dimension"}},"entities":{"type":"array","items":{"$ref":"#/$defs/entity"}},"measures":{"type":"array","items":{"$ref":"#/$defs/measure"}},"model":{"type":"string","default":"ref('')"},"primary_entity":{"type":"string"}},"additionalProperties":false}},"snapshots":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/$defs/column_properties"}},"config":{"type":"object","properties":{"alias":{"type":"string"},"check_cols":{"$ref":"#/$defs/string_or_array_of_strings"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"grants":{"$ref":"#/$defs/grants"},"persist_docs":{"$ref":"#/$defs/persist_docs_config"},"post-hook":{"$ref":"#/$defs/array_of_strings"},"pre-hook":{"$ref":"#/$defs/array_of_strings"},"quote_columns":{"$ref":"#/$defs/boolean_or_jinja_string"},"strategy":{"type":"string"},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"target_database":{"type":"string"},"target_schema":{"type":"string"},"unique_key":{"$ref":"#/$defs/string_or_array_of_strings"},"updated_at":{"type":"string"}}},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"docs":{"$ref":"#/$defs/docs_config"},"group":{"$ref":"#/$defs/group"},"meta":{"type":"object"},"relation":{"description":"Required when defining your snapshot in YAML instead of using a legacy snapshot block.","type":"string","default":"source('', '')"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}}},"additionalProperties":false}},"sources":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"description":"How you will identify the schema in {{ source() }} calls. Unless `schema` is also set, this will be the name of the schema in the database.","type":"string"},"description":{"type":"string"},"config":{"type":"object"},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"database":{"type":"string"},"freshness":{"$ref":"#/$defs/freshness_definition"},"loaded_at_field":{"type":"string"},"loader":{"type":"string"},"meta":{"type":"object"},"overrides":{"title":"Package to Override","description":"The name of another package installed in your project. If that package has a source with the same name as this one, its properties will be applied on top of the base properties of the overridden source. https://docs.getdbt.com/reference/resource-properties/overrides","type":"string"},"quoting":{"type":"object","properties":{"database":{"$ref":"#/$defs/boolean_or_jinja_string"},"identifier":{"$ref":"#/$defs/boolean_or_jinja_string"},"schema":{"$ref":"#/$defs/boolean_or_jinja_string"}},"additionalProperties":false},"schema":{"description":"The schema name as stored in the database. Only needed if you want to use a different `name` than what exists in the database (otherwise `name` is used by default)","type":"string"},"tables":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"title":"Name","description":"How you will identify the table in {{ source() }} calls. Unless `identifier` is also set, this will be the name of the table in the database.","type":"string"},"description":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/$defs/column_properties"}},"config":{"type":"object","properties":{"event_time":{"description":"The column that represents the actual moment the row's event happened. Contrast with, for example, when it was loaded to the warehouse.","type":"string"},"additionalProperties":true}},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"external":{"type":"object"},"freshness":{"$ref":"#/$defs/freshness_definition"},"identifier":{"title":"Identifier","description":"The table name as stored in the database. Only needed if you want to give the source a different name than what exists in the database (otherwise `name` is used by default)","type":"string"},"loaded_at_field":{"description":"Which column to check during data freshness tests. Only needed if the table has a different loaded_at_field to the one defined on the source overall.","type":"string"},"loader":{"type":"string"},"meta":{"type":"object"},"quoting":{"type":"object","properties":{"database":{"$ref":"#/$defs/boolean_or_jinja_string"},"identifier":{"$ref":"#/$defs/boolean_or_jinja_string"},"schema":{"$ref":"#/$defs/boolean_or_jinja_string"}},"additionalProperties":false},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}}},"additionalProperties":false}},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}}}}},"unit_tests":{"type":"array","items":{"type":"object","required":["expect","model","name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"config":{"type":"object","properties":{"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"meta":{"type":"object"},"tags":{"$ref":"#/$defs/string_or_array_of_strings"}},"additionalProperties":false},"expect":{"type":"object","if":{"properties":{"format":{"const":"dict"}}},"then":{"properties":{"rows":{"description":"When `format` is `dict`, each item should be a dictionary containing a key-value pair for each column and its value, e.g. `{id: 1, code: 'ABC'}`","type":"array","items":{"type":"object"}}}},"else":{"properties":{"rows":{"description":"When `format` is csv or sql, a string containing comma-separated headers and values. Alternatively provide a fixture. Use the pipe character | to create a multi-line string in YAML.","type":"string"}}},"properties":{"fixture":{"description":"Only relevant when format is csv. Specify the name of a fixture instead of providing `rows`.","type":"string"},"format":{"description":"Defaults to `dict` when not specified","type":"string","enum":["csv","dict","sql"]},"additionalProperties":false}},"given":{"type":"array","items":{"type":"object","if":{"properties":{"format":{"const":"dict"}}},"then":{"properties":{"rows":{"description":"When `format` is `dict`, each item should be a dictionary containing a key-value pair for each column and its value, e.g. `{id: 1, code: 'ABC'}`","type":"array","items":{"type":"object"}}}},"else":{"properties":{"rows":{"description":"When `format` is csv or sql, a string containing comma-separated headers and values. Alternatively provide a fixture. Use the pipe character | to create a multi-line string in YAML.","type":"string"}}},"properties":{"fixture":{"description":"Only relevant when format is csv. Specify the name of a fixture instead of providing `rows`.","type":"string"},"format":{"description":"Defaults to `dict` when not specified","type":"string","enum":["csv","dict","sql"]},"input":{"description":"The relation whose inputs you need to mock. Enclose in ref or source without curly braces","type":"string","examples":["ref('model_b')","ref('upstream_project', 'model_b')","source('schema', 'table')"]},"additionalProperties":false}}},"model":{"description":"The name of the model whose behaviour you are testing. Does not need to be wrapped in a ref.","type":"string","examples":["my_model"]},"overrides":{"type":"object","properties":{"env_vars":{"type":"object"},"macros":{"type":"object","examples":[{"is_incremental":"true"}]},"vars":{"type":"object"}},"additionalProperties":false},"additionalProperties":false},"additionalProperties":false}}},"additionalProperties":false,"$defs":{"aggregation_type_params":{"type":"object","properties":{"percentile":{"type":"number"},"use_approximate_percentile":{"type":"boolean"},"use_discrete_percentile":{"type":"boolean"}},"additionalProperties":false},"array_of_strings":{"type":"array","items":{"type":"string"}},"boolean_or_jinja_string":{"oneOf":[{"$ref":"#/$defs/jinja_string"},{"type":"boolean"}],"additionalProperties":false},"column_properties":{"type":"object","required":["name"],"uniqueItems":true,"properties":{"name":{"type":"string"},"description":{"type":"string"},"constraints":{"$ref":"#/$defs/constraints"},"data_tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}},"data_type":{"type":"string"},"granularity":{"enum":["day","hour","microsecond","millisecond","minute","month","nanosecond","quarter","second","week","year"]},"meta":{"type":"object"},"policy_tags":{"title":"Policy tags","description":"Configurations, specific to BigQuery adapter, used to set policy tags on specific columns, enabling column-level security. Only relevant when `persist_docs.columns` is true.","type":"array","items":{"type":"string"}},"quote":{"$ref":"#/$defs/boolean_or_jinja_string"},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"tests":{"type":"array","items":{"$ref":"#/$defs/data_tests"}}},"additionalProperties":false},"constraints":{"type":"array","items":{"type":"object","required":["type"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"$ref":"#/$defs/string_or_array_of_strings"},"expression":{"type":"string"},"warn_unenforced":{"$ref":"#/$defs/boolean_or_jinja_string"},"warn_unsupported":{"$ref":"#/$defs/boolean_or_jinja_string"}}}},"conversion_metric_type_params":{"type":"object","properties":{"conversion_type_params":{"type":"object","required":["base_measure","conversion_measure","entity"],"properties":{"base_measure":{"$ref":"#/$defs/metric_input_measure"},"calculation":{"type":"string","default":"conversion_rate","enum":["conversion_rate","CONVERSION_RATE","conversions","CONVERSIONS"]},"constant_properties":{"type":"array","items":{"type":"object","required":["base_property","conversion_property"],"properties":{"base_property":{"description":"DIMENSION or ENTITY","type":"string"},"conversion_property":{"description":"DIMENSION or ENTITY","type":"string"}}}},"conversion_measure":{"$ref":"#/$defs/metric_input_measure"},"entity":{"description":"The entity to calculate over","type":"string"},"window":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"cumulative_metric_type_params":{"type":"object","properties":{"cumulative_type_params":{"type":"object","properties":{"grain_to_date":{"type":"string"},"period_agg":{"enum":["average","first","last"]},"window":{"type":"string"}},"additionalProperties":false},"grain_to_date":{"enum":["day","hour","microsecond","millisecond","minute","month","nanosecond","quarter","second","week","year"]},"measure":{"$ref":"#/$defs/metric_input_measure"},"window":{"type":"string"}},"additionalProperties":false},"data_tests":{"anyOf":[{"type":"string"},{"enum":["not_null","unique"]},{"title":"Relationships Test","type":"object","properties":{"relationships":{"type":"object","required":["field","to"],"properties":{"name":{"type":"string"},"config":{"$ref":"#/$defs/test_configs"},"field":{"title":"Relationships: Field","description":"The foreign key column","type":"string","default":"<FOREIGN_KEY_COLUMN>"},"to":{"type":"string","default":"ref('')","examples":["ref('parent_model')","source('parent_schema', 'parent_table')"]},"where":{"type":"string"}}}}},{"title":"Accepted Values Test","type":"object","properties":{"accepted_values":{"type":"object","required":["values"],"properties":{"name":{"type":"string"},"config":{"$ref":"#/$defs/test_configs"},"quote":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}},"where":{"type":"string"}}}}},{"title":"User defined test","type":"object","patternProperties":{".*":{"type":"object","properties":{"name":{"type":"string"},"config":{"$ref":"#/$defs/test_configs"},"where":{"type":"string"}}}}}]},"derived_metric_type_params":{"type":"object","properties":{"expr":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/$defs/metric_input_schema"}}},"additionalProperties":false},"dimension":{"type":"object","required":["name","type"],"anyOf":[{"not":{"$ref":"#/$defs/is-time-dimension"}},{"required":["type_params"]}],"properties":{"name":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"description":{"type":"string"},"type":{"enum":["CATEGORICAL","categorical","TIME","time"]},"config":{"type":"object","properties":{"meta":{"type":"object","propertyNames":{"type":"string"}}}},"expr":{"type":["boolean","string"]},"is_partition":{"type":"boolean"},"type_params":{"$ref":"#/$defs/dimension_type_params"}},"additionalProperties":false},"dimension_type_params":{"type":"object","required":["time_granularity"],"properties":{"time_granularity":{"enum":["DAY","day","HOUR","hour","MICROSECOND","microsecond","MILLISECOND","millisecond","MINUTE","minute","MONTH","month","NANOSECOND","nanosecond","QUARTER","quarter","SECOND","second","WEEK","week","YEAR","year"]},"validity_params":{"$ref":"#/$defs/validity_params"}},"additionalProperties":false},"docs_config":{"title":"Docs config","description":"Configurations for the appearance of nodes in the dbt documentation.","type":"object","properties":{"node_color":{"description":"The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.","type":"string","pattern":"^(#[a-fA-F0-9]{3}|#[a-fA-F0-9]{6}|[^#][a-zA-Z]*)$"},"show":{"type":"boolean","default":true}},"additionalProperties":false},"entity":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"type":{"enum":["FOREIGN","foreign","NATURAL","natural","PRIMARY","primary","UNIQUE","unique"]},"config":{"type":"object","properties":{"meta":{"type":"object","propertyNames":{"type":"string"}}}},"entity":{"type":"string"},"expr":{"type":["boolean","string"]}},"additionalProperties":false},"export":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"config":{"type":"object","properties":{"alias":{"type":"string"},"export_as":{"enum":["cache","table","view"]},"schema":{"type":"string"}},"additionalProperties":true}},"additionalProperties":false},"freshness_definition":{"default":{"error_after":{"count":2,"period":"day"},"warn_after":{"count":1,"period":"day"}},"oneOf":[{"type":"object","properties":{"error_after":{"$ref":"#/$defs/freshness_rules"},"filter":{"type":"string"},"warn_after":{"$ref":"#/$defs/freshness_rules"}},"additionalProperties":false},{"const":null}]},"freshness_rules":{"type":"object","required":["count","period"],"properties":{"count":{"$ref":"#/$defs/number_or_jinja_string"},"period":{"type":"string","enum":["day","hour","minute"]}},"additionalProperties":false},"grants":{"description":"grant config. each key is a database permission and the value is the grantee of that permission","type":"object","patternProperties":{".*":{"$ref":"#/$defs/string_or_array_of_strings"}},"additionalProperties":false},"group":{"type":"string"},"include_exclude":{"type":"object","properties":{"exclude":{"$ref":"#/$defs/string_or_array_of_strings"},"include":{"$ref":"#/$defs/string_or_array_of_strings"}}},"is-time-dimension":{"required":["type"],"properties":{"type":{"enum":["TIME","time"]}}},"jinja_string":{"type":"string","pattern":"\\{\\{.*\\}\\}"},"measure":{"type":"object","required":["agg","name"],"properties":{"name":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"description":{"type":"string"},"agg":{"enum":["AVERAGE","average","COUNT","count","COUNT_DISTINCT","count_distinct","MAX","max","MEDIAN","median","MIN","min","PERCENTILE","percentile","SUM","sum","SUM_BOOLEAN","sum_boolean"]},"agg_params":{"$ref":"#/$defs/aggregation_type_params"},"agg_time_dimension":{"type":"string","pattern":"(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$"},"config":{"type":"object","properties":{"meta":{"type":"object","propertyNames":{"type":"string"}}}},"create_metric":{"type":"boolean"},"create_metric_display_name":{"type":"string"},"expr":{"type":["boolean","integer","string"]},"label":{"type":"string"},"non_additive_dimension":{"$ref":"#/$defs/non_additive_dimension"}},"additionalProperties":false},"metric_input_measure":{"oneOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string"},"fill_nulls_with":{"anyOf":[{"type":"string"},{"type":"integer"}]},"filter":{"type":"string"},"join_to_timespine":{"type":"boolean"}},"additionalProperties":false}]},"metric_input_schema":{"oneOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string"},"alias":{"type":"string"},"filter":{"type":"string"},"offset_to_grain":{"type":"string"},"offset_window":{"type":"string"}},"additionalProperties":false}]},"model_configs":{"type":"object","properties":{"auto_refresh":{"$ref":"#/$defs/boolean_or_jinja_string"},"backup":{"$ref":"#/$defs/boolean_or_jinja_string"},"contract":{"type":"object","properties":{"enforced":{"$ref":"#/$defs/boolean_or_jinja_string"}}},"event_time":{"description":"The column that represents the actual moment the row's event happened. Contrast with, for example, when it was loaded to the warehouse.","type":"string"},"file_format":{"type":"string"},"grant_access_to":{"title":"Authorized views","description":"Configuration, specific to BigQuery adapter, used to setup authorized views.","type":"array","items":{"type":"object","required":["database","project"],"properties":{"database":{"type":"string"},"project":{"type":"string"}},"additionalProperties":false}},"grants":{"$ref":"#/$defs/grants"},"hours_to_expiration":{"description":"Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.","type":"number"},"kms_key_name":{"description":"Configuration of the KMS key name, specific to BigQuery adapter.","type":"string","pattern":"projects/[a-zA-Z0-9_-]*/locations/[a-zA-Z0-9_-]*/keyRings/.*/cryptoKeys/.*"},"labels":{"title":"Label configs","description":"Configuration specific to BigQuery adapter used to add labels and tags to tables/views created by dbt.","type":"object","patternProperties":{"^[a-z][a-z0-9_-]{0,62}$":{"type":"string","pattern":"^[a-z0-9_-]{0,63}$"}},"additionalProperties":false},"location":{"type":"string"},"materialized":{"type":"string"},"on_configuration_change":{"type":"string","enum":["apply","continue","fail"]},"on_schema_change":{"type":"string","enum":["append_new_columns","fail","ignore","sync_all_columns"]},"snowflake_warehouse":{"type":"string"},"sql_header":{"type":"string"},"target_lag":{"type":"string","pattern":"^(?:downstream|\\d+\\s*(?:seconds|minutes|hours|days))$"}}},"non_additive_dimension":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"window_choice":{"enum":["MAX","max","MIN","min"]},"window_groupings":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"number_or_jinja_string":{"oneOf":[{"$ref":"#/$defs/jinja_string"},{"type":"number"}],"additionalProperties":false},"persist_docs_config":{"title":"Persist docs config","description":"Configurations for the persistence of the dbt documentation.","type":"object","properties":{"columns":{"$ref":"#/$defs/boolean_or_jinja_string","default":true},"relation":{"$ref":"#/$defs/boolean_or_jinja_string","default":true}},"additionalProperties":false},"ratio_metric_type_params":{"type":"object","properties":{"denominator":{"$ref":"#/$defs/metric_input_schema"},"filter":{"type":"string"},"numerator":{"$ref":"#/$defs/metric_input_schema"}},"additionalProperties":false},"simple_metric_type_params":{"type":"object","properties":{"measure":{"$ref":"#/$defs/metric_input_measure"}},"additionalProperties":false},"string_or_array_of_strings":{"oneOf":[{"type":"string"},{"$ref":"#/$defs/array_of_strings"}]},"test_configs":{"title":"Test configs","description":"Configurations set here will override configs set in dbt_project.yml.","type":"object","properties":{"alias":{"description":"Only relevant when `store_failures` is true","type":"string"},"database":{"description":"Only relevant when `store_failures` is true","type":"string"},"enabled":{"$ref":"#/$defs/boolean_or_jinja_string"},"error_if":{"type":"string"},"fail_calc":{"type":"string"},"limit":{"type":"integer"},"schema":{"description":"Only relevant when `store_failures` is true","type":"string"},"severity":{"oneOf":[{"$ref":"#/$defs/jinja_string"},{"type":"string","enum":["error","warn"]}]},"store_failures":{"$ref":"#/$defs/boolean_or_jinja_string"},"tags":{"$ref":"#/$defs/string_or_array_of_strings"},"warn_if":{"type":"string"}}},"validity_params":{"type":"object","properties":{"is_end":{"type":"boolean"},"is_start":{"type":"boolean"}},"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "dbt_yml_files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
dbt_yml_files
|
schema-store
|
schema_store_247
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"profile\":{\"type\":\"object\",\"required\":[\"name\"],\"allOf\":[{\"$ref\":\"#/definitions/content\"}],\"anyOf\":[{\"properties\":{\"executablePath\":{\"type\":\"string\",\"description\":\"An absolute path to the to the executable.\",\"default\":\"\",\"minLength\":1}},\"not\":{\"required\":[\"commandName\"]}},{\"properties\":{\"commandName\":{\"type\":\"string\",\"description\":\"The name of the command to call.\",\"default\":\"\",\"minLength\":1}},\"not\":{\"required\":[\"executablePath\"]}}]},\"content\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the debug profile\",\"minLength\":1},\"commandLineArgs\":{\"type\":\"string\",\"description\":\"The arguments to pass to the command.\",\"default\":\"\"},\"workingDirectory\":{\"type\":\"string\",\"description\":\"Sets the working directory of the command.\"},\"launchBrowser\":{\"type\":\"boolean\",\"description\":\"Set to true if the browser should be launched.\",\"default\":false},\"launchUrl\":{\"type\":\"string\",\"description\":\"The relative URL to launch in the browser.\",\"format\":\"uri\"},\"environmentVariables\":{\"type\":\"object\",\"description\":\"Set the environment variables as key/value pairs.\",\"additionalProperties\":{\"type\":\"string\"}},\"sdkVersion\":{\"type\":\"string\",\"description\":\"Sets the version of the SDK.\"}}}},\"id\":\"https://json.schemastore.org/debugsettings.json\",\"properties\":{\"profiles\":{\"type\":\"array\",\"description\":\"A list of debug profiles\",\"items\":{\"$ref\":\"#/definitions/profile\"}}},\"title\":\"JSON schema for the ASP.NET DebugSettings.json files.\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for the ASP.NET DebugSettings.json files.\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"profile":{"type":"object","required":["name"],"allOf":[{"$ref":"#/definitions/content"}],"anyOf":[{"properties":{"executablePath":{"type":"string","description":"An absolute path to the to the executable.","default":"","minLength":1}},"not":{"required":["commandName"]}},{"properties":{"commandName":{"type":"string","description":"The name of the command to call.","default":"","minLength":1}},"not":{"required":["executablePath"]}}]},"content":{"properties":{"name":{"type":"string","description":"The name of the debug profile","minLength":1},"commandLineArgs":{"type":"string","description":"The arguments to pass to the command.","default":""},"workingDirectory":{"type":"string","description":"Sets the working directory of the command."},"launchBrowser":{"type":"boolean","description":"Set to true if the browser should be launched.","default":false},"launchUrl":{"type":"string","description":"The relative URL to launch in the browser.","format":"uri"},"environmentVariables":{"type":"object","description":"Set the environment variables as key/value pairs.","additionalProperties":{"type":"string"}},"sdkVersion":{"type":"string","description":"Sets the version of the SDK."}}}},"id":"https://json.schemastore.org/debugsettings.json","properties":{"profiles":{"type":"array","description":"A list of debug profiles","items":{"$ref":"#/definitions/profile"}}},"title":"JSON schema for the ASP.NET DebugSettings.json files.","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for the ASP.NET DebugSettings.json files.". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for the ASP.NET DebugSettings.json files.
|
schema-store
|
schema_store_248
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"properties\":{\"defaults\":{\"items\":{\"properties\":{\"default_name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"policy_assignments\":{\"items\":{\"properties\":{\"parameter_names\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"policy_assignment_name\":{\"type\":\"string\"}},\"required\":[\"policy_assignment_name\",\"parameter_names\"],\"type\":\"object\"},\"type\":\"array\"}},\"required\":[\"default_name\",\"policy_assignments\"],\"type\":\"object\"},\"type\":\"array\"}},\"required\":[\"defaults\"],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"default_policy_values\". Here are the required top‑level fields: defaults. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","properties":{"defaults":{"items":{"properties":{"default_name":{"type":"string"},"description":{"type":"string"},"policy_assignments":{"items":{"properties":{"parameter_names":{"items":{"type":"string"},"type":"array"},"policy_assignment_name":{"type":"string"}},"required":["policy_assignment_name","parameter_names"],"type":"object"},"type":"array"}},"required":["default_name","policy_assignments"],"type":"object"},"type":"array"}},"required":["defaults"],"type":"object"}
|
Provide a JSON object that satisfies the schema "default_policy_values". Here are the required top‑level fields: defaults. Return only the valid JSON object.
|
default_policy_values
|
schema-store
|
schema_store_249
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dein.json\",\"additionalProperties\":false,\"definitions\":{\"Plugin\":{\"title\":\"Pattern for a definition of vim plugin\",\"type\":\"object\",\"required\":[\"repo\"],\"additionalProperties\":false,\"properties\":{\"repo\":{\"title\":\"repository. \",\"description\":\"The repository URI or local repository directory path.\",\"oneOf\":[{\"$ref\":\"#/definitions/Url\"},{\"$ref\":\"#/definitions/Path\"},{\"$ref\":\"#/definitions/repo-string-pattern\"}],\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L118\"}}},\"augroup\":{\"description\":\"An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L694\"}}},\"build\":{\"description\":\"Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L699\"}}},\"depends\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"Specify a list of plugins a plugin depends on. List items are '{plugin-name}'. Those specified in the list are NOT installed automatically. Note: The loading order is not guaranteed in non lazy plugins.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L719\"}}},\"frozen\":{\"$ref\":\"#/definitions/Boolean\",\"description\":\"If set to v:true, dein doesn't update it automatically. It is useful for outdated plugins that can no longer be updated.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L726\"}}},\"ftplugin\":{\"description\":\"'_' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"_\":{\"title\":\"all filetypes\",\"description\":\"'_' key is executed after all ftplugin.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L733\"}}}},\"patternProperties\":{\"^[0-9a-zA-Z].+$\":{\"title\":\"filetype\",\"description\":\"'{filetype}' key is executed {filetype} ftplugin.\\nYou can define multiple filetypes by '{filetype1}_{filetype2}' key.\\n'b:undo_ftplugin' is defined automatically.\",\"type\":\"string\"}},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L731\"}}},\"if\":{\"description\":\"If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin\",\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"integer\"},{\"type\":\"string\"}],\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L738\"}}},\"lazy\":{\"description\":\"If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins. It is meaningless and just increases the overhead. You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.\",\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"integer\"}],\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L746\"}}},\"merged\":{\"$ref\":\"#/definitions/Boolean\",\"description\":\"If set to v:false, dein doesn't merge the plugin directory. It is useful for the plugin files conflicts.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L757\"}}},\"merge_ftdetect\":{\"$ref\":\"#/definitions/Boolean\",\"description\":\"If set to v:true, dein merge the plugin \\\"ftdetect\\\" directory. It is useful to enable file detection when lazy loaded plugin. Note: It does not work if ftdetect script depends on lazy plugin functions.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L764\"}}},\"name\":{\"description\":\"Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L771\"}}},\"normalized_name\":{\"description\":\"Specify the normalized name of the plugin. If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L782\"}}},\"on_cmd\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If it is matched to the executed command, dein will call |dein#source()|.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L796\"}}},\"on_event\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"dein will call |dein#source()| on the events.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L801\"}}},\"on_func\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If it is matched to the called function, dein will call |dein#source()|.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L805\"}}},\"on_ft\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If it is matched to 'filetype', dein will call |dein#source()|.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L811\"}}},\"on_if\":{\"description\":\"If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L816\"}}},\"on_lua\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If it is matched to the required lua module root, dein will call |dein#source()|. Note: It is for neovim only. Note: It does not work for neovim standard modules.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L829\"}}},\"on_map\":{\"description\":\"If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.\",\"oneOf\":[{\"$ref\":\"#/definitions/on_map-dict\"},{\"$ref\":\"#/definitions/on_map-array\"},{\"$ref\":\"#/definitions/on_map-string\"}],\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L836\"}}},\"on_path\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If set to '.*', dein will call |dein#source()| on editing allfiles. Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L874\"}}},\"on_source\":{\"$ref\":\"#/definitions/ArrayOrString\",\"description\":\"If set to '.*', dein will call |dein#source()| on editing allfiles. Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins. \",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L881\"}}},\"overwrite\":{\"$ref\":\"#/definitions/Boolean\",\"description\":\"If set to v:true, dein overwrite existing plugin config when |dein#add()|.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L886\"}}},\"path\":{\"description\":\"Specify the plugin downloaded path.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L891\"}}},\"rev\":{\"description\":\"Specify a revision number or branch/tag name. If it is '*' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.*'.Note: If the type is 'raw', rev must be hash number.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L895\"}}},\"rtp\":{\"description\":\"Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'\",\"type\":\"string\",\"default\":\"vim\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L906\"}}},\"script_type\":{\"description\":\"Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.\",\"type\":\"string\",\"enum\":[\"indent\",\"plugin\",\"colors\",\"ftplugin\"],\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L919\"}}},\"timeout\":{\"description\":\"The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.\",\"type\":\"integer\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L935\"}}},\"trusted\":{\"$ref\":\"#/definitions/Boolean\",\"description\":\"If set to v:true, dein will load the plugin in 'sudo' mode. If you don't set it, dein won't load it.\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L940\"}}},\"type\":{\"description\":\"Specify the repository type. If it is omitted, a guess is made based on {repository}.\",\"type\":\"string\",\"enum\":[\"none\",\"raw\",\"git\"],\"x-taplo\":{\"docs\":{\"enumValues\":[\"None repository\",\"Raw plugin file ('script_type' attribute is needed)\",\"git\"]},\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L945\",\"enumValues\":[\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L951\",\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L952\",\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L954\"]}}},\"type__depth\":{\"description\":\"The history depth for 'git clone'.\\n If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository.\\n Note: This attribute is available in git type only.\\n\\n https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024\",\"type\":\"integer\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L956\"}}},\"hook_add\":{\"description\":\"It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L981\"}}},\"hook_done_update\":{\"description\":\"It is executed after the all plugins are updated.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1002\"}}},\"hook_post_source\":{\"description\":\"It is executed after plugins are sourced. Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed. \",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1006\"}}},\"hook_post_update\":{\"description\":\"It is executed after the plugins are updated.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1015\"}}},\"hook_source\":{\"description\":\"It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded. 'type': 'string',\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1021\"}}},\"lua_add\":{\"description\":\"Lua language string hook instead of Vim script.\\nIt is converted to \\\"hook_add\\\" key.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/4a888738849c67294ab6264d8776324c7d6b2441/doc/dein.txt#L1084\"}}},\"lua_source\":{\"description\":\"Lua language string hook instead of Vim script.\\nIt is converted to \\\"hook_source\\\" key.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/4a888738849c67294ab6264d8776324c7d6b2441/doc/dein.txt#L1084\"}}}},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L115\"},\"initKeys\":[\"repo\"]}},\"MultiplePlugins\":{\"title\":\"Pattern for multiple definition of vim plugin\",\"type\":\"object\",\"required\":[\"plugins\"],\"additionalProperties\":false,\"properties\":{\"plugins\":{\"title\":\"plugins\",\"type\":\"array\",\"description\":\"The repository URI or local repository directory path.\",\"items\":{\"$ref\":\"#/definitions/repo-string-pattern\"},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1073\"}}}}},\"Url\":{\"title\":\"path\",\"type\":\"string\",\"pattern\":\"^https?:\\\\/\\\\/(www\\\\.)?[-a-zA-Z0-9@:%._\\\\+~#=]{1,256}\\\\.[a-zA-Z0-9()]{1,6}\\\\b([-a-zA-Z0-9()@:%_\\\\+.~#?&//=]*)$\"},\"repo-string-pattern\":{\"title\":\"repo name pattern\",\"description\":\"If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.\",\"type\":\"string\",\"pattern\":\"^[a-zA-Z-_0-9]+/[a-zA-Z-_0-9\\\\.]+$\"},\"Path\":{\"title\":\"path\",\"type\":\"string\",\"pattern\":\"^[~|/][a-zA-Z-_0-9/\\\\.~]+$\"},\"vim-mode-key-pattern-string\":{\"type\":\"string\",\"pattern\":\"^[nvxsomilct]+$\"},\"vim-mode-key-mapping-string\":{\"type\":\"string\"},\"on_map-string\":{\"type\":\"string\",\"oneOf\":[{\"$ref\":\"#/definitions/vim-mode-key-pattern-string\"},{\"$ref\":\"#/definitions/vim-mode-key-mapping-string\"}]},\"on_map-array1\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/on_map-string\"}},\"on_map-array2\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/vim-mode-key-mapping-string\"}},\"on_map-array\":{\"oneOf\":[{\"$ref\":\"#/definitions/on_map-array1\"},{\"$ref\":\"#/definitions/on_map-array2\"}]},\"on_map-dict\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[nvxsomilct]+$\":{\"description\":\"Pattern for vim key binding. You can use plugin prefix mappings. You can use '<Plug>' keyword as {mapping}. If{mapping} is '<Plug>', '<Plug>(normalized_name' is used. linter support is now under development\",\"oneOf\":[{\"$ref\":\"#/definitions/vim-mode-key-mapping-string\"},{\"$ref\":\"#/definitions/on_map-array2\"}]}}},\"ArrayOrString\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}]},\"Boolean\":{\"oneOf\":[{\"type\":\"boolean\"},{\"enum\":[0,1],\"type\":\"number\"}]}},\"description\":\"A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)\",\"properties\":{\"plugins\":{\"title\":\"Definition properties table for installing a vim plugin\",\"description\":\"Definition properties table for installing a vim plugin.\\nIt is converted to |dein#add()|.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Plugin\"},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1068\"}}},\"ftplugin\":{\"title\":\"ftplugin definition\",\"description\":\"'_' key is executed after all ftplugin.\\n'{filetype}' key is executed {filetype} ftplugin.\\n You can define multiple filetypes by '{filetype1}_{filetype2}' key.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"_\":{\"title\":\"all filetypes\",\"description\":\"'_' key is executed after all ftplugin.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1056\"}}}},\"patternProperties\":{\"^[0-9a-zA-Z].+$\":{\"title\":\"filetype\",\"description\":\"'{filetype}' key is executed {filetype} ftplugin.\\nYou can define multiple filetypes by '{filetype1}_{filetype2}' key.\\n'b:undo_ftplugin' is defined automatically.\",\"type\":\"string\"}},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1054\"}}},\"hook_add\":{\"title\":\"hook_add definition\",\"description\":\"It is the global |dein-options-hook_add|.\\nIt is executed in |dein#end()|.\",\"type\":\"string\",\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1063\"}}},\"multiple_plugins\":{\"title\":\"It is converted to |dein-toml-hook_add|\",\"description\":\"It is converted to |dein-toml-hook_add|\\n\\\"plugins\\\" key is needed.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/MultiplePlugins\"},\"x-taplo\":{\"links\":{\"key\":\"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1073\"}}}},\"required\":[\"plugins\"],\"title\":\"dein.vim\",\"type\":\"object\",\"x-taplo-info\":{\"authors\":[\"kkiyama117 (https://github.com/kkiyama117)\",\"raa0121 (https://github.com/raa0121)\",\"Hibiki (https://github.com/4513ECHO)\",\"mikan (https://github.com/mikanIchinose)\"],\"version\":\"0.1.0\",\"patterns\":[\"^(.*(/|\\\\\\\\)\\\\.*dein.*\\\\.toml|\\\\.*dein.*\\\\.toml)$\"]}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dein.vim\". Here are the required top‑level fields: plugins. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dein.json","additionalProperties":false,"definitions":{"Plugin":{"title":"Pattern for a definition of vim plugin","type":"object","required":["repo"],"additionalProperties":false,"properties":{"repo":{"title":"repository. ","description":"The repository URI or local repository directory path.","oneOf":[{"$ref":"#/definitions/Url"},{"$ref":"#/definitions/Path"},{"$ref":"#/definitions/repo-string-pattern"}],"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L118"}}},"augroup":{"description":"An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L694"}}},"build":{"description":"Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L699"}}},"depends":{"$ref":"#/definitions/ArrayOrString","description":"Specify a list of plugins a plugin depends on. List items are '{plugin-name}'. Those specified in the list are NOT installed automatically. Note: The loading order is not guaranteed in non lazy plugins.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L719"}}},"frozen":{"$ref":"#/definitions/Boolean","description":"If set to v:true, dein doesn't update it automatically. It is useful for outdated plugins that can no longer be updated.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L726"}}},"ftplugin":{"description":"'_' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin.","type":"object","additionalProperties":false,"properties":{"_":{"title":"all filetypes","description":"'_' key is executed after all ftplugin.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L733"}}}},"patternProperties":{"^[0-9a-zA-Z].+$":{"title":"filetype","description":"'{filetype}' key is executed {filetype} ftplugin.\nYou can define multiple filetypes by '{filetype1}_{filetype2}' key.\n'b:undo_ftplugin' is defined automatically.","type":"string"}},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L731"}}},"if":{"description":"If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin","anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}],"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L738"}}},"lazy":{"description":"If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins. It is meaningless and just increases the overhead. You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.","anyOf":[{"type":"boolean"},{"type":"integer"}],"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L746"}}},"merged":{"$ref":"#/definitions/Boolean","description":"If set to v:false, dein doesn't merge the plugin directory. It is useful for the plugin files conflicts.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L757"}}},"merge_ftdetect":{"$ref":"#/definitions/Boolean","description":"If set to v:true, dein merge the plugin \"ftdetect\" directory. It is useful to enable file detection when lazy loaded plugin. Note: It does not work if ftdetect script depends on lazy plugin functions.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L764"}}},"name":{"description":"Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L771"}}},"normalized_name":{"description":"Specify the normalized name of the plugin. If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L782"}}},"on_cmd":{"$ref":"#/definitions/ArrayOrString","description":"If it is matched to the executed command, dein will call |dein#source()|.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L796"}}},"on_event":{"$ref":"#/definitions/ArrayOrString","description":"dein will call |dein#source()| on the events.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L801"}}},"on_func":{"$ref":"#/definitions/ArrayOrString","description":"If it is matched to the called function, dein will call |dein#source()|.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L805"}}},"on_ft":{"$ref":"#/definitions/ArrayOrString","description":"If it is matched to 'filetype', dein will call |dein#source()|.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L811"}}},"on_if":{"description":"If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L816"}}},"on_lua":{"$ref":"#/definitions/ArrayOrString","description":"If it is matched to the required lua module root, dein will call |dein#source()|. Note: It is for neovim only. Note: It does not work for neovim standard modules.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L829"}}},"on_map":{"description":"If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.","oneOf":[{"$ref":"#/definitions/on_map-dict"},{"$ref":"#/definitions/on_map-array"},{"$ref":"#/definitions/on_map-string"}],"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L836"}}},"on_path":{"$ref":"#/definitions/ArrayOrString","description":"If set to '.*', dein will call |dein#source()| on editing allfiles. Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L874"}}},"on_source":{"$ref":"#/definitions/ArrayOrString","description":"If set to '.*', dein will call |dein#source()| on editing allfiles. Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins. ","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L881"}}},"overwrite":{"$ref":"#/definitions/Boolean","description":"If set to v:true, dein overwrite existing plugin config when |dein#add()|.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L886"}}},"path":{"description":"Specify the plugin downloaded path.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L891"}}},"rev":{"description":"Specify a revision number or branch/tag name. If it is '*' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.*'.Note: If the type is 'raw', rev must be hash number.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L895"}}},"rtp":{"description":"Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'","type":"string","default":"vim","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L906"}}},"script_type":{"description":"Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.","type":"string","enum":["indent","plugin","colors","ftplugin"],"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L919"}}},"timeout":{"description":"The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.","type":"integer","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L935"}}},"trusted":{"$ref":"#/definitions/Boolean","description":"If set to v:true, dein will load the plugin in 'sudo' mode. If you don't set it, dein won't load it.","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L940"}}},"type":{"description":"Specify the repository type. If it is omitted, a guess is made based on {repository}.","type":"string","enum":["none","raw","git"],"x-taplo":{"docs":{"enumValues":["None repository","Raw plugin file ('script_type' attribute is needed)","git"]},"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L945","enumValues":["https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L951","https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L952","https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L954"]}}},"type__depth":{"description":"The history depth for 'git clone'.\n If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository.\n Note: This attribute is available in git type only.\n\n https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024","type":"integer","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L956"}}},"hook_add":{"description":"It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L981"}}},"hook_done_update":{"description":"It is executed after the all plugins are updated.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1002"}}},"hook_post_source":{"description":"It is executed after plugins are sourced. Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed. ","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1006"}}},"hook_post_update":{"description":"It is executed after the plugins are updated.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1015"}}},"hook_source":{"description":"It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded. 'type': 'string',","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1021"}}},"lua_add":{"description":"Lua language string hook instead of Vim script.\nIt is converted to \"hook_add\" key.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/4a888738849c67294ab6264d8776324c7d6b2441/doc/dein.txt#L1084"}}},"lua_source":{"description":"Lua language string hook instead of Vim script.\nIt is converted to \"hook_source\" key.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/4a888738849c67294ab6264d8776324c7d6b2441/doc/dein.txt#L1084"}}}},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L115"},"initKeys":["repo"]}},"MultiplePlugins":{"title":"Pattern for multiple definition of vim plugin","type":"object","required":["plugins"],"additionalProperties":false,"properties":{"plugins":{"title":"plugins","type":"array","description":"The repository URI or local repository directory path.","items":{"$ref":"#/definitions/repo-string-pattern"},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1073"}}}}},"Url":{"title":"path","type":"string","pattern":"^https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)$"},"repo-string-pattern":{"title":"repo name pattern","description":"If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.","type":"string","pattern":"^[a-zA-Z-_0-9]+/[a-zA-Z-_0-9\\.]+$"},"Path":{"title":"path","type":"string","pattern":"^[~|/][a-zA-Z-_0-9/\\.~]+$"},"vim-mode-key-pattern-string":{"type":"string","pattern":"^[nvxsomilct]+$"},"vim-mode-key-mapping-string":{"type":"string"},"on_map-string":{"type":"string","oneOf":[{"$ref":"#/definitions/vim-mode-key-pattern-string"},{"$ref":"#/definitions/vim-mode-key-mapping-string"}]},"on_map-array1":{"type":"array","items":{"$ref":"#/definitions/on_map-string"}},"on_map-array2":{"type":"array","items":{"$ref":"#/definitions/vim-mode-key-mapping-string"}},"on_map-array":{"oneOf":[{"$ref":"#/definitions/on_map-array1"},{"$ref":"#/definitions/on_map-array2"}]},"on_map-dict":{"type":"object","additionalProperties":false,"patternProperties":{"^[nvxsomilct]+$":{"description":"Pattern for vim key binding. You can use plugin prefix mappings. You can use '<Plug>' keyword as {mapping}. If{mapping} is '<Plug>', '<Plug>(normalized_name' is used. linter support is now under development","oneOf":[{"$ref":"#/definitions/vim-mode-key-mapping-string"},{"$ref":"#/definitions/on_map-array2"}]}}},"ArrayOrString":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}]},"Boolean":{"oneOf":[{"type":"boolean"},{"enum":[0,1],"type":"number"}]}},"description":"A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)","properties":{"plugins":{"title":"Definition properties table for installing a vim plugin","description":"Definition properties table for installing a vim plugin.\nIt is converted to |dein#add()|.","type":"array","items":{"$ref":"#/definitions/Plugin"},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1068"}}},"ftplugin":{"title":"ftplugin definition","description":"'_' key is executed after all ftplugin.\n'{filetype}' key is executed {filetype} ftplugin.\n You can define multiple filetypes by '{filetype1}_{filetype2}' key.","type":"object","additionalProperties":false,"properties":{"_":{"title":"all filetypes","description":"'_' key is executed after all ftplugin.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1056"}}}},"patternProperties":{"^[0-9a-zA-Z].+$":{"title":"filetype","description":"'{filetype}' key is executed {filetype} ftplugin.\nYou can define multiple filetypes by '{filetype1}_{filetype2}' key.\n'b:undo_ftplugin' is defined automatically.","type":"string"}},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1054"}}},"hook_add":{"title":"hook_add definition","description":"It is the global |dein-options-hook_add|.\nIt is executed in |dein#end()|.","type":"string","x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1063"}}},"multiple_plugins":{"title":"It is converted to |dein-toml-hook_add|","description":"It is converted to |dein-toml-hook_add|\n\"plugins\" key is needed.","type":"array","items":{"$ref":"#/definitions/MultiplePlugins"},"x-taplo":{"links":{"key":"https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L1073"}}}},"required":["plugins"],"title":"dein.vim","type":"object","x-taplo-info":{"authors":["kkiyama117 (https://github.com/kkiyama117)","raa0121 (https://github.com/raa0121)","Hibiki (https://github.com/4513ECHO)","mikan (https://github.com/mikanIchinose)"],"version":"0.1.0","patterns":["^(.*(/|\\\\)\\.*dein.*\\.toml|\\.*dein.*\\.toml)$"]}}
|
Provide a JSON object that satisfies the schema "dein.vim". Here are the required top‑level fields: plugins. Return only the valid JSON object.
|
dein.vim
|
schema-store
|
schema_store_250
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dependabot-2.0.json\",\"additionalProperties\":false,\"definitions\":{\"timezone\":{\"type\":\"string\",\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmara\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Timbuktu\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/Buenos_Aires\",\"America/Argentina/Catamarca\",\"America/Argentina/ComodRivadavia\",\"America/Argentina/Cordoba\",\"America/Argentina/Jujuy\",\"America/Argentina/La_Rioja\",\"America/Argentina/Mendoza\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Atikokan\",\"America/Atka\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Ensenada\",\"America/Fort_Nelson\",\"America/Fort_Wayne\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Indianapolis\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Louisville\",\"America/Kentucky/Monticello\",\"America/Knox_IN\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montreal\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nipigon\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Nuuk\",\"America/Ojinaga\",\"America/Panama\",\"America/Pangnirtung\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Acre\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rainy_River\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Rosario\",\"America/Santa_Isabel\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Shiprock\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Thunder_Bay\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Virgin\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"America/Yellowknife\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/South_Pole\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Ashkhabad\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Choibalsan\",\"Asia/Chongqing\",\"Asia/Chungking\",\"Asia/Colombo\",\"Asia/Dacca\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Harbin\",\"Asia/Hebron\",\"Asia/Ho_Chi_Minh\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Istanbul\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kashgar\",\"Asia/Kathmandu\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macao\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tel_Aviv\",\"Asia/Thimbu\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ujung_Pandang\",\"Asia/Ulaanbaatar\",\"Asia/Ulan_Bator\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Faroe\",\"Atlantic/Jan_Mayen\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/ACT\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Canberra\",\"Australia/Currie\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/LHI\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/North\",\"Australia/NSW\",\"Australia/Perth\",\"Australia/Queensland\",\"Australia/South\",\"Australia/Sydney\",\"Australia/Tasmania\",\"Australia/Victoria\",\"Australia/West\",\"Australia/Yancowinna\",\"Brazil/Acre\",\"Brazil/DeNoronha\",\"Brazil/East\",\"Brazil/West\",\"Canada/Atlantic\",\"Canada/Central\",\"Canada/Eastern\",\"Canada/Mountain\",\"Canada/Newfoundland\",\"Canada/Pacific\",\"Canada/Saskatchewan\",\"Canada/Yukon\",\"Chile/Continental\",\"Chile/EasterIsland\",\"Cuba\",\"Egypt\",\"Eire\",\"Etc/GMT\",\"Etc/GMT+0\",\"Etc/GMT+1\",\"Etc/GMT+10\",\"Etc/GMT+11\",\"Etc/GMT+12\",\"Etc/GMT+2\",\"Etc/GMT+3\",\"Etc/GMT+4\",\"Etc/GMT+5\",\"Etc/GMT+6\",\"Etc/GMT+7\",\"Etc/GMT+8\",\"Etc/GMT+9\",\"Etc/GMT-0\",\"Etc/GMT-1\",\"Etc/GMT-10\",\"Etc/GMT-11\",\"Etc/GMT-12\",\"Etc/GMT-13\",\"Etc/GMT-14\",\"Etc/GMT-2\",\"Etc/GMT-3\",\"Etc/GMT-4\",\"Etc/GMT-5\",\"Etc/GMT-6\",\"Etc/GMT-7\",\"Etc/GMT-8\",\"Etc/GMT-9\",\"Etc/GMT0\",\"Etc/Greenwich\",\"Etc/UCT\",\"Etc/Universal\",\"Etc/UTC\",\"Etc/Zulu\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belfast\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Nicosia\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Tiraspol\",\"Europe/Ulyanovsk\",\"Europe/Uzhgorod\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zaporozhye\",\"Europe/Zurich\",\"GB\",\"GB-Eire\",\"Hongkong\",\"Iceland\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Iran\",\"Israel\",\"Jamaica\",\"Japan\",\"Kwajalein\",\"Libya\",\"Mexico/BajaNorte\",\"Mexico/BajaSur\",\"Mexico/General\",\"Navajo\",\"NZ\",\"NZ-CHAT\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Chuuk\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Johnston\",\"Pacific/Kanton\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Pohnpei\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Samoa\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\",\"Pacific/Yap\",\"Poland\",\"Portugal\",\"PRC\",\"ROC\",\"Singapore\",\"US/Alaska\",\"US/Aleutian\",\"US/Arizona\",\"US/Central\",\"US/East-Indiana\",\"US/Eastern\",\"US/Hawaii\",\"US/Indiana-Starke\",\"US/Michigan\",\"US/Mountain\",\"US/Pacific\",\"US/Samoa\"]},\"dependency-type\":{\"type\":\"string\",\"enum\":[\"direct\",\"indirect\",\"all\",\"production\",\"development\"],\"x-intellij-enum-metadata\":{\"direct\":{\"description\":\"All explicitly defined dependencies.\"},\"indirect\":{\"description\":\"Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies).\"},\"all\":{\"description\":\"All explicitly defined dependencies. For bundler, pip, composer, cargo, also the dependencies of direct dependencies.\"},\"production\":{\"description\":\"Only dependencies in the 'Product dependency group'.\"},\"development\":{\"description\":\"Only dependencies in the 'Development dependency group'.\"}}},\"update-types\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"version-update:semver-major\",\"version-update:semver-minor\",\"version-update:semver-patch\"]},\"minItems\":1,\"uniqueItems\":true},\"insecure-external-code-execution\":{\"type\":\"string\",\"enum\":[\"allow\",\"deny\"]},\"versioning-strategy\":{\"type\":\"string\",\"enum\":[\"auto\",\"increase\",\"increase-if-necessary\",\"lockfile-only\",\"widen\"],\"x-intellij-enum-metadata\":{\"auto\":{\"description\":\"Try to differentiate between apps and libraries. Use 'increase' for apps and 'widen' for libraries.\"},\"increase\":{\"description\":\"Always increase the minimum version requirement to match the new version. If a range already exists, typically this only increases the lower bound.\"},\"increase-if-necessary\":{\"description\":\"Leave the constraint if the original constraint allows the new version, otherwise, bump the constraint.\"},\"lockfile-only\":{\"description\":\"Only create pull requests to update lockfiles. Ignore any new versions that would require package manifest changes.\"},\"widen\":{\"description\":\"Widen the allowed version requirements to include both the new and old versions, when possible. Typically, this only increases the maximum allowed version requirement.\"}}},\"package-ecosystem-values\":{\"enum\":[\"bun\",\"bundler\",\"cargo\",\"composer\",\"devcontainers\",\"docker\",\"docker-compose\",\"dotnet-sdk\",\"elm\",\"gitsubmodule\",\"github-actions\",\"gomod\",\"gradle\",\"helm\",\"maven\",\"mix\",\"npm\",\"nuget\",\"pip\",\"pub\",\"swift\",\"terraform\",\"uv\"]},\"schedule-day\":{\"type\":\"string\",\"enum\":[\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\",\"sunday\"]},\"schedule-interval\":{\"type\":\"string\",\"enum\":[\"daily\",\"weekly\",\"monthly\",\"quarterly\",\"semiannually\",\"yearly\",\"cron\"]},\"update\":{\"type\":\"object\",\"properties\":{\"allow\":{\"description\":\"Customize which updates are allowed\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dependency-name\":{\"type\":\"string\"},\"dependency-type\":{\"$ref\":\"#/definitions/dependency-type\"}},\"anyOf\":[{\"required\":[\"dependency-name\"]},{\"required\":[\"dependency-type\"]}],\"additionalProperties\":false}},\"assignees\":{\"description\":\"Assignees to set on pull requests\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"minItems\":1,\"uniqueItems\":true},\"commit-message\":{\"description\":\"Dependabot attempts to detect your commit message preferences and use similar patterns. Use this option to specify your preferences explicitly.\",\"type\":\"object\",\"properties\":{\"prefix\":{\"description\":\"A prefix for all commit messages. When you specify a prefix for commit messages, GitHub will automatically add a colon between the defined prefix and the commit message provided the defined prefix ends with a letter, number, closing parenthesis, or closing bracket. This means that, for example, if you end the prefix with a whitespace, there will be no colon added between the prefix and the commit message.\",\"type\":\"string\",\"maxLength\":50},\"prefix-development\":{\"description\":\"A separate prefix for all commit messages that update dependencies in the Development dependency group. When you specify a value for this option, the prefix is used only for updates to dependencies in the Production dependency group. This is not supported by all package ecosystems.\",\"type\":\"string\",\"maxLength\":50},\"include\":{\"description\":\"Specifies that any prefix is followed by a list of the dependencies updated in the commit.\",\"type\":\"string\",\"enum\":[\"scope\"],\"default\":\"scope\"}},\"anyOf\":[{\"required\":[\"prefix\"]},{\"required\":[\"prefix-development\"]},{\"required\":[\"include\"]}],\"additionalProperties\":false},\"directories\":{\"description\":\"Locations of package manifests\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"minItems\":1,\"uniqueItems\":true},\"directory\":{\"description\":\"Location of package manifests\",\"type\":\"string\",\"default\":\"/\"},\"groups\":{\"description\":\"Configure groups for dependencies. Each 'groups' property is arbitrary will appear in pull request titles and branch names. For example, the code snippet '{\\\"groups\\\": {\\\"NPM dependencies\\\": {\\\"patterns\\\": [\\\"*\\\"]}}}' sets the group name to 'NPM dependencies'.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"applies-to\":{\"description\":\"Use to specify a whether the rules in the group apply to version updates or security updates.\",\"type\":\"string\",\"enum\":[\"version-updates\",\"security-updates\"]},\"dependency-type\":{\"description\":\"Specify a dependency type to be included in the group.\",\"type\":\"string\",\"enum\":[\"development\",\"production\"]},\"patterns\":{\"description\":\"Define strings of characters that match with a dependency name (or multiple dependency names) to include those dependencies in the group.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true,\"minItems\":1},\"exclude-patterns\":{\"description\":\"Exclude certain dependencies from the group. If a dependency is excluded from a group, Dependabot will continue to raise single pull requests to update the dependency to its latest version.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true,\"minItems\":1},\"update-types\":{\"description\":\"Specify the semantic versioning level to include in the group\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"major\",\"minor\",\"patch\"]},\"minItems\":1,\"uniqueItems\":true}},\"anyOf\":[{\"required\":[\"dependency-type\"]},{\"required\":[\"patterns\"]},{\"required\":[\"exclude-patterns\"]},{\"required\":[\"update-types\"]}],\"additionalProperties\":false},\"minProperties\":1},\"ignore\":{\"description\":\"Ignore certain dependencies or versions\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"dependency-name\":{\"description\":\"Use to ignore updates for dependencies with matching names, optionally using * to match zero or more characters.\",\"type\":\"string\"},\"update-types\":{\"$ref\":\"#/definitions/update-types\",\"description\":\"Use to ignore types of updates. You can combine this with 'dependency-name: \\\"*\\\"' to ignore particular update-types for all dependencies.\"},\"versions\":{\"description\":\"Use to ignore specific versions or ranges of versions. If you want to define a range, use the standard pattern for the package manager.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true}},\"anyOf\":[{\"required\":[\"dependency-name\"]},{\"required\":[\"update-types\"]},{\"required\":[\"versions\"]}],\"additionalProperties\":false}},\"insecure-external-code-execution\":{\"$ref\":\"#/definitions/insecure-external-code-execution\",\"description\":\"Allow or deny code execution in manifest files\"},\"labels\":{\"description\":\"Labels to set on pull requests\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"minItems\":0,\"uniqueItems\":true,\"default\":[\"dependencies\"]},\"milestone\":{\"description\":\"Associate all pull requests raised for a package manager with a milestone. You need to specify the numeric identifier of the milestone and not its label.\",\"type\":\"integer\",\"minimum\":1},\"open-pull-requests-limit\":{\"description\":\"Limit number of open pull requests for version updates\",\"type\":\"integer\",\"minimum\":0,\"default\":5},\"package-ecosystem\":{\"$comment\":\"These values are restricted by a top-level if-then-else when 'enable-beta-ecosystems' is not enabled.\",\"description\":\"Package manager to use\",\"type\":\"string\",\"anyOf\":[{\"$ref\":\"#/definitions/package-ecosystem-values\"},{\"minLength\":1}]},\"pull-request-branch-name\":{\"description\":\"Pull request branch name preferences\",\"type\":\"object\",\"properties\":{\"separator\":{\"description\":\"Change separator for PR branch name\",\"type\":\"string\",\"default\":\"/\",\"enum\":[\"-\",\"_\",\"/\"]}},\"required\":[\"separator\"],\"additionalProperties\":false},\"rebase-strategy\":{\"description\":\"Disable automatic rebasing. 'auto' is the default and Dependabot will rebase open pull requests when changes are detected. 'disabled' will disable automatic rebasing.\",\"type\":\"string\",\"enum\":[\"auto\",\"disabled\"],\"default\":\"auto\"},\"registries\":{\"$comment\":\"'registries' must be either an array of strings, or the string constant '*'.\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true,\"minItems\":1},{\"type\":\"string\",\"const\":\"*\"}]},\"reviewers\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"description\":\"Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager. You must use the full team name, including the organization, as if you were @mentioning the team.\",\"minItems\":1,\"uniqueItems\":true},\"schedule\":{\"description\":\"Schedule preferences\",\"type\":\"object\",\"properties\":{\"interval\":{\"$ref\":\"#/definitions/schedule-interval\"},\"day\":{\"$ref\":\"#/definitions/schedule-day\",\"description\":\"Specify an alternative day to check for updates\"},\"time\":{\"type\":\"string\",\"description\":\"Specify an alternative time of day to check for updates (format: hh:mm)\",\"pattern\":\"^([01][0-9]|2[0-3]):[0-5][0-9]$\"},\"timezone\":{\"$ref\":\"#/definitions/timezone\",\"description\":\"The time zone identifier must be from the Time Zone database maintained by IANA\"},\"cronjob\":{\"type\":\"string\",\"description\":\"Specify a valid cron expression for updates\"}},\"allOf\":[{\"$comment\":\"If interval type is 'cron', enforce 'cronjob' property.\",\"if\":{\"properties\":{\"interval\":{\"const\":\"cron\"}}},\"then\":{\"required\":[\"interval\",\"cronjob\"]},\"else\":{\"required\":[\"interval\"]}}]},\"target-branch\":{\"description\":\"Specify a different branch for manifest files and for pull requests.\",\"type\":\"string\",\"minLength\":1},\"vendor\":{\"description\":\"Tell Dependabot to vendor dependencies when updating them. Don't use this option if you're using 'gomod'.\",\"type\":\"boolean\"},\"versioning-strategy\":{\"$ref\":\"#/definitions/versioning-strategy\",\"description\":\"How to update manifest version requirements\"}},\"allOf\":[{\"required\":[\"package-ecosystem\",\"schedule\"]},{\"oneOf\":[{\"required\":[\"directories\"]},{\"required\":[\"directory\"]}]}]},\"registry\":{\"type\":\"object\",\"description\":\"The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.\",\"additionalProperties\":false,\"patternProperties\":{\".+\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"description\":\"Identifies the type of registry.\",\"enum\":[\"composer-repository\",\"docker-registry\",\"git\",\"hex-organization\",\"hex-repository\",\"maven-repository\",\"npm-registry\",\"nuget-feed\",\"python-index\",\"rubygems-server\",\"terraform-registry\"]},\"url\":{\"description\":\"The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, 'https://' is assumed. Dependabot adds or ignores trailing slashes as required.\",\"type\":\"string\"},\"username\":{\"description\":\"The username that Dependabot uses to access the registry.\",\"type\":\"string\"},\"password\":{\"description\":\"A reference to a Dependabot secret containing the password for the specified user.\",\"type\":\"string\"},\"key\":{\"description\":\"A reference to a Dependabot secret containing an access key for this registry.\",\"type\":\"string\"},\"token\":{\"description\":\"A reference to a Dependabot secret containing an access token for this registry.\",\"type\":\"string\"},\"replaces-base\":{\"description\":\"For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).\",\"type\":\"boolean\"},\"organization\":{\"description\":\"\",\"type\":\"string\"},\"repo\":{\"description\":\"\",\"type\":\"string\"},\"auth-key\":{\"description\":\"\",\"type\":\"string\"},\"public-key-fingerprint\":{\"description\":\"\",\"type\":\"string\"}},\"required\":[\"type\",\"url\"]}},\"minProperties\":1}},\"properties\":{\"version\":{\"title\":\"Config file version\",\"description\":\"Dependabot configuration files require this key, and its value must be 2\",\"type\":\"integer\",\"enum\":[2]},\"enable-beta-ecosystems\":{\"description\":\"Enable ecosystems that have beta-level support\",\"type\":\"boolean\"},\"updates\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/update\",\"title\":\"Package Ecosystem\",\"description\":\"Element for each one package manager that you want GitHub Dependabot to monitor for new versions\"}},\"registries\":{\"$ref\":\"#/definitions/registry\"}},\"required\":[\"version\",\"updates\"],\"title\":\"GitHub Dependabot v2 config\",\"type\":\"object\",\"allOf\":[{\"$comment\":\"If 'enable-beta-ecosystems' is NOT enabled, enforce known 'package-ecosystem' values.\",\"if\":{\"properties\":{\"enable-beta-ecosystems\":{\"const\":true}},\"required\":[\"enable-beta-ecosystems\"]},\"then\":{},\"else\":{\"properties\":{\"updates\":{\"items\":{\"properties\":{\"package-ecosystem\":{\"$ref\":\"#/definitions/package-ecosystem-values\"}}}}}}}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"GitHub Dependabot v2 config\". Here are the required top‑level fields: version, updates. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dependabot-2.0.json","additionalProperties":false,"definitions":{"timezone":{"type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/North","Australia/NSW","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/Universal","Etc/UTC","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","Navajo","NZ","NZ-CHAT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","PRC","ROC","Singapore","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa"]},"dependency-type":{"type":"string","enum":["direct","indirect","all","production","development"],"x-intellij-enum-metadata":{"direct":{"description":"All explicitly defined dependencies."},"indirect":{"description":"Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies)."},"all":{"description":"All explicitly defined dependencies. For bundler, pip, composer, cargo, also the dependencies of direct dependencies."},"production":{"description":"Only dependencies in the 'Product dependency group'."},"development":{"description":"Only dependencies in the 'Development dependency group'."}}},"update-types":{"type":"array","items":{"type":"string","enum":["version-update:semver-major","version-update:semver-minor","version-update:semver-patch"]},"minItems":1,"uniqueItems":true},"insecure-external-code-execution":{"type":"string","enum":["allow","deny"]},"versioning-strategy":{"type":"string","enum":["auto","increase","increase-if-necessary","lockfile-only","widen"],"x-intellij-enum-metadata":{"auto":{"description":"Try to differentiate between apps and libraries. Use 'increase' for apps and 'widen' for libraries."},"increase":{"description":"Always increase the minimum version requirement to match the new version. If a range already exists, typically this only increases the lower bound."},"increase-if-necessary":{"description":"Leave the constraint if the original constraint allows the new version, otherwise, bump the constraint."},"lockfile-only":{"description":"Only create pull requests to update lockfiles. Ignore any new versions that would require package manifest changes."},"widen":{"description":"Widen the allowed version requirements to include both the new and old versions, when possible. Typically, this only increases the maximum allowed version requirement."}}},"package-ecosystem-values":{"enum":["bun","bundler","cargo","composer","devcontainers","docker","docker-compose","dotnet-sdk","elm","gitsubmodule","github-actions","gomod","gradle","helm","maven","mix","npm","nuget","pip","pub","swift","terraform","uv"]},"schedule-day":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"schedule-interval":{"type":"string","enum":["daily","weekly","monthly","quarterly","semiannually","yearly","cron"]},"update":{"type":"object","properties":{"allow":{"description":"Customize which updates are allowed","type":"array","items":{"type":"object","properties":{"dependency-name":{"type":"string"},"dependency-type":{"$ref":"#/definitions/dependency-type"}},"anyOf":[{"required":["dependency-name"]},{"required":["dependency-type"]}],"additionalProperties":false}},"assignees":{"description":"Assignees to set on pull requests","type":"array","items":{"type":"string","minLength":1},"minItems":1,"uniqueItems":true},"commit-message":{"description":"Dependabot attempts to detect your commit message preferences and use similar patterns. Use this option to specify your preferences explicitly.","type":"object","properties":{"prefix":{"description":"A prefix for all commit messages. When you specify a prefix for commit messages, GitHub will automatically add a colon between the defined prefix and the commit message provided the defined prefix ends with a letter, number, closing parenthesis, or closing bracket. This means that, for example, if you end the prefix with a whitespace, there will be no colon added between the prefix and the commit message.","type":"string","maxLength":50},"prefix-development":{"description":"A separate prefix for all commit messages that update dependencies in the Development dependency group. When you specify a value for this option, the prefix is used only for updates to dependencies in the Production dependency group. This is not supported by all package ecosystems.","type":"string","maxLength":50},"include":{"description":"Specifies that any prefix is followed by a list of the dependencies updated in the commit.","type":"string","enum":["scope"],"default":"scope"}},"anyOf":[{"required":["prefix"]},{"required":["prefix-development"]},{"required":["include"]}],"additionalProperties":false},"directories":{"description":"Locations of package manifests","type":"array","items":{"type":"string","minLength":1},"minItems":1,"uniqueItems":true},"directory":{"description":"Location of package manifests","type":"string","default":"/"},"groups":{"description":"Configure groups for dependencies. Each 'groups' property is arbitrary will appear in pull request titles and branch names. For example, the code snippet '{\"groups\": {\"NPM dependencies\": {\"patterns\": [\"*\"]}}}' sets the group name to 'NPM dependencies'.","type":"object","additionalProperties":{"type":"object","properties":{"applies-to":{"description":"Use to specify a whether the rules in the group apply to version updates or security updates.","type":"string","enum":["version-updates","security-updates"]},"dependency-type":{"description":"Specify a dependency type to be included in the group.","type":"string","enum":["development","production"]},"patterns":{"description":"Define strings of characters that match with a dependency name (or multiple dependency names) to include those dependencies in the group.","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true,"minItems":1},"exclude-patterns":{"description":"Exclude certain dependencies from the group. If a dependency is excluded from a group, Dependabot will continue to raise single pull requests to update the dependency to its latest version.","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true,"minItems":1},"update-types":{"description":"Specify the semantic versioning level to include in the group","type":"array","items":{"type":"string","enum":["major","minor","patch"]},"minItems":1,"uniqueItems":true}},"anyOf":[{"required":["dependency-type"]},{"required":["patterns"]},{"required":["exclude-patterns"]},{"required":["update-types"]}],"additionalProperties":false},"minProperties":1},"ignore":{"description":"Ignore certain dependencies or versions","type":"array","items":{"type":"object","properties":{"dependency-name":{"description":"Use to ignore updates for dependencies with matching names, optionally using * to match zero or more characters.","type":"string"},"update-types":{"$ref":"#/definitions/update-types","description":"Use to ignore types of updates. You can combine this with 'dependency-name: \"*\"' to ignore particular update-types for all dependencies."},"versions":{"description":"Use to ignore specific versions or ranges of versions. If you want to define a range, use the standard pattern for the package manager.","type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true}},"anyOf":[{"required":["dependency-name"]},{"required":["update-types"]},{"required":["versions"]}],"additionalProperties":false}},"insecure-external-code-execution":{"$ref":"#/definitions/insecure-external-code-execution","description":"Allow or deny code execution in manifest files"},"labels":{"description":"Labels to set on pull requests","type":"array","items":{"type":"string","minLength":1},"minItems":0,"uniqueItems":true,"default":["dependencies"]},"milestone":{"description":"Associate all pull requests raised for a package manager with a milestone. You need to specify the numeric identifier of the milestone and not its label.","type":"integer","minimum":1},"open-pull-requests-limit":{"description":"Limit number of open pull requests for version updates","type":"integer","minimum":0,"default":5},"package-ecosystem":{"$comment":"These values are restricted by a top-level if-then-else when 'enable-beta-ecosystems' is not enabled.","description":"Package manager to use","type":"string","anyOf":[{"$ref":"#/definitions/package-ecosystem-values"},{"minLength":1}]},"pull-request-branch-name":{"description":"Pull request branch name preferences","type":"object","properties":{"separator":{"description":"Change separator for PR branch name","type":"string","default":"/","enum":["-","_","/"]}},"required":["separator"],"additionalProperties":false},"rebase-strategy":{"description":"Disable automatic rebasing. 'auto' is the default and Dependabot will rebase open pull requests when changes are detected. 'disabled' will disable automatic rebasing.","type":"string","enum":["auto","disabled"],"default":"auto"},"registries":{"$comment":"'registries' must be either an array of strings, or the string constant '*'.","oneOf":[{"type":"array","items":{"type":"string","minLength":1},"uniqueItems":true,"minItems":1},{"type":"string","const":"*"}]},"reviewers":{"type":"array","items":{"type":"string","minLength":1},"description":"Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager. You must use the full team name, including the organization, as if you were @mentioning the team.","minItems":1,"uniqueItems":true},"schedule":{"description":"Schedule preferences","type":"object","properties":{"interval":{"$ref":"#/definitions/schedule-interval"},"day":{"$ref":"#/definitions/schedule-day","description":"Specify an alternative day to check for updates"},"time":{"type":"string","description":"Specify an alternative time of day to check for updates (format: hh:mm)","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]$"},"timezone":{"$ref":"#/definitions/timezone","description":"The time zone identifier must be from the Time Zone database maintained by IANA"},"cronjob":{"type":"string","description":"Specify a valid cron expression for updates"}},"allOf":[{"$comment":"If interval type is 'cron', enforce 'cronjob' property.","if":{"properties":{"interval":{"const":"cron"}}},"then":{"required":["interval","cronjob"]},"else":{"required":["interval"]}}]},"target-branch":{"description":"Specify a different branch for manifest files and for pull requests.","type":"string","minLength":1},"vendor":{"description":"Tell Dependabot to vendor dependencies when updating them. Don't use this option if you're using 'gomod'.","type":"boolean"},"versioning-strategy":{"$ref":"#/definitions/versioning-strategy","description":"How to update manifest version requirements"}},"allOf":[{"required":["package-ecosystem","schedule"]},{"oneOf":[{"required":["directories"]},{"required":["directory"]}]}]},"registry":{"type":"object","description":"The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.","additionalProperties":false,"patternProperties":{".+":{"type":"object","additionalProperties":false,"properties":{"type":{"description":"Identifies the type of registry.","enum":["composer-repository","docker-registry","git","hex-organization","hex-repository","maven-repository","npm-registry","nuget-feed","python-index","rubygems-server","terraform-registry"]},"url":{"description":"The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, 'https://' is assumed. Dependabot adds or ignores trailing slashes as required.","type":"string"},"username":{"description":"The username that Dependabot uses to access the registry.","type":"string"},"password":{"description":"A reference to a Dependabot secret containing the password for the specified user.","type":"string"},"key":{"description":"A reference to a Dependabot secret containing an access key for this registry.","type":"string"},"token":{"description":"A reference to a Dependabot secret containing an access token for this registry.","type":"string"},"replaces-base":{"description":"For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).","type":"boolean"},"organization":{"description":"","type":"string"},"repo":{"description":"","type":"string"},"auth-key":{"description":"","type":"string"},"public-key-fingerprint":{"description":"","type":"string"}},"required":["type","url"]}},"minProperties":1}},"properties":{"version":{"title":"Config file version","description":"Dependabot configuration files require this key, and its value must be 2","type":"integer","enum":[2]},"enable-beta-ecosystems":{"description":"Enable ecosystems that have beta-level support","type":"boolean"},"updates":{"type":"array","items":{"$ref":"#/definitions/update","title":"Package Ecosystem","description":"Element for each one package manager that you want GitHub Dependabot to monitor for new versions"}},"registries":{"$ref":"#/definitions/registry"}},"required":["version","updates"],"title":"GitHub Dependabot v2 config","type":"object","allOf":[{"$comment":"If 'enable-beta-ecosystems' is NOT enabled, enforce known 'package-ecosystem' values.","if":{"properties":{"enable-beta-ecosystems":{"const":true}},"required":["enable-beta-ecosystems"]},"then":{},"else":{"properties":{"updates":{"items":{"properties":{"package-ecosystem":{"$ref":"#/definitions/package-ecosystem-values"}}}}}}}]}
|
Provide a JSON object that satisfies the schema "GitHub Dependabot v2 config". Here are the required top‑level fields: version, updates. Return only the valid JSON object.
|
GitHub Dependabot v2 config
|
schema-store
|
schema_store_251
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{},\"id\":\"https://json.schemastore.org/dependabot.json\",\"properties\":{\"version\":{\"type\":\"integer\",\"default\":1,\"examples\":[1],\"minimum\":1,\"maximum\":1},\"update_configs\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"package_manager\",\"directory\",\"update_schedule\"],\"properties\":{\"package_manager\":{\"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\"],\"description\":\"What package manager to use\",\"examples\":[\"ruby:bundler\"]},\"directory\":{\"type\":\"string\",\"description\":\"Where to look for package manifests\",\"examples\":[\"/app\"]},\"update_schedule\":{\"type\":\"string\",\"enum\":[\"live\",\"daily\",\"weekly\",\"monthly\"],\"description\":\"How often to check for updates\",\"examples\":[\"live\"]},\"target_branch\":{\"type\":\"string\",\"description\":\"Branch to create pull requests against. By default your repository's default branch is used.\",\"items\":{\"type\":\"string\",\"description\":\"branchname\",\"examples\":[\"develop\"]}},\"default_reviewers\":{\"type\":\"array\",\"description\":\"Reviewers to set on update pull requests.\",\"items\":{\"type\":\"string\",\"description\":\"reviewer github username\",\"examples\":[\"github-username\"]}},\"default_assignees\":{\"type\":\"array\",\"description\":\"Assignees to set on update pull requests.\",\"items\":{\"type\":\"string\",\"description\":\"assignee github username\",\"examples\":[\"github_username_1\"]}},\"default_labels\":{\"type\":\"array\",\"description\":\"Labels to set on update pull requests. By default 'dependencies' is used.\",\"items\":{\"type\":\"string\",\"examples\":[\"label-name\"]}},\"default_milestone\":{\"type\":\"integer\",\"description\":\"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.\"},\"allowed_updates\":{\"type\":\"array\",\"description\":\"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).\",\"items\":{\"type\":\"object\",\"minItems\":1,\"properties\":{\"match\":{\"type\":\"object\",\"properties\":{\"dependency_name\":{\"type\":\"string\",\"description\":\"matching on dependency name \",\"examples\":[\"react*\"]},\"dependency_type\":{\"type\":\"string\",\"description\":\"only allow certain updates\",\"examples\":[\"development\",\"production\",\"direct\",\"indirect\",\"all\"]},\"update_type\":{\"type\":\"string\",\"enum\":[\"security\",\"all\"],\"description\":\"which updates to do\",\"default\":\"security\",\"examples\":[\"all\"]}}}}}},\"ignored_updates\":{\"type\":\"array\",\"description\":\"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).\",\"items\":{\"type\":\"object\",\"minItems\":1,\"properties\":{\"match\":{\"type\":\"object\",\"properties\":{\"dependency_name\":{\"type\":\"string\",\"description\":\"matching on dependency name \",\"examples\":[\"aws*\"]},\"version_requirement\":{\"type\":\"string\",\"description\":\"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).\",\"examples\":[\"4.x\"]}}}}}},\"automerged_updates\":{\"type\":\"array\",\"description\":\"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 checks pass before merging. You can also set working hours for automerging in your dashboard account settings.\",\"items\":{\"type\":\"object\",\"minItems\":1,\"properties\":{\"match\":{\"type\":\"object\",\"properties\":{\"dependency_name\":{\"type\":\"string\",\"description\":\"matching on dependency name \",\"examples\":[\"aws*\"]},\"dependency_type\":{\"type\":\"string\",\"enum\":[\"development\",\"production\",\"all\"],\"examples\":[\"production*\"]},\"update_type\":{\"type\":\"string\",\"enum\":[\"security:patch\",\"semver:patch\",\"semver:minor\",\"in_range\",\"all\"],\"examples\":[\"semver:patch\"]}}}}}},\"version_requirement_updates\":{\"type\":\"string\",\"enum\":[\"off\",\"auto\",\"widen_ranges\",\"increase_versions\",\"increase_versions_if_necessary\"],\"description\":\"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.\",\"examples\":[\"widen_ranges\"]},\"commit_message\":{\"type\":\"object\",\"description\":\"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.\",\"properties\":{\"prefix\":{\"type\":\"string\",\"examples\":[\"chore\"]},\"prefix_development\":{\"type\":\"string\",\"examples\":[\"fix\"]},\"include_scope\":{\"type\":\"boolean\"}}}}}}},\"required\":[\"version\",\"update_configs\"],\"title\":\"Dependabot configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Dependabot configuration file\". Here are the required top‑level fields: version, update_configs. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{},"id":"https://json.schemastore.org/dependabot.json","properties":{"version":{"type":"integer","default":1,"examples":[1],"minimum":1,"maximum":1},"update_configs":{"type":"array","items":{"type":"object","required":["package_manager","directory","update_schedule"],"properties":{"package_manager":{"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"],"description":"What package manager to use","examples":["ruby:bundler"]},"directory":{"type":"string","description":"Where to look for package manifests","examples":["/app"]},"update_schedule":{"type":"string","enum":["live","daily","weekly","monthly"],"description":"How often to check for updates","examples":["live"]},"target_branch":{"type":"string","description":"Branch to create pull requests against. By default your repository's default branch is used.","items":{"type":"string","description":"branchname","examples":["develop"]}},"default_reviewers":{"type":"array","description":"Reviewers to set on update pull requests.","items":{"type":"string","description":"reviewer github username","examples":["github-username"]}},"default_assignees":{"type":"array","description":"Assignees to set on update pull requests.","items":{"type":"string","description":"assignee github username","examples":["github_username_1"]}},"default_labels":{"type":"array","description":"Labels to set on update pull requests. By default 'dependencies' is used.","items":{"type":"string","examples":["label-name"]}},"default_milestone":{"type":"integer","description":"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."},"allowed_updates":{"type":"array","description":"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).","items":{"type":"object","minItems":1,"properties":{"match":{"type":"object","properties":{"dependency_name":{"type":"string","description":"matching on dependency name ","examples":["react*"]},"dependency_type":{"type":"string","description":"only allow certain updates","examples":["development","production","direct","indirect","all"]},"update_type":{"type":"string","enum":["security","all"],"description":"which updates to do","default":"security","examples":["all"]}}}}}},"ignored_updates":{"type":"array","description":"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).","items":{"type":"object","minItems":1,"properties":{"match":{"type":"object","properties":{"dependency_name":{"type":"string","description":"matching on dependency name ","examples":["aws*"]},"version_requirement":{"type":"string","description":"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).","examples":["4.x"]}}}}}},"automerged_updates":{"type":"array","description":"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 checks pass before merging. You can also set working hours for automerging in your dashboard account settings.","items":{"type":"object","minItems":1,"properties":{"match":{"type":"object","properties":{"dependency_name":{"type":"string","description":"matching on dependency name ","examples":["aws*"]},"dependency_type":{"type":"string","enum":["development","production","all"],"examples":["production*"]},"update_type":{"type":"string","enum":["security:patch","semver:patch","semver:minor","in_range","all"],"examples":["semver:patch"]}}}}}},"version_requirement_updates":{"type":"string","enum":["off","auto","widen_ranges","increase_versions","increase_versions_if_necessary"],"description":"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.","examples":["widen_ranges"]},"commit_message":{"type":"object","description":"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.","properties":{"prefix":{"type":"string","examples":["chore"]},"prefix_development":{"type":"string","examples":["fix"]},"include_scope":{"type":"boolean"}}}}}}},"required":["version","update_configs"],"title":"Dependabot configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "Dependabot configuration file". Here are the required top‑level fields: version, update_configs. Return only the valid JSON object.
|
Dependabot configuration file
|
schema-store
|
schema_store_252
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"dependencies\",\"type\":\"object\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"properties\":{\"packages\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"object\",\"required\":[\"package\",\"version\"],\"properties\":{\"version\":{\"title\":\"Package version\",\"description\":\"A semantic version string or range, such as [\\\">=1.0.0\\\", \\\"<2.0.0\\\"]\",\"type\":[\"array\",\"number\",\"string\"]},\"install-prerelease\":{\"title\":\"Install Prerelease\",\"description\":\"Opt in to prerelease versions of a package\",\"type\":\"boolean\"},\"package\":{\"title\":\"Package identifier\",\"description\":\"Must be in format `org_name/package_name`. Refer to hub.getdbt.com for installation instructions\",\"type\":\"string\",\"examples\":[\"dbt-labs/dbt_utils\"],\"pattern\":\"^[\\\\w\\\\-\\\\.]+/[\\\\w\\\\-\\\\.]+$\"}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"private\"],\"properties\":{\"private\":{\"title\":\"Package identifier\",\"description\":\"Must be in format `org_name/package_name`. Refer to docs.getdbt.com for installation instructions\",\"type\":\"string\",\"examples\":[\"dbt-labs/private_dbt_utils\"],\"pattern\":\"^[\\\\w\\\\-\\\\.]+/[\\\\w\\\\-\\\\.]+$\"},\"revision\":{\"title\":\"Revision\",\"description\":\"Pin your package to a specific release by specifying a release name\",\"type\":\"string\"},\"subdirectory\":{\"title\":\"Repo subdirectory\",\"description\":\"Subdirectory of the repo where the dbt package is located\",\"type\":\"string\"}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"git\"],\"properties\":{\"git\":{\"title\":\"Git URL\",\"type\":\"string\"},\"revision\":{\"title\":\"Revision\",\"description\":\"Pin your package to a specific release by specifying a release name\",\"type\":\"string\"},\"subdirectory\":{\"title\":\"Subdirectory\",\"description\":\"Only required if the package is nested in a subdirectory of the git project\",\"type\":\"string\"}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"name\",\"tarball\"],\"properties\":{\"name\":{\"description\":\"dbt will create a subdirectory in your `packages-install-path` with this name, and the tarball's source code will be installed here.\",\"type\":\"string\"},\"tarball\":{\"title\":\"Internally-hosted tarball URL\",\"type\":\"string\"}},\"additionalProperties\":false},{\"type\":\"object\",\"properties\":{\"local\":{\"type\":\"string\"}},\"additionalProperties\":false}]},\"minItems\":1},\"projects\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"}},\"additionalProperties\":false}}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dependencies\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"dependencies","type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{"packages":{"type":"array","items":{"anyOf":[{"type":"object","required":["package","version"],"properties":{"version":{"title":"Package version","description":"A semantic version string or range, such as [\">=1.0.0\", \"<2.0.0\"]","type":["array","number","string"]},"install-prerelease":{"title":"Install Prerelease","description":"Opt in to prerelease versions of a package","type":"boolean"},"package":{"title":"Package identifier","description":"Must be in format `org_name/package_name`. Refer to hub.getdbt.com for installation instructions","type":"string","examples":["dbt-labs/dbt_utils"],"pattern":"^[\\w\\-\\.]+/[\\w\\-\\.]+$"}},"additionalProperties":false},{"type":"object","required":["private"],"properties":{"private":{"title":"Package identifier","description":"Must be in format `org_name/package_name`. Refer to docs.getdbt.com for installation instructions","type":"string","examples":["dbt-labs/private_dbt_utils"],"pattern":"^[\\w\\-\\.]+/[\\w\\-\\.]+$"},"revision":{"title":"Revision","description":"Pin your package to a specific release by specifying a release name","type":"string"},"subdirectory":{"title":"Repo subdirectory","description":"Subdirectory of the repo where the dbt package is located","type":"string"}},"additionalProperties":false},{"type":"object","required":["git"],"properties":{"git":{"title":"Git URL","type":"string"},"revision":{"title":"Revision","description":"Pin your package to a specific release by specifying a release name","type":"string"},"subdirectory":{"title":"Subdirectory","description":"Only required if the package is nested in a subdirectory of the git project","type":"string"}},"additionalProperties":false},{"type":"object","required":["name","tarball"],"properties":{"name":{"description":"dbt will create a subdirectory in your `packages-install-path` with this name, and the tarball's source code will be installed here.","type":"string"},"tarball":{"title":"Internally-hosted tarball URL","type":"string"}},"additionalProperties":false},{"type":"object","properties":{"local":{"type":"string"}},"additionalProperties":false}]},"minItems":1},"projects":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "dependencies". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
dependencies
|
schema-store
|
schema_store_253
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/deployed.json\",\"additionalProperties\":false,\"definitions\":{\"privateKey\":{\"description\":\"Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).\",\"type\":[\"string\",\"object\"]},\"passphrase\":{\"description\":\"For an encrypted privateKey, this is the passphrase used to decrypt it.\",\"type\":\"string\",\"minLength\":1},\"script\":{\"description\":\"Execute script commands.\",\"type\":\"string\",\"minLength\":1},\"backupName\":{\"description\":\"Old version backup name.\",\"type\":\"string\",\"minLength\":1},\"removeLocalDir\":{\"description\":\"Delete localpath after deployment.\",\"type\":\"boolean\"},\"clearRemoteDir\":{\"description\":\"Empty the old version before deploying the new version.\",\"type\":\"boolean\"}},\"description\":\"JSON schema for the deployed cli config file. \\n\\nSee also: https://hyhello.github.io/deployed\\n\\n\",\"properties\":{\"$schema\":{\"description\":\"JSON Schema for deployed.\",\"type\":\"string\",\"minLength\":1},\"projectName\":{\"description\":\"Name of project to be released.\",\"type\":\"string\",\"minLength\":1},\"cluster\":{\"type\":\"array\",\"uniqueItems\":true,\"description\":\"Alias collection of environment to be deployed.\",\"items\":{\"type\":\"string\"}},\"privateKey\":{\"$ref\":\"#/definitions/privateKey\"},\"passphrase\":{\"$ref\":\"#/definitions/passphrase\"},\"script\":{\"$ref\":\"#/definitions/script\"},\"backupName\":{\"$ref\":\"#/definitions/backupName\"},\"removeLocalDir\":{\"$ref\":\"#/definitions/removeLocalDir\"},\"clearRemoteDir\":{\"$ref\":\"#/definitions/clearRemoteDir\"},\"modeList\":{\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"required\":[\"mode\",\"name\",\"host\",\"port\",\"username\",\"localPath\",\"remotePath\"],\"additionalProperties\":false,\"properties\":{\"mode\":{\"description\":\"Deployment environment alias.\",\"type\":\"string\",\"minLength\":1},\"name\":{\"description\":\"Deployment environment name.\",\"type\":\"string\",\"minLength\":1},\"host\":{\"description\":\"Hostname or IP address of the server.\",\"type\":\"string\",\"minLength\":1},\"port\":{\"description\":\"Port number of the server.\",\"type\":\"integer\",\"minimum\":1},\"username\":{\"description\":\"Username for authentication.\",\"type\":\"string\",\"minLength\":1},\"password\":{\"description\":\"Password for password-based user authentication.\",\"type\":\"string\",\"minLength\":1},\"remotePath\":{\"description\":\"Deployment path.\",\"type\":\"string\",\"minLength\":2},\"localPath\":{\"description\":\"Local upload path.\",\"type\":\"string\",\"minLength\":1},\"backupPath\":{\"description\":\"Backup path.\",\"type\":\"string\",\"minLength\":2},\"privateKey\":{\"$ref\":\"#/definitions/privateKey\"},\"passphrase\":{\"$ref\":\"#/definitions/passphrase\"},\"script\":{\"$ref\":\"#/definitions/script\"},\"backupName\":{\"$ref\":\"#/definitions/backupName\"},\"removeLocalDir\":{\"$ref\":\"#/definitions/removeLocalDir\"},\"clearRemoteDir\":{\"$ref\":\"#/definitions/clearRemoteDir\"}}}},\"plugin\":{\"description\":\"List of plugins to load and use.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":[\"string\",\"array\"],\"items\":[{\"description\":\"The name of the plugin.\",\"type\":\"string\"},{\"description\":\"The options of the plugin.\",\"type\":\"object\"}]}}},\"required\":[\"projectName\",\"modeList\"],\"title\":\"deployed cli\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"deployed cli\". Here are the required top‑level fields: projectName, modeList. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/deployed.json","additionalProperties":false,"definitions":{"privateKey":{"description":"Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).","type":["string","object"]},"passphrase":{"description":"For an encrypted privateKey, this is the passphrase used to decrypt it.","type":"string","minLength":1},"script":{"description":"Execute script commands.","type":"string","minLength":1},"backupName":{"description":"Old version backup name.","type":"string","minLength":1},"removeLocalDir":{"description":"Delete localpath after deployment.","type":"boolean"},"clearRemoteDir":{"description":"Empty the old version before deploying the new version.","type":"boolean"}},"description":"JSON schema for the deployed cli config file. \n\nSee also: https://hyhello.github.io/deployed\n\n","properties":{"$schema":{"description":"JSON Schema for deployed.","type":"string","minLength":1},"projectName":{"description":"Name of project to be released.","type":"string","minLength":1},"cluster":{"type":"array","uniqueItems":true,"description":"Alias collection of environment to be deployed.","items":{"type":"string"}},"privateKey":{"$ref":"#/definitions/privateKey"},"passphrase":{"$ref":"#/definitions/passphrase"},"script":{"$ref":"#/definitions/script"},"backupName":{"$ref":"#/definitions/backupName"},"removeLocalDir":{"$ref":"#/definitions/removeLocalDir"},"clearRemoteDir":{"$ref":"#/definitions/clearRemoteDir"},"modeList":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["mode","name","host","port","username","localPath","remotePath"],"additionalProperties":false,"properties":{"mode":{"description":"Deployment environment alias.","type":"string","minLength":1},"name":{"description":"Deployment environment name.","type":"string","minLength":1},"host":{"description":"Hostname or IP address of the server.","type":"string","minLength":1},"port":{"description":"Port number of the server.","type":"integer","minimum":1},"username":{"description":"Username for authentication.","type":"string","minLength":1},"password":{"description":"Password for password-based user authentication.","type":"string","minLength":1},"remotePath":{"description":"Deployment path.","type":"string","minLength":2},"localPath":{"description":"Local upload path.","type":"string","minLength":1},"backupPath":{"description":"Backup path.","type":"string","minLength":2},"privateKey":{"$ref":"#/definitions/privateKey"},"passphrase":{"$ref":"#/definitions/passphrase"},"script":{"$ref":"#/definitions/script"},"backupName":{"$ref":"#/definitions/backupName"},"removeLocalDir":{"$ref":"#/definitions/removeLocalDir"},"clearRemoteDir":{"$ref":"#/definitions/clearRemoteDir"}}}},"plugin":{"description":"List of plugins to load and use.","type":"array","uniqueItems":true,"items":{"type":["string","array"],"items":[{"description":"The name of the plugin.","type":"string"},{"description":"The options of the plugin.","type":"object"}]}}},"required":["projectName","modeList"],"title":"deployed cli","type":"object"}
|
Provide a JSON object that satisfies the schema "deployed cli". Here are the required top‑level fields: projectName, modeList. Return only the valid JSON object.
|
deployed cli
|
schema-store
|
schema_store_254
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$defs\":{\"ruleProperties\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"excludes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ignoreAnnotated\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ignoreFunction\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}},\"id\":\"https://json.schemastore.org/detekt-1.22.0.json\",\"properties\":{\"build\":{\"type\":\"object\",\"properties\":{\"maxIssues\":{\"type\":\"integer\"},\"excludeCorrectable\":{\"type\":\"boolean\"},\"weights\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"integer\"}}}},\"config\":{\"type\":\"object\",\"properties\":{\"validation\":{\"type\":\"boolean\"},\"warningsAsErrors\":{\"type\":\"boolean\"},\"checkExhaustiveness\":{\"type\":\"boolean\"},\"excludes\":{\"type\":\"string\"}}},\"processors\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"exclude\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"console-reports\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"exclude\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"output-reports\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"exclude\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"comments\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"AbsentOrWrongFileLicense\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"licenseTemplateFile\":{\"type\":\"string\"},\"licenseTemplateIsRegex\":{\"type\":\"boolean\"}}},\"CommentOverPrivateFunction\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"CommentOverPrivateProperty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"DeprecatedBlockTag\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EndOfSentenceFormat\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"endOfSentenceFormat\":{\"type\":\"string\"}}},\"KDocReferencesNonPublicProperty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"OutdatedDocumentation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"matchTypeParameters\":{\"type\":\"boolean\"},\"matchDeclarationsOrder\":{\"type\":\"boolean\"},\"allowParamOnConstructorProperties\":{\"type\":\"boolean\"}}},\"UndocumentedPublicClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"searchInNestedClass\":{\"type\":\"boolean\"},\"searchInInnerClass\":{\"type\":\"boolean\"},\"searchInInnerObject\":{\"type\":\"boolean\"},\"searchInInnerInterface\":{\"type\":\"boolean\"},\"searchInProtectedClass\":{\"type\":\"boolean\"}}},\"UndocumentedPublicFunction\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"searchProtectedFunction\":{\"type\":\"boolean\"}}},\"UndocumentedPublicProperty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"searchProtectedProperty\":{\"type\":\"boolean\"}}}}},\"complexity\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"CognitiveComplexMethod\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"ComplexCondition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"ComplexInterface\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"},\"includeStaticDeclarations\":{\"type\":\"boolean\"},\"includePrivateDeclarations\":{\"type\":\"boolean\"},\"ignoreOverloaded\":{\"type\":\"boolean\"}}},\"CyclomaticComplexMethod\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"},\"ignoreSingleWhenExpression\":{\"type\":\"boolean\"},\"ignoreSimpleWhenEntries\":{\"type\":\"boolean\"},\"ignoreNestingFunctions\":{\"type\":\"boolean\"},\"nestingFunctions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"LabeledExpression\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoredLabels\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"LargeClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"LongMethod\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"LongParameterList\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"functionThreshold\":{\"type\":\"integer\"},\"constructorThreshold\":{\"type\":\"integer\"},\"ignoreDefaultParameters\":{\"type\":\"boolean\"},\"ignoreDataClasses\":{\"type\":\"boolean\"},\"ignoreAnnotatedParameter\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"MethodOverloading\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"NamedArguments\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"},\"ignoreArgumentsMatchingNames\":{\"type\":\"boolean\"}}},\"NestedBlockDepth\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"NestedScopeFunctions\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"},\"functions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ReplaceSafeCallChainWithRun\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"StringLiteralDuplication\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"},\"ignoreAnnotation\":{\"type\":\"boolean\"},\"excludeStringsWithLessThan5Characters\":{\"type\":\"boolean\"},\"ignoreStringsRegex\":{\"type\":\"string\"}}},\"TooManyFunctions\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"thresholdInFiles\":{\"type\":\"integer\"},\"thresholdInClasses\":{\"type\":\"integer\"},\"thresholdInInterfaces\":{\"type\":\"integer\"},\"thresholdInObjects\":{\"type\":\"integer\"},\"thresholdInEnums\":{\"type\":\"integer\"},\"ignoreDeprecated\":{\"type\":\"boolean\"},\"ignorePrivate\":{\"type\":\"boolean\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}}}},\"coroutines\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"GlobalCoroutineUsage\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"InjectDispatcher\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"dispatcherNames\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"RedundantSuspendModifier\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SleepInsteadOfDelay\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SuspendFunWithCoroutineScopeReceiver\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SuspendFunWithFlowReturnType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}},\"empty-blocks\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"EmptyCatchBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowedExceptionNameRegex\":{\"type\":\"string\"}}},\"EmptyClassBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyDefaultConstructor\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyDoWhileBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyElseBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyFinallyBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyForBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyFunctionBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"EmptyIfBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyInitBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyKtFile\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptySecondaryConstructor\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyTryBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyWhenBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EmptyWhileBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}},\"exceptions\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"ExceptionRaisedInUnexpectedLocation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"methodNames\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"InstanceOfCheckForException\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NotImplementedDeclaration\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ObjectExtendsThrowable\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"PrintStackTrace\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"RethrowCaughtException\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ReturnFromFinally\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreLabeled\":{\"type\":\"boolean\"}}},\"SwallowedException\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoredExceptionTypes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"allowedExceptionNameRegex\":{\"type\":\"string\"}}},\"ThrowingExceptionFromFinally\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ThrowingExceptionInMain\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ThrowingExceptionsWithoutMessageOrCause\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"exceptions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ThrowingNewInstanceOfSameException\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"TooGenericExceptionCaught\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"exceptionNames\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"allowedExceptionNameRegex\":{\"type\":\"string\"}}},\"TooGenericExceptionThrown\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"exceptionNames\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"naming\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"BooleanPropertyNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowedPattern\":{\"type\":\"string\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"ClassNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"classPattern\":{\"type\":\"string\"}}},\"ConstructorParameterNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"parameterPattern\":{\"type\":\"string\"},\"privateParameterPattern\":{\"type\":\"string\"},\"excludeClassPattern\":{\"type\":\"string\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"EnumNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"enumEntryPattern\":{\"type\":\"string\"}}},\"ForbiddenClassName\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"forbiddenName\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"FunctionMaxLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maximumFunctionNameLength\":{\"type\":\"integer\"}}},\"FunctionMinLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"minimumFunctionNameLength\":{\"type\":\"integer\"}}},\"FunctionNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"functionPattern\":{\"type\":\"string\"},\"excludeClassPattern\":{\"type\":\"string\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"FunctionParameterNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"parameterPattern\":{\"type\":\"string\"},\"excludeClassPattern\":{\"type\":\"string\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"InvalidPackageDeclaration\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"rootPackage\":{\"type\":\"string\"},\"requireRootInDeclaration\":{\"type\":\"boolean\"}}},\"LambdaParameterNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"parameterPattern\":{\"type\":\"string\"}}},\"MatchingDeclarationName\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"mustBeFirst\":{\"type\":\"boolean\"}}},\"MemberNameEqualsClassName\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreOverridden\":{\"type\":\"boolean\"}}},\"NoNameShadowing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NonBooleanPropertyPrefixedWithIs\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ObjectPropertyNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"constantPattern\":{\"type\":\"string\"},\"propertyPattern\":{\"type\":\"string\"},\"privatePropertyPattern\":{\"type\":\"string\"}}},\"PackageNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"packagePattern\":{\"type\":\"string\"}}},\"TopLevelPropertyNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"constantPattern\":{\"type\":\"string\"},\"propertyPattern\":{\"type\":\"string\"},\"privatePropertyPattern\":{\"type\":\"string\"}}},\"VariableMaxLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maximumVariableNameLength\":{\"type\":\"integer\"}}},\"VariableMinLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"minimumVariableNameLength\":{\"type\":\"integer\"}}},\"VariableNaming\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"variablePattern\":{\"type\":\"string\"},\"privateVariablePattern\":{\"type\":\"string\"},\"excludeClassPattern\":{\"type\":\"string\"},\"ignoreOverridden\":{\"type\":\"boolean\"}}}}},\"performance\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"ArrayPrimitive\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"CouldBeSequence\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"threshold\":{\"type\":\"integer\"}}},\"ForEachOnRange\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SpreadOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryPartOfBinaryExpression\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryTemporaryInstantiation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}},\"potential-bugs\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"AvoidReferentialEquality\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"forbiddenTypePatterns\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"CastToNullableType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"Deprecation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"DontDowncastCollectionTypes\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"DoubleMutabilityForCollection\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"mutableTypes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ElseCaseInsteadOfExhaustiveWhen\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EqualsAlwaysReturnsTrueOrFalse\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EqualsWithHashCodeExist\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ExitOutsideMain\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ExplicitGarbageCollectionCall\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"HasPlatformType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"IgnoredReturnValue\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"restrictToConfig\":{\"type\":\"boolean\"},\"returnValueAnnotations\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ignoreReturnValueAnnotations\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"returnValueTypes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ignoreFunctionCall\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ImplicitDefaultLocale\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ImplicitUnitReturnType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowExplicitReturnType\":{\"type\":\"boolean\"}}},\"InvalidRange\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"IteratorHasNextCallsNextMethod\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"IteratorNotThrowingNoSuchElementException\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"LateinitUsage\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreOnClassesPattern\":{\"type\":\"string\"}}},\"MapGetWithNotNullAssertionOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"MissingPackageDeclaration\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NullCheckOnMutableProperty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NullableToStringCall\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnconditionalJumpStatementInLoop\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryNotNullCheck\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryNotNullOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessarySafeCall\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnreachableCatchBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnreachableCode\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnsafeCallOnNullableType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnsafeCast\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnusedUnaryOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UselessPostfixExpression\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"WrongEqualsTypeParameter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}},\"style\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"AlsoCouldBeApply\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"CanBeNonNullable\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"CascadingCallWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"includeElvis\":{\"type\":\"boolean\"}}},\"ClassOrdering\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"CollapsibleIfStatements\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"DataClassContainsFunctions\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"conversionFunctionPrefix\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"DataClassShouldBeImmutable\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"DestructuringDeclarationWithTooManyEntries\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maxDestructuringEntries\":{\"type\":\"integer\"}}},\"EqualsNullCall\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"EqualsOnSignatureLine\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ExplicitCollectionElementAccessMethod\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ExplicitItLambdaParameter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ExpressionBodySyntax\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"includeLineWrapping\":{\"type\":\"boolean\"}}},\"ForbiddenComment\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"values\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"allowedPatterns\":{\"type\":\"string\"},\"customMessage\":{\"type\":\"string\"}}},\"ForbiddenImport\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"imports\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"}},\"required\":[\"value\"]}},\"forbiddenPatterns\":{\"type\":\"string\"}}},\"ForbiddenMethodCall\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"methods\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"string\"},\"reason\":{\"type\":\"string\"}},\"required\":[\"value\"]}}}},\"ForbiddenSuppress\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"rules\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ForbiddenVoid\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreOverridden\":{\"type\":\"boolean\"},\"ignoreUsageInGenerics\":{\"type\":\"boolean\"}}},\"FunctionOnlyReturningConstant\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreOverridableFunction\":{\"type\":\"boolean\"},\"ignoreActualFunction\":{\"type\":\"boolean\"},\"excludedFunctions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"LoopWithTooManyJumpStatements\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maxJumpCount\":{\"type\":\"integer\"}}},\"MagicNumber\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ignoreHashCodeFunction\":{\"type\":\"boolean\"},\"ignorePropertyDeclaration\":{\"type\":\"boolean\"},\"ignoreLocalVariableDeclaration\":{\"type\":\"boolean\"},\"ignoreConstantDeclaration\":{\"type\":\"boolean\"},\"ignoreCompanionObjectPropertyDeclaration\":{\"type\":\"boolean\"},\"ignoreAnnotation\":{\"type\":\"boolean\"},\"ignoreNamedArgument\":{\"type\":\"boolean\"},\"ignoreEnums\":{\"type\":\"boolean\"},\"ignoreRanges\":{\"type\":\"boolean\"},\"ignoreExtensionFunctions\":{\"type\":\"boolean\"}}},\"MandatoryBracesIfStatements\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"MandatoryBracesLoops\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"MaxChainedCallsOnSameLine\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maxChainedCalls\":{\"type\":\"integer\"}}},\"MaxLineLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maxLineLength\":{\"type\":\"integer\"},\"excludePackageStatements\":{\"type\":\"boolean\"},\"excludeImportStatements\":{\"type\":\"boolean\"},\"excludeCommentStatements\":{\"type\":\"boolean\"},\"excludeRawStrings\":{\"type\":\"boolean\"}}},\"MayBeConst\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ModifierOrder\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"MultilineLambdaItParameter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"MultilineRawStringIndentation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"indentSize\":{\"type\":\"integer\"}}},\"NestedClassesVisibility\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NewLineAtEndOfFile\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NoTabs\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"NullableBooleanCheck\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ObjectLiteralToLambda\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"OptionalAbstractKeyword\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"OptionalUnit\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"OptionalWhenBraces\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"PreferToOverPairSyntax\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ProtectedMemberInFinalClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"RedundantExplicitType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"RedundantHigherOrderMapUsage\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"RedundantVisibilityModifierRule\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ReturnCount\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"max\":{\"type\":\"integer\"},\"excludedFunctions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"excludeLabeled\":{\"type\":\"boolean\"},\"excludeReturnFromLambda\":{\"type\":\"boolean\"},\"excludeGuardClauses\":{\"type\":\"boolean\"}}},\"SafeCast\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SerialVersionUIDInSerializableClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"SpacingBetweenPackageAndImports\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ThrowsCount\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"max\":{\"type\":\"integer\"},\"excludeGuardClauses\":{\"type\":\"boolean\"}}},\"TrailingWhitespace\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"TrimMultilineRawString\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnderscoresInNumericLiterals\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"acceptableLength\":{\"type\":\"integer\"},\"allowNonStandardGrouping\":{\"type\":\"boolean\"}}},\"UnnecessaryAbstractClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryAnnotationUseSiteTarget\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryApply\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryBackticks\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryFilter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryInheritance\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryInnerClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryLet\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnnecessaryParentheses\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowForUnclearPrecedence\":{\"type\":\"boolean\"}}},\"UntilInsteadOfRangeTo\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnusedImports\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnusedPrivateClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UnusedPrivateMember\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowedNames\":{\"type\":\"string\"}}},\"UseAnyOrNoneInsteadOfFind\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseArrayLiteralsInAnnotations\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseCheckNotNull\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseCheckOrError\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseDataClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"allowVars\":{\"type\":\"boolean\"}}},\"UseEmptyCounterpart\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseIfEmptyOrIfBlank\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseIfInsteadOfWhen\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseIsNullOrEmpty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseOrEmpty\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseRequire\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseRequireNotNull\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UseSumOfInsteadOfFlatMapSize\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UselessCallOnNotNull\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"UtilityClassWithPublicConstructor\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"VarCouldBeVal\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignoreLateinitVar\":{\"type\":\"boolean\"}}},\"WildcardImport\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"excludeImports\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"formatting\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"android\":{\"type\":\"boolean\"},\"autoCorrect\":{\"type\":\"boolean\"},\"AnnotationOnSeparateLine\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"AnnotationSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ArgumentListWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"indentSize\":{\"type\":\"integer\"},\"maxLineLength\":{\"type\":\"integer\"}}},\"BlockCommentInitialStarAlignment\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ChainWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"CommentSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"CommentWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"indentSize\":{\"type\":\"integer\"}}},\"DiscouragedCommentLocation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"EnumEntryNameCase\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"Filename\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"FinalNewline\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"insertFinalNewLine\":{\"type\":\"boolean\"}}},\"FunKeywordSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"FunctionReturnTypeSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"FunctionSignature\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"forceMultilineWhenParameterCountGreaterOrEqualThan\":{\"type\":\"integer\"},\"functionBodyExpressionWrapping\":{\"type\":\"string\"},\"maxLineLength\":{\"type\":\"integer\"},\"indentSize\":{\"type\":\"integer\"}}},\"FunctionStartOfBodySpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"FunctionTypeReferenceSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ImportOrdering\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"layout\":{\"type\":\"string\"}}},\"Indentation\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"indentSize\":{\"type\":\"integer\"}}},\"KdocWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"indentSize\":{\"type\":\"integer\"}}},\"MaximumLineLength\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"maxLineLength\":{\"type\":\"integer\"},\"ignoreBackTickedIdentifier\":{\"type\":\"boolean\"}}},\"ModifierListSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ModifierOrdering\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"MultiLineIfElse\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoBlankLineBeforeRbrace\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoBlankLinesInChainedMethodCalls\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoConsecutiveBlankLines\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoEmptyClassBody\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoEmptyFirstLineInMethodBlock\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoLineBreakAfterElse\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoLineBreakBeforeAssignment\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoMultipleSpaces\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoSemicolons\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoTrailingSpaces\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoUnitReturn\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoUnusedImports\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"NoWildcardImports\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"packagesToUseImportOnDemandProperty\":{\"type\":\"string\"}}},\"NullableTypeSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"PackageName\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ParameterListSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"ParameterListWrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"maxLineLength\":{\"type\":\"integer\"}}},\"SpacingAroundAngleBrackets\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundColon\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundComma\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundCurly\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundDot\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundDoubleColon\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundKeyword\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundOperators\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundParens\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundRangeOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingAroundUnaryOperator\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingBetweenDeclarationsWithAnnotations\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingBetweenDeclarationsWithComments\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"SpacingBetweenFunctionNameAndOpeningParenthesis\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"StringTemplate\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"TrailingCommaOnCallSite\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"useTrailingCommaOnCallSite\":{\"type\":\"boolean\"}}},\"TrailingCommaOnDeclarationSite\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"useTrailingCommaOnDeclarationSite\":{\"type\":\"boolean\"}}},\"TypeArgumentListSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"TypeParameterListSpacing\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"UnnecessaryParenthesesBeforeTrailingLambda\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"}}},\"Wrapping\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"autoCorrect\":{\"type\":\"boolean\"},\"indentSize\":{\"type\":\"integer\"}}}}},\"libraries\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"ForbiddenPublicDataClass\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}],\"properties\":{\"ignorePackages\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"LibraryCodeMustSpecifyReturnType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"LibraryEntitiesShouldNotBePublic\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}},\"ruleauthors\":{\"type\":\"object\",\"properties\":{\"active\":{\"type\":\"boolean\"},\"UseEntityAtName\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]},\"ViolatesTypeResolutionRequirements\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/$defs/ruleProperties\"}]}}}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"detekt-1.22.0\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$defs":{"ruleProperties":{"type":"object","properties":{"active":{"type":"boolean"},"excludes":{"type":"array","items":{"type":"string"}},"ignoreAnnotated":{"type":"array","items":{"type":"string"}},"ignoreFunction":{"type":"array","items":{"type":"string"}}}}},"id":"https://json.schemastore.org/detekt-1.22.0.json","properties":{"build":{"type":"object","properties":{"maxIssues":{"type":"integer"},"excludeCorrectable":{"type":"boolean"},"weights":{"type":"object","additionalProperties":{"type":"integer"}}}},"config":{"type":"object","properties":{"validation":{"type":"boolean"},"warningsAsErrors":{"type":"boolean"},"checkExhaustiveness":{"type":"boolean"},"excludes":{"type":"string"}}},"processors":{"type":"object","properties":{"active":{"type":"boolean"},"exclude":{"type":"array","items":{"type":"string"}}}},"console-reports":{"type":"object","properties":{"active":{"type":"boolean"},"exclude":{"type":"array","items":{"type":"string"}}}},"output-reports":{"type":"object","properties":{"active":{"type":"boolean"},"exclude":{"type":"array","items":{"type":"string"}}}},"comments":{"type":"object","properties":{"active":{"type":"boolean"},"AbsentOrWrongFileLicense":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"licenseTemplateFile":{"type":"string"},"licenseTemplateIsRegex":{"type":"boolean"}}},"CommentOverPrivateFunction":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"CommentOverPrivateProperty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"DeprecatedBlockTag":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EndOfSentenceFormat":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"endOfSentenceFormat":{"type":"string"}}},"KDocReferencesNonPublicProperty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"OutdatedDocumentation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"matchTypeParameters":{"type":"boolean"},"matchDeclarationsOrder":{"type":"boolean"},"allowParamOnConstructorProperties":{"type":"boolean"}}},"UndocumentedPublicClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"searchInNestedClass":{"type":"boolean"},"searchInInnerClass":{"type":"boolean"},"searchInInnerObject":{"type":"boolean"},"searchInInnerInterface":{"type":"boolean"},"searchInProtectedClass":{"type":"boolean"}}},"UndocumentedPublicFunction":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"searchProtectedFunction":{"type":"boolean"}}},"UndocumentedPublicProperty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"searchProtectedProperty":{"type":"boolean"}}}}},"complexity":{"type":"object","properties":{"active":{"type":"boolean"},"CognitiveComplexMethod":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"ComplexCondition":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"ComplexInterface":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"},"includeStaticDeclarations":{"type":"boolean"},"includePrivateDeclarations":{"type":"boolean"},"ignoreOverloaded":{"type":"boolean"}}},"CyclomaticComplexMethod":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"},"ignoreSingleWhenExpression":{"type":"boolean"},"ignoreSimpleWhenEntries":{"type":"boolean"},"ignoreNestingFunctions":{"type":"boolean"},"nestingFunctions":{"type":"array","items":{"type":"string"}}}},"LabeledExpression":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoredLabels":{"type":"array","items":{"type":"string"}}}},"LargeClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"LongMethod":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"LongParameterList":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"functionThreshold":{"type":"integer"},"constructorThreshold":{"type":"integer"},"ignoreDefaultParameters":{"type":"boolean"},"ignoreDataClasses":{"type":"boolean"},"ignoreAnnotatedParameter":{"type":"array","items":{"type":"string"}}}},"MethodOverloading":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"NamedArguments":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"},"ignoreArgumentsMatchingNames":{"type":"boolean"}}},"NestedBlockDepth":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"NestedScopeFunctions":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"},"functions":{"type":"array","items":{"type":"string"}}}},"ReplaceSafeCallChainWithRun":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"StringLiteralDuplication":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"},"ignoreAnnotation":{"type":"boolean"},"excludeStringsWithLessThan5Characters":{"type":"boolean"},"ignoreStringsRegex":{"type":"string"}}},"TooManyFunctions":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"thresholdInFiles":{"type":"integer"},"thresholdInClasses":{"type":"integer"},"thresholdInInterfaces":{"type":"integer"},"thresholdInObjects":{"type":"integer"},"thresholdInEnums":{"type":"integer"},"ignoreDeprecated":{"type":"boolean"},"ignorePrivate":{"type":"boolean"},"ignoreOverridden":{"type":"boolean"}}}}},"coroutines":{"type":"object","properties":{"active":{"type":"boolean"},"GlobalCoroutineUsage":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"InjectDispatcher":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"dispatcherNames":{"type":"array","items":{"type":"string"}}}},"RedundantSuspendModifier":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SleepInsteadOfDelay":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SuspendFunWithCoroutineScopeReceiver":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SuspendFunWithFlowReturnType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}},"empty-blocks":{"type":"object","properties":{"active":{"type":"boolean"},"EmptyCatchBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowedExceptionNameRegex":{"type":"string"}}},"EmptyClassBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyDefaultConstructor":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyDoWhileBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyElseBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyFinallyBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyForBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyFunctionBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreOverridden":{"type":"boolean"}}},"EmptyIfBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyInitBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyKtFile":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptySecondaryConstructor":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyTryBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyWhenBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EmptyWhileBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}},"exceptions":{"type":"object","properties":{"active":{"type":"boolean"},"ExceptionRaisedInUnexpectedLocation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"methodNames":{"type":"array","items":{"type":"string"}}}},"InstanceOfCheckForException":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NotImplementedDeclaration":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ObjectExtendsThrowable":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"PrintStackTrace":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"RethrowCaughtException":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ReturnFromFinally":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreLabeled":{"type":"boolean"}}},"SwallowedException":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoredExceptionTypes":{"type":"array","items":{"type":"string"}},"allowedExceptionNameRegex":{"type":"string"}}},"ThrowingExceptionFromFinally":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ThrowingExceptionInMain":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ThrowingExceptionsWithoutMessageOrCause":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"exceptions":{"type":"array","items":{"type":"string"}}}},"ThrowingNewInstanceOfSameException":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"TooGenericExceptionCaught":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"exceptionNames":{"type":"array","items":{"type":"string"}},"allowedExceptionNameRegex":{"type":"string"}}},"TooGenericExceptionThrown":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"exceptionNames":{"type":"array","items":{"type":"string"}}}}}},"naming":{"type":"object","properties":{"active":{"type":"boolean"},"BooleanPropertyNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowedPattern":{"type":"string"},"ignoreOverridden":{"type":"boolean"}}},"ClassNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"classPattern":{"type":"string"}}},"ConstructorParameterNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"parameterPattern":{"type":"string"},"privateParameterPattern":{"type":"string"},"excludeClassPattern":{"type":"string"},"ignoreOverridden":{"type":"boolean"}}},"EnumNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"enumEntryPattern":{"type":"string"}}},"ForbiddenClassName":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"forbiddenName":{"type":"array","items":{"type":"string"}}}},"FunctionMaxLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maximumFunctionNameLength":{"type":"integer"}}},"FunctionMinLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"minimumFunctionNameLength":{"type":"integer"}}},"FunctionNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"functionPattern":{"type":"string"},"excludeClassPattern":{"type":"string"},"ignoreOverridden":{"type":"boolean"}}},"FunctionParameterNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"parameterPattern":{"type":"string"},"excludeClassPattern":{"type":"string"},"ignoreOverridden":{"type":"boolean"}}},"InvalidPackageDeclaration":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"rootPackage":{"type":"string"},"requireRootInDeclaration":{"type":"boolean"}}},"LambdaParameterNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"parameterPattern":{"type":"string"}}},"MatchingDeclarationName":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"mustBeFirst":{"type":"boolean"}}},"MemberNameEqualsClassName":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreOverridden":{"type":"boolean"}}},"NoNameShadowing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NonBooleanPropertyPrefixedWithIs":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ObjectPropertyNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"constantPattern":{"type":"string"},"propertyPattern":{"type":"string"},"privatePropertyPattern":{"type":"string"}}},"PackageNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"packagePattern":{"type":"string"}}},"TopLevelPropertyNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"constantPattern":{"type":"string"},"propertyPattern":{"type":"string"},"privatePropertyPattern":{"type":"string"}}},"VariableMaxLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maximumVariableNameLength":{"type":"integer"}}},"VariableMinLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"minimumVariableNameLength":{"type":"integer"}}},"VariableNaming":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"variablePattern":{"type":"string"},"privateVariablePattern":{"type":"string"},"excludeClassPattern":{"type":"string"},"ignoreOverridden":{"type":"boolean"}}}}},"performance":{"type":"object","properties":{"active":{"type":"boolean"},"ArrayPrimitive":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"CouldBeSequence":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"threshold":{"type":"integer"}}},"ForEachOnRange":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SpreadOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryPartOfBinaryExpression":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryTemporaryInstantiation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}},"potential-bugs":{"type":"object","properties":{"active":{"type":"boolean"},"AvoidReferentialEquality":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"forbiddenTypePatterns":{"type":"array","items":{"type":"string"}}}},"CastToNullableType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"Deprecation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"DontDowncastCollectionTypes":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"DoubleMutabilityForCollection":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"mutableTypes":{"type":"array","items":{"type":"string"}}}},"ElseCaseInsteadOfExhaustiveWhen":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EqualsAlwaysReturnsTrueOrFalse":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EqualsWithHashCodeExist":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ExitOutsideMain":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ExplicitGarbageCollectionCall":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"HasPlatformType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"IgnoredReturnValue":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"restrictToConfig":{"type":"boolean"},"returnValueAnnotations":{"type":"array","items":{"type":"string"}},"ignoreReturnValueAnnotations":{"type":"array","items":{"type":"string"}},"returnValueTypes":{"type":"array","items":{"type":"string"}},"ignoreFunctionCall":{"type":"array","items":{"type":"string"}}}},"ImplicitDefaultLocale":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ImplicitUnitReturnType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowExplicitReturnType":{"type":"boolean"}}},"InvalidRange":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"IteratorHasNextCallsNextMethod":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"IteratorNotThrowingNoSuchElementException":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"LateinitUsage":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreOnClassesPattern":{"type":"string"}}},"MapGetWithNotNullAssertionOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"MissingPackageDeclaration":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NullCheckOnMutableProperty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NullableToStringCall":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnconditionalJumpStatementInLoop":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryNotNullCheck":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryNotNullOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessarySafeCall":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnreachableCatchBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnreachableCode":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnsafeCallOnNullableType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnsafeCast":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnusedUnaryOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UselessPostfixExpression":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"WrongEqualsTypeParameter":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}},"style":{"type":"object","properties":{"active":{"type":"boolean"},"AlsoCouldBeApply":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"CanBeNonNullable":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"CascadingCallWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"includeElvis":{"type":"boolean"}}},"ClassOrdering":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"CollapsibleIfStatements":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"DataClassContainsFunctions":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"conversionFunctionPrefix":{"type":"array","items":{"type":"string"}}}},"DataClassShouldBeImmutable":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"DestructuringDeclarationWithTooManyEntries":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maxDestructuringEntries":{"type":"integer"}}},"EqualsNullCall":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"EqualsOnSignatureLine":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ExplicitCollectionElementAccessMethod":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ExplicitItLambdaParameter":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ExpressionBodySyntax":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"includeLineWrapping":{"type":"boolean"}}},"ForbiddenComment":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"values":{"type":"array","items":{"type":"string"}},"allowedPatterns":{"type":"string"},"customMessage":{"type":"string"}}},"ForbiddenImport":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"imports":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"reason":{"type":"string"}},"required":["value"]}},"forbiddenPatterns":{"type":"string"}}},"ForbiddenMethodCall":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"methods":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"reason":{"type":"string"}},"required":["value"]}}}},"ForbiddenSuppress":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"rules":{"type":"array","items":{"type":"string"}}}},"ForbiddenVoid":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreOverridden":{"type":"boolean"},"ignoreUsageInGenerics":{"type":"boolean"}}},"FunctionOnlyReturningConstant":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreOverridableFunction":{"type":"boolean"},"ignoreActualFunction":{"type":"boolean"},"excludedFunctions":{"type":"array","items":{"type":"string"}}}},"LoopWithTooManyJumpStatements":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maxJumpCount":{"type":"integer"}}},"MagicNumber":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreNumbers":{"type":"array","items":{"type":"string"}},"ignoreHashCodeFunction":{"type":"boolean"},"ignorePropertyDeclaration":{"type":"boolean"},"ignoreLocalVariableDeclaration":{"type":"boolean"},"ignoreConstantDeclaration":{"type":"boolean"},"ignoreCompanionObjectPropertyDeclaration":{"type":"boolean"},"ignoreAnnotation":{"type":"boolean"},"ignoreNamedArgument":{"type":"boolean"},"ignoreEnums":{"type":"boolean"},"ignoreRanges":{"type":"boolean"},"ignoreExtensionFunctions":{"type":"boolean"}}},"MandatoryBracesIfStatements":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"MandatoryBracesLoops":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"MaxChainedCallsOnSameLine":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maxChainedCalls":{"type":"integer"}}},"MaxLineLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maxLineLength":{"type":"integer"},"excludePackageStatements":{"type":"boolean"},"excludeImportStatements":{"type":"boolean"},"excludeCommentStatements":{"type":"boolean"},"excludeRawStrings":{"type":"boolean"}}},"MayBeConst":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ModifierOrder":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"MultilineLambdaItParameter":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"MultilineRawStringIndentation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"indentSize":{"type":"integer"}}},"NestedClassesVisibility":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NewLineAtEndOfFile":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NoTabs":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"NullableBooleanCheck":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ObjectLiteralToLambda":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"OptionalAbstractKeyword":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"OptionalUnit":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"OptionalWhenBraces":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"PreferToOverPairSyntax":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ProtectedMemberInFinalClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"RedundantExplicitType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"RedundantHigherOrderMapUsage":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"RedundantVisibilityModifierRule":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ReturnCount":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"max":{"type":"integer"},"excludedFunctions":{"type":"array","items":{"type":"string"}},"excludeLabeled":{"type":"boolean"},"excludeReturnFromLambda":{"type":"boolean"},"excludeGuardClauses":{"type":"boolean"}}},"SafeCast":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SerialVersionUIDInSerializableClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"SpacingBetweenPackageAndImports":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ThrowsCount":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"max":{"type":"integer"},"excludeGuardClauses":{"type":"boolean"}}},"TrailingWhitespace":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"TrimMultilineRawString":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnderscoresInNumericLiterals":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"acceptableLength":{"type":"integer"},"allowNonStandardGrouping":{"type":"boolean"}}},"UnnecessaryAbstractClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryAnnotationUseSiteTarget":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryApply":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryBackticks":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryFilter":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryInheritance":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryInnerClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryLet":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnnecessaryParentheses":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowForUnclearPrecedence":{"type":"boolean"}}},"UntilInsteadOfRangeTo":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnusedImports":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnusedPrivateClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UnusedPrivateMember":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowedNames":{"type":"string"}}},"UseAnyOrNoneInsteadOfFind":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseArrayLiteralsInAnnotations":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseCheckNotNull":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseCheckOrError":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseDataClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"allowVars":{"type":"boolean"}}},"UseEmptyCounterpart":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseIfEmptyOrIfBlank":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseIfInsteadOfWhen":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseIsNullOrEmpty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseOrEmpty":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseRequire":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseRequireNotNull":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UseSumOfInsteadOfFlatMapSize":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UselessCallOnNotNull":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"UtilityClassWithPublicConstructor":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"VarCouldBeVal":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignoreLateinitVar":{"type":"boolean"}}},"WildcardImport":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"excludeImports":{"type":"array","items":{"type":"string"}}}}}},"formatting":{"type":"object","properties":{"active":{"type":"boolean"},"android":{"type":"boolean"},"autoCorrect":{"type":"boolean"},"AnnotationOnSeparateLine":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"AnnotationSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ArgumentListWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"indentSize":{"type":"integer"},"maxLineLength":{"type":"integer"}}},"BlockCommentInitialStarAlignment":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ChainWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"CommentSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"CommentWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"indentSize":{"type":"integer"}}},"DiscouragedCommentLocation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"EnumEntryNameCase":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"Filename":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"FinalNewline":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"insertFinalNewLine":{"type":"boolean"}}},"FunKeywordSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"FunctionReturnTypeSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"FunctionSignature":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"forceMultilineWhenParameterCountGreaterOrEqualThan":{"type":"integer"},"functionBodyExpressionWrapping":{"type":"string"},"maxLineLength":{"type":"integer"},"indentSize":{"type":"integer"}}},"FunctionStartOfBodySpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"FunctionTypeReferenceSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ImportOrdering":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"layout":{"type":"string"}}},"Indentation":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"indentSize":{"type":"integer"}}},"KdocWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"indentSize":{"type":"integer"}}},"MaximumLineLength":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"maxLineLength":{"type":"integer"},"ignoreBackTickedIdentifier":{"type":"boolean"}}},"ModifierListSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ModifierOrdering":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"MultiLineIfElse":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoBlankLineBeforeRbrace":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoBlankLinesInChainedMethodCalls":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoConsecutiveBlankLines":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoEmptyClassBody":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoEmptyFirstLineInMethodBlock":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoLineBreakAfterElse":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoLineBreakBeforeAssignment":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoMultipleSpaces":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoSemicolons":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoTrailingSpaces":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoUnitReturn":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoUnusedImports":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"NoWildcardImports":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"packagesToUseImportOnDemandProperty":{"type":"string"}}},"NullableTypeSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"PackageName":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ParameterListSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"ParameterListWrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"maxLineLength":{"type":"integer"}}},"SpacingAroundAngleBrackets":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundColon":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundComma":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundCurly":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundDot":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundDoubleColon":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundKeyword":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundOperators":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundParens":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundRangeOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingAroundUnaryOperator":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingBetweenDeclarationsWithAnnotations":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingBetweenDeclarationsWithComments":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"SpacingBetweenFunctionNameAndOpeningParenthesis":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"StringTemplate":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"TrailingCommaOnCallSite":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"useTrailingCommaOnCallSite":{"type":"boolean"}}},"TrailingCommaOnDeclarationSite":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"useTrailingCommaOnDeclarationSite":{"type":"boolean"}}},"TypeArgumentListSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"TypeParameterListSpacing":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"UnnecessaryParenthesesBeforeTrailingLambda":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"}}},"Wrapping":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"autoCorrect":{"type":"boolean"},"indentSize":{"type":"integer"}}}}},"libraries":{"type":"object","properties":{"active":{"type":"boolean"},"ForbiddenPublicDataClass":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}],"properties":{"ignorePackages":{"type":"array","items":{"type":"string"}}}},"LibraryCodeMustSpecifyReturnType":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"LibraryEntitiesShouldNotBePublic":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}},"ruleauthors":{"type":"object","properties":{"active":{"type":"boolean"},"UseEntityAtName":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]},"ViolatesTypeResolutionRequirements":{"type":"object","allOf":[{"$ref":"#/$defs/ruleProperties"}]}}}},"type":"object"}
|
Provide a JSON object that satisfies the schema "detekt-1.22.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
detekt-1.22.0
|
schema-store
|
schema_store_255
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"allOf\":[{\"$ref\":\"./devContainer.base.schema.json\"},{\"$ref\":\"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.codespaces.schema.json\"},{\"$ref\":\"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.vscode.schema.json\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"devContainer.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"allOf":[{"$ref":"./devContainer.base.schema.json"},{"$ref":"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.codespaces.schema.json"},{"$ref":"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.vscode.schema.json"}]}
|
Provide a JSON object that satisfies the schema "devContainer.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
devContainer.schema
|
schema-store
|
schema_store_256
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"$id\":\"https://github.com/jetify-com/devbox/plugins\",\"title\":\"Devbox Plugin Schema\",\"description\":\"Defines fields and values for public devbox plugins\",\"type\":\"object\",\"properties\":{\"$schema\":{\"description\":\"The schema version of this plugin file.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the plugin.\",\"type\":\"string\"},\"version\":{\"description\":\"The version of the plugin.\",\"type\":\"string\"},\"description\":{\"description\":\"A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs `devbox info`\",\"type\":\"string\"},\"packages\":{\"description\":\"Collection of packages to install\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"description\":\"Name and version of each package in name@version format.\",\"type\":\"string\"}},{\"type\":\"object\",\"description\":\"Name of each package in {\\\"name\\\": {\\\"version\\\": \\\"1.2.3\\\"}} format.\",\"patternProperties\":{\".*\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"Version number of the specified package in {\\\"version\\\": \\\"1.2.3\\\"} format.\",\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Version of the package\"},\"platforms\":{\"type\":\"array\",\"description\":\"Names of platforms to install the package on. This package will be skipped for any platforms not on this list\",\"items\":{\"enum\":[\"i686-linux\",\"aarch64-linux\",\"aarch64-darwin\",\"x86_64-darwin\",\"x86_64-linux\",\"armv7l-linux\"]}},\"excluded_platforms\":{\"type\":\"array\",\"description\":\"Names of platforms to exclude the package on\",\"items\":{\"enum\":[\"i686-linux\",\"aarch64-linux\",\"aarch64-darwin\",\"x86_64-darwin\",\"x86_64-linux\",\"armv7l-linux\"]}},\"glibc_patch\":{\"type\":\"boolean\",\"description\":\"Whether to patch glibc to the latest available version for this package\"}}},{\"type\":\"string\",\"description\":\"Version of the package to install.\"}]}}}]},\"env\":{\"type\":\"object\",\"description\":\"List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json\",\"patternProperties\":{\".*\":{\"type\":\"string\",\"description\":\"Value of the environment variable.\"}}},\"create_files\":{\"type\":\"object\",\"description\":\"List of files to create in the user's project directory when the plugin is activated. The key points to the file path where the file will be created. The value points to the default file that should be copied to that location\",\"patternProperties\":{\".*\":{\"type\":\"string\",\"description\":\"Contents of the file.\"}}},\"shell\":{\"type\":\"object\",\"description\":\"Shell specific options and hooks for the plugin.\",\"items\":{\"init_hook\":{\"type\":[\"array\",\"string\"],\"description\":\"Shell command to run right before initializing the user's shell, running a script, or starting a service\"},\"scripts\":{\"description\":\"List of command/script definitions to run with `devbox run <script_name>`.\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"description\":\"Alias name for the script.\",\"type\":[\"array\",\"string\"],\"items\":{\"type\":\"string\",\"description\":\"The script's shell commands.\"}}}}}},\"include\":{\"description\":\"List of additional plugins to activate within your devbox shell\",\"type\":\"array\",\"items\":{\"description\":\"Name of the plugin to activate.\",\"type\":\"string\"}}},\"required\":[\"name\",\"version\",\"description\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Devbox Plugin Schema\". Here are the required top‑level fields: name, version, description. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft-04/schema#","$id":"https://github.com/jetify-com/devbox/plugins","title":"Devbox Plugin Schema","description":"Defines fields and values for public devbox plugins","type":"object","properties":{"$schema":{"description":"The schema version of this plugin file.","type":"string"},"name":{"description":"The name of the plugin.","type":"string"},"version":{"description":"The version of the plugin.","type":"string"},"description":{"description":"A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs `devbox info`","type":"string"},"packages":{"description":"Collection of packages to install","oneOf":[{"type":"array","items":{"description":"Name and version of each package in name@version format.","type":"string"}},{"type":"object","description":"Name of each package in {\"name\": {\"version\": \"1.2.3\"}} format.","patternProperties":{".*":{"oneOf":[{"type":"object","description":"Version number of the specified package in {\"version\": \"1.2.3\"} format.","properties":{"version":{"type":"string","description":"Version of the package"},"platforms":{"type":"array","description":"Names of platforms to install the package on. This package will be skipped for any platforms not on this list","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"excluded_platforms":{"type":"array","description":"Names of platforms to exclude the package on","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"glibc_patch":{"type":"boolean","description":"Whether to patch glibc to the latest available version for this package"}}},{"type":"string","description":"Version of the package to install."}]}}}]},"env":{"type":"object","description":"List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json","patternProperties":{".*":{"type":"string","description":"Value of the environment variable."}}},"create_files":{"type":"object","description":"List of files to create in the user's project directory when the plugin is activated. The key points to the file path where the file will be created. The value points to the default file that should be copied to that location","patternProperties":{".*":{"type":"string","description":"Contents of the file."}}},"shell":{"type":"object","description":"Shell specific options and hooks for the plugin.","items":{"init_hook":{"type":["array","string"],"description":"Shell command to run right before initializing the user's shell, running a script, or starting a service"},"scripts":{"description":"List of command/script definitions to run with `devbox run <script_name>`.","type":"object","patternProperties":{".*":{"description":"Alias name for the script.","type":["array","string"],"items":{"type":"string","description":"The script's shell commands."}}}}}},"include":{"description":"List of additional plugins to activate within your devbox shell","type":"array","items":{"description":"Name of the plugin to activate.","type":"string"}}},"required":["name","version","description"]}
|
Provide a JSON object that satisfies the schema "Devbox Plugin Schema". Here are the required top‑level fields: name, version, description. Return only the valid JSON object.
|
Devbox Plugin Schema
|
schema-store
|
schema_store_257
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$id\":\"https://github.com/jetify-com/devbox\",\"title\":\"Devbox json definition\",\"description\":\"Defines fields and acceptable values of devbox.json\",\"type\":\"object\",\"properties\":{\"$schema\":{\"description\":\"The schema version of this devbox.json file.\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the Devbox development environment.\",\"type\":\"string\"},\"description\":{\"description\":\"A description of the Devbox development environment.\",\"type\":\"string\"},\"packages\":{\"description\":\"Collection of packages to install\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"description\":\"Name and version of each package in name@version format.\",\"type\":\"string\"}},{\"type\":\"object\",\"description\":\"Name of each package in {\\\"name\\\": {\\\"version\\\": \\\"1.2.3\\\"}} format.\",\"patternProperties\":{\".*\":{\"oneOf\":[{\"type\":\"object\",\"description\":\"Version number of the specified package in {\\\"version\\\": \\\"1.2.3\\\"} format.\",\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Version of the package\"},\"platforms\":{\"type\":\"array\",\"description\":\"Names of platforms to install the package on. This package will be skipped for any platforms not on this list\",\"items\":{\"enum\":[\"i686-linux\",\"aarch64-linux\",\"aarch64-darwin\",\"x86_64-darwin\",\"x86_64-linux\",\"armv7l-linux\"]}},\"excluded_platforms\":{\"type\":\"array\",\"description\":\"Names of platforms to exclude the package on\",\"items\":{\"enum\":[\"i686-linux\",\"aarch64-linux\",\"aarch64-darwin\",\"x86_64-darwin\",\"x86_64-linux\",\"armv7l-linux\"]}},\"glibc_patch\":{\"type\":\"boolean\",\"description\":\"Whether to patch glibc to the latest available version for this package\"}}},{\"type\":\"string\",\"description\":\"Version of the package to install.\"}]}}}]},\"env\":{\"description\":\"List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"type\":\"string\",\"description\":\"Value of the environment variable.\"}}},\"shell\":{\"description\":\"Definitions of scripts and actions to take when in devbox shell.\",\"type\":\"object\",\"properties\":{\"init_hook\":{\"type\":[\"array\",\"string\"],\"items\":{\"description\":\"List of shell commands/scripts to run right after devbox shell starts.\",\"type\":\"string\"}},\"scripts\":{\"description\":\"List of command/script definitions to run with `devbox run <script_name>`.\",\"type\":\"object\",\"patternProperties\":{\".*\":{\"description\":\"Alias name for the script.\",\"type\":[\"array\",\"string\"],\"items\":{\"type\":\"string\",\"description\":\"The script's shell commands.\"}}}}},\"additionalProperties\":false},\"include\":{\"description\":\"List of additional plugins to activate within your devbox shell\",\"type\":\"array\",\"items\":{\"description\":\"Name of the plugin to activate.\",\"type\":\"string\"}},\"env_from\":{\"type\":\"string\"},\"nixpkgs\":{\"type\":\"object\",\"properties\":{\"commit\":{\"type\":\"string\",\"description\":\"The commit hash of the nixpkgs repository to use\"}}}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Devbox json definition\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$id":"https://github.com/jetify-com/devbox","title":"Devbox json definition","description":"Defines fields and acceptable values of devbox.json","type":"object","properties":{"$schema":{"description":"The schema version of this devbox.json file.","type":"string"},"name":{"description":"The name of the Devbox development environment.","type":"string"},"description":{"description":"A description of the Devbox development environment.","type":"string"},"packages":{"description":"Collection of packages to install","oneOf":[{"type":"array","items":{"description":"Name and version of each package in name@version format.","type":"string"}},{"type":"object","description":"Name of each package in {\"name\": {\"version\": \"1.2.3\"}} format.","patternProperties":{".*":{"oneOf":[{"type":"object","description":"Version number of the specified package in {\"version\": \"1.2.3\"} format.","properties":{"version":{"type":"string","description":"Version of the package"},"platforms":{"type":"array","description":"Names of platforms to install the package on. This package will be skipped for any platforms not on this list","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"excluded_platforms":{"type":"array","description":"Names of platforms to exclude the package on","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"glibc_patch":{"type":"boolean","description":"Whether to patch glibc to the latest available version for this package"}}},{"type":"string","description":"Version of the package to install."}]}}}]},"env":{"description":"List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.","type":"object","patternProperties":{".*":{"type":"string","description":"Value of the environment variable."}}},"shell":{"description":"Definitions of scripts and actions to take when in devbox shell.","type":"object","properties":{"init_hook":{"type":["array","string"],"items":{"description":"List of shell commands/scripts to run right after devbox shell starts.","type":"string"}},"scripts":{"description":"List of command/script definitions to run with `devbox run <script_name>`.","type":"object","patternProperties":{".*":{"description":"Alias name for the script.","type":["array","string"],"items":{"type":"string","description":"The script's shell commands."}}}}},"additionalProperties":false},"include":{"description":"List of additional plugins to activate within your devbox shell","type":"array","items":{"description":"Name of the plugin to activate.","type":"string"}},"env_from":{"type":"string"},"nixpkgs":{"type":"object","properties":{"commit":{"type":"string","description":"The commit hash of the nixpkgs repository to use"}}}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "Devbox json definition". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Devbox json definition
|
schema-store
|
schema_store_258
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"description\":\"Devfile describes the structure of a cloud-native devworkspace and development environment.\",\"type\":\"object\",\"title\":\"Devfile schema - Version 2.2.0\",\"required\":[\"schemaVersion\"],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"commands\":{\"description\":\"Predefined, ready-to-use, devworkspace-related commands\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"id\"],\"oneOf\":[{\"required\":[\"exec\"]},{\"required\":[\"apply\"]},{\"required\":[\"composite\"]}],\"properties\":{\"apply\":{\"description\":\"Command that consists in applying a given component definition, typically bound to a devworkspace event.\\n\\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\\n\\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.\",\"type\":\"object\",\"required\":[\"component\"],\"properties\":{\"component\":{\"description\":\"Describes component that will be applied\",\"type\":\"string\"},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"required\":[\"kind\"],\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"}},\"additionalProperties\":false},\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"composite\":{\"description\":\"Composite command that allows executing several sub-commands either sequentially or concurrently\",\"type\":\"object\",\"properties\":{\"commands\":{\"description\":\"The commands that comprise this composite command\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"required\":[\"kind\"],\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"},\"parallel\":{\"description\":\"Indicates if the sub-commands should be executed concurrently\",\"type\":\"boolean\"}},\"additionalProperties\":false},\"exec\":{\"description\":\"CLI Command executed in an existing component container\",\"type\":\"object\",\"required\":[\"commandLine\",\"component\"],\"properties\":{\"commandLine\":{\"description\":\"The actual command-line string\\n\\nSpecial variables that can be used:\\n\\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\\n\\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.\",\"type\":\"string\"},\"component\":{\"description\":\"Describes component to which given action relates\",\"type\":\"string\"},\"env\":{\"description\":\"Optional list of environment variables that have to be set before running the command\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"value\"],\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"required\":[\"kind\"],\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"hotReloadCapable\":{\"description\":\"Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"},\"workingDir\":{\"description\":\"Working directory where the command should be executed\\n\\nSpecial variables that can be used:\\n\\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\\n\\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.\",\"type\":\"string\"}},\"additionalProperties\":false},\"id\":{\"description\":\"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"}},\"additionalProperties\":false}},\"components\":{\"description\":\"List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"container\"]},{\"required\":[\"kubernetes\"]},{\"required\":[\"openshift\"]},{\"required\":[\"volume\"]},{\"required\":[\"image\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"container\":{\"description\":\"Allows adding and configuring devworkspace-related containers\",\"type\":\"object\",\"required\":[\"image\"],\"properties\":{\"annotation\":{\"description\":\"Annotations that should be added to specific resources for this container\",\"type\":\"object\",\"properties\":{\"deployment\":{\"description\":\"Annotations to be added to deployment\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"service\":{\"description\":\"Annotations to be added to service\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"args\":{\"description\":\"The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\\n\\nDefaults to an empty array, meaning use whatever is defined in the image.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"command\":{\"description\":\"The command to run in the dockerimage component instead of the default one provided in the image.\\n\\nDefaults to an empty array, meaning use whatever is defined in the image.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"cpuLimit\":{\"type\":\"string\"},\"cpuRequest\":{\"type\":\"string\"},\"dedicatedPod\":{\"description\":\"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"targetPort\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"default\":\"public\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"default\":\"http\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"env\":{\"description\":\"Environment variables used in this container.\\n\\nThe following variables are reserved and cannot be overridden via env:\\n\\n - `$PROJECTS_ROOT`\\n\\n - `$PROJECT_SOURCE`\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"value\"],\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"image\":{\"type\":\"string\"},\"memoryLimit\":{\"type\":\"string\"},\"memoryRequest\":{\"type\":\"string\"},\"mountSources\":{\"description\":\"Toggles whether or not the project source code should be mounted in the component.\\n\\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.\",\"type\":\"boolean\"},\"sourceMapping\":{\"description\":\"Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.\",\"type\":\"string\",\"default\":\"/projects\"},\"volumeMounts\":{\"description\":\"List of volumes mounts that should be mounted is this container.\",\"type\":\"array\",\"items\":{\"description\":\"Volume that should be mounted to a component container\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.\",\"type\":\"string\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},\"image\":{\"description\":\"Allows specifying the definition of an image for outer loop builds\",\"type\":\"object\",\"required\":[\"imageName\"],\"oneOf\":[{\"required\":[\"dockerfile\"]}],\"properties\":{\"autoBuild\":{\"description\":\"Defines if the image should be built during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"dockerfile\":{\"description\":\"Allows specifying dockerfile type build\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"devfileRegistry\"]},{\"required\":[\"git\"]}],\"properties\":{\"args\":{\"description\":\"The arguments to supply to the dockerfile build.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"buildContext\":{\"description\":\"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container\",\"type\":\"string\"},\"devfileRegistry\":{\"description\":\"Dockerfile's Devfile Registry source\",\"type\":\"object\",\"required\":[\"id\"],\"properties\":{\"id\":{\"description\":\"Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.\",\"type\":\"string\"},\"registryUrl\":{\"description\":\"Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.\",\"type\":\"string\"}},\"additionalProperties\":false},\"git\":{\"description\":\"Dockerfile's Git source\",\"type\":\"object\",\"required\":[\"remotes\"],\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"fileLocation\":{\"description\":\"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.\",\"type\":\"string\"},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"rootRequired\":{\"description\":\"Specify if a privileged builder pod is required.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"uri\":{\"description\":\"URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.\",\"type\":\"string\"}},\"additionalProperties\":false},\"imageName\":{\"description\":\"Name of the image for the resulting outerloop build\",\"type\":\"string\"}},\"additionalProperties\":false},\"kubernetes\":{\"description\":\"Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"inlined\"]}],\"properties\":{\"deployByDefault\":{\"description\":\"Defines if the component should be deployed during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"targetPort\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"default\":\"public\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"default\":\"http\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"inlined\":{\"description\":\"Inlined manifest\",\"type\":\"string\"},\"uri\":{\"description\":\"Location in a file fetched from a uri.\",\"type\":\"string\"}},\"additionalProperties\":false},\"name\":{\"description\":\"Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"openshift\":{\"description\":\"Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"inlined\"]}],\"properties\":{\"deployByDefault\":{\"description\":\"Defines if the component should be deployed during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"targetPort\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"default\":\"public\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"default\":\"http\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"inlined\":{\"description\":\"Inlined manifest\",\"type\":\"string\"},\"uri\":{\"description\":\"Location in a file fetched from a uri.\",\"type\":\"string\"}},\"additionalProperties\":false},\"volume\":{\"description\":\"Allows specifying the definition of a volume shared by several other components\",\"type\":\"object\",\"properties\":{\"ephemeral\":{\"description\":\"Ephemeral volumes are not stored persistently across restarts. Defaults to false\",\"type\":\"boolean\"},\"size\":{\"description\":\"Size of the volume\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"events\":{\"description\":\"Bindings of commands to events. Each command is referred-to by its name.\",\"type\":\"object\",\"properties\":{\"postStart\":{\"description\":\"IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"postStop\":{\"description\":\"IDs of commands that should be executed after stopping the devworkspace.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"preStart\":{\"description\":\"IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"preStop\":{\"description\":\"IDs of commands that should be executed before stopping the devworkspace.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"metadata\":{\"description\":\"Optional metadata\",\"type\":\"object\",\"properties\":{\"architectures\":{\"description\":\"Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"description\":\"Architecture describes the architecture type\",\"type\":\"string\",\"enum\":[\"amd64\",\"arm64\",\"ppc64le\",\"s390x\"]}},\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.\",\"type\":\"object\",\"additionalProperties\":true},\"description\":{\"description\":\"Optional devfile description\",\"type\":\"string\"},\"displayName\":{\"description\":\"Optional devfile display name\",\"type\":\"string\"},\"globalMemoryLimit\":{\"description\":\"Optional devfile global memory limit\",\"type\":\"string\"},\"icon\":{\"description\":\"Optional devfile icon, can be a URI or a relative path in the project\",\"type\":\"string\"},\"language\":{\"description\":\"Optional devfile language\",\"type\":\"string\"},\"name\":{\"description\":\"Optional devfile name\",\"type\":\"string\"},\"projectType\":{\"description\":\"Optional devfile project type\",\"type\":\"string\"},\"provider\":{\"description\":\"Optional devfile provider information\",\"type\":\"string\"},\"supportUrl\":{\"description\":\"Optional link to a page that provides support information\",\"type\":\"string\"},\"tags\":{\"description\":\"Optional devfile tags\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"version\":{\"description\":\"Optional semver-compatible version\",\"type\":\"string\",\"pattern\":\"^([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)(\\\\-[0-9a-z-]+(\\\\.[0-9a-z-]+)*)?(\\\\+[0-9A-Za-z-]+(\\\\.[0-9A-Za-z-]+)*)?$\"},\"website\":{\"description\":\"Optional devfile website\",\"type\":\"string\"}},\"additionalProperties\":true},\"parent\":{\"description\":\"Parent devworkspace template\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"id\"]},{\"required\":[\"kubernetes\"]}],\"properties\":{\"attributes\":{\"description\":\"Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"object\",\"additionalProperties\":true},\"commands\":{\"description\":\"Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"id\"],\"oneOf\":[{\"required\":[\"exec\"]},{\"required\":[\"apply\"]},{\"required\":[\"composite\"]}],\"properties\":{\"apply\":{\"description\":\"Command that consists in applying a given component definition, typically bound to a devworkspace event.\\n\\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\\n\\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.\",\"type\":\"object\",\"properties\":{\"component\":{\"description\":\"Describes component that will be applied\",\"type\":\"string\"},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"}},\"additionalProperties\":false},\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"composite\":{\"description\":\"Composite command that allows executing several sub-commands either sequentially or concurrently\",\"type\":\"object\",\"properties\":{\"commands\":{\"description\":\"The commands that comprise this composite command\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"},\"parallel\":{\"description\":\"Indicates if the sub-commands should be executed concurrently\",\"type\":\"boolean\"}},\"additionalProperties\":false},\"exec\":{\"description\":\"CLI Command executed in an existing component container\",\"type\":\"object\",\"properties\":{\"commandLine\":{\"description\":\"The actual command-line string\\n\\nSpecial variables that can be used:\\n\\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\\n\\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.\",\"type\":\"string\"},\"component\":{\"description\":\"Describes component to which given action relates\",\"type\":\"string\"},\"env\":{\"description\":\"Optional list of environment variables that have to be set before running the command\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"group\":{\"description\":\"Defines the group this command is part of\",\"type\":\"object\",\"properties\":{\"isDefault\":{\"description\":\"Identifies the default command for a given group kind\",\"type\":\"boolean\"},\"kind\":{\"description\":\"Kind of group the command is part of\",\"type\":\"string\",\"enum\":[\"build\",\"run\",\"test\",\"debug\",\"deploy\"]}},\"additionalProperties\":false},\"hotReloadCapable\":{\"description\":\"Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"label\":{\"description\":\"Optional label that provides a label for this command to be used in Editor UI menus for example\",\"type\":\"string\"},\"workingDir\":{\"description\":\"Working directory where the command should be executed\\n\\nSpecial variables that can be used:\\n\\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\\n\\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.\",\"type\":\"string\"}},\"additionalProperties\":false},\"id\":{\"description\":\"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"}},\"additionalProperties\":false}},\"components\":{\"description\":\"Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"container\"]},{\"required\":[\"kubernetes\"]},{\"required\":[\"openshift\"]},{\"required\":[\"volume\"]},{\"required\":[\"image\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"container\":{\"description\":\"Allows adding and configuring devworkspace-related containers\",\"type\":\"object\",\"properties\":{\"annotation\":{\"description\":\"Annotations that should be added to specific resources for this container\",\"type\":\"object\",\"properties\":{\"deployment\":{\"description\":\"Annotations to be added to deployment\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"service\":{\"description\":\"Annotations to be added to service\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"args\":{\"description\":\"The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\\n\\nDefaults to an empty array, meaning use whatever is defined in the image.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"command\":{\"description\":\"The command to run in the dockerimage component instead of the default one provided in the image.\\n\\nDefaults to an empty array, meaning use whatever is defined in the image.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"cpuLimit\":{\"type\":\"string\"},\"cpuRequest\":{\"type\":\"string\"},\"dedicatedPod\":{\"description\":\"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"env\":{\"description\":\"Environment variables used in this container.\\n\\nThe following variables are reserved and cannot be overridden via env:\\n\\n - `$PROJECTS_ROOT`\\n\\n - `$PROJECT_SOURCE`\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"image\":{\"type\":\"string\"},\"memoryLimit\":{\"type\":\"string\"},\"memoryRequest\":{\"type\":\"string\"},\"mountSources\":{\"description\":\"Toggles whether or not the project source code should be mounted in the component.\\n\\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.\",\"type\":\"boolean\"},\"sourceMapping\":{\"description\":\"Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.\",\"type\":\"string\"},\"volumeMounts\":{\"description\":\"List of volumes mounts that should be mounted is this container.\",\"type\":\"array\",\"items\":{\"description\":\"Volume that should be mounted to a component container\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.\",\"type\":\"string\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},\"image\":{\"description\":\"Allows specifying the definition of an image for outer loop builds\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"dockerfile\"]},{\"required\":[\"autoBuild\"]}],\"properties\":{\"autoBuild\":{\"description\":\"Defines if the image should be built during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"dockerfile\":{\"description\":\"Allows specifying dockerfile type build\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"devfileRegistry\"]},{\"required\":[\"git\"]}],\"properties\":{\"args\":{\"description\":\"The arguments to supply to the dockerfile build.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"buildContext\":{\"description\":\"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container\",\"type\":\"string\"},\"devfileRegistry\":{\"description\":\"Dockerfile's Devfile Registry source\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.\",\"type\":\"string\"},\"registryUrl\":{\"description\":\"Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.\",\"type\":\"string\"}},\"additionalProperties\":false},\"git\":{\"description\":\"Dockerfile's Git source\",\"type\":\"object\",\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"fileLocation\":{\"description\":\"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.\",\"type\":\"string\"},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"rootRequired\":{\"description\":\"Specify if a privileged builder pod is required.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"uri\":{\"description\":\"URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.\",\"type\":\"string\"}},\"additionalProperties\":false},\"imageName\":{\"description\":\"Name of the image for the resulting outerloop build\",\"type\":\"string\"}},\"additionalProperties\":false},\"kubernetes\":{\"description\":\"Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"inlined\"]}],\"properties\":{\"deployByDefault\":{\"description\":\"Defines if the component should be deployed during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"inlined\":{\"description\":\"Inlined manifest\",\"type\":\"string\"},\"uri\":{\"description\":\"Location in a file fetched from a uri.\",\"type\":\"string\"}},\"additionalProperties\":false},\"name\":{\"description\":\"Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"openshift\":{\"description\":\"Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"uri\"]},{\"required\":[\"inlined\"]}],\"properties\":{\"deployByDefault\":{\"description\":\"Defines if the component should be deployed during startup.\\n\\nDefault value is `false`\",\"type\":\"boolean\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"annotation\":{\"description\":\"Annotations to be added to Kubernetes Ingress or Openshift Route\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"attributes\":{\"description\":\"Map of implementation-dependant string-based free-form attributes.\\n\\nExamples of Che-specific attributes:\\n- cookiesAuthEnabled: \\\"true\\\" / \\\"false\\\",\\n- type: \\\"terminal\\\" / \\\"ide\\\" / \\\"ide-dev\\\",\",\"type\":\"object\",\"additionalProperties\":true},\"exposure\":{\"description\":\"Describes how the endpoint should be exposed on the network.\\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\\n\\nDefault value is `public`\",\"type\":\"string\",\"enum\":[\"public\",\"internal\",\"none\"]},\"name\":{\"type\":\"string\",\"maxLength\":15,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"path\":{\"description\":\"Path of the endpoint URL\",\"type\":\"string\"},\"protocol\":{\"description\":\"Describes the application and transport protocols of the traffic that will go through this endpoint.\\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\\n\\nDefault value is `http`\",\"type\":\"string\",\"enum\":[\"http\",\"https\",\"ws\",\"wss\",\"tcp\",\"udp\"]},\"secure\":{\"description\":\"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.\",\"type\":\"boolean\"},\"targetPort\":{\"description\":\"Port number to be used within the container component. The same port cannot be used by two different container components.\",\"type\":\"integer\"}},\"additionalProperties\":false}},\"inlined\":{\"description\":\"Inlined manifest\",\"type\":\"string\"},\"uri\":{\"description\":\"Location in a file fetched from a uri.\",\"type\":\"string\"}},\"additionalProperties\":false},\"volume\":{\"description\":\"Allows specifying the definition of a volume shared by several other components\",\"type\":\"object\",\"properties\":{\"ephemeral\":{\"description\":\"Ephemeral volumes are not stored persistently across restarts. Defaults to false\",\"type\":\"boolean\"},\"size\":{\"description\":\"Size of the volume\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"id\":{\"description\":\"Id in a registry that contains a Devfile yaml file\",\"type\":\"string\"},\"kubernetes\":{\"description\":\"Reference to a Kubernetes CRD of type DevWorkspaceTemplate\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}},\"additionalProperties\":false},\"projects\":{\"description\":\"Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"git\"]},{\"required\":[\"zip\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"clonePath\":{\"description\":\"Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.\",\"type\":\"string\"},\"git\":{\"description\":\"Project's Git source\",\"type\":\"object\",\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"name\":{\"description\":\"Project name\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"zip\":{\"description\":\"Project's Zip source\",\"type\":\"object\",\"properties\":{\"location\":{\"description\":\"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"registryUrl\":{\"description\":\"Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.\",\"type\":\"string\"},\"starterProjects\":{\"description\":\"Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"git\"]},{\"required\":[\"zip\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"description\":{\"description\":\"Description of a starter project\",\"type\":\"string\"},\"git\":{\"description\":\"Project's Git source\",\"type\":\"object\",\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"name\":{\"description\":\"Project name\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"subDir\":{\"description\":\"Sub-directory from a starter project to be used as root for starter project.\",\"type\":\"string\"},\"zip\":{\"description\":\"Project's Zip source\",\"type\":\"object\",\"properties\":{\"location\":{\"description\":\"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"uri\":{\"description\":\"URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.\",\"type\":\"string\"},\"variables\":{\"description\":\"Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"version\":{\"description\":\"Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.\",\"type\":\"string\",\"pattern\":\"^(latest)|(([1-9])\\\\.([0-9]+)\\\\.([0-9]+)(\\\\-[0-9a-z-]+(\\\\.[0-9a-z-]+)*)?(\\\\+[0-9A-Za-z-]+(\\\\.[0-9A-Za-z-]+)*)?)$\"}},\"additionalProperties\":false},\"projects\":{\"description\":\"Projects worked on in the devworkspace, containing names and sources locations\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"git\"]},{\"required\":[\"zip\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"clonePath\":{\"description\":\"Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.\",\"type\":\"string\"},\"git\":{\"description\":\"Project's Git source\",\"type\":\"object\",\"required\":[\"remotes\"],\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"name\":{\"description\":\"Project name\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"zip\":{\"description\":\"Project's Zip source\",\"type\":\"object\",\"properties\":{\"location\":{\"description\":\"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"schemaVersion\":{\"description\":\"Devfile schema version\",\"type\":\"string\",\"pattern\":\"^([2-9])\\\\.([0-9]+)\\\\.([0-9]+)(\\\\-[0-9a-z-]+(\\\\.[0-9a-z-]+)*)?(\\\\+[0-9A-Za-z-]+(\\\\.[0-9A-Za-z-]+)*)?$\"},\"starterProjects\":{\"description\":\"StarterProjects is a project that can be used as a starting point when bootstrapping new projects\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"oneOf\":[{\"required\":[\"git\"]},{\"required\":[\"zip\"]}],\"properties\":{\"attributes\":{\"description\":\"Map of implementation-dependant free-form YAML attributes.\",\"type\":\"object\",\"additionalProperties\":true},\"description\":{\"description\":\"Description of a starter project\",\"type\":\"string\"},\"git\":{\"description\":\"Project's Git source\",\"type\":\"object\",\"required\":[\"remotes\"],\"properties\":{\"checkoutFrom\":{\"description\":\"Defines from what the project should be checked out. Required if there are more than one remote configured\",\"type\":\"object\",\"properties\":{\"remote\":{\"description\":\"The remote name should be used as init. Required if there are more than one remote configured\",\"type\":\"string\"},\"revision\":{\"description\":\"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.\",\"type\":\"string\"}},\"additionalProperties\":false},\"remotes\":{\"description\":\"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"name\":{\"description\":\"Project name\",\"type\":\"string\",\"maxLength\":63,\"pattern\":\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\"},\"subDir\":{\"description\":\"Sub-directory from a starter project to be used as root for starter project.\",\"type\":\"string\"},\"zip\":{\"description\":\"Project's Zip source\",\"type\":\"object\",\"properties\":{\"location\":{\"description\":\"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH\",\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"variables\":{\"description\":\"Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for\\n\\n - schemaVersion, metadata, parent source\\n\\n - element identifiers, e.g. command id, component name, endpoint name, project name\\n\\n - references to identifiers, e.g. in events, a command's component, container's volume mount name\\n\\n - string enums, e.g. command group kind, endpoint exposure\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Devfile schema - Version 2.2.0\". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"description":"Devfile describes the structure of a cloud-native devworkspace and development environment.","type":"object","title":"Devfile schema - Version 2.2.0","required":["schemaVersion"],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"commands":{"description":"Predefined, ready-to-use, devworkspace-related commands","type":"array","items":{"type":"object","required":["id"],"oneOf":[{"required":["exec"]},{"required":["apply"]},{"required":["composite"]}],"properties":{"apply":{"description":"Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.","type":"object","required":["component"],"properties":{"component":{"description":"Describes component that will be applied","type":"string"},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"}},"additionalProperties":false},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"composite":{"description":"Composite command that allows executing several sub-commands either sequentially or concurrently","type":"object","properties":{"commands":{"description":"The commands that comprise this composite command","type":"array","items":{"type":"string"}},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"parallel":{"description":"Indicates if the sub-commands should be executed concurrently","type":"boolean"}},"additionalProperties":false},"exec":{"description":"CLI Command executed in an existing component container","type":"object","required":["commandLine","component"],"properties":{"commandLine":{"description":"The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.","type":"string"},"component":{"description":"Describes component to which given action relates","type":"string"},"env":{"description":"Optional list of environment variables that have to be set before running the command","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"hotReloadCapable":{"description":"Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`","type":"boolean"},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"workingDir":{"description":"Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.","type":"string"}},"additionalProperties":false},"id":{"description":"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}},"additionalProperties":false}},"components":{"description":"List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["container"]},{"required":["kubernetes"]},{"required":["openshift"]},{"required":["volume"]},{"required":["image"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"container":{"description":"Allows adding and configuring devworkspace-related containers","type":"object","required":["image"],"properties":{"annotation":{"description":"Annotations that should be added to specific resources for this container","type":"object","properties":{"deployment":{"description":"Annotations to be added to deployment","type":"object","additionalProperties":{"type":"string"}},"service":{"description":"Annotations to be added to service","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"args":{"description":"The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"command":{"description":"The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"cpuLimit":{"type":"string"},"cpuRequest":{"type":"string"},"dedicatedPod":{"description":"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"env":{"description":"Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"image":{"type":"string"},"memoryLimit":{"type":"string"},"memoryRequest":{"type":"string"},"mountSources":{"description":"Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.","type":"boolean"},"sourceMapping":{"description":"Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.","type":"string","default":"/projects"},"volumeMounts":{"description":"List of volumes mounts that should be mounted is this container.","type":"array","items":{"description":"Volume that should be mounted to a component container","type":"object","required":["name"],"properties":{"name":{"description":"The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"image":{"description":"Allows specifying the definition of an image for outer loop builds","type":"object","required":["imageName"],"oneOf":[{"required":["dockerfile"]}],"properties":{"autoBuild":{"description":"Defines if the image should be built during startup.\n\nDefault value is `false`","type":"boolean"},"dockerfile":{"description":"Allows specifying dockerfile type build","type":"object","oneOf":[{"required":["uri"]},{"required":["devfileRegistry"]},{"required":["git"]}],"properties":{"args":{"description":"The arguments to supply to the dockerfile build.","type":"array","items":{"type":"string"}},"buildContext":{"description":"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container","type":"string"},"devfileRegistry":{"description":"Dockerfile's Devfile Registry source","type":"object","required":["id"],"properties":{"id":{"description":"Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.","type":"string"},"registryUrl":{"description":"Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.","type":"string"}},"additionalProperties":false},"git":{"description":"Dockerfile's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"fileLocation":{"description":"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.","type":"string"},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"rootRequired":{"description":"Specify if a privileged builder pod is required.\n\nDefault value is `false`","type":"boolean"},"uri":{"description":"URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.","type":"string"}},"additionalProperties":false},"imageName":{"description":"Name of the image for the resulting outerloop build","type":"string"}},"additionalProperties":false},"kubernetes":{"description":"Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.","type":"object","oneOf":[{"required":["uri"]},{"required":["inlined"]}],"properties":{"deployByDefault":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"name":{"description":"Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"openshift":{"description":"Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.","type":"object","oneOf":[{"required":["uri"]},{"required":["inlined"]}],"properties":{"deployByDefault":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"volume":{"description":"Allows specifying the definition of a volume shared by several other components","type":"object","properties":{"ephemeral":{"description":"Ephemeral volumes are not stored persistently across restarts. Defaults to false","type":"boolean"},"size":{"description":"Size of the volume","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"events":{"description":"Bindings of commands to events. Each command is referred-to by its name.","type":"object","properties":{"postStart":{"description":"IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.","type":"array","items":{"type":"string"}},"postStop":{"description":"IDs of commands that should be executed after stopping the devworkspace.","type":"array","items":{"type":"string"}},"preStart":{"description":"IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.","type":"array","items":{"type":"string"}},"preStop":{"description":"IDs of commands that should be executed before stopping the devworkspace.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"metadata":{"description":"Optional metadata","type":"object","properties":{"architectures":{"description":"Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture","type":"array","uniqueItems":true,"items":{"description":"Architecture describes the architecture type","type":"string","enum":["amd64","arm64","ppc64le","s390x"]}},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.","type":"object","additionalProperties":true},"description":{"description":"Optional devfile description","type":"string"},"displayName":{"description":"Optional devfile display name","type":"string"},"globalMemoryLimit":{"description":"Optional devfile global memory limit","type":"string"},"icon":{"description":"Optional devfile icon, can be a URI or a relative path in the project","type":"string"},"language":{"description":"Optional devfile language","type":"string"},"name":{"description":"Optional devfile name","type":"string"},"projectType":{"description":"Optional devfile project type","type":"string"},"provider":{"description":"Optional devfile provider information","type":"string"},"supportUrl":{"description":"Optional link to a page that provides support information","type":"string"},"tags":{"description":"Optional devfile tags","type":"array","items":{"type":"string"}},"version":{"description":"Optional semver-compatible version","type":"string","pattern":"^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},"website":{"description":"Optional devfile website","type":"string"}},"additionalProperties":true},"parent":{"description":"Parent devworkspace template","type":"object","oneOf":[{"required":["uri"]},{"required":["id"]},{"required":["kubernetes"]}],"properties":{"attributes":{"description":"Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"object","additionalProperties":true},"commands":{"description":"Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["id"],"oneOf":[{"required":["exec"]},{"required":["apply"]},{"required":["composite"]}],"properties":{"apply":{"description":"Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.","type":"object","properties":{"component":{"description":"Describes component that will be applied","type":"string"},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"}},"additionalProperties":false},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"composite":{"description":"Composite command that allows executing several sub-commands either sequentially or concurrently","type":"object","properties":{"commands":{"description":"The commands that comprise this composite command","type":"array","items":{"type":"string"}},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"parallel":{"description":"Indicates if the sub-commands should be executed concurrently","type":"boolean"}},"additionalProperties":false},"exec":{"description":"CLI Command executed in an existing component container","type":"object","properties":{"commandLine":{"description":"The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.","type":"string"},"component":{"description":"Describes component to which given action relates","type":"string"},"env":{"description":"Optional list of environment variables that have to be set before running the command","type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"hotReloadCapable":{"description":"Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`","type":"boolean"},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"workingDir":{"description":"Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.","type":"string"}},"additionalProperties":false},"id":{"description":"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}},"additionalProperties":false}},"components":{"description":"Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["container"]},{"required":["kubernetes"]},{"required":["openshift"]},{"required":["volume"]},{"required":["image"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"container":{"description":"Allows adding and configuring devworkspace-related containers","type":"object","properties":{"annotation":{"description":"Annotations that should be added to specific resources for this container","type":"object","properties":{"deployment":{"description":"Annotations to be added to deployment","type":"object","additionalProperties":{"type":"string"}},"service":{"description":"Annotations to be added to service","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"args":{"description":"The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"command":{"description":"The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"cpuLimit":{"type":"string"},"cpuRequest":{"type":"string"},"dedicatedPod":{"description":"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"env":{"description":"Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`","type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"image":{"type":"string"},"memoryLimit":{"type":"string"},"memoryRequest":{"type":"string"},"mountSources":{"description":"Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.","type":"boolean"},"sourceMapping":{"description":"Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.","type":"string"},"volumeMounts":{"description":"List of volumes mounts that should be mounted is this container.","type":"array","items":{"description":"Volume that should be mounted to a component container","type":"object","required":["name"],"properties":{"name":{"description":"The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"image":{"description":"Allows specifying the definition of an image for outer loop builds","type":"object","oneOf":[{"required":["dockerfile"]},{"required":["autoBuild"]}],"properties":{"autoBuild":{"description":"Defines if the image should be built during startup.\n\nDefault value is `false`","type":"boolean"},"dockerfile":{"description":"Allows specifying dockerfile type build","type":"object","oneOf":[{"required":["uri"]},{"required":["devfileRegistry"]},{"required":["git"]}],"properties":{"args":{"description":"The arguments to supply to the dockerfile build.","type":"array","items":{"type":"string"}},"buildContext":{"description":"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container","type":"string"},"devfileRegistry":{"description":"Dockerfile's Devfile Registry source","type":"object","properties":{"id":{"description":"Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.","type":"string"},"registryUrl":{"description":"Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.","type":"string"}},"additionalProperties":false},"git":{"description":"Dockerfile's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"fileLocation":{"description":"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.","type":"string"},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"rootRequired":{"description":"Specify if a privileged builder pod is required.\n\nDefault value is `false`","type":"boolean"},"uri":{"description":"URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.","type":"string"}},"additionalProperties":false},"imageName":{"description":"Name of the image for the resulting outerloop build","type":"string"}},"additionalProperties":false},"kubernetes":{"description":"Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.","type":"object","oneOf":[{"required":["uri"]},{"required":["inlined"]}],"properties":{"deployByDefault":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"name":{"description":"Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"openshift":{"description":"Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.","type":"object","oneOf":[{"required":["uri"]},{"required":["inlined"]}],"properties":{"deployByDefault":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"volume":{"description":"Allows specifying the definition of a volume shared by several other components","type":"object","properties":{"ephemeral":{"description":"Ephemeral volumes are not stored persistently across restarts. Defaults to false","type":"boolean"},"size":{"description":"Size of the volume","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"id":{"description":"Id in a registry that contains a Devfile yaml file","type":"string"},"kubernetes":{"description":"Reference to a Kubernetes CRD of type DevWorkspaceTemplate","type":"object","required":["name"],"properties":{"name":{"type":"string"},"namespace":{"type":"string"}},"additionalProperties":false},"projects":{"description":"Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"clonePath":{"description":"Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.","type":"string"},"git":{"description":"Project's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"registryUrl":{"description":"Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.","type":"string"},"starterProjects":{"description":"Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"description":{"description":"Description of a starter project","type":"string"},"git":{"description":"Project's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"subDir":{"description":"Sub-directory from a starter project to be used as root for starter project.","type":"string"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"uri":{"description":"URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.","type":"string"},"variables":{"description":"Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"object","additionalProperties":{"type":"string"}},"version":{"description":"Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.","type":"string","pattern":"^(latest)|(([1-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?)$"}},"additionalProperties":false},"projects":{"description":"Projects worked on in the devworkspace, containing names and sources locations","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"clonePath":{"description":"Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.","type":"string"},"git":{"description":"Project's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"schemaVersion":{"description":"Devfile schema version","type":"string","pattern":"^([2-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},"starterProjects":{"description":"StarterProjects is a project that can be used as a starting point when bootstrapping new projects","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"description":{"description":"Description of a starter project","type":"string"},"git":{"description":"Project's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.","type":"string"}},"additionalProperties":false},"remotes":{"description":"The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"subDir":{"description":"Sub-directory from a starter project to be used as root for starter project.","type":"string"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"variables":{"description":"Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for\n\n - schemaVersion, metadata, parent source\n\n - element identifiers, e.g. command id, component name, endpoint name, project name\n\n - references to identifiers, e.g. in events, a command's component, container's volume mount name\n\n - string enums, e.g. command group kind, endpoint exposure","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "Devfile schema - Version 2.2.0". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object.
|
Devfile schema - Version 2.2.0
|
schema-store
|
schema_store_259
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"runObject\":{\"type\":\"object\",\"required\":[\"tool\"],\"properties\":{\"tool\":{\"title\":\"The tool name\",\"description\":\"The name of the tool to run.\",\"type\":\"string\",\"enum\":[\"apt-get-install\",\"azurecli-login\",\"choco-install\",\"choco-upgrade\",\"dotnet-restore\",\"dotnet-toolinstall\",\"enable-iis\",\"msi-install\",\"npm-install\",\"nuget-restore\",\"require-azureartifactscredentialprovider\",\"require-azurecli\",\"require-choco\",\"require-dotnetcoresdk\",\"require-dotnetframeworksdk\",\"require-gitsubmodule\",\"require-mssql\",\"require-nodejs\",\"require-npm\",\"require-nuget\",\"require-psmodule\",\"require-vcpkg\",\"require-vscomponent\",\"require-winget\",\"set-env\",\"vcpkg-install\",\"windowsfeature-disable\",\"windowsfeature-enable\",\"windowsfeature-list\",\"winget-install\",\"wsl-install\"]},\"input\":{\"title\":\"The tool input\",\"description\":\"The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"additionalOptions\":{\"title\":\"Additional options\",\"description\":\"Additional Options to be appended to the tool's command line.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"comments\":{\"title\":\"Comments\",\"description\":\"Comments for this tool item. For documentation only; ignored by the tool.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"additionalProperties\":false}},\"id\":\"https://json.schemastore.org/devinit.schema-6.0.json\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"run\":{\"title\":\"The list of tools to run\",\"description\":\"'devinit.exe init' runs this list of tools sequentially. See also 'devinit.exe run'.\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/runObject\"}],\"anyOf\":[{\"$ref\":\"#/definitions/runObject\"}]}},\"comments\":{\"title\":\"Comments\",\"description\":\"Comments for this file. For documentation only; ignored by the tool.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"required\":[\"run\"],\"title\":\"Codespaces DevInit Configuration\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Codespaces DevInit Configuration\". Here are the required top‑level fields: run. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"runObject":{"type":"object","required":["tool"],"properties":{"tool":{"title":"The tool name","description":"The name of the tool to run.","type":"string","enum":["apt-get-install","azurecli-login","choco-install","choco-upgrade","dotnet-restore","dotnet-toolinstall","enable-iis","msi-install","npm-install","nuget-restore","require-azureartifactscredentialprovider","require-azurecli","require-choco","require-dotnetcoresdk","require-dotnetframeworksdk","require-gitsubmodule","require-mssql","require-nodejs","require-npm","require-nuget","require-psmodule","require-vcpkg","require-vscomponent","require-winget","set-env","vcpkg-install","windowsfeature-disable","windowsfeature-enable","windowsfeature-list","winget-install","wsl-install"]},"input":{"title":"The tool input","description":"The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.","anyOf":[{"type":"string"},{"type":"null"}]},"additionalOptions":{"title":"Additional options","description":"Additional Options to be appended to the tool's command line.","anyOf":[{"type":"string"},{"type":"null"}]},"comments":{"title":"Comments","description":"Comments for this tool item. For documentation only; ignored by the tool.","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}},"id":"https://json.schemastore.org/devinit.schema-6.0.json","properties":{"$schema":{"type":"string"},"run":{"title":"The list of tools to run","description":"'devinit.exe init' runs this list of tools sequentially. See also 'devinit.exe run'.","items":{"allOf":[{"$ref":"#/definitions/runObject"}],"anyOf":[{"$ref":"#/definitions/runObject"}]}},"comments":{"title":"Comments","description":"Comments for this file. For documentation only; ignored by the tool.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["run"],"title":"Codespaces DevInit Configuration","type":"object"}
|
Provide a JSON object that satisfies the schema "Codespaces DevInit Configuration". Here are the required top‑level fields: run. Return only the valid JSON object.
|
Codespaces DevInit Configuration
|
schema-store
|
schema_store_260
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://github.com/loft-sh/devspace/pkg/devspace/config/versions/latest/config\",\"$defs\":{\"Attach\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enabled can be used to enable attaching to a container\"},\"disableReplace\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableReplace prevents DevSpace from actually replacing the pod with modifications so that\\nthe pod starts up correctly.\"},\"disableTTY\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableTTY is used to tell DevSpace to not use a TTY connection for attaching\"}},\"type\":\"object\"},\"BandwidthLimits\":{\"properties\":{\"download\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Download is the download limit in kilo bytes per second\"},\"upload\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Upload is the upload limit in kilo bytes per second\"}},\"type\":\"object\",\"description\":\"BandwidthLimits defines the struct for specifying the sync bandwidth limits\"},\"BuildKitConfig\":{\"properties\":{\"inCluster\":{\"oneOf\":[{\"$ref\":\"#/$defs/BuildKitInClusterConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"InCluster if specified, DevSpace will use BuildKit to build the image within the cluster\"},\"preferMinikube\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"PreferMinikube if false, will not try to use the minikube docker daemon to build the image\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are additional arguments to call docker buildx build with\"},\"command\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Command to override the base command to create a builder and build images. Defaults to [\\\"docker\\\", \\\"buildx\\\"]\"}},\"type\":\"object\",\"description\":\"BuildKitConfig tells the DevSpace CLI to\"},\"BuildKitInClusterConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the builder to use. If omitted, DevSpace will try to create\\nor reuse a builder in the form devspace-$NAMESPACE\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace where to create the builder deployment in. Defaults to the current\\nactive namespace.\"},\"rootless\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Rootless if enabled will create a rootless builder deployment.\"},\"image\":{\"type\":\"string\",\"description\":\"Image is the docker image to use for the BuildKit deployment\"},\"nodeSelector\":{\"type\":\"string\",\"description\":\"NodeSelector is the node selector to use for the BuildKit deployment\"},\"noCreate\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.\\nIf this is true, DevSpace will fail if the specified builder cannot be found.\"},\"noRecreate\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration\\nin the devspace.yaml differs from the actual builder configuration. If this is\\ntrue, DevSpace will not try to do that.\"},\"noLoad\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"NoLoad if enabled, DevSpace will not try to load the built image into the local docker\\ndaemon if skip push is defined\"},\"createArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"CreateArgs are additional args to create the builder with.\"}},\"type\":\"object\",\"description\":\"BuildKitInClusterConfig holds the buildkit builder config\"},\"ChartConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the helm chart to deploy. Can also be a local path or an oci url\",\"group\":\"repo\",\"group_name\":\"Source: Helm Repository\"},\"version\":{\"type\":\"string\",\"description\":\"Version is the version of the helm chart to deploy\",\"group\":\"repo\"},\"repo\":{\"type\":\"string\",\"description\":\"RepoURL is the url of the repo to deploy the chart from\",\"group\":\"repo\"},\"username\":{\"type\":\"string\",\"description\":\"Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth\",\"group\":\"repo\"},\"password\":{\"type\":\"string\",\"description\":\"Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth\",\"group\":\"repo\"},\"path\":{\"type\":\"string\",\"description\":\"Path is the local path where DevSpace can find the artifact.\\nThis option is mutually exclusive with the git option.\",\"group\":\"path\",\"group_name\":\"Source: Local Filesystem\"},\"git\":{\"type\":\"string\",\"description\":\"Git is the remote repository to download the artifact from. You can either use\\nhttps projects or ssh projects here, but need to make sure git can pull the project.\\nThis option is mutually exclusive with the path option.\",\"group\":\"git\",\"group_name\":\"Source: Git Repository\"},\"subPath\":{\"type\":\"string\",\"description\":\"SubPath is a path within the git repository where the artifact lies in\",\"group\":\"git\"},\"branch\":{\"type\":\"string\",\"description\":\"Branch is the git branch to pull\",\"group\":\"git\"},\"tag\":{\"type\":\"string\",\"description\":\"Tag is the tag to pull\",\"group\":\"git\"},\"revision\":{\"type\":\"string\",\"description\":\"Revision is the git revision to pull\",\"group\":\"git\"},\"cloneArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"CloneArgs are additional arguments that should be supplied to the git CLI\",\"group\":\"git\"},\"disableShallow\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableShallow can be used to turn off shallow clones as these are the default used\\nby devspace\",\"group\":\"git\"},\"disablePull\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisablePull will disable pulling every time DevSpace is reevaluating this source\",\"group\":\"git\"}},\"type\":\"object\",\"description\":\"ChartConfig defines the helm chart options\"},\"CommandConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of a command that is used via `devspace run NAME`\"},\"section\":{\"type\":\"string\",\"description\":\"Section can be used to group similar commands together in `devspace list commands`\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the command that should be executed. For example: 'echo 123'\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are optional and if defined, command is not executed within a shell\\nand rather directly.\"},\"appendArgs\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"AppendArgs will append arguments passed to the DevSpace command automatically to\\nthe specified command.\"},\"description\":{\"type\":\"string\",\"description\":\"Description describes what the command is doing and can be seen in `devspace list commands`\"},\"internal\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Internal commands are not show in list and are usable through run_command\"},\"after\":{\"type\":\"string\",\"description\":\"After is executed after the command was run. It is executed also when\\nthe command was interrupted which will set the env variable COMMAND_INTERRUPT\\nto true as well as when the command errored which will set the error string to\\nCOMMAND_ERROR.\"}},\"type\":\"object\",\"required\":[\"command\"],\"description\":\"CommandConfig defines the command specification\"},\"CustomConfig\":{\"properties\":{\"command\":{\"type\":\"string\",\"description\":\"Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}\\nto reference the image and tag that should get built.\"},\"onChange\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"OnChange will determine when the command should be rerun\"}},\"type\":\"object\",\"description\":\"CustomConfig tells the DevSpace CLI to build with a custom build script\"},\"DependencyConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is used internally\"},\"disabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Disabled excludes this dependency from variable resolution and pipeline runs\"},\"path\":{\"type\":\"string\",\"description\":\"Path is the local path where DevSpace can find the artifact.\\nThis option is mutually exclusive with the git option.\",\"group\":\"path\",\"group_name\":\"Source: Local Filesystem\"},\"git\":{\"type\":\"string\",\"description\":\"Git is the remote repository to download the artifact from. You can either use\\nhttps projects or ssh projects here, but need to make sure git can pull the project.\\nThis option is mutually exclusive with the path option.\",\"group\":\"git\",\"group_name\":\"Source: Git Repository\"},\"subPath\":{\"type\":\"string\",\"description\":\"SubPath is a path within the git repository where the artifact lies in\",\"group\":\"git\"},\"branch\":{\"type\":\"string\",\"description\":\"Branch is the git branch to pull\",\"group\":\"git\"},\"tag\":{\"type\":\"string\",\"description\":\"Tag is the tag to pull\",\"group\":\"git\"},\"revision\":{\"type\":\"string\",\"description\":\"Revision is the git revision to pull\",\"group\":\"git\"},\"cloneArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"CloneArgs are additional arguments that should be supplied to the git CLI\",\"group\":\"git\"},\"disableShallow\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableShallow can be used to turn off shallow clones as these are the default used\\nby devspace\",\"group\":\"git\"},\"disablePull\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisablePull will disable pulling every time DevSpace is reevaluating this source\",\"group\":\"git\"},\"pipeline\":{\"type\":\"string\",\"description\":\"Pipeline is the pipeline to deploy by default. Defaults to 'deploy'\",\"default\":\"deploy\",\"group\":\"execution\",\"group_name\":\"Execution\"},\"vars\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Vars are variables that should be passed to the dependency\",\"group\":\"execution\"},\"overwriteVars\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"OverwriteVars specifies if DevSpace should pass the parent variables to the dependency\",\"group\":\"execution\"},\"ignoreDependencies\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"IgnoreDependencies defines if dependencies of the dependency should be excluded\",\"group\":\"execution\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace specifies the namespace this dependency should be deployed to\",\"group\":\"execution\"}},\"type\":\"object\",\"description\":\"DependencyConfig defines the devspace dependency\"},\"DeploymentConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the deployment\"},\"helm\":{\"oneOf\":[{\"$ref\":\"#/$defs/HelmConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Helm tells DevSpace to deploy this deployment via helm\"},\"kubectl\":{\"oneOf\":[{\"$ref\":\"#/$defs/KubectlConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize\"},\"updateImageTags\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the\\nimages section with their most recent built tag.\",\"default\":true},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace where to deploy this deployment\"}},\"type\":\"object\",\"description\":\"DeploymentConfig defines the configuration how the devspace should be deployed\"},\"DevContainer\":{\"properties\":{\"container\":{\"type\":\"string\",\"description\":\"Container is the container name these services should get started.\",\"group\":\"selector\",\"group_name\":\"Selector\"},\"arch\":{\"type\":\"string\",\"description\":\"Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.\",\"group\":\"selector\"},\"devImage\":{\"type\":\"string\",\"description\":\"DevImage is the image to use for this container and will replace the existing image\\nif necessary.\",\"group\":\"modifications\",\"group_name\":\"Modifications\"},\"command\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Command can be used to override the entrypoint of the container\",\"group\":\"modifications\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args can be used to override the args of the container\",\"group\":\"modifications\"},\"workingDir\":{\"type\":\"string\",\"description\":\"WorkingDir can be used to override the working dir of the container\",\"group\":\"modifications\"},\"env\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/EnvVar\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Env can be used to add environment variables to the container. DevSpace will\\nnot replace existing environment variables if an environment variable is defined here.\",\"group\":\"modifications\"},\"resources\":{\"oneOf\":[{\"$ref\":\"#/$defs/PodResources\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Resources can be used to override the resource definitions of the container\",\"group\":\"modifications\"},\"reversePorts\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PortMapping\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ReversePorts are port mappings to make local ports available inside the container\",\"group\":\"ports\",\"group_name\":\"Port Forwarding\"},\"sync\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/SyncConfig\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Sync allows you to sync certain local paths with paths inside the container\",\"group\":\"sync\",\"group_name\":\"File Sync\"},\"persistPaths\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PersistentPath\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"PersistPaths allows you to persist certain paths within this container with a persistent volume claim\"},\"terminal\":{\"oneOf\":[{\"$ref\":\"#/$defs/Terminal\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Terminal allows you to tell DevSpace to open a terminal with screen support to this container\",\"group\":\"workflows\",\"group_name\":\"Foreground Dev Workflows\"},\"logs\":{\"oneOf\":[{\"$ref\":\"#/$defs/Logs\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Logs allows you to tell DevSpace to stream logs from this container to the console\",\"group\":\"workflows\"},\"attach\":{\"oneOf\":[{\"$ref\":\"#/$defs/Attach\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Attach allows you to tell DevSpace to attach to this container\",\"group\":\"workflows\"},\"ssh\":{\"oneOf\":[{\"$ref\":\"#/$defs/SSH\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"SSH allows you to create an SSH tunnel to this container\"},\"proxyCommands\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/ProxyCommand\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ProxyCommands allow you to proxy certain local commands to the container\",\"group\":\"workflows_background\"},\"restartHelper\":{\"oneOf\":[{\"$ref\":\"#/$defs/RestartHelper\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\\nthe container and restarting it and is injected via an annotation in the replaced pod.\",\"group\":\"workflows_background\"}},\"type\":\"object\",\"description\":\"DevContainer holds options for dev services that should get started within a certain container of the selected pod\"},\"DevPod\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the dev configuration\"},\"imageSelector\":{\"type\":\"string\",\"description\":\"ImageSelector to select a pod\",\"group\":\"selector\"},\"labelSelector\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"LabelSelector to select a pod\",\"group\":\"selector\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace where to select the pod\",\"group\":\"selector\"},\"container\":{\"type\":\"string\",\"description\":\"Container is the container name these services should get started.\",\"group\":\"selector\",\"group_name\":\"Selector\"},\"arch\":{\"type\":\"string\",\"description\":\"Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.\",\"group\":\"selector\"},\"devImage\":{\"type\":\"string\",\"description\":\"DevImage is the image to use for this container and will replace the existing image\\nif necessary.\",\"group\":\"modifications\",\"group_name\":\"Modifications\"},\"command\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Command can be used to override the entrypoint of the container\",\"group\":\"modifications\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args can be used to override the args of the container\",\"group\":\"modifications\"},\"workingDir\":{\"type\":\"string\",\"description\":\"WorkingDir can be used to override the working dir of the container\",\"group\":\"modifications\"},\"env\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/EnvVar\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Env can be used to add environment variables to the container. DevSpace will\\nnot replace existing environment variables if an environment variable is defined here.\",\"group\":\"modifications\"},\"resources\":{\"oneOf\":[{\"$ref\":\"#/$defs/PodResources\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Resources can be used to override the resource definitions of the container\",\"group\":\"modifications\"},\"reversePorts\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PortMapping\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ReversePorts are port mappings to make local ports available inside the container\",\"group\":\"ports\",\"group_name\":\"Port Forwarding\"},\"sync\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/SyncConfig\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Sync allows you to sync certain local paths with paths inside the container\",\"group\":\"sync\",\"group_name\":\"File Sync\"},\"persistPaths\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PersistentPath\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"PersistPaths allows you to persist certain paths within this container with a persistent volume claim\"},\"terminal\":{\"oneOf\":[{\"$ref\":\"#/$defs/Terminal\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Terminal allows you to tell DevSpace to open a terminal with screen support to this container\",\"group\":\"workflows\",\"group_name\":\"Foreground Dev Workflows\"},\"logs\":{\"oneOf\":[{\"$ref\":\"#/$defs/Logs\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Logs allows you to tell DevSpace to stream logs from this container to the console\",\"group\":\"workflows\"},\"attach\":{\"oneOf\":[{\"$ref\":\"#/$defs/Attach\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Attach allows you to tell DevSpace to attach to this container\",\"group\":\"workflows\"},\"ssh\":{\"oneOf\":[{\"$ref\":\"#/$defs/SSH\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"SSH allows you to create an SSH tunnel to this container\"},\"proxyCommands\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/ProxyCommand\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ProxyCommands allow you to proxy certain local commands to the container\",\"group\":\"workflows_background\"},\"restartHelper\":{\"oneOf\":[{\"$ref\":\"#/$defs/RestartHelper\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\\nthe container and restarting it and is injected via an annotation in the replaced pod.\",\"group\":\"workflows_background\"},\"ports\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PortMapping\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Ports defines port mappings from the remote pod that should be forwarded to your local\\ncomputer\",\"group\":\"ports\"},\"persistenceOptions\":{\"oneOf\":[{\"$ref\":\"#/$defs/PersistenceOptions\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"PersistenceOptions are additional options for persisting paths within this pod\",\"group\":\"modifications\"},\"patches\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PatchConfig\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Patches are additional changes to the pod spec that should be applied\",\"group\":\"modifications\"},\"open\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/OpenConfig\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Open defines urls that should be opened as soon as they are reachable\",\"group\":\"workflows_background\",\"group_name\":\"Background Dev Workflows\"},\"containers\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/DevContainer\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"group\":\"selector\"}},\"type\":\"object\",\"description\":\"DevPod holds configurations for selecting a pod and starting dev services for that pod\"},\"DockerConfig\":{\"properties\":{\"disableFallback\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableFallback allows you to turn off kaniko building if docker isn't installed\"},\"preferMinikube\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"PreferMinikube allows you to turn off using the minikube docker daemon if the minikube\\ncontext is used.\"},\"useCli\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"UseCLI specifies if DevSpace should use the docker cli for building\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are additional arguments to pass to the docker cli\"}},\"type\":\"object\",\"description\":\"DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost\"},\"EnvVar\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the environment variable\"},\"value\":{\"type\":\"string\",\"description\":\"Value of the environment variable\"}},\"type\":\"object\",\"required\":[\"name\",\"value\"]},\"HelmConfig\":{\"properties\":{\"releaseName\":{\"type\":\"string\",\"description\":\"ReleaseName of the helm configuration\"},\"chart\":{\"oneOf\":[{\"$ref\":\"#/$defs/ChartConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Chart holds the chart configuration and where DevSpace can find the chart\"},\"values\":{\"oneOf\":[{\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Values are additional values that should get passed to deploying this chart\"},\"valuesFiles\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ValuesFiles are additional files that hold values for deploying this chart\"},\"displayOutput\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisplayOutput allows you to display the helm output to the console\"},\"upgradeArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"UpgradeArgs are additional arguments to pass to `helm upgrade`\"},\"templateArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"TemplateArgs are additional arguments to pass to `helm template`\"},\"disableDependencyUpdate\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableDependencyUpdate disables helm dependencies update, default to false\"}},\"type\":\"object\",\"description\":\"HelmConfig defines the specific helm options used during deployment\"},\"HookConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the hook\"},\"disabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Disabled can be used to disable the hook\"},\"events\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Events are the events when the hook should be executed\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the base command that is either executed locally or in a remote container.\\nCommand is mutually exclusive with other hook actions. In the case this is defined\\ntogether with where.container, DevSpace will until the target container is running and\\nonly then execute the command. If the container does not start in time, DevSpace will fail.\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are additional arguments passed together with the command to execute.\"},\"os\":{\"type\":\"string\",\"description\":\"If an operating system is defined, the hook will only be executed for the given os.\\nAll supported golang OS types are supported and multiple can be combined with ','.\"},\"upload\":{\"oneOf\":[{\"$ref\":\"#/$defs/HookSyncConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"If Upload is specified, DevSpace will upload certain local files or folders into a\\nremote container.\"},\"download\":{\"oneOf\":[{\"$ref\":\"#/$defs/HookSyncConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Same as Upload, but with this option DevSpace will download files or folders from\\na remote container.\"},\"logs\":{\"oneOf\":[{\"$ref\":\"#/$defs/HookLogsConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"If logs is defined will print the logs of the target container. This is useful for containers\\nthat should finish like init containers or job pods. Otherwise this hook will never terminate.\"},\"wait\":{\"oneOf\":[{\"$ref\":\"#/$defs/HookWaitConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"If wait is defined the hook will wait until the matched pod or container is running or is terminated\\nwith a certain exit code.\"},\"background\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If true, the hook will be executed in the background.\"},\"silent\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If true, the hook will not output anything to the standard out of DevSpace except\\nfor the case when the hook fails, where DevSpace will show the error including\\nthe captured output streams of the hook.\"},\"container\":{\"oneOf\":[{\"$ref\":\"#/$defs/HookContainer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Container specifies where the hook should be run. If this is omitted DevSpace expects a\\nlocal command hook.\"}},\"type\":\"object\",\"required\":[\"events\"],\"description\":\"HookConfig defines a hook\"},\"HookContainer\":{\"properties\":{\"labelSelector\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"LabelSelector to select a container\"},\"pod\":{\"type\":\"string\",\"description\":\"Pod name to use\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace to use\"},\"imageSelector\":{\"type\":\"string\",\"description\":\"ImageSelector to select a container\"},\"containerName\":{\"type\":\"string\",\"description\":\"ContainerName to use\"},\"wait\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Wait can be used to disable waiting\"},\"timeout\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Timeout is how long to wait (in seconds) for the container to start. Default is 150 seconds.\",\"default\":150},\"once\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Once only executes an hook once in the container until it is restarted\"}},\"type\":\"object\",\"description\":\"HookContainer defines how to select one or more containers to execute a hook in\"},\"HookLogsConfig\":{\"properties\":{\"tailLines\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If set, the number of lines from the end of the logs to show. If not specified,\\nlogs are shown from the creation of the container\"}},\"type\":\"object\",\"description\":\"HookLogsConfig defines a hook logs config\"},\"HookSyncConfig\":{\"properties\":{\"localPath\":{\"type\":\"string\",\"description\":\"LocalPath to sync files from\"},\"containerPath\":{\"type\":\"string\",\"description\":\"ContainerPath to sync files to\"}},\"type\":\"object\",\"description\":\"HookSyncConfig defines a hook upload config\"},\"HookWaitConfig\":{\"properties\":{\"running\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If running is true, will wait until the matched containers are running. Can be used together with terminatedWithCode.\"},\"terminatedWithCode\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If terminatedWithCode is not nil, will wait until the matched containers are terminated with the given exit code.\\nIf the container has exited with a different exit code, the hook will fail. Can be used together with running.\"},\"timeout\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"The amount of seconds to wait until the hook will fail. Defaults to 150 seconds.\"}},\"type\":\"object\",\"description\":\"HookWaitConfig defines a hook wait config\"},\"Image\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the image, will be filled automatically\"},\"image\":{\"type\":\"string\",\"description\":\"Image is the complete image name including registry and repository\\nfor example myregistry.com/mynamespace/myimage\"},\"tags\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Tags is an array that specifies all tags that should be build during\\nthe build process. If this is empty, devspace will generate a random tag\"},\"dockerfile\":{\"type\":\"string\",\"description\":\"Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.\",\"default\":\"./Dockerfile\",\"group\":\"buildConfig\"},\"context\":{\"type\":\"string\",\"description\":\"Context is the context path to build with. Defaults to the current working directory\",\"default\":\"./\",\"group\":\"buildConfig\"},\"entrypoint\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Entrypoint specifies an entrypoint that will be appended to the dockerfile during\\nimage build in memory. Example: [\\\"sleep\\\", \\\"99999\\\"]\",\"group\":\"overwrites\",\"group_name\":\"In-Memory Overwrites\"},\"cmd\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Cmd specifies the arguments for the entrypoint that will be appended\\nduring build in memory to the dockerfile\",\"group\":\"overwrites\"},\"appendDockerfileInstructions\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build\\nat the current build target and are appended before the entrypoint and cmd instructions\",\"group\":\"overwrites\"},\"buildArgs\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"BuildArgs are the build args that are to the build\",\"group\":\"buildConfig\",\"group_name\":\"Build Configuration\"},\"target\":{\"type\":\"string\",\"description\":\"Target is the target that should get used during the build. Only works if the dockerfile supports this\",\"group\":\"buildConfig\"},\"network\":{\"type\":\"string\",\"description\":\"Network is the network that should get used to build the image\",\"group\":\"buildConfig\"},\"rebuildStrategy\":{\"type\":\"string\",\"enum\":[\"default\",\"always\",\"ignoreContextChanges\"],\"description\":\"RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will\\nrebuild an image if one of the following conditions is true:\\n- The dockerfile has changed\\n- The configuration within the devspace.yaml for the image has changed\\n- A file within the docker context (excluding .dockerignore rules) has changed\\nThis option is ignored for custom builds.\",\"group\":\"buildConfig\"},\"skipPush\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen\\nas build method\",\"group\":\"pushPull\",\"group_name\":\"Push & Pull\"},\"createPullSecret\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"CreatePullSecret specifies if a pull secret should be created for this image in the\\ntarget namespace. Defaults to true\",\"group\":\"pushPull\"},\"buildKit\":{\"oneOf\":[{\"$ref\":\"#/$defs/BuildKitConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit\",\"group\":\"engines\",\"group_name\":\"Build Engines\"},\"docker\":{\"oneOf\":[{\"$ref\":\"#/$defs/DockerConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Docker if docker is specified, DevSpace will build the image using the local docker daemon\",\"group\":\"engines\"},\"kaniko\":{\"oneOf\":[{\"$ref\":\"#/$defs/KanikoConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko\",\"group\":\"engines\"},\"custom\":{\"oneOf\":[{\"$ref\":\"#/$defs/CustomConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Custom if custom is specified, DevSpace will build the image with the help of\\na custom script.\",\"group\":\"engines\"}},\"type\":\"object\",\"required\":[\"image\"],\"description\":\"Image defines the image specification\"},\"Import\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enabled specifies if the given import should be enabled\"},\"path\":{\"type\":\"string\",\"description\":\"Path is the local path where DevSpace can find the artifact.\\nThis option is mutually exclusive with the git option.\",\"group\":\"path\",\"group_name\":\"Source: Local Filesystem\"},\"git\":{\"type\":\"string\",\"description\":\"Git is the remote repository to download the artifact from. You can either use\\nhttps projects or ssh projects here, but need to make sure git can pull the project.\\nThis option is mutually exclusive with the path option.\",\"group\":\"git\",\"group_name\":\"Source: Git Repository\"},\"subPath\":{\"type\":\"string\",\"description\":\"SubPath is a path within the git repository where the artifact lies in\",\"group\":\"git\"},\"branch\":{\"type\":\"string\",\"description\":\"Branch is the git branch to pull\",\"group\":\"git\"},\"tag\":{\"type\":\"string\",\"description\":\"Tag is the tag to pull\",\"group\":\"git\"},\"revision\":{\"type\":\"string\",\"description\":\"Revision is the git revision to pull\",\"group\":\"git\"},\"cloneArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"CloneArgs are additional arguments that should be supplied to the git CLI\",\"group\":\"git\"},\"disableShallow\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableShallow can be used to turn off shallow clones as these are the default used\\nby devspace\",\"group\":\"git\"},\"disablePull\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisablePull will disable pulling every time DevSpace is reevaluating this source\",\"group\":\"git\"}},\"type\":\"object\",\"description\":\"Import specifies the source of the devspace config to merge\"},\"KanikoAdditionalMount\":{\"properties\":{\"secret\":{\"oneOf\":[{\"$ref\":\"#/$defs/KanikoAdditionalMountSecret\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"The secret that should be mounted\"},\"configMap\":{\"oneOf\":[{\"$ref\":\"#/$defs/KanikoAdditionalMountConfigMap\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"The configMap that should be mounted\"},\"readOnly\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false.\\n+optional\"},\"mountPath\":{\"type\":\"string\",\"description\":\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"},\"subPath\":{\"type\":\"string\",\"description\":\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\\n+optional\"}},\"type\":\"object\",\"description\":\"KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like\"},\"KanikoAdditionalMountConfigMap\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the configmap\\n+optional\"},\"items\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/KanikoAdditionalMountKeyToPath\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"If unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\\n+optional\"},\"defaultMode\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Optional: mode bits to use on created files by default. Must be a\\nvalue between 0 and 0777. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set.\\n+optional\"}},\"type\":\"object\"},\"KanikoAdditionalMountKeyToPath\":{\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"The key to project.\"},\"path\":{\"type\":\"string\",\"description\":\"The relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"},\"mode\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Optional: mode bits to use on this file, must be a value between 0\\nand 0777. If not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set.\\n+optional\"}},\"type\":\"object\",\"required\":[\"key\",\"path\"]},\"KanikoAdditionalMountSecret\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the secret in the pod's namespace to use.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\\n+optional\"},\"items\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/KanikoAdditionalMountKeyToPath\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\\n+optional\"},\"defaultMode\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Optional: mode bits to use on created files by default. Must be a\\nvalue between 0 and 0777. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set.\\n+optional\"}},\"type\":\"object\",\"required\":[\"name\"]},\"KanikoConfig\":{\"properties\":{\"cache\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Cache tells DevSpace if a cache repository should be used. defaults to false\"},\"snapshotMode\":{\"type\":\"string\",\"description\":\"SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time\"},\"image\":{\"type\":\"string\",\"description\":\"Image is the image name of the kaniko pod to use\"},\"initImage\":{\"type\":\"string\",\"description\":\"InitImage to override the init image of the kaniko pod\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args for additional arguments that should be passed to kaniko\"},\"command\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Command to replace the starting command for the kaniko container\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace is the namespace where the kaniko pod should be run\"},\"insecure\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Insecure allows pushing to insecure registries\"},\"pullSecret\":{\"type\":\"string\",\"description\":\"PullSecret is the pull secret to mount by default\"},\"skipPullSecretMount\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"SkipPullSecretMount will skip mounting the pull secret\"},\"nodeSelector\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"NodeSelector is the node selector to use for the kaniko pod\"},\"tolerations\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/Toleration\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Tolerations is a tolerations list to use for the kaniko pod\"},\"serviceAccount\":{\"type\":\"string\",\"description\":\"ServiceAccount the service account to use for the kaniko pod\"},\"generateName\":{\"type\":\"string\",\"description\":\"GenerateName is the optional prefix that will be set to the generateName field of the build pod\"},\"annotations\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Annotations are extra annotations that will be added to the build pod\"},\"labels\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Labels are extra labels that will be added to the build pod\"},\"initEnv\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"InitEnv are extra environment variables that will be added to the build init container\"},\"env\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Env are extra environment variables that will be added to the build kaniko container\\nWill populate the env.value field.\"},\"envFrom\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"object\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container\\nWill populate the env.valueFrom field.\"},\"additionalMounts\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/KanikoAdditionalMount\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"AdditionalMounts are additional mounts that will be added to the build pod\"},\"resources\":{\"oneOf\":[{\"$ref\":\"#/$defs/PodResources\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Resources are the resources that should be set on the kaniko pod\"}},\"type\":\"object\",\"description\":\"KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost\"},\"KubectlConfig\":{\"properties\":{\"manifests\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Manifests is a list of files or folders that will be deployed by DevSpace using kubectl\\nor kustomize\"},\"applyArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ApplyArgs are extra arguments for `kubectl apply`\"},\"createArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply`\"},\"kubectlBinaryPath\":{\"type\":\"string\",\"description\":\"KubectlBinaryPath is the optional path where to find the kubectl binary\"},\"inlineManifest\":{\"type\":\"string\",\"description\":\"InlineManifests is a block containing the manifest to deploy\"},\"kustomize\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Kustomize can be used to enable kustomize instead of kubectl\",\"group\":\"kustomize\",\"group_name\":\"Kustomize\"},\"kustomizeArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply`\",\"group\":\"kustomize\"},\"kustomizeBinaryPath\":{\"type\":\"string\",\"description\":\"KustomizeBinaryPath is the optional path where to find the kustomize binary\",\"group\":\"kustomize\"},\"patches\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PatchTarget\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Patches are additional changes to the pod spec that should be applied\",\"group\":\"modifications\"}},\"type\":\"object\",\"description\":\"KubectlConfig defines the specific kubectl options used during deployment\"},\"LocalRegistryConfig\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enabled enables the local registry for pushing images.\\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\\nWhen `true` the local registry will always be used.\\nWhen `false` the local registry will never be used.\"},\"localbuild\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"LocalBuild enables use of local docker builder instead of building in the cluster\"},\"namespace\":{\"type\":\"string\",\"description\":\"Namespace where the local registry is deployed. Default is the current context's namespace\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the deployment and service of the local registry. Default is `registry`\"},\"image\":{\"type\":\"string\",\"description\":\"Image of the local registry. Default is `registry:2.8.1`\"},\"buildKitImage\":{\"type\":\"string\",\"description\":\"BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless`\"},\"port\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Port that the registry image listens on. Default is `5000`\"},\"persistence\":{\"oneOf\":[{\"$ref\":\"#/$defs/LocalRegistryPersistence\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Persistence settings for the local registry\"}},\"type\":\"object\",\"description\":\"LocalRegistryConfig holds the configuration of the local image registry\"},\"LocalRegistryPersistence\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enable enables persistence for the local registry\"},\"size\":{\"type\":\"string\",\"description\":\"Size of the persistent volume for local docker registry storage. Default is `5Gi`\"},\"storageClassName\":{\"type\":\"string\",\"description\":\"StorageClassName of the persistent volume. Default is your cluster's configured default storage class\"}},\"type\":\"object\",\"description\":\"LocalRegistryPersistence configures persistence settings for the local registry\"},\"Logs\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enabled can be used to enable printing container logs\"},\"lastLines\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"LastLines is the amount of lines to print of the running container initially\"}},\"type\":\"object\"},\"OpenConfig\":{\"properties\":{\"url\":{\"type\":\"string\",\"description\":\"URL is the url to open in the browser after it is available\"}},\"type\":\"object\",\"description\":\"OpenConfig defines what to open after services have been started\"},\"PatchConfig\":{\"properties\":{\"op\":{\"type\":\"string\",\"description\":\"Operation is the path operation to do. Can be either replace, add or remove\"},\"path\":{\"type\":\"string\",\"description\":\"Path is the config path to apply the patch to\"},\"value\":{\"description\":\"Value is the value to use for this patch.\"}},\"type\":\"object\",\"required\":[\"op\",\"path\"],\"description\":\"PatchConfig describes a config patch and how it should be applied\"},\"PatchTarget\":{\"properties\":{\"target\":{\"oneOf\":[{\"$ref\":\"#/$defs/Target\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Target describes where to apply a config patch\"},\"op\":{\"type\":\"string\",\"description\":\"Operation is the path operation to do. Can be either replace, add or remove\"},\"path\":{\"type\":\"string\",\"description\":\"Path is the config path to apply the patch to\"},\"value\":{\"description\":\"Value is the value to use for this patch.\"}},\"type\":\"object\",\"required\":[\"target\",\"op\",\"path\"],\"description\":\"PatchTarget describes a config patch and how it should be applied\"},\"PersistenceOptions\":{\"properties\":{\"size\":{\"type\":\"string\",\"description\":\"Size is the size of the created persistent volume in Kubernetes size notation like 5Gi\"},\"storageClassName\":{\"type\":\"string\",\"description\":\"StorageClassName is the storage type DevSpace should use for this persistent volume\"},\"accessModes\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"AccessModes are the access modes DevSpace should use for the persistent volume\"},\"readOnly\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"ReadOnly specifies if the volume should be read only\"},\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the PVC that should be created. If a PVC with that name\\nalready exists, DevSpace will use that PVC instead of creating one.\"}},\"type\":\"object\",\"description\":\"PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration\"},\"PersistentPath\":{\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path is the container path that should get persisted. By default, DevSpace will create an init container\\nthat will copy over the contents of this folder from the existing image.\"},\"volumePath\":{\"type\":\"string\",\"description\":\"VolumePath is the sub path on the volume that is mounted as persistent volume for this path\"},\"readOnly\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"ReadOnly will make the persistent path read only to the user\"},\"skipPopulate\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"SkipPopulate will not create an init container to copy over the existing contents if true\"},\"initContainer\":{\"oneOf\":[{\"$ref\":\"#/$defs/PersistentPathInitContainer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"InitContainer holds additional options for the persistent path init container\"}},\"type\":\"object\",\"description\":\"PersistentPath holds options to configure persistence for DevSpace\"},\"PersistentPathInitContainer\":{\"properties\":{\"resources\":{\"oneOf\":[{\"$ref\":\"#/$defs/PodResources\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Resources are the resources used by the persistent path init container\"}},\"type\":\"object\",\"description\":\"PersistentPathInitContainer defines additional options for the persistent path init container\"},\"Pipeline\":{\"properties\":{\"name\":{\"type\":\"string\",\"enum\":[\"dev\",\"deploy\",\"build\",\"purge\",\".*\"],\"description\":\"Name of the pipeline, will be filled automatically\"},\"run\":{\"type\":\"string\",\"description\":\"Run is the actual shell command that should be executed during this pipeline\"},\"flags\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/PipelineFlag\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Flags are extra flags that can be used for running the pipeline via\\ndevspace run-pipeline.\"},\"continueOnError\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"ContinueOnError will not fail the whole job and pipeline if\\na call within the step fails.\"}},\"type\":\"object\",\"description\":\"Pipeline defines what DevSpace should do.\"},\"PipelineFlag\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the flag\"},\"short\":{\"type\":\"string\",\"description\":\"Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'\"},\"type\":{\"type\":\"string\",\"enum\":[\"bool\",\"int\",\"string\",\"stringArray\"],\"description\":\"Type is the type of the flag. Defaults to `bool`\"},\"default\":{\"description\":\"Default is the default value for this flag\"},\"description\":{\"type\":\"string\",\"description\":\"Description is the description as shown in `devspace run-pipeline my-pipe -h`\"}},\"type\":\"object\",\"description\":\"PipelineFlag defines an extra pipeline flag\"},\"PodResources\":{\"properties\":{\"requests\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Requests are the requests part of the resources\"},\"limits\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Limits are the limits part of the resources\"}},\"type\":\"object\",\"description\":\"PodResources describes the resources section of the started kaniko pod\"},\"PortMapping\":{\"properties\":{\"port\":{\"type\":\"string\",\"description\":\"Port is a port mapping that maps the localPort:remotePort. So if\\nyou port forward the remote port will be available at the local port.\\nIf you do reverse port forwarding, the local port will be available\\nat the remote port in the container. If only port is specified, local and\\nremote port are the same.\"},\"bindAddress\":{\"type\":\"string\",\"description\":\"BindAddress is the address DevSpace should listen on. Optional and defaults\\nto localhost.\"}},\"type\":\"object\",\"required\":[\"port\"],\"description\":\"PortMapping defines the ports for a PortMapping\"},\"ProxyCommand\":{\"properties\":{\"gitCredentials\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"GitCredentials configures a git credentials helper inside the container that proxies local git credentials\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the name of the command that should be available in the remote container. DevSpace\\nwill create a small script for that inside the container that redirect command execution to\\nthe local computer.\"},\"localCommand\":{\"type\":\"string\",\"description\":\"LocalCommand can be used to run a different command than specified via the command option. By\\ndefault, this will be assumed to be the same as command.\"},\"skipContainerEnv\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"SkipContainerEnv will not forward the container environment variables to the local command\"},\"env\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Env are extra environment variables to set for the command\"}},\"type\":\"object\"},\"PullSecretConfig\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the pull secret name to deploy\"},\"registry\":{\"type\":\"string\",\"description\":\"The registry to create the image pull secret for.\\nEmpty string == docker hub\\ne.g. gcr.io\"},\"username\":{\"type\":\"string\",\"description\":\"The username of the registry. If this is empty, devspace will try\\nto receive the auth data from the local docker\"},\"password\":{\"type\":\"string\",\"description\":\"The password to use for the registry. If this is empty, devspace will\\ntry to receive the auth data from the local docker\"},\"email\":{\"type\":\"string\",\"description\":\"The optional email to use\"},\"secret\":{\"type\":\"string\",\"description\":\"The secret to create\"},\"serviceAccounts\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"The service account to add the secret to\"}},\"type\":\"object\",\"description\":\"PullSecretConfig defines a pull secret that should be created by DevSpace\"},\"RequireCommand\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the command that should be installed\"},\"versionArgs\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"VersionArgs are the arguments to retrieve the version of the command\"},\"versionRegEx\":{\"type\":\"string\",\"description\":\"VersionRegEx is the regex that is used to parse the version\"},\"version\":{\"type\":\"string\",\"description\":\"Version constraint of the command that should be installed\"}},\"type\":\"object\",\"required\":[\"name\"]},\"RequireConfig\":{\"properties\":{\"devspace\":{\"type\":\"string\",\"description\":\"DevSpace specifies the DevSpace version constraint that is needed to use this config\"},\"commands\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/RequireCommand\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Commands specifies an array of commands that need to be installed locally to use this config\"},\"plugins\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/RequirePlugin\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Plugins specifies an array of plugins that need to be installed locally\"}},\"type\":\"object\"},\"RequirePlugin\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the plugin that should be installed\"},\"version\":{\"type\":\"string\",\"description\":\"Version constraint of the plugin that should be installed\"}},\"type\":\"object\",\"required\":[\"name\",\"version\"]},\"RestartHelper\":{\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path defines the path to the restart helper that might be used if certain config\\noptions are enabled\"},\"inject\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Inject signals DevSpace to inject the restart helper\"}},\"type\":\"object\"},\"SSH\":{\"properties\":{\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Enabled can be used to enable the ssh server within the container. By default,\\nDevSpace will generate the required keys and create an entry in your ~/.ssh/config\\nfor this container that can be used via `ssh dev-config-name.dev-project-name.devspace`\"},\"localHostname\":{\"type\":\"string\",\"description\":\"LocalHostname is the local ssh host to write to the ~/.ssh/config\"},\"localPort\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"LocalPort is the local port to forward from, if empty will be random\"},\"remoteAddress\":{\"type\":\"string\",\"description\":\"RemoteAddress is the address to listen to inside the container\"},\"useInclude\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace\\nwill also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,\\nbut unfortunately not all SSH clients support this.\"}},\"type\":\"object\"},\"SyncConfig\":{\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.'\\nto specify either the local or remote working directory. This is valid for example: .:.\"},\"excludePaths\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"ExcludePaths is an array of file patterns in gitignore format to exclude.\",\"group\":\"exclude\",\"group_name\":\"Exclude Paths From File Sync\"},\"excludeFile\":{\"type\":\"string\",\"description\":\"ExcludeFile loads the file patterns to exclude from a file.\",\"group\":\"exclude\"},\"downloadExcludePaths\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading\",\"group\":\"exclude\"},\"downloadExcludeFile\":{\"type\":\"string\",\"description\":\"DownloadExcludeFile loads the file patterns to exclude from downloading from a file.\",\"group\":\"exclude\"},\"uploadExcludePaths\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading\",\"group\":\"exclude\"},\"uploadExcludeFile\":{\"type\":\"string\",\"description\":\"UploadExcludeFile loads the file patterns to exclude from uploading from a file.\",\"group\":\"exclude\"},\"startContainer\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"StartContainer will start the container after initial sync is done. This will\\ninject a devspacehelper into the pod and you need to define dev.*.command for\\nthis to work.\",\"group\":\"actions\",\"group_name\":\"Sync-Triggered Actions\"},\"onUpload\":{\"oneOf\":[{\"$ref\":\"#/$defs/SyncOnUpload\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"OnUpload can be used to execute certain commands on uploading either in the container or locally as\\nwell as restart the container after a file changed has happened.\",\"group\":\"actions\"},\"initialSync\":{\"type\":\"string\",\"description\":\"InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal\",\"group\":\"initial_sync\",\"group_name\":\"Initial Sync\"},\"waitInitialSync\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done\",\"group\":\"initial_sync\"},\"initialSyncCompareBy\":{\"type\":\"string\",\"description\":\"InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible\",\"group\":\"initial_sync\"},\"disableDownload\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableDownload will disable downloading completely\",\"group\":\"one_direction\",\"group_name\":\"One-Directional Sync\"},\"disableUpload\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableUpload will disable uploading completely\",\"group\":\"one_direction\"},\"bandwidthLimits\":{\"oneOf\":[{\"$ref\":\"#/$defs/BandwidthLimits\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this\\nsync configuration\"},\"polling\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Polling will tell the remote container to use polling instead of inotify\"},\"noWatch\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"NoWatch will terminate the sync after the initial sync is done\"},\"file\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"File signals DevSpace that this is a single file that should get synced instead of a whole directory\"}},\"type\":\"object\",\"description\":\"SyncConfig defines the paths for a SyncFolder\"},\"SyncExec\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name to show for this exec in the logs\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the command to execute. If no args are specified this is executed\\nwithin a shell.\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are arguments to pass to the command\"},\"failOnError\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"FailOnError specifies if the sync should fail if the command fails\"},\"local\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Local specifies if the command should be executed locally instead of within the\\ncontainer\"},\"once\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Once executes this command only once in the container's life. Can be used to initialize\\na container before starting it, but after everything was synced.\"},\"onChange\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"OnChange is an array of file patterns that trigger this command execution\"}},\"type\":\"object\"},\"SyncOnUpload\":{\"properties\":{\"restartContainer\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If true restart container will try to restart the container after a change has been made. Make sure that\\nimages.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper\\nscript is present in the container root folder.\"},\"exec\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/SyncExec\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Exec will execute the given commands in order after a sync operation\"}},\"type\":\"object\",\"description\":\"SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded\"},\"Target\":{\"properties\":{\"apiVersion\":{\"type\":\"string\",\"description\":\"ApiVersion is the Kubernetes api of the target resource\"},\"kind\":{\"type\":\"string\",\"description\":\"Kind is the kind of the target resource (eg: Deployment, Service ...)\"},\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the target resource\"}},\"type\":\"object\",\"required\":[\"apiVersion\",\"kind\",\"name\"],\"description\":\"Target describes where to apply a config patch\"},\"Terminal\":{\"properties\":{\"command\":{\"type\":\"string\",\"description\":\"Command is the command that should be executed on terminal start.\\nThis command is executed within a shell.\"},\"workDir\":{\"type\":\"string\",\"description\":\"WorkDir is the working directory that is used to execute the command in.\"},\"enabled\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"If enabled is true, DevSpace will use the terminal. Can be also\\nused to disable the terminal if set to false. DevSpace makes sure\\nthat within a pipeline only one dev configuration can open a terminal\\nat a time and subsequent dev terminals will fail.\"},\"disableReplace\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableReplace tells DevSpace to not replace the pod or adjust its settings\\nto make sure the pod is sleeping when opening a terminal\"},\"disableScreen\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableScreen will disable screen which is used by DevSpace by default to preserve\\nsessions if connections interrupt or the session is lost.\"},\"disableTTY\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"DisableTTY will disable a tty shell for terminal command execution\"}},\"type\":\"object\",\"description\":\"Terminal describes the terminal options\"},\"Toleration\":{\"properties\":{\"Key\":{\"type\":\"string\"},\"Operator\":{\"type\":\"string\"},\"Value\":{\"type\":\"string\"},\"Effect\":{\"type\":\"string\"},\"TolerationSeconds\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}]}},\"type\":\"object\",\"required\":[\"Key\",\"Operator\",\"Value\",\"Effect\",\"TolerationSeconds\"]},\"Variable\":{\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name is the name of the variable\"},\"value\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}],\"description\":\"Value is a shortcut for using source: none and default: my-value\",\"group\":\"static\",\"group_name\":\"Static Value\"},\"question\":{\"type\":\"string\",\"description\":\"Question can be used to define a custom question if the variable was not yet used\",\"group\":\"question\",\"group_name\":\"Value From Input (Question)\"},\"default\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"}],\"description\":\"Default is the default value the variable should have if not set by the user\",\"group\":\"question\"},\"options\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Options are options that can be selected when the variable question is asked\",\"group\":\"question\"},\"password\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"Password signals that this variable should not be visible if entered\",\"group\":\"question\"},\"validationPattern\":{\"type\":\"string\",\"description\":\"ValidationPattern can be used to verify the user input\",\"group\":\"question\"},\"validationMessage\":{\"type\":\"string\",\"description\":\"ValidationMessage can be used to tell the user the format of the variable value\",\"group\":\"question\"},\"noCache\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"NoCache can be used to prompt the user on every run for this variable\",\"group\":\"question\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell\\ncommand.\",\"group\":\"execution\",\"group_name\":\"Value From Command\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are optional args that will be used for the command\",\"group\":\"execution\"},\"commands\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/VariableCommand\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Commands are additional commands that can be used to run a different command on a different operating\\nsystem.\",\"group\":\"execution\"},\"alwaysResolve\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"},{\"type\":\"string\",\"pattern\":\"(\\\\$+!?\\\\{[a-zA-Z0-9\\\\-\\\\_\\\\.]+\\\\})\"}],\"description\":\"AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false.\"},\"source\":{\"type\":\"string\",\"enum\":[\"all\",\"env\",\"input\",\"command\",\"none\"],\"description\":\"Source defines where the variable should be taken from\"}},\"type\":\"object\",\"description\":\"Variable describes the var definition\"},\"VariableCommand\":{\"properties\":{\"os\":{\"type\":\"string\",\"description\":\"OperatingSystem is optional and defines the operating system this\\ncommand should be executed on\"},\"command\":{\"type\":\"string\",\"description\":\"Command is the command to use to retrieve the value for this variable. If no\\nargs are specified the command is run within a pseudo shell.\"},\"args\":{\"oneOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Args are optional arguments for the command\"}},\"type\":\"object\"}},\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Version holds the config version. DevSpace will always convert older configs to the current latest\\nconfig version, which makes it possible to use the newest DevSpace version also with older config\\nversions.\"},\"name\":{\"type\":\"string\",\"description\":\"Name specifies the name of the DevSpace project and uniquely identifies a project.\\nDevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace.\\nIf not provided, DevSpace will use the name of the current working directory.\"},\"imports\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/Import\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration\\ninto multiple files and reuse those through git, a remote url or common local path.\"},\"functions\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by\\nimports.\"},\"pipelines\":{\"anyOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/Pipeline\"}},\"type\":\"object\"},{\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge\\nis called. Pipelines are defined through a special POSIX script that allows you to use special commands\\nsuch as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute\\na specific functionality. The pipelines dev, build, deploy and purge are special and will override\\nthe default functionality of the respective command if defined. All other pipelines can be either run\\nvia the devspace run-pipeline command or used within another pipeline through run_pipelines.\"},\"images\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/Image\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.\\nIf you are using a custom pipeline, you can dynamically define which image is built at which time during the\\nexecution.\"},\"deployments\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/DeploymentConfig\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.\\nIf you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the\\nexecution.\"},\"dev\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/DevPod\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod\\nor even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.\\nDev allows you to:\\n- sync local folders to the Kubernetes pod\\n- port forward remote ports to your local computer\\n- forward local ports into the Kubernetes pod\\n- configure an ssh tunnel to the Kubernetes pod\\n- proxy local commands to the container\\n- restart the container on file changes\"},\"vars\":{\"anyOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/Variable\"}},\"type\":\"object\"},{\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Vars are config variables that can be used inside other config sections to replace certain values dynamically\"},\"commands\":{\"anyOf\":[{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/CommandConfig\"}},\"type\":\"object\"},{\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash\\nthat also allows executing special commands such as run_watch or is_equal.\"},\"dependencies\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/DependencyConfig\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed\\nfrom within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects\\nthat typically lie including source code in a different folder and can be used to compose a full microservice\\napplication that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use\\nthe same project multiple times, make sure to use a different name for each of those instances.\"},\"pullSecrets\":{\"oneOf\":[{\"patternProperties\":{\".*\":{\"$ref\":\"#/$defs/PullSecretConfig\"}},\"type\":\"object\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"PullSecrets are image pull secrets that will be created by devspace in the target namespace\\nduring devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single\\none or the one specified.\"},\"require\":{\"oneOf\":[{\"$ref\":\"#/$defs/RequireConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not\\nfulfilled, DevSpace will fail.\"},\"hooks\":{\"oneOf\":[{\"items\":{\"$ref\":\"#/$defs/HookConfig\"},\"type\":\"array\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"Hooks are actions that are executed at certain points within the pipeline. Hooks are ordered and are executed\\nin the order they are specified. They are deprecated and pipelines should be used instead.\"},\"localRegistry\":{\"oneOf\":[{\"$ref\":\"#/$defs/LocalRegistryConfig\"},{\"type\":\"string\",\"pattern\":\"(?ms)^\\\\$\\\\$?\\\\#?\\\\!?\\\\((.+)\\\\)$\"}],\"description\":\"LocalRegistry specifies the configuration for a local image registry\"}},\"type\":\"object\",\"required\":[\"version\",\"name\"],\"description\":\"Config defines the configuration\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"devspace-schema\". Here are the required top‑level fields: version, name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft/2020-12/schema","$id":"https://github.com/loft-sh/devspace/pkg/devspace/config/versions/latest/config","$defs":{"Attach":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enabled can be used to enable attaching to a container"},"disableReplace":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableReplace prevents DevSpace from actually replacing the pod with modifications so that\nthe pod starts up correctly."},"disableTTY":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableTTY is used to tell DevSpace to not use a TTY connection for attaching"}},"type":"object"},"BandwidthLimits":{"properties":{"download":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Download is the download limit in kilo bytes per second"},"upload":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Upload is the upload limit in kilo bytes per second"}},"type":"object","description":"BandwidthLimits defines the struct for specifying the sync bandwidth limits"},"BuildKitConfig":{"properties":{"inCluster":{"oneOf":[{"$ref":"#/$defs/BuildKitInClusterConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"InCluster if specified, DevSpace will use BuildKit to build the image within the cluster"},"preferMinikube":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"PreferMinikube if false, will not try to use the minikube docker daemon to build the image"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are additional arguments to call docker buildx build with"},"command":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Command to override the base command to create a builder and build images. Defaults to [\"docker\", \"buildx\"]"}},"type":"object","description":"BuildKitConfig tells the DevSpace CLI to"},"BuildKitInClusterConfig":{"properties":{"name":{"type":"string","description":"Name is the name of the builder to use. If omitted, DevSpace will try to create\nor reuse a builder in the form devspace-$NAMESPACE"},"namespace":{"type":"string","description":"Namespace where to create the builder deployment in. Defaults to the current\nactive namespace."},"rootless":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Rootless if enabled will create a rootless builder deployment."},"image":{"type":"string","description":"Image is the docker image to use for the BuildKit deployment"},"nodeSelector":{"type":"string","description":"NodeSelector is the node selector to use for the BuildKit deployment"},"noCreate":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.\nIf this is true, DevSpace will fail if the specified builder cannot be found."},"noRecreate":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration\nin the devspace.yaml differs from the actual builder configuration. If this is\ntrue, DevSpace will not try to do that."},"noLoad":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"NoLoad if enabled, DevSpace will not try to load the built image into the local docker\ndaemon if skip push is defined"},"createArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"CreateArgs are additional args to create the builder with."}},"type":"object","description":"BuildKitInClusterConfig holds the buildkit builder config"},"ChartConfig":{"properties":{"name":{"type":"string","description":"Name is the name of the helm chart to deploy. Can also be a local path or an oci url","group":"repo","group_name":"Source: Helm Repository"},"version":{"type":"string","description":"Version is the version of the helm chart to deploy","group":"repo"},"repo":{"type":"string","description":"RepoURL is the url of the repo to deploy the chart from","group":"repo"},"username":{"type":"string","description":"Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth","group":"repo"},"password":{"type":"string","description":"Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth","group":"repo"},"path":{"type":"string","description":"Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.","group":"path","group_name":"Source: Local Filesystem"},"git":{"type":"string","description":"Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.","group":"git","group_name":"Source: Git Repository"},"subPath":{"type":"string","description":"SubPath is a path within the git repository where the artifact lies in","group":"git"},"branch":{"type":"string","description":"Branch is the git branch to pull","group":"git"},"tag":{"type":"string","description":"Tag is the tag to pull","group":"git"},"revision":{"type":"string","description":"Revision is the git revision to pull","group":"git"},"cloneArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"CloneArgs are additional arguments that should be supplied to the git CLI","group":"git"},"disableShallow":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace","group":"git"},"disablePull":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisablePull will disable pulling every time DevSpace is reevaluating this source","group":"git"}},"type":"object","description":"ChartConfig defines the helm chart options"},"CommandConfig":{"properties":{"name":{"type":"string","description":"Name is the name of a command that is used via `devspace run NAME`"},"section":{"type":"string","description":"Section can be used to group similar commands together in `devspace list commands`"},"command":{"type":"string","description":"Command is the command that should be executed. For example: 'echo 123'"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are optional and if defined, command is not executed within a shell\nand rather directly."},"appendArgs":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"AppendArgs will append arguments passed to the DevSpace command automatically to\nthe specified command."},"description":{"type":"string","description":"Description describes what the command is doing and can be seen in `devspace list commands`"},"internal":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Internal commands are not show in list and are usable through run_command"},"after":{"type":"string","description":"After is executed after the command was run. It is executed also when\nthe command was interrupted which will set the env variable COMMAND_INTERRUPT\nto true as well as when the command errored which will set the error string to\nCOMMAND_ERROR."}},"type":"object","required":["command"],"description":"CommandConfig defines the command specification"},"CustomConfig":{"properties":{"command":{"type":"string","description":"Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}\nto reference the image and tag that should get built."},"onChange":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"OnChange will determine when the command should be rerun"}},"type":"object","description":"CustomConfig tells the DevSpace CLI to build with a custom build script"},"DependencyConfig":{"properties":{"name":{"type":"string","description":"Name is used internally"},"disabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Disabled excludes this dependency from variable resolution and pipeline runs"},"path":{"type":"string","description":"Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.","group":"path","group_name":"Source: Local Filesystem"},"git":{"type":"string","description":"Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.","group":"git","group_name":"Source: Git Repository"},"subPath":{"type":"string","description":"SubPath is a path within the git repository where the artifact lies in","group":"git"},"branch":{"type":"string","description":"Branch is the git branch to pull","group":"git"},"tag":{"type":"string","description":"Tag is the tag to pull","group":"git"},"revision":{"type":"string","description":"Revision is the git revision to pull","group":"git"},"cloneArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"CloneArgs are additional arguments that should be supplied to the git CLI","group":"git"},"disableShallow":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace","group":"git"},"disablePull":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisablePull will disable pulling every time DevSpace is reevaluating this source","group":"git"},"pipeline":{"type":"string","description":"Pipeline is the pipeline to deploy by default. Defaults to 'deploy'","default":"deploy","group":"execution","group_name":"Execution"},"vars":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Vars are variables that should be passed to the dependency","group":"execution"},"overwriteVars":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"OverwriteVars specifies if DevSpace should pass the parent variables to the dependency","group":"execution"},"ignoreDependencies":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"IgnoreDependencies defines if dependencies of the dependency should be excluded","group":"execution"},"namespace":{"type":"string","description":"Namespace specifies the namespace this dependency should be deployed to","group":"execution"}},"type":"object","description":"DependencyConfig defines the devspace dependency"},"DeploymentConfig":{"properties":{"name":{"type":"string","description":"Name of the deployment"},"helm":{"oneOf":[{"$ref":"#/$defs/HelmConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Helm tells DevSpace to deploy this deployment via helm"},"kubectl":{"oneOf":[{"$ref":"#/$defs/KubectlConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize"},"updateImageTags":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the\nimages section with their most recent built tag.","default":true},"namespace":{"type":"string","description":"Namespace where to deploy this deployment"}},"type":"object","description":"DeploymentConfig defines the configuration how the devspace should be deployed"},"DevContainer":{"properties":{"container":{"type":"string","description":"Container is the container name these services should get started.","group":"selector","group_name":"Selector"},"arch":{"type":"string","description":"Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.","group":"selector"},"devImage":{"type":"string","description":"DevImage is the image to use for this container and will replace the existing image\nif necessary.","group":"modifications","group_name":"Modifications"},"command":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Command can be used to override the entrypoint of the container","group":"modifications"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args can be used to override the args of the container","group":"modifications"},"workingDir":{"type":"string","description":"WorkingDir can be used to override the working dir of the container","group":"modifications"},"env":{"oneOf":[{"items":{"$ref":"#/$defs/EnvVar"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Env can be used to add environment variables to the container. DevSpace will\nnot replace existing environment variables if an environment variable is defined here.","group":"modifications"},"resources":{"oneOf":[{"$ref":"#/$defs/PodResources"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Resources can be used to override the resource definitions of the container","group":"modifications"},"reversePorts":{"oneOf":[{"items":{"$ref":"#/$defs/PortMapping"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ReversePorts are port mappings to make local ports available inside the container","group":"ports","group_name":"Port Forwarding"},"sync":{"oneOf":[{"items":{"$ref":"#/$defs/SyncConfig"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Sync allows you to sync certain local paths with paths inside the container","group":"sync","group_name":"File Sync"},"persistPaths":{"oneOf":[{"items":{"$ref":"#/$defs/PersistentPath"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"PersistPaths allows you to persist certain paths within this container with a persistent volume claim"},"terminal":{"oneOf":[{"$ref":"#/$defs/Terminal"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Terminal allows you to tell DevSpace to open a terminal with screen support to this container","group":"workflows","group_name":"Foreground Dev Workflows"},"logs":{"oneOf":[{"$ref":"#/$defs/Logs"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Logs allows you to tell DevSpace to stream logs from this container to the console","group":"workflows"},"attach":{"oneOf":[{"$ref":"#/$defs/Attach"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Attach allows you to tell DevSpace to attach to this container","group":"workflows"},"ssh":{"oneOf":[{"$ref":"#/$defs/SSH"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"SSH allows you to create an SSH tunnel to this container"},"proxyCommands":{"oneOf":[{"items":{"$ref":"#/$defs/ProxyCommand"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ProxyCommands allow you to proxy certain local commands to the container","group":"workflows_background"},"restartHelper":{"oneOf":[{"$ref":"#/$defs/RestartHelper"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\nthe container and restarting it and is injected via an annotation in the replaced pod.","group":"workflows_background"}},"type":"object","description":"DevContainer holds options for dev services that should get started within a certain container of the selected pod"},"DevPod":{"properties":{"name":{"type":"string","description":"Name of the dev configuration"},"imageSelector":{"type":"string","description":"ImageSelector to select a pod","group":"selector"},"labelSelector":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"LabelSelector to select a pod","group":"selector"},"namespace":{"type":"string","description":"Namespace where to select the pod","group":"selector"},"container":{"type":"string","description":"Container is the container name these services should get started.","group":"selector","group_name":"Selector"},"arch":{"type":"string","description":"Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but\ndevspace tries to find out the architecture by itself by looking at the node this container runs on.","group":"selector"},"devImage":{"type":"string","description":"DevImage is the image to use for this container and will replace the existing image\nif necessary.","group":"modifications","group_name":"Modifications"},"command":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Command can be used to override the entrypoint of the container","group":"modifications"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args can be used to override the args of the container","group":"modifications"},"workingDir":{"type":"string","description":"WorkingDir can be used to override the working dir of the container","group":"modifications"},"env":{"oneOf":[{"items":{"$ref":"#/$defs/EnvVar"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Env can be used to add environment variables to the container. DevSpace will\nnot replace existing environment variables if an environment variable is defined here.","group":"modifications"},"resources":{"oneOf":[{"$ref":"#/$defs/PodResources"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Resources can be used to override the resource definitions of the container","group":"modifications"},"reversePorts":{"oneOf":[{"items":{"$ref":"#/$defs/PortMapping"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ReversePorts are port mappings to make local ports available inside the container","group":"ports","group_name":"Port Forwarding"},"sync":{"oneOf":[{"items":{"$ref":"#/$defs/SyncConfig"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Sync allows you to sync certain local paths with paths inside the container","group":"sync","group_name":"File Sync"},"persistPaths":{"oneOf":[{"items":{"$ref":"#/$defs/PersistentPath"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"PersistPaths allows you to persist certain paths within this container with a persistent volume claim"},"terminal":{"oneOf":[{"$ref":"#/$defs/Terminal"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Terminal allows you to tell DevSpace to open a terminal with screen support to this container","group":"workflows","group_name":"Foreground Dev Workflows"},"logs":{"oneOf":[{"$ref":"#/$defs/Logs"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Logs allows you to tell DevSpace to stream logs from this container to the console","group":"workflows"},"attach":{"oneOf":[{"$ref":"#/$defs/Attach"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Attach allows you to tell DevSpace to attach to this container","group":"workflows"},"ssh":{"oneOf":[{"$ref":"#/$defs/SSH"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"SSH allows you to create an SSH tunnel to this container"},"proxyCommands":{"oneOf":[{"items":{"$ref":"#/$defs/ProxyCommand"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ProxyCommands allow you to proxy certain local commands to the container","group":"workflows_background"},"restartHelper":{"oneOf":[{"$ref":"#/$defs/RestartHelper"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of\nthe container and restarting it and is injected via an annotation in the replaced pod.","group":"workflows_background"},"ports":{"oneOf":[{"items":{"$ref":"#/$defs/PortMapping"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Ports defines port mappings from the remote pod that should be forwarded to your local\ncomputer","group":"ports"},"persistenceOptions":{"oneOf":[{"$ref":"#/$defs/PersistenceOptions"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"PersistenceOptions are additional options for persisting paths within this pod","group":"modifications"},"patches":{"oneOf":[{"items":{"$ref":"#/$defs/PatchConfig"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Patches are additional changes to the pod spec that should be applied","group":"modifications"},"open":{"oneOf":[{"items":{"$ref":"#/$defs/OpenConfig"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Open defines urls that should be opened as soon as they are reachable","group":"workflows_background","group_name":"Background Dev Workflows"},"containers":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/DevContainer"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"group":"selector"}},"type":"object","description":"DevPod holds configurations for selecting a pod and starting dev services for that pod"},"DockerConfig":{"properties":{"disableFallback":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableFallback allows you to turn off kaniko building if docker isn't installed"},"preferMinikube":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"PreferMinikube allows you to turn off using the minikube docker daemon if the minikube\ncontext is used."},"useCli":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"UseCLI specifies if DevSpace should use the docker cli for building"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are additional arguments to pass to the docker cli"}},"type":"object","description":"DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost"},"EnvVar":{"properties":{"name":{"type":"string","description":"Name of the environment variable"},"value":{"type":"string","description":"Value of the environment variable"}},"type":"object","required":["name","value"]},"HelmConfig":{"properties":{"releaseName":{"type":"string","description":"ReleaseName of the helm configuration"},"chart":{"oneOf":[{"$ref":"#/$defs/ChartConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Chart holds the chart configuration and where DevSpace can find the chart"},"values":{"oneOf":[{"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Values are additional values that should get passed to deploying this chart"},"valuesFiles":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ValuesFiles are additional files that hold values for deploying this chart"},"displayOutput":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisplayOutput allows you to display the helm output to the console"},"upgradeArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"UpgradeArgs are additional arguments to pass to `helm upgrade`"},"templateArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"TemplateArgs are additional arguments to pass to `helm template`"},"disableDependencyUpdate":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableDependencyUpdate disables helm dependencies update, default to false"}},"type":"object","description":"HelmConfig defines the specific helm options used during deployment"},"HookConfig":{"properties":{"name":{"type":"string","description":"Name is the name of the hook"},"disabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Disabled can be used to disable the hook"},"events":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Events are the events when the hook should be executed"},"command":{"type":"string","description":"Command is the base command that is either executed locally or in a remote container.\nCommand is mutually exclusive with other hook actions. In the case this is defined\ntogether with where.container, DevSpace will until the target container is running and\nonly then execute the command. If the container does not start in time, DevSpace will fail."},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are additional arguments passed together with the command to execute."},"os":{"type":"string","description":"If an operating system is defined, the hook will only be executed for the given os.\nAll supported golang OS types are supported and multiple can be combined with ','."},"upload":{"oneOf":[{"$ref":"#/$defs/HookSyncConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"If Upload is specified, DevSpace will upload certain local files or folders into a\nremote container."},"download":{"oneOf":[{"$ref":"#/$defs/HookSyncConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Same as Upload, but with this option DevSpace will download files or folders from\na remote container."},"logs":{"oneOf":[{"$ref":"#/$defs/HookLogsConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"If logs is defined will print the logs of the target container. This is useful for containers\nthat should finish like init containers or job pods. Otherwise this hook will never terminate."},"wait":{"oneOf":[{"$ref":"#/$defs/HookWaitConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"If wait is defined the hook will wait until the matched pod or container is running or is terminated\nwith a certain exit code."},"background":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If true, the hook will be executed in the background."},"silent":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If true, the hook will not output anything to the standard out of DevSpace except\nfor the case when the hook fails, where DevSpace will show the error including\nthe captured output streams of the hook."},"container":{"oneOf":[{"$ref":"#/$defs/HookContainer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Container specifies where the hook should be run. If this is omitted DevSpace expects a\nlocal command hook."}},"type":"object","required":["events"],"description":"HookConfig defines a hook"},"HookContainer":{"properties":{"labelSelector":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"LabelSelector to select a container"},"pod":{"type":"string","description":"Pod name to use"},"namespace":{"type":"string","description":"Namespace to use"},"imageSelector":{"type":"string","description":"ImageSelector to select a container"},"containerName":{"type":"string","description":"ContainerName to use"},"wait":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Wait can be used to disable waiting"},"timeout":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Timeout is how long to wait (in seconds) for the container to start. Default is 150 seconds.","default":150},"once":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Once only executes an hook once in the container until it is restarted"}},"type":"object","description":"HookContainer defines how to select one or more containers to execute a hook in"},"HookLogsConfig":{"properties":{"tailLines":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If set, the number of lines from the end of the logs to show. If not specified,\nlogs are shown from the creation of the container"}},"type":"object","description":"HookLogsConfig defines a hook logs config"},"HookSyncConfig":{"properties":{"localPath":{"type":"string","description":"LocalPath to sync files from"},"containerPath":{"type":"string","description":"ContainerPath to sync files to"}},"type":"object","description":"HookSyncConfig defines a hook upload config"},"HookWaitConfig":{"properties":{"running":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If running is true, will wait until the matched containers are running. Can be used together with terminatedWithCode."},"terminatedWithCode":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If terminatedWithCode is not nil, will wait until the matched containers are terminated with the given exit code.\nIf the container has exited with a different exit code, the hook will fail. Can be used together with running."},"timeout":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"The amount of seconds to wait until the hook will fail. Defaults to 150 seconds."}},"type":"object","description":"HookWaitConfig defines a hook wait config"},"Image":{"properties":{"name":{"type":"string","description":"Name of the image, will be filled automatically"},"image":{"type":"string","description":"Image is the complete image name including registry and repository\nfor example myregistry.com/mynamespace/myimage"},"tags":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Tags is an array that specifies all tags that should be build during\nthe build process. If this is empty, devspace will generate a random tag"},"dockerfile":{"type":"string","description":"Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.","default":"./Dockerfile","group":"buildConfig"},"context":{"type":"string","description":"Context is the context path to build with. Defaults to the current working directory","default":"./","group":"buildConfig"},"entrypoint":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Entrypoint specifies an entrypoint that will be appended to the dockerfile during\nimage build in memory. Example: [\"sleep\", \"99999\"]","group":"overwrites","group_name":"In-Memory Overwrites"},"cmd":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Cmd specifies the arguments for the entrypoint that will be appended\nduring build in memory to the dockerfile","group":"overwrites"},"appendDockerfileInstructions":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build\nat the current build target and are appended before the entrypoint and cmd instructions","group":"overwrites"},"buildArgs":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"BuildArgs are the build args that are to the build","group":"buildConfig","group_name":"Build Configuration"},"target":{"type":"string","description":"Target is the target that should get used during the build. Only works if the dockerfile supports this","group":"buildConfig"},"network":{"type":"string","description":"Network is the network that should get used to build the image","group":"buildConfig"},"rebuildStrategy":{"type":"string","enum":["default","always","ignoreContextChanges"],"description":"RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will\nrebuild an image if one of the following conditions is true:\n- The dockerfile has changed\n- The configuration within the devspace.yaml for the image has changed\n- A file within the docker context (excluding .dockerignore rules) has changed\nThis option is ignored for custom builds.","group":"buildConfig"},"skipPush":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen\nas build method","group":"pushPull","group_name":"Push & Pull"},"createPullSecret":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"CreatePullSecret specifies if a pull secret should be created for this image in the\ntarget namespace. Defaults to true","group":"pushPull"},"buildKit":{"oneOf":[{"$ref":"#/$defs/BuildKitConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit","group":"engines","group_name":"Build Engines"},"docker":{"oneOf":[{"$ref":"#/$defs/DockerConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Docker if docker is specified, DevSpace will build the image using the local docker daemon","group":"engines"},"kaniko":{"oneOf":[{"$ref":"#/$defs/KanikoConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko","group":"engines"},"custom":{"oneOf":[{"$ref":"#/$defs/CustomConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Custom if custom is specified, DevSpace will build the image with the help of\na custom script.","group":"engines"}},"type":"object","required":["image"],"description":"Image defines the image specification"},"Import":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enabled specifies if the given import should be enabled"},"path":{"type":"string","description":"Path is the local path where DevSpace can find the artifact.\nThis option is mutually exclusive with the git option.","group":"path","group_name":"Source: Local Filesystem"},"git":{"type":"string","description":"Git is the remote repository to download the artifact from. You can either use\nhttps projects or ssh projects here, but need to make sure git can pull the project.\nThis option is mutually exclusive with the path option.","group":"git","group_name":"Source: Git Repository"},"subPath":{"type":"string","description":"SubPath is a path within the git repository where the artifact lies in","group":"git"},"branch":{"type":"string","description":"Branch is the git branch to pull","group":"git"},"tag":{"type":"string","description":"Tag is the tag to pull","group":"git"},"revision":{"type":"string","description":"Revision is the git revision to pull","group":"git"},"cloneArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"CloneArgs are additional arguments that should be supplied to the git CLI","group":"git"},"disableShallow":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableShallow can be used to turn off shallow clones as these are the default used\nby devspace","group":"git"},"disablePull":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisablePull will disable pulling every time DevSpace is reevaluating this source","group":"git"}},"type":"object","description":"Import specifies the source of the devspace config to merge"},"KanikoAdditionalMount":{"properties":{"secret":{"oneOf":[{"$ref":"#/$defs/KanikoAdditionalMountSecret"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"The secret that should be mounted"},"configMap":{"oneOf":[{"$ref":"#/$defs/KanikoAdditionalMountConfigMap"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"The configMap that should be mounted"},"readOnly":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional"},"mountPath":{"type":"string","description":"Path within the container at which the volume should be mounted. Must\nnot contain ':'."},"subPath":{"type":"string","description":"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional"}},"type":"object","description":"KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like"},"KanikoAdditionalMountConfigMap":{"properties":{"name":{"type":"string","description":"Name of the configmap\n+optional"},"items":{"oneOf":[{"items":{"$ref":"#/$defs/KanikoAdditionalMountKeyToPath"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional"},"defaultMode":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"}},"type":"object"},"KanikoAdditionalMountKeyToPath":{"properties":{"key":{"type":"string","description":"The key to project."},"path":{"type":"string","description":"The relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'."},"mode":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Optional: mode bits to use on this file, must be a value between 0\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"}},"type":"object","required":["key","path"]},"KanikoAdditionalMountSecret":{"properties":{"name":{"type":"string","description":"Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional"},"items":{"oneOf":[{"items":{"$ref":"#/$defs/KanikoAdditionalMountKeyToPath"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional"},"defaultMode":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional"}},"type":"object","required":["name"]},"KanikoConfig":{"properties":{"cache":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Cache tells DevSpace if a cache repository should be used. defaults to false"},"snapshotMode":{"type":"string","description":"SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time"},"image":{"type":"string","description":"Image is the image name of the kaniko pod to use"},"initImage":{"type":"string","description":"InitImage to override the init image of the kaniko pod"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args for additional arguments that should be passed to kaniko"},"command":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Command to replace the starting command for the kaniko container"},"namespace":{"type":"string","description":"Namespace is the namespace where the kaniko pod should be run"},"insecure":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Insecure allows pushing to insecure registries"},"pullSecret":{"type":"string","description":"PullSecret is the pull secret to mount by default"},"skipPullSecretMount":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"SkipPullSecretMount will skip mounting the pull secret"},"nodeSelector":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"NodeSelector is the node selector to use for the kaniko pod"},"tolerations":{"oneOf":[{"items":{"$ref":"#/$defs/Toleration"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Tolerations is a tolerations list to use for the kaniko pod"},"serviceAccount":{"type":"string","description":"ServiceAccount the service account to use for the kaniko pod"},"generateName":{"type":"string","description":"GenerateName is the optional prefix that will be set to the generateName field of the build pod"},"annotations":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Annotations are extra annotations that will be added to the build pod"},"labels":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Labels are extra labels that will be added to the build pod"},"initEnv":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"InitEnv are extra environment variables that will be added to the build init container"},"env":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Env are extra environment variables that will be added to the build kaniko container\nWill populate the env.value field."},"envFrom":{"oneOf":[{"patternProperties":{".*":{"type":"object"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container\nWill populate the env.valueFrom field."},"additionalMounts":{"oneOf":[{"items":{"$ref":"#/$defs/KanikoAdditionalMount"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"AdditionalMounts are additional mounts that will be added to the build pod"},"resources":{"oneOf":[{"$ref":"#/$defs/PodResources"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Resources are the resources that should be set on the kaniko pod"}},"type":"object","description":"KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost"},"KubectlConfig":{"properties":{"manifests":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Manifests is a list of files or folders that will be deployed by DevSpace using kubectl\nor kustomize"},"applyArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ApplyArgs are extra arguments for `kubectl apply`"},"createArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply`"},"kubectlBinaryPath":{"type":"string","description":"KubectlBinaryPath is the optional path where to find the kubectl binary"},"inlineManifest":{"type":"string","description":"InlineManifests is a block containing the manifest to deploy"},"kustomize":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Kustomize can be used to enable kustomize instead of kubectl","group":"kustomize","group_name":"Kustomize"},"kustomizeArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply`","group":"kustomize"},"kustomizeBinaryPath":{"type":"string","description":"KustomizeBinaryPath is the optional path where to find the kustomize binary","group":"kustomize"},"patches":{"oneOf":[{"items":{"$ref":"#/$defs/PatchTarget"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Patches are additional changes to the pod spec that should be applied","group":"modifications"}},"type":"object","description":"KubectlConfig defines the specific kubectl options used during deployment"},"LocalRegistryConfig":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enabled enables the local registry for pushing images.\nWhen unset the local registry will be used as a fallback if there are no push permissions for the registry.\nWhen `true` the local registry will always be used.\nWhen `false` the local registry will never be used."},"localbuild":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"LocalBuild enables use of local docker builder instead of building in the cluster"},"namespace":{"type":"string","description":"Namespace where the local registry is deployed. Default is the current context's namespace"},"name":{"type":"string","description":"Name of the deployment and service of the local registry. Default is `registry`"},"image":{"type":"string","description":"Image of the local registry. Default is `registry:2.8.1`"},"buildKitImage":{"type":"string","description":"BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless`"},"port":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Port that the registry image listens on. Default is `5000`"},"persistence":{"oneOf":[{"$ref":"#/$defs/LocalRegistryPersistence"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Persistence settings for the local registry"}},"type":"object","description":"LocalRegistryConfig holds the configuration of the local image registry"},"LocalRegistryPersistence":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enable enables persistence for the local registry"},"size":{"type":"string","description":"Size of the persistent volume for local docker registry storage. Default is `5Gi`"},"storageClassName":{"type":"string","description":"StorageClassName of the persistent volume. Default is your cluster's configured default storage class"}},"type":"object","description":"LocalRegistryPersistence configures persistence settings for the local registry"},"Logs":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enabled can be used to enable printing container logs"},"lastLines":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"LastLines is the amount of lines to print of the running container initially"}},"type":"object"},"OpenConfig":{"properties":{"url":{"type":"string","description":"URL is the url to open in the browser after it is available"}},"type":"object","description":"OpenConfig defines what to open after services have been started"},"PatchConfig":{"properties":{"op":{"type":"string","description":"Operation is the path operation to do. Can be either replace, add or remove"},"path":{"type":"string","description":"Path is the config path to apply the patch to"},"value":{"description":"Value is the value to use for this patch."}},"type":"object","required":["op","path"],"description":"PatchConfig describes a config patch and how it should be applied"},"PatchTarget":{"properties":{"target":{"oneOf":[{"$ref":"#/$defs/Target"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Target describes where to apply a config patch"},"op":{"type":"string","description":"Operation is the path operation to do. Can be either replace, add or remove"},"path":{"type":"string","description":"Path is the config path to apply the patch to"},"value":{"description":"Value is the value to use for this patch."}},"type":"object","required":["target","op","path"],"description":"PatchTarget describes a config patch and how it should be applied"},"PersistenceOptions":{"properties":{"size":{"type":"string","description":"Size is the size of the created persistent volume in Kubernetes size notation like 5Gi"},"storageClassName":{"type":"string","description":"StorageClassName is the storage type DevSpace should use for this persistent volume"},"accessModes":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"AccessModes are the access modes DevSpace should use for the persistent volume"},"readOnly":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"ReadOnly specifies if the volume should be read only"},"name":{"type":"string","description":"Name is the name of the PVC that should be created. If a PVC with that name\nalready exists, DevSpace will use that PVC instead of creating one."}},"type":"object","description":"PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration"},"PersistentPath":{"properties":{"path":{"type":"string","description":"Path is the container path that should get persisted. By default, DevSpace will create an init container\nthat will copy over the contents of this folder from the existing image."},"volumePath":{"type":"string","description":"VolumePath is the sub path on the volume that is mounted as persistent volume for this path"},"readOnly":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"ReadOnly will make the persistent path read only to the user"},"skipPopulate":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"SkipPopulate will not create an init container to copy over the existing contents if true"},"initContainer":{"oneOf":[{"$ref":"#/$defs/PersistentPathInitContainer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"InitContainer holds additional options for the persistent path init container"}},"type":"object","description":"PersistentPath holds options to configure persistence for DevSpace"},"PersistentPathInitContainer":{"properties":{"resources":{"oneOf":[{"$ref":"#/$defs/PodResources"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Resources are the resources used by the persistent path init container"}},"type":"object","description":"PersistentPathInitContainer defines additional options for the persistent path init container"},"Pipeline":{"properties":{"name":{"type":"string","enum":["dev","deploy","build","purge",".*"],"description":"Name of the pipeline, will be filled automatically"},"run":{"type":"string","description":"Run is the actual shell command that should be executed during this pipeline"},"flags":{"oneOf":[{"items":{"$ref":"#/$defs/PipelineFlag"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Flags are extra flags that can be used for running the pipeline via\ndevspace run-pipeline."},"continueOnError":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"ContinueOnError will not fail the whole job and pipeline if\na call within the step fails."}},"type":"object","description":"Pipeline defines what DevSpace should do."},"PipelineFlag":{"properties":{"name":{"type":"string","description":"Name is the name of the flag"},"short":{"type":"string","description":"Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'"},"type":{"type":"string","enum":["bool","int","string","stringArray"],"description":"Type is the type of the flag. Defaults to `bool`"},"default":{"description":"Default is the default value for this flag"},"description":{"type":"string","description":"Description is the description as shown in `devspace run-pipeline my-pipe -h`"}},"type":"object","description":"PipelineFlag defines an extra pipeline flag"},"PodResources":{"properties":{"requests":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Requests are the requests part of the resources"},"limits":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Limits are the limits part of the resources"}},"type":"object","description":"PodResources describes the resources section of the started kaniko pod"},"PortMapping":{"properties":{"port":{"type":"string","description":"Port is a port mapping that maps the localPort:remotePort. So if\nyou port forward the remote port will be available at the local port.\nIf you do reverse port forwarding, the local port will be available\nat the remote port in the container. If only port is specified, local and\nremote port are the same."},"bindAddress":{"type":"string","description":"BindAddress is the address DevSpace should listen on. Optional and defaults\nto localhost."}},"type":"object","required":["port"],"description":"PortMapping defines the ports for a PortMapping"},"ProxyCommand":{"properties":{"gitCredentials":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"GitCredentials configures a git credentials helper inside the container that proxies local git credentials"},"command":{"type":"string","description":"Command is the name of the command that should be available in the remote container. DevSpace\nwill create a small script for that inside the container that redirect command execution to\nthe local computer."},"localCommand":{"type":"string","description":"LocalCommand can be used to run a different command than specified via the command option. By\ndefault, this will be assumed to be the same as command."},"skipContainerEnv":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"SkipContainerEnv will not forward the container environment variables to the local command"},"env":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Env are extra environment variables to set for the command"}},"type":"object"},"PullSecretConfig":{"properties":{"name":{"type":"string","description":"Name is the pull secret name to deploy"},"registry":{"type":"string","description":"The registry to create the image pull secret for.\nEmpty string == docker hub\ne.g. gcr.io"},"username":{"type":"string","description":"The username of the registry. If this is empty, devspace will try\nto receive the auth data from the local docker"},"password":{"type":"string","description":"The password to use for the registry. If this is empty, devspace will\ntry to receive the auth data from the local docker"},"email":{"type":"string","description":"The optional email to use"},"secret":{"type":"string","description":"The secret to create"},"serviceAccounts":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"The service account to add the secret to"}},"type":"object","description":"PullSecretConfig defines a pull secret that should be created by DevSpace"},"RequireCommand":{"properties":{"name":{"type":"string","description":"Name is the name of the command that should be installed"},"versionArgs":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"VersionArgs are the arguments to retrieve the version of the command"},"versionRegEx":{"type":"string","description":"VersionRegEx is the regex that is used to parse the version"},"version":{"type":"string","description":"Version constraint of the command that should be installed"}},"type":"object","required":["name"]},"RequireConfig":{"properties":{"devspace":{"type":"string","description":"DevSpace specifies the DevSpace version constraint that is needed to use this config"},"commands":{"oneOf":[{"items":{"$ref":"#/$defs/RequireCommand"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Commands specifies an array of commands that need to be installed locally to use this config"},"plugins":{"oneOf":[{"items":{"$ref":"#/$defs/RequirePlugin"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Plugins specifies an array of plugins that need to be installed locally"}},"type":"object"},"RequirePlugin":{"properties":{"name":{"type":"string","description":"Name of the plugin that should be installed"},"version":{"type":"string","description":"Version constraint of the plugin that should be installed"}},"type":"object","required":["name","version"]},"RestartHelper":{"properties":{"path":{"type":"string","description":"Path defines the path to the restart helper that might be used if certain config\noptions are enabled"},"inject":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Inject signals DevSpace to inject the restart helper"}},"type":"object"},"SSH":{"properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Enabled can be used to enable the ssh server within the container. By default,\nDevSpace will generate the required keys and create an entry in your ~/.ssh/config\nfor this container that can be used via `ssh dev-config-name.dev-project-name.devspace`"},"localHostname":{"type":"string","description":"LocalHostname is the local ssh host to write to the ~/.ssh/config"},"localPort":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"LocalPort is the local port to forward from, if empty will be random"},"remoteAddress":{"type":"string","description":"RemoteAddress is the address to listen to inside the container"},"useInclude":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace\nwill also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,\nbut unfortunately not all SSH clients support this."}},"type":"object"},"SyncConfig":{"properties":{"path":{"type":"string","description":"Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.'\nto specify either the local or remote working directory. This is valid for example: .:."},"excludePaths":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"ExcludePaths is an array of file patterns in gitignore format to exclude.","group":"exclude","group_name":"Exclude Paths From File Sync"},"excludeFile":{"type":"string","description":"ExcludeFile loads the file patterns to exclude from a file.","group":"exclude"},"downloadExcludePaths":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading","group":"exclude"},"downloadExcludeFile":{"type":"string","description":"DownloadExcludeFile loads the file patterns to exclude from downloading from a file.","group":"exclude"},"uploadExcludePaths":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading","group":"exclude"},"uploadExcludeFile":{"type":"string","description":"UploadExcludeFile loads the file patterns to exclude from uploading from a file.","group":"exclude"},"startContainer":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"StartContainer will start the container after initial sync is done. This will\ninject a devspacehelper into the pod and you need to define dev.*.command for\nthis to work.","group":"actions","group_name":"Sync-Triggered Actions"},"onUpload":{"oneOf":[{"$ref":"#/$defs/SyncOnUpload"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"OnUpload can be used to execute certain commands on uploading either in the container or locally as\nwell as restart the container after a file changed has happened.","group":"actions"},"initialSync":{"type":"string","description":"InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal","group":"initial_sync","group_name":"Initial Sync"},"waitInitialSync":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done","group":"initial_sync"},"initialSyncCompareBy":{"type":"string","description":"InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible","group":"initial_sync"},"disableDownload":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableDownload will disable downloading completely","group":"one_direction","group_name":"One-Directional Sync"},"disableUpload":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableUpload will disable uploading completely","group":"one_direction"},"bandwidthLimits":{"oneOf":[{"$ref":"#/$defs/BandwidthLimits"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this\nsync configuration"},"polling":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Polling will tell the remote container to use polling instead of inotify"},"noWatch":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"NoWatch will terminate the sync after the initial sync is done"},"file":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"File signals DevSpace that this is a single file that should get synced instead of a whole directory"}},"type":"object","description":"SyncConfig defines the paths for a SyncFolder"},"SyncExec":{"properties":{"name":{"type":"string","description":"Name is the name to show for this exec in the logs"},"command":{"type":"string","description":"Command is the command to execute. If no args are specified this is executed\nwithin a shell."},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are arguments to pass to the command"},"failOnError":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"FailOnError specifies if the sync should fail if the command fails"},"local":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Local specifies if the command should be executed locally instead of within the\ncontainer"},"once":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Once executes this command only once in the container's life. Can be used to initialize\na container before starting it, but after everything was synced."},"onChange":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"OnChange is an array of file patterns that trigger this command execution"}},"type":"object"},"SyncOnUpload":{"properties":{"restartContainer":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If true restart container will try to restart the container after a change has been made. Make sure that\nimages.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper\nscript is present in the container root folder."},"exec":{"oneOf":[{"items":{"$ref":"#/$defs/SyncExec"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Exec will execute the given commands in order after a sync operation"}},"type":"object","description":"SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded"},"Target":{"properties":{"apiVersion":{"type":"string","description":"ApiVersion is the Kubernetes api of the target resource"},"kind":{"type":"string","description":"Kind is the kind of the target resource (eg: Deployment, Service ...)"},"name":{"type":"string","description":"Name is the name of the target resource"}},"type":"object","required":["apiVersion","kind","name"],"description":"Target describes where to apply a config patch"},"Terminal":{"properties":{"command":{"type":"string","description":"Command is the command that should be executed on terminal start.\nThis command is executed within a shell."},"workDir":{"type":"string","description":"WorkDir is the working directory that is used to execute the command in."},"enabled":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"If enabled is true, DevSpace will use the terminal. Can be also\nused to disable the terminal if set to false. DevSpace makes sure\nthat within a pipeline only one dev configuration can open a terminal\nat a time and subsequent dev terminals will fail."},"disableReplace":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableReplace tells DevSpace to not replace the pod or adjust its settings\nto make sure the pod is sleeping when opening a terminal"},"disableScreen":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableScreen will disable screen which is used by DevSpace by default to preserve\nsessions if connections interrupt or the session is lost."},"disableTTY":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"DisableTTY will disable a tty shell for terminal command execution"}},"type":"object","description":"Terminal describes the terminal options"},"Toleration":{"properties":{"Key":{"type":"string"},"Operator":{"type":"string"},"Value":{"type":"string"},"Effect":{"type":"string"},"TolerationSeconds":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}]}},"type":"object","required":["Key","Operator","Value","Effect","TolerationSeconds"]},"Variable":{"properties":{"name":{"type":"string","description":"Name is the name of the variable"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}],"description":"Value is a shortcut for using source: none and default: my-value","group":"static","group_name":"Static Value"},"question":{"type":"string","description":"Question can be used to define a custom question if the variable was not yet used","group":"question","group_name":"Value From Input (Question)"},"default":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}],"description":"Default is the default value the variable should have if not set by the user","group":"question"},"options":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Options are options that can be selected when the variable question is asked","group":"question"},"password":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"Password signals that this variable should not be visible if entered","group":"question"},"validationPattern":{"type":"string","description":"ValidationPattern can be used to verify the user input","group":"question"},"validationMessage":{"type":"string","description":"ValidationMessage can be used to tell the user the format of the variable value","group":"question"},"noCache":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"NoCache can be used to prompt the user on every run for this variable","group":"question"},"command":{"type":"string","description":"Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell\ncommand.","group":"execution","group_name":"Value From Command"},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are optional args that will be used for the command","group":"execution"},"commands":{"oneOf":[{"items":{"$ref":"#/$defs/VariableCommand"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Commands are additional commands that can be used to run a different command on a different operating\nsystem.","group":"execution"},"alwaysResolve":{"oneOf":[{"type":"boolean"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"},{"type":"string","pattern":"(\\$+!?\\{[a-zA-Z0-9\\-\\_\\.]+\\})"}],"description":"AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false."},"source":{"type":"string","enum":["all","env","input","command","none"],"description":"Source defines where the variable should be taken from"}},"type":"object","description":"Variable describes the var definition"},"VariableCommand":{"properties":{"os":{"type":"string","description":"OperatingSystem is optional and defines the operating system this\ncommand should be executed on"},"command":{"type":"string","description":"Command is the command to use to retrieve the value for this variable. If no\nargs are specified the command is run within a pseudo shell."},"args":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Args are optional arguments for the command"}},"type":"object"}},"properties":{"version":{"type":"string","description":"Version holds the config version. DevSpace will always convert older configs to the current latest\nconfig version, which makes it possible to use the newest DevSpace version also with older config\nversions."},"name":{"type":"string","description":"Name specifies the name of the DevSpace project and uniquely identifies a project.\nDevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace.\nIf not provided, DevSpace will use the name of the current working directory."},"imports":{"oneOf":[{"items":{"$ref":"#/$defs/Import"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration\ninto multiple files and reuse those through git, a remote url or common local path."},"functions":{"oneOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by\nimports."},"pipelines":{"anyOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"patternProperties":{".*":{"$ref":"#/$defs/Pipeline"}},"type":"object"},{"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge\nis called. Pipelines are defined through a special POSIX script that allows you to use special commands\nsuch as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute\na specific functionality. The pipelines dev, build, deploy and purge are special and will override\nthe default functionality of the respective command if defined. All other pipelines can be either run\nvia the devspace run-pipeline command or used within another pipeline through run_pipelines."},"images":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/Image"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.\nIf you are using a custom pipeline, you can dynamically define which image is built at which time during the\nexecution."},"deployments":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/DeploymentConfig"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.\nIf you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the\nexecution."},"dev":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/DevPod"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod\nor even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.\nDev allows you to:\n- sync local folders to the Kubernetes pod\n- port forward remote ports to your local computer\n- forward local ports into the Kubernetes pod\n- configure an ssh tunnel to the Kubernetes pod\n- proxy local commands to the container\n- restart the container on file changes"},"vars":{"anyOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"patternProperties":{".*":{"$ref":"#/$defs/Variable"}},"type":"object"},{"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Vars are config variables that can be used inside other config sections to replace certain values dynamically"},"commands":{"anyOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"patternProperties":{".*":{"$ref":"#/$defs/CommandConfig"}},"type":"object"},{"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash\nthat also allows executing special commands such as run_watch or is_equal."},"dependencies":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/DependencyConfig"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed\nfrom within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects\nthat typically lie including source code in a different folder and can be used to compose a full microservice\napplication that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use\nthe same project multiple times, make sure to use a different name for each of those instances."},"pullSecrets":{"oneOf":[{"patternProperties":{".*":{"$ref":"#/$defs/PullSecretConfig"}},"type":"object"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"PullSecrets are image pull secrets that will be created by devspace in the target namespace\nduring devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single\none or the one specified."},"require":{"oneOf":[{"$ref":"#/$defs/RequireConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not\nfulfilled, DevSpace will fail."},"hooks":{"oneOf":[{"items":{"$ref":"#/$defs/HookConfig"},"type":"array"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"Hooks are actions that are executed at certain points within the pipeline. Hooks are ordered and are executed\nin the order they are specified. They are deprecated and pipelines should be used instead."},"localRegistry":{"oneOf":[{"$ref":"#/$defs/LocalRegistryConfig"},{"type":"string","pattern":"(?ms)^\\$\\$?\\#?\\!?\\((.+)\\)$"}],"description":"LocalRegistry specifies the configuration for a local image registry"}},"type":"object","required":["version","name"],"description":"Config defines the configuration"}
|
Provide a JSON object that satisfies the schema "devspace-schema". Here are the required top‑level fields: version, name. Return only the valid JSON object.
|
devspace-schema
|
schema-store
|
schema_store_261
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"id\":\"https://github.com/erda-project/erda/.erda/schemas/dice.yaml.json\",\"title\":\"Erda dice.yml Schema\",\"type\":\"object\",\"properties\":{\"$schema\":{\"type\":\"string\",\"default\":\"https://github.com/erda-project/erda/raw/master/.erda/schemas/dice.yaml.json\"},\"version\":{\"description\":\"dice.yml \\u8bed\\u6cd5\\u89c4\\u8303\\u7248\\u672c\",\"type\":\"string\",\"default\":\"2.0\"},\"meta\":{\"description\":\"dice.yml \\u7684\\u5143\\u6570\\u636e\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"envs\":{\"description\":\"\\u5168\\u5c40\\u73af\\u5883\\u53d8\\u91cf, \\u4f18\\u5148\\u7ea7\\u4f4e\\u4e8e service \\u6216 job \\u81ea\\u8eab\\u7684\\u73af\\u5883\\u53d8\\u91cf\",\"$ref\":\"#/definitions/EnvMap\"},\"services\":{\"description\":\"\\u5b9a\\u4e49\\u670d\\u52a1\\u5217\\u8868, \\u4e00\\u4e2a dice.yml \\u4e0d\\u80fd\\u540c\\u65f6\\u5b9a\\u4e49 services \\u548c jobs\",\"$ref\":\"#/definitions/Services\"},\"jobs\":{\"description\":\"\\u5b9a\\u4e49\\u4efb\\u52a1\\u5217\\u8868, \\u4e00\\u4e2a dice.yml \\u4e0d\\u80fd\\u540c\\u65f6\\u5b9a\\u4e49 services \\u548c jobs\",\"$ref\":\"#/definitions/Jobs\"},\"addons\":{\"$ref\":\"#/definitions/AddOns\",\"description\":\"\\u5b9a\\u4e49\\u670d\\u52a1\\u6240\\u9700\\u7684\\u4e2d\\u95f4\\u4ef6, \\u4e2d\\u95f4\\u4ef6\\u7684\\u76f8\\u5173\\u53d8\\u91cf\\u4ee5\\u73af\\u5883\\u53d8\\u91cf\\u65b9\\u5f0f\\u6ce8\\u5165\"},\"environments\":{\"description\":\"\\u5982\\u679c\\u5404\\u73af\\u5883\\u6709\\u73af\\u5883\\u53d8\\u91cf, Services, Addons \\u5b9a\\u4e49\\u6709\\u5dee\\u5f02, \\u53ef\\u4ee5\\u5728\\u6b64\\u5904\\u8fdb\\u884c\\u5dee\\u5f02\\u5316\\u5b9a\\u4e49\",\"$ref\":\"#/definitions/EnvObjects\"},\"values\":{\"description\":\"\\u5b9a\\u4e49\\u5404\\u73af\\u5883\\u7684 key-values, \\u53ef\\u4ee5\\u5728\\u5176\\u4ed6\\u5b57\\u6bb5\\u7684\\u503c\\u4e2d\\u5f15\\u7528\",\"$ref\":\"#/definitions/ValueObjects\"}},\"required\":[\"version\"],\"dependencies\":{\"services\":{\"oneOf\":[{\"required\":[\"services\"]},{\"required\":[\"jobs\"]}]},\"jobs\":{\"oneOf\":[{\"required\":[\"services\"]},{\"required\":[\"jobs\"]}]}},\"description\":\"services \\u4e0e jobs \\u4e0d\\u80fd\\u540c\\u65f6\\u5b58\\u5728\\u4e8e\\u4e00\\u4e2a dice.yml \\u4e2d\",\"additionalProperties\":false,\"definitions\":{\"Services\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Service\"}},\"Service\":{\"type\":\"object\",\"properties\":{\"image\":{\"description\":\"\\u670d\\u52a1\\u955c\\u50cf\",\"type\":\"string\"},\"image_username\":{\"description\":\"\\u62c9\\u53d6\\u955c\\u50cf\\u7684\\u7528\\u6237\\u540d\",\"type\":\"string\"},\"image_password\":{\"description\":\"\\u62c9\\u53d6\\u955c\\u50cf\\u7684\\u5bc6\\u7801\",\"type\":\"string\"},\"cmd\":{\"description\":\"\\u542f\\u52a8\\u547d\\u4ee4, \\u4e0d\\u586b\\u5219\\u6309\\u955c\\u50cf\\u7684 Entrypoint \\u542f\\u52a8\",\"type\":\"string\"},\"ports\":{\"description\":\"\\u8981\\u542f\\u7528\\u7684\\u7aef\\u53e3\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ServicePort\"}},\"envs\":{\"description\":\"\\u73af\\u5883\\u53d8\\u91cf, \\u4f18\\u5148\\u7ea7\\u9ad8\\u4e8e\\u5168\\u5c40\\u73af\\u5883\\u53d8\\u91cf\",\"$ref\":\"#/definitions/EnvMap\"},\"hosts\":{\"description\":\"\\u57df\\u540d\\u5217\\u8868, \\u53ef\\u4ee5\\u5f15\\u7528 values \\u4e2d\\u5b9a\\u4e49\\u7684\\u503c\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"resources\":{\"description\":\"\\u670d\\u52a1 (Pod) \\u4f7f\\u7528\\u7684\\u8d44\\u6e90\",\"$ref\":\"#/definitions/Resources\"},\"labels\":{\"description\":\"\\u670d\\u52a1\\u6807\\u7b7e\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"annotations\":{\"description\":\"\\u6ce8\\u89e3\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"binds\":{\"description\":\"\\u6587\\u4ef6\\u6302\\u8f7d\",\"$ref\":\"#/definitions/Binds\"},\"volumes\":{\"description\":\"\\u5b9a\\u4e49\\u5377\",\"$ref\":\"#/definitions/Volumes\"},\"deployments\":{\"description\":\"\\u5b9a\\u4e49 K8s Deployment \\u7ec6\\u8282\",\"$ref\":\"#/definitions/Deployments\"},\"depends_on\":{\"description\":\"\\u4f9d\\u8d56\\u7684\\u670d\\u52a1\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"expose\":{\"description\":\"\\u8981\\u5f00\\u653e\\u7684\\u7aef\\u53e3, Erda \\u4f1a\\u521b\\u5efa\\u4e00\\u4e2a K8s Service \\u5e76\\u5f00\\u653e\\u8fd9\\u4e9b\\u7aef\\u53e3\",\"type\":\"array\",\"items\":{\"type\":\"integer\",\"default\":8080}},\"health_check\":{\"description\":\"\\u5065\\u5eb7\\u68c0\\u67e5, \\u5373\\u670d\\u52a1\\u53ef\\u63d0\\u4f9b\\u670d\\u52a1\\u7684\\u6761\\u4ef6\",\"$ref\":\"#/definitions/HealthCheck\"},\"sidecars\":{\"description\":\"\\u5b9a\\u4e49\\u8fb9\\u8f66\\u5bb9\\u5668, \\u5982\\u65e5\\u5fd7\\u6536\\u96c6, \\u7f51\\u7edc\\u4ee3\\u7406\\u7b49\",\"type\":\"object\",\"patternProperties\":{\"^[A-za-z].*\":{\"$ref\":\"#/definitions/SideCar\"}}},\"init\":{\"description\":\"\\u5b9a\\u4e49\\u521d\\u59cb\\u5316\\u5bb9\\u5668, \\u5982\\u6570\\u636e\\u51c6\\u5907, migration \\u7b49\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/InitContainer\"}},\"mesh_enable\":{\"deprecationMessage\":\"Erda \\u5df2\\u4e0d\\u652f\\u6301\\u8be5\\u529f\\u80fd\",\"type\":\"boolean\"},\"traffic_security\":{\"description\":\"\\u5b9a\\u4e49\\u6d41\\u91cf\\u5b89\\u5168\\u7b56\\u7565 (\\u4f1a\\u5f15\\u7528\\u7f51\\u5173)\",\"$ref\":\"#/definitions/TrafficSecurity\"},\"endpoints\":{\"description\":\"\\u5b9a\\u4e49\\u57df\\u540d, \\u53ef\\u4ee5\\u5f15\\u7528 values \\u4e2d\\u5b9a\\u4e49\\u7684\\u503c\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Endpoint\"}},\"k8s_snippet\":{\"description\":\"\\u5b9a\\u4e49\\u5bb9\\u5668\\u7ec6\\u8282\",\"$ref\":\"#/definitions/K8SSnippet\"}}},\"ServicePort\":{\"type\":\"object\",\"properties\":{\"port\":{\"description\":\"\\u542f\\u7528\\u7684\\u7aef\\u53e3\\u53f7\",\"type\":\"integer\",\"default\":8080},\"protocol\":{\"description\":\"4/7 \\u5c42\\u7f51\\u7edc\\u534f\\u8bae\",\"type\":\"string\",\"default\":\"TCP\"},\"l4_protocol\":{\"description\":\"4 \\u5c42\\u7f51\\u7edc\\u534f\\u8bae\",\"type\":\"string\",\"enum\":[\"TCP\",\"UDP\"],\"default\":\"TCP\"},\"expose\":{\"description\":\"\\u662f\\u5426\\u5f00\\u653e\\u8be5\\u7aef\\u53e3\",\"type\":\"boolean\",\"default\":false},\"default\":{\"description\":\"\\u662f\\u5426\\u4e3a\\u9ed8\\u8ba4\\u7aef\\u53e3, \\u8bbe\\u7f6e\\u57df\\u540d\\u65f6\\u4f1a\\u5c06\\u5bf9\\u8be5\\u57df\\u540d\\u7684\\u8bbf\\u95ee\\u53cd\\u5411\\u4ee3\\u7406\\u5230\\u9ed8\\u8ba4\\u7aef\\u53e3\",\"type\":\"boolean\",\"default\":false}}},\"EnvMap\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Z][^a-z]*$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"number\"},{\"type\":\"boolean\"}]}},\"additionalProperties\":false},\"Resources\":{\"description\":\"\\u53ef\\u4ee5\\u7528 cpu: ${request_cpu:1} \\u5f15\\u7528 values \\u548c\\u8bbe\\u7f6e\\u9ed8\\u8ba4\\u503c\",\"type\":\"object\",\"properties\":{\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\"}],\"description\":\"CPU \\u6838\\u5fc3\\u6570, \\u5bf9\\u5e94 K8s \\u4e2d request \\u503c.\\n\\u53ef\\u4ee5\\u7528 ${request_cpu:1} \\u5f15\\u7528 values \\u548c\\u8bbe\\u7f6e\\u9ed8\\u8ba4\\u503c\",\"examples\":[\"${request_cpu:1}\"],\"default\":1},\"mem\":{\"description\":\"\\u5185\\u5b58\\u6570, \\u5355\\u4f4d M\",\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]},\"max_cpu\":{\"description\":\"\\u6700\\u5927 CPU \\u6838\\u5fc3\\u6570\",\"type\":\"number\"},\"max_mem\":{\"description\":\"\\u6700\\u5927\\u5185\\u5b58\\u6570\",\"type\":\"integer\"},\"disk\":{\"description\":\"\\u78c1\\u76d8\\u8bf7\\u6c42\\u91cf\",\"type\":\"integer\"},\"network\":{\"description\":\"\\u7f51\\u7edc\\u914d\\u7f6e\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"emptydir_size\":{\"type\":\"integer\"},\"ephemeral_storage_size\":{\"type\":\"integer\"}}},\"Binds\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"Jobs\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Job\"}},\"AddOns\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/AddOn\"}},\"ValueObjects\":{\"type\":\"object\",\"patternProperties\":{\"development|test|staging|production\":{\"$ref\":\"#/definitions/ValueMap\"}}},\"Volume\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"storage\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"size\":{\"type\":\"integer\"},\"targetPath\":{\"type\":\"string\"},\"readOnly\":{\"type\":\"boolean\"},\"snapshot\":{\"$ref\":\"#/definitions/VolumeSnapshot\"}}},\"Deployments\":{\"type\":\"object\",\"properties\":{\"replicas\":{\"description\":\"Pod \\u526f\\u672c\\u6570\",\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]},\"policies\":{\"description\":\"\\u7b56\\u7565\",\"type\":\"string\"},\"labels\":{\"description\":\"\\u6807\\u7b7e\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"workload\":{\"description\":\"\\u8d1f\\u8f7d\",\"type\":\"string\"},\"selectors\":{\"description\":\"K8s selector\",\"$ref\":\"#/definitions/Selectors\"}}},\"HealthCheck\":{\"type\":\"object\",\"properties\":{\"http\":{\"description\":\"\\u901a\\u8fc7 HTTP \\u63a5\\u53e3\\u8fdb\\u884c\\u5065\\u5eb7\\u68c0\\u67e5\",\"$ref\":\"#/definitions/HTTPCheck\",\"default\":{\"port\":8080,\"path\":\"/api/health\",\"duration\":120}},\"exec\":{\"description\":\"\\u901a\\u8fc7\\u6267\\u884c\\u5bb9\\u5668\\u547d\\u4ee4\\u8fdb\\u884c\\u5065\\u5eb7\\u68c0\\u67e5\",\"$ref\":\"#/definitions/ExecCheck\"}}},\"SideCar\":{\"type\":\"object\",\"properties\":{\"image\":{\"description\":\"\\u5bb9\\u5668\\u955c\\u50cf\",\"type\":\"string\"},\"cmd\":{\"description\":\"\\u5bb9\\u5668\\u542f\\u52a8\\u547d\\u4ee4\",\"type\":\"string\"},\"envs\":{\"description\":\"\\u5bb9\\u5668\\u73af\\u5883\\u53d8\\u91cf\",\"$ref\":\"#/definitions/EnvMap\"},\"resources\":{\"description\":\"\\u5bb9\\u5668\\u8d44\\u6e90\",\"$ref\":\"#/definitions/Resources\"}}},\"InitContainer\":{\"type\":\"object\",\"properties\":{\"image\":{\"description\":\"\\u5bb9\\u5668\\u955c\\u50cf\",\"type\":\"string\"},\"shared_dir\":{\"description\":\"\\u5171\\u4eab\\u76ee\\u5f55\",\"type\":\"array\",\"items\":{\"description\":\"\\u5171\\u4eab\\u76ee\\u5f55\\u5217\\u8868\",\"$ref\":\"#/definitions/SharedDir\"}},\"cmd\":{\"description\":\"\\u5bb9\\u5668\\u542f\\u52a8\\u547d\\u4ee4\",\"type\":\"string\"},\"resources\":{\"description\":\"\\u5bb9\\u5668\\u8d44\\u6e90\",\"$ref\":\"#/definitions/Resources\"}}},\"TrafficSecurity\":{\"type\":\"object\",\"properties\":{\"mode\":{\"description\":\"\\u6d41\\u91cf\\u5b89\\u5168\\u7b56\\u7565\\u6a21\\u5f0f\",\"type\":\"string\"}}},\"Endpoint\":{\"type\":\"object\",\"properties\":{\"domain\":{\"description\":\"\\u57df\\u540d, \\u5c06\\u8be5\\u670d\\u52a1\\u7684\\u63a5\\u53e3\\u805a\\u5408\\u5230\\u8be5\\u57df\\u540d\\u4e0b\",\"type\":\"string\"},\"path\":{\"description\":\"\\u805a\\u5408\\u8def\\u7531\\u7684\\u8def\\u7531\\u8def\\u5f84\",\"type\":\"string\"},\"backend_path\":{\"description\":\"\\u805a\\u5408\\u8def\\u7531\\u7684\\u540e\\u7aef\\u670d\\u52a1\\u8def\\u5f84\",\"type\":\"string\"},\"policies\":{\"description\":\"\\u8def\\u7531\\u7b56\\u7565\",\"$ref\":\"#/definitions/EndpointPolicies\"}}},\"K8SSnippet\":{\"type\":\"object\",\"description\":\"\\u5b9a\\u4e49\\u5bb9\\u5668\\u7ec6\\u8282, \\u9700\\u8981\\u719f\\u6089 Kubernetes, \\u53c2\\u8003 k8s.io/api/core/v1.Container\",\"properties\":{\"container\":{\"description\":\"\\u5b9a\\u4e49\\u5bb9\\u5668\\u7ec6\\u8282, \\u9700\\u8981\\u719f\\u6089 Kubernetes, \\u53c2\\u8003 k8s.io/api/core/v1.Container\",\"$ref\":\"#/definitions/ContainerSnippet\"}}},\"Job\":{\"type\":\"object\",\"properties\":{\"image\":{\"description\":\"\\u5bb9\\u5668\\u955c\\u50cf\",\"type\":\"string\"},\"cmd\":{\"description\":\"\\u5bb9\\u5668\\u542f\\u52a8\\u547d\\u4ee4, \\u5982\\u4e0d\\u586b\\u5219\\u9ed8\\u8ba4\\u4e3a\\u5bb9\\u5668\\u7684 Entrypoint\",\"type\":\"string\"},\"envs\":{\"description\":\"\\u5bb9\\u5668\\u73af\\u5883\\u53d8\\u91cf\",\"$ref\":\"#/definitions/EnvMap\"},\"resources\":{\"description\":\"\\u5b9a\\u4e49 Pod \\u8fd0\\u884c\\u6240\\u8bf7\\u6c42\\u7684\\u8d44\\u6e90\",\"$ref\":\"#/definitions/Resources\"},\"labels\":{\"description\":\"\\u5b9a\\u4e49 Pod \\u6807\\u7b7e\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"binds\":{\"description\":\"\\u5b9a\\u4e49\\u6302\\u8f7d\\u7684\\u76ee\\u5f55\",\"$ref\":\"#/definitions/Binds\"},\"volumes\":{\"description\":\"\\u5b9a\\u4e49\\u5377\",\"$ref\":\"#/definitions/Volumes\"},\"init\":{\"description\":\"\\u5b9a\\u4e49\\u521d\\u59cb\\u5316\\u5bb9\\u5668, \\u5982\\u6570\\u636e\\u51c6\\u5907, migration \\u7b49\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/InitContainer\"}},\"hosts\":{\"description\":\"\\u5b9a\\u4e49\\u670d\\u52a1\\u57df\\u540d\",\"type\":\"string\",\"items\":{\"type\":\"string\"}}}},\"Volumes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Volume\"}},\"AddOn\":{\"type\":\"object\",\"properties\":{\"plan\":{\"description\":\"\\u4e2d\\u95f4\\u4ef6 engine \\u548c\\u89c4\\u683c, \\u5982 mysql:basic\",\"type\":\"string\"},\"as\":{\"type\":\"string\"},\"options\":{\"type\":\"object\",\"description\":\"\\u4e2d\\u95f4\\u4ef6\\u7684\\u5143\\u6570\\u636e\\u548c\\u914d\\u7f6e\",\"additionalProperties\":{\"type\":\"string\"}},\"actions\":{\"type\":\"object\",\"additionalProperties\":true},\"image\":{\"description\":\"\\u4e2d\\u95f4\\u4ef6\\u955c\\u50cf\",\"type\":\"string\"}}},\"ValueMap\":{\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"number\"},{\"type\":\"boolean\"}]}},\"VolumeSnapshot\":{\"type\":\"object\",\"properties\":{\"maxHistory\":{\"type\":\"integer\"}}},\"Selectors\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Selector\"}},\"HTTPCheck\":{\"type\":\"object\",\"properties\":{\"port\":{\"description\":\"\\u7aef\\u53e3\",\"type\":\"integer\",\"default\":8080},\"path\":{\"description\":\"\\u8def\\u5f84\",\"type\":\"string\",\"default\":\"/api/health\"},\"duration\":{\"description\":\"\\u6267\\u884c\\u5065\\u5eb7\\u68c0\\u67e5\\u7684\\u95f4\\u9694\\u65f6\\u95f4\",\"type\":\"integer\",\"default\":120}}},\"ExecCheck\":{\"type\":\"object\",\"properties\":{\"cmd\":{\"description\":\"\\u6267\\u884c\\u5065\\u5eb7\\u68c0\\u67e5\\u7684\\u5bb9\\u5668\\u547d\\u4ee4\",\"type\":\"string\"},\"duration\":{\"description\":\"\\u6267\\u884c\\u5065\\u5eb7\\u68c0\\u67e5\\u7684\\u95f4\\u9694\\u65f6\\u95f4\",\"type\":\"integer\"}}},\"SharedDir\":{\"type\":\"object\",\"properties\":{\"main\":{\"description\":\"\\u4e3b\\u5bb9\\u5668\\u7684\\u76ee\\u5f55\",\"type\":\"string\"},\"sidecar\":{\"description\":\"\\u8fb9\\u8f66\\u5bb9\\u5668\\u7684\\u76ee\\u5f55\",\"type\":\"string\"}}},\"EndpointPolicies\":{\"type\":\"object\",\"properties\":{\"cors\":{\"description\":\"\\u8de8\\u57df\\u7b56\\u7565\",\"type\":\"object\",\"additionalProperties\":true},\"rate_limit\":{\"description\":\"\\u9650\\u6d41\\u7b56\\u7565\",\"type\":\"object\",\"additionalProperties\":true}}},\"Selector\":{\"type\":\"object\",\"properties\":{\"not\":{\"type\":\"boolean\"},\"values\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ContainerSnippet\":{\"description\":\"\\u53c2\\u8003 k8s.io/api/core/v1.Container\",\"type\":\"object\",\"additionalProperties\":true},\"EnvObjects\":{\"type\":\"object\",\"patternProperties\":{\"development|test|staging|production\":{\"$ref\":\"#/definitions/EnvObject\"}}},\"EnvObject\":{\"type\":\"object\",\"properties\":{\"envs\":{\"description\":\"\\u73af\\u5883\\u53d8\\u91cf\",\"$ref\":\"#/definitions/EnvMap\"},\"services\":{\"description\":\"\\u670d\\u52a1\\u5217\\u8868\",\"$ref\":\"#/definitions/Services\"},\"addons\":{\"description\":\"\\u4e2d\\u95f4\\u4ef6\\u5217\\u8868\",\"$ref\":\"#/definitions/AddOns\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Erda dice.yml Schema\". Here are the required top‑level fields: version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","id":"https://github.com/erda-project/erda/.erda/schemas/dice.yaml.json","title":"Erda dice.yml Schema","type":"object","properties":{"$schema":{"type":"string","default":"https://github.com/erda-project/erda/raw/master/.erda/schemas/dice.yaml.json"},"version":{"description":"dice.yml \u8bed\u6cd5\u89c4\u8303\u7248\u672c","type":"string","default":"2.0"},"meta":{"description":"dice.yml \u7684\u5143\u6570\u636e","type":"object","additionalProperties":{"type":"string"}},"envs":{"description":"\u5168\u5c40\u73af\u5883\u53d8\u91cf, \u4f18\u5148\u7ea7\u4f4e\u4e8e service \u6216 job \u81ea\u8eab\u7684\u73af\u5883\u53d8\u91cf","$ref":"#/definitions/EnvMap"},"services":{"description":"\u5b9a\u4e49\u670d\u52a1\u5217\u8868, \u4e00\u4e2a dice.yml \u4e0d\u80fd\u540c\u65f6\u5b9a\u4e49 services \u548c jobs","$ref":"#/definitions/Services"},"jobs":{"description":"\u5b9a\u4e49\u4efb\u52a1\u5217\u8868, \u4e00\u4e2a dice.yml \u4e0d\u80fd\u540c\u65f6\u5b9a\u4e49 services \u548c jobs","$ref":"#/definitions/Jobs"},"addons":{"$ref":"#/definitions/AddOns","description":"\u5b9a\u4e49\u670d\u52a1\u6240\u9700\u7684\u4e2d\u95f4\u4ef6, \u4e2d\u95f4\u4ef6\u7684\u76f8\u5173\u53d8\u91cf\u4ee5\u73af\u5883\u53d8\u91cf\u65b9\u5f0f\u6ce8\u5165"},"environments":{"description":"\u5982\u679c\u5404\u73af\u5883\u6709\u73af\u5883\u53d8\u91cf, Services, Addons \u5b9a\u4e49\u6709\u5dee\u5f02, \u53ef\u4ee5\u5728\u6b64\u5904\u8fdb\u884c\u5dee\u5f02\u5316\u5b9a\u4e49","$ref":"#/definitions/EnvObjects"},"values":{"description":"\u5b9a\u4e49\u5404\u73af\u5883\u7684 key-values, \u53ef\u4ee5\u5728\u5176\u4ed6\u5b57\u6bb5\u7684\u503c\u4e2d\u5f15\u7528","$ref":"#/definitions/ValueObjects"}},"required":["version"],"dependencies":{"services":{"oneOf":[{"required":["services"]},{"required":["jobs"]}]},"jobs":{"oneOf":[{"required":["services"]},{"required":["jobs"]}]}},"description":"services \u4e0e jobs \u4e0d\u80fd\u540c\u65f6\u5b58\u5728\u4e8e\u4e00\u4e2a dice.yml \u4e2d","additionalProperties":false,"definitions":{"Services":{"type":"object","additionalProperties":{"$ref":"#/definitions/Service"}},"Service":{"type":"object","properties":{"image":{"description":"\u670d\u52a1\u955c\u50cf","type":"string"},"image_username":{"description":"\u62c9\u53d6\u955c\u50cf\u7684\u7528\u6237\u540d","type":"string"},"image_password":{"description":"\u62c9\u53d6\u955c\u50cf\u7684\u5bc6\u7801","type":"string"},"cmd":{"description":"\u542f\u52a8\u547d\u4ee4, \u4e0d\u586b\u5219\u6309\u955c\u50cf\u7684 Entrypoint \u542f\u52a8","type":"string"},"ports":{"description":"\u8981\u542f\u7528\u7684\u7aef\u53e3","type":"array","items":{"$ref":"#/definitions/ServicePort"}},"envs":{"description":"\u73af\u5883\u53d8\u91cf, \u4f18\u5148\u7ea7\u9ad8\u4e8e\u5168\u5c40\u73af\u5883\u53d8\u91cf","$ref":"#/definitions/EnvMap"},"hosts":{"description":"\u57df\u540d\u5217\u8868, \u53ef\u4ee5\u5f15\u7528 values \u4e2d\u5b9a\u4e49\u7684\u503c","type":"array","items":{"type":"string"}},"resources":{"description":"\u670d\u52a1 (Pod) \u4f7f\u7528\u7684\u8d44\u6e90","$ref":"#/definitions/Resources"},"labels":{"description":"\u670d\u52a1\u6807\u7b7e","type":"object","additionalProperties":{"type":"string"}},"annotations":{"description":"\u6ce8\u89e3","type":"object","additionalProperties":{"type":"string"}},"binds":{"description":"\u6587\u4ef6\u6302\u8f7d","$ref":"#/definitions/Binds"},"volumes":{"description":"\u5b9a\u4e49\u5377","$ref":"#/definitions/Volumes"},"deployments":{"description":"\u5b9a\u4e49 K8s Deployment \u7ec6\u8282","$ref":"#/definitions/Deployments"},"depends_on":{"description":"\u4f9d\u8d56\u7684\u670d\u52a1","type":"array","items":{"type":"string"}},"expose":{"description":"\u8981\u5f00\u653e\u7684\u7aef\u53e3, Erda \u4f1a\u521b\u5efa\u4e00\u4e2a K8s Service \u5e76\u5f00\u653e\u8fd9\u4e9b\u7aef\u53e3","type":"array","items":{"type":"integer","default":8080}},"health_check":{"description":"\u5065\u5eb7\u68c0\u67e5, \u5373\u670d\u52a1\u53ef\u63d0\u4f9b\u670d\u52a1\u7684\u6761\u4ef6","$ref":"#/definitions/HealthCheck"},"sidecars":{"description":"\u5b9a\u4e49\u8fb9\u8f66\u5bb9\u5668, \u5982\u65e5\u5fd7\u6536\u96c6, \u7f51\u7edc\u4ee3\u7406\u7b49","type":"object","patternProperties":{"^[A-za-z].*":{"$ref":"#/definitions/SideCar"}}},"init":{"description":"\u5b9a\u4e49\u521d\u59cb\u5316\u5bb9\u5668, \u5982\u6570\u636e\u51c6\u5907, migration \u7b49","type":"object","additionalProperties":{"$ref":"#/definitions/InitContainer"}},"mesh_enable":{"deprecationMessage":"Erda \u5df2\u4e0d\u652f\u6301\u8be5\u529f\u80fd","type":"boolean"},"traffic_security":{"description":"\u5b9a\u4e49\u6d41\u91cf\u5b89\u5168\u7b56\u7565 (\u4f1a\u5f15\u7528\u7f51\u5173)","$ref":"#/definitions/TrafficSecurity"},"endpoints":{"description":"\u5b9a\u4e49\u57df\u540d, \u53ef\u4ee5\u5f15\u7528 values \u4e2d\u5b9a\u4e49\u7684\u503c","type":"array","items":{"$ref":"#/definitions/Endpoint"}},"k8s_snippet":{"description":"\u5b9a\u4e49\u5bb9\u5668\u7ec6\u8282","$ref":"#/definitions/K8SSnippet"}}},"ServicePort":{"type":"object","properties":{"port":{"description":"\u542f\u7528\u7684\u7aef\u53e3\u53f7","type":"integer","default":8080},"protocol":{"description":"4/7 \u5c42\u7f51\u7edc\u534f\u8bae","type":"string","default":"TCP"},"l4_protocol":{"description":"4 \u5c42\u7f51\u7edc\u534f\u8bae","type":"string","enum":["TCP","UDP"],"default":"TCP"},"expose":{"description":"\u662f\u5426\u5f00\u653e\u8be5\u7aef\u53e3","type":"boolean","default":false},"default":{"description":"\u662f\u5426\u4e3a\u9ed8\u8ba4\u7aef\u53e3, \u8bbe\u7f6e\u57df\u540d\u65f6\u4f1a\u5c06\u5bf9\u8be5\u57df\u540d\u7684\u8bbf\u95ee\u53cd\u5411\u4ee3\u7406\u5230\u9ed8\u8ba4\u7aef\u53e3","type":"boolean","default":false}}},"EnvMap":{"type":"object","patternProperties":{"^[A-Z][^a-z]*$":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]}},"additionalProperties":false},"Resources":{"description":"\u53ef\u4ee5\u7528 cpu: ${request_cpu:1} \u5f15\u7528 values \u548c\u8bbe\u7f6e\u9ed8\u8ba4\u503c","type":"object","properties":{"cpu":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"CPU \u6838\u5fc3\u6570, \u5bf9\u5e94 K8s \u4e2d request \u503c.\n\u53ef\u4ee5\u7528 ${request_cpu:1} \u5f15\u7528 values \u548c\u8bbe\u7f6e\u9ed8\u8ba4\u503c","examples":["${request_cpu:1}"],"default":1},"mem":{"description":"\u5185\u5b58\u6570, \u5355\u4f4d M","anyOf":[{"type":"integer"},{"type":"string"}]},"max_cpu":{"description":"\u6700\u5927 CPU \u6838\u5fc3\u6570","type":"number"},"max_mem":{"description":"\u6700\u5927\u5185\u5b58\u6570","type":"integer"},"disk":{"description":"\u78c1\u76d8\u8bf7\u6c42\u91cf","type":"integer"},"network":{"description":"\u7f51\u7edc\u914d\u7f6e","type":"object","additionalProperties":{"type":"string"}},"emptydir_size":{"type":"integer"},"ephemeral_storage_size":{"type":"integer"}}},"Binds":{"type":"array","items":{"type":"string"}},"Jobs":{"type":"object","additionalProperties":{"$ref":"#/definitions/Job"}},"AddOns":{"type":"object","additionalProperties":{"$ref":"#/definitions/AddOn"}},"ValueObjects":{"type":"object","patternProperties":{"development|test|staging|production":{"$ref":"#/definitions/ValueMap"}}},"Volume":{"type":"object","properties":{"id":{"type":"string"},"storage":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"targetPath":{"type":"string"},"readOnly":{"type":"boolean"},"snapshot":{"$ref":"#/definitions/VolumeSnapshot"}}},"Deployments":{"type":"object","properties":{"replicas":{"description":"Pod \u526f\u672c\u6570","anyOf":[{"type":"integer"},{"type":"string"}]},"policies":{"description":"\u7b56\u7565","type":"string"},"labels":{"description":"\u6807\u7b7e","type":"object","additionalProperties":{"type":"string"}},"workload":{"description":"\u8d1f\u8f7d","type":"string"},"selectors":{"description":"K8s selector","$ref":"#/definitions/Selectors"}}},"HealthCheck":{"type":"object","properties":{"http":{"description":"\u901a\u8fc7 HTTP \u63a5\u53e3\u8fdb\u884c\u5065\u5eb7\u68c0\u67e5","$ref":"#/definitions/HTTPCheck","default":{"port":8080,"path":"/api/health","duration":120}},"exec":{"description":"\u901a\u8fc7\u6267\u884c\u5bb9\u5668\u547d\u4ee4\u8fdb\u884c\u5065\u5eb7\u68c0\u67e5","$ref":"#/definitions/ExecCheck"}}},"SideCar":{"type":"object","properties":{"image":{"description":"\u5bb9\u5668\u955c\u50cf","type":"string"},"cmd":{"description":"\u5bb9\u5668\u542f\u52a8\u547d\u4ee4","type":"string"},"envs":{"description":"\u5bb9\u5668\u73af\u5883\u53d8\u91cf","$ref":"#/definitions/EnvMap"},"resources":{"description":"\u5bb9\u5668\u8d44\u6e90","$ref":"#/definitions/Resources"}}},"InitContainer":{"type":"object","properties":{"image":{"description":"\u5bb9\u5668\u955c\u50cf","type":"string"},"shared_dir":{"description":"\u5171\u4eab\u76ee\u5f55","type":"array","items":{"description":"\u5171\u4eab\u76ee\u5f55\u5217\u8868","$ref":"#/definitions/SharedDir"}},"cmd":{"description":"\u5bb9\u5668\u542f\u52a8\u547d\u4ee4","type":"string"},"resources":{"description":"\u5bb9\u5668\u8d44\u6e90","$ref":"#/definitions/Resources"}}},"TrafficSecurity":{"type":"object","properties":{"mode":{"description":"\u6d41\u91cf\u5b89\u5168\u7b56\u7565\u6a21\u5f0f","type":"string"}}},"Endpoint":{"type":"object","properties":{"domain":{"description":"\u57df\u540d, \u5c06\u8be5\u670d\u52a1\u7684\u63a5\u53e3\u805a\u5408\u5230\u8be5\u57df\u540d\u4e0b","type":"string"},"path":{"description":"\u805a\u5408\u8def\u7531\u7684\u8def\u7531\u8def\u5f84","type":"string"},"backend_path":{"description":"\u805a\u5408\u8def\u7531\u7684\u540e\u7aef\u670d\u52a1\u8def\u5f84","type":"string"},"policies":{"description":"\u8def\u7531\u7b56\u7565","$ref":"#/definitions/EndpointPolicies"}}},"K8SSnippet":{"type":"object","description":"\u5b9a\u4e49\u5bb9\u5668\u7ec6\u8282, \u9700\u8981\u719f\u6089 Kubernetes, \u53c2\u8003 k8s.io/api/core/v1.Container","properties":{"container":{"description":"\u5b9a\u4e49\u5bb9\u5668\u7ec6\u8282, \u9700\u8981\u719f\u6089 Kubernetes, \u53c2\u8003 k8s.io/api/core/v1.Container","$ref":"#/definitions/ContainerSnippet"}}},"Job":{"type":"object","properties":{"image":{"description":"\u5bb9\u5668\u955c\u50cf","type":"string"},"cmd":{"description":"\u5bb9\u5668\u542f\u52a8\u547d\u4ee4, \u5982\u4e0d\u586b\u5219\u9ed8\u8ba4\u4e3a\u5bb9\u5668\u7684 Entrypoint","type":"string"},"envs":{"description":"\u5bb9\u5668\u73af\u5883\u53d8\u91cf","$ref":"#/definitions/EnvMap"},"resources":{"description":"\u5b9a\u4e49 Pod \u8fd0\u884c\u6240\u8bf7\u6c42\u7684\u8d44\u6e90","$ref":"#/definitions/Resources"},"labels":{"description":"\u5b9a\u4e49 Pod \u6807\u7b7e","type":"object","additionalProperties":{"type":"string"}},"binds":{"description":"\u5b9a\u4e49\u6302\u8f7d\u7684\u76ee\u5f55","$ref":"#/definitions/Binds"},"volumes":{"description":"\u5b9a\u4e49\u5377","$ref":"#/definitions/Volumes"},"init":{"description":"\u5b9a\u4e49\u521d\u59cb\u5316\u5bb9\u5668, \u5982\u6570\u636e\u51c6\u5907, migration \u7b49","type":"object","additionalProperties":{"$ref":"#/definitions/InitContainer"}},"hosts":{"description":"\u5b9a\u4e49\u670d\u52a1\u57df\u540d","type":"string","items":{"type":"string"}}}},"Volumes":{"type":"array","items":{"$ref":"#/definitions/Volume"}},"AddOn":{"type":"object","properties":{"plan":{"description":"\u4e2d\u95f4\u4ef6 engine \u548c\u89c4\u683c, \u5982 mysql:basic","type":"string"},"as":{"type":"string"},"options":{"type":"object","description":"\u4e2d\u95f4\u4ef6\u7684\u5143\u6570\u636e\u548c\u914d\u7f6e","additionalProperties":{"type":"string"}},"actions":{"type":"object","additionalProperties":true},"image":{"description":"\u4e2d\u95f4\u4ef6\u955c\u50cf","type":"string"}}},"ValueMap":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]}},"VolumeSnapshot":{"type":"object","properties":{"maxHistory":{"type":"integer"}}},"Selectors":{"type":"object","additionalProperties":{"$ref":"#/definitions/Selector"}},"HTTPCheck":{"type":"object","properties":{"port":{"description":"\u7aef\u53e3","type":"integer","default":8080},"path":{"description":"\u8def\u5f84","type":"string","default":"/api/health"},"duration":{"description":"\u6267\u884c\u5065\u5eb7\u68c0\u67e5\u7684\u95f4\u9694\u65f6\u95f4","type":"integer","default":120}}},"ExecCheck":{"type":"object","properties":{"cmd":{"description":"\u6267\u884c\u5065\u5eb7\u68c0\u67e5\u7684\u5bb9\u5668\u547d\u4ee4","type":"string"},"duration":{"description":"\u6267\u884c\u5065\u5eb7\u68c0\u67e5\u7684\u95f4\u9694\u65f6\u95f4","type":"integer"}}},"SharedDir":{"type":"object","properties":{"main":{"description":"\u4e3b\u5bb9\u5668\u7684\u76ee\u5f55","type":"string"},"sidecar":{"description":"\u8fb9\u8f66\u5bb9\u5668\u7684\u76ee\u5f55","type":"string"}}},"EndpointPolicies":{"type":"object","properties":{"cors":{"description":"\u8de8\u57df\u7b56\u7565","type":"object","additionalProperties":true},"rate_limit":{"description":"\u9650\u6d41\u7b56\u7565","type":"object","additionalProperties":true}}},"Selector":{"type":"object","properties":{"not":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}}},"ContainerSnippet":{"description":"\u53c2\u8003 k8s.io/api/core/v1.Container","type":"object","additionalProperties":true},"EnvObjects":{"type":"object","patternProperties":{"development|test|staging|production":{"$ref":"#/definitions/EnvObject"}}},"EnvObject":{"type":"object","properties":{"envs":{"description":"\u73af\u5883\u53d8\u91cf","$ref":"#/definitions/EnvMap"},"services":{"description":"\u670d\u52a1\u5217\u8868","$ref":"#/definitions/Services"},"addons":{"description":"\u4e2d\u95f4\u4ef6\u5217\u8868","$ref":"#/definitions/AddOns"}}}}}
|
Provide a JSON object that satisfies the schema "Erda dice.yml Schema". Here are the required top‑level fields: version. Return only the valid JSON object.
|
Erda dice.yml Schema
|
schema-store
|
schema_store_262
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$defs\":{\"AdvancedConfig\":{\"additionalProperties\":true,\"description\":\"This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.\",\"properties\":{\"alt_operation_matcher\":{\"default\":false,\"description\":\"Use different algorithm to match Tezos operations (dev only)\",\"title\":\"alt_operation_matcher\",\"type\":\"boolean\"},\"decimal_precision\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Overwrite precision if it's not guessed correctly based on project models.\",\"title\":\"decimal_precision\"},\"early_realtime\":{\"default\":false,\"description\":\"Establish realtime connection and start collecting messages while sync is in progress (faster, but consumes more RAM).\",\"title\":\"early_realtime\",\"type\":\"boolean\"},\"postpone_jobs\":{\"default\":false,\"description\":\"Do not start job scheduler until all indexes reach the realtime state.\",\"title\":\"postpone_jobs\",\"type\":\"boolean\"},\"reindex\":{\"additionalProperties\":{\"$ref\":\"#/$defs/ReindexingAction\"},\"description\":\"Mapping of reindexing reasons and actions DipDup performs.\",\"propertyNames\":{\"$ref\":\"#/$defs/ReindexingReason\"},\"title\":\"reindex\",\"type\":\"object\"},\"rollback_depth\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A number of blocks to keep for rollback (affects all datasources)\",\"title\":\"rollback_depth\"},\"scheduler\":{\"anyOf\":[{\"type\":\"object\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"`apscheduler` scheduler config.\",\"title\":\"scheduler\"},\"unsafe_sqlite\":{\"default\":false,\"description\":\"Disable journaling and data integrity checks. Use only for testing.\",\"title\":\"unsafe_sqlite\",\"type\":\"boolean\"},\"watchdog\":{\"additionalProperties\":{\"$ref\":\"#/$defs/WatchdogConfig\"},\"description\":\"Mapping of watchdog triggers and actions DipDup performs.\",\"propertyNames\":{\"$ref\":\"#/$defs/WatchdogTrigger\"},\"title\":\"watchdog\",\"type\":\"object\"}},\"title\":\"AdvancedConfig\",\"type\":\"object\"},\"ApiConfig\":{\"additionalProperties\":false,\"description\":\"Management API config\",\"properties\":{\"host\":{\"default\":\"127.0.0.1\",\"description\":\"Host to bind to\",\"title\":\"host\",\"type\":\"string\"},\"port\":{\"default\":46339,\"description\":\"Port to bind to\",\"title\":\"port\",\"type\":\"integer\"}},\"title\":\"ApiConfig\",\"type\":\"object\"},\"CoinbaseDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Coinbase datasource config\",\"properties\":{\"api_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API key\",\"title\":\"api_key\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"coinbase\",\"default\":\"coinbase\",\"description\":\"always 'coinbase'\",\"title\":\"kind\",\"type\":\"string\"},\"passphrase\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API passphrase\",\"title\":\"passphrase\"},\"secret_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API secret key\",\"title\":\"secret_key\"}},\"title\":\"CoinbaseDatasourceConfig\",\"type\":\"object\"},\"EvmAddress\":{\"$ref\":\"#/$defs/Hex\"},\"EvmBlockvisionDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Blockvision datasource config\",\"properties\":{\"api_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API key\",\"title\":\"api_key\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"evm.blockvision\",\"default\":\"evm.blockvision\",\"description\":\"always 'evm.blockvision'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"API URL\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"EvmBlockvisionDatasourceConfig\",\"type\":\"object\"},\"EvmContractConfig\":{\"additionalProperties\":false,\"description\":\"EVM contract config\",\"properties\":{\"abi\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract ABI\",\"title\":\"abi\"},\"address\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract address\",\"title\":\"address\"},\"kind\":{\"const\":\"evm\",\"default\":\"evm\",\"description\":\"Always `evm`\",\"title\":\"kind\",\"type\":\"string\"},\"typename\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for the contract script\",\"title\":\"typename\"}},\"title\":\"EvmContractConfig\",\"type\":\"object\"},\"EvmEtherscanDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Etherscan datasource config\",\"properties\":{\"api_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API key\",\"title\":\"api_key\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"anyOf\":[{\"const\":\"evm.etherscan\",\"type\":\"string\"},{\"const\":\"abi.etherscan\",\"type\":\"string\"}],\"default\":\"evm.etherscan\",\"description\":\"always 'evm.etherscan'\",\"title\":\"kind\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"API URL\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"EvmEtherscanDatasourceConfig\",\"type\":\"object\"},\"EvmEventsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid event handler\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/EvmContractConfig\"}],\"description\":\"EVM contract\",\"title\":\"contract\"},\"name\":{\"description\":\"Event name\",\"title\":\"name\",\"type\":\"string\"}},\"required\":[\"callback\",\"contract\",\"name\"],\"title\":\"EvmEventsHandlerConfig\",\"type\":\"object\"},\"EvmEventsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid datasource config\",\"properties\":{\"datasources\":{\"description\":\"`evm` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/EvmSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmNodeDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmSourcifyDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmBlockvisionDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmEtherscanDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Event handlers\",\"items\":{\"$ref\":\"#/$defs/EvmEventsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"evm.events\",\"default\":\"evm.events\",\"description\":\"Always 'evm.events'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing and disable this index\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"EvmEventsIndexConfig\",\"type\":\"object\"},\"EvmNodeDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"EVM node datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"evm.node\",\"default\":\"evm.node\",\"description\":\"Always 'evm.node'\",\"title\":\"kind\",\"type\":\"string\"},\"rollback_depth\":{\"default\":32,\"description\":\"A number of blocks to store in database for rollback\",\"title\":\"rollback_depth\",\"type\":\"integer\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"EVM node URL\",\"title\":\"url\"},\"ws_url\":{\"anyOf\":[{\"$ref\":\"#/$defs/WsUrl\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"EVM node WebSocket URL\",\"title\":\"ws_url\"}},\"required\":[\"url\"],\"title\":\"EvmNodeDatasourceConfig\",\"type\":\"object\"},\"EvmSourcifyDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Sourcify datasource config\",\"properties\":{\"api_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API key\",\"title\":\"api_key\"},\"chain_id\":{\"description\":\"Chain ID\",\"title\":\"chain_id\",\"type\":\"integer\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"evm.sourcify\",\"default\":\"evm.sourcify\",\"description\":\"always 'evm.sourcify'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"default\":\"https://sourcify.dev/server\",\"description\":\"API URL\",\"title\":\"url\"}},\"required\":[\"chain_id\"],\"title\":\"EvmSourcifyDatasourceConfig\",\"type\":\"object\"},\"EvmSubsquidDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"evm.subsquid\",\"default\":\"evm.subsquid\",\"description\":\"always 'evm.subsquid'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"URL of Subsquid Network API\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"EvmSubsquidDatasourceConfig\",\"type\":\"object\"},\"EvmTransactionsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid transaction handler\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"from\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/EvmContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Transaction sender\",\"title\":\"from\"},\"method\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Method name\",\"title\":\"method\"},\"signature\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Method signature\",\"title\":\"signature\"},\"to\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/EvmContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Transaction receiver\",\"title\":\"to\"}},\"required\":[\"callback\"],\"title\":\"EvmTransactionsHandlerConfig\",\"type\":\"object\"},\"EvmTransactionsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Index that uses Subsquid Network as a datasource for transactions\",\"properties\":{\"datasources\":{\"description\":\"`evm` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/EvmSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmNodeDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmSourcifyDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmBlockvisionDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmEtherscanDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Transaction handlers\",\"items\":{\"$ref\":\"#/$defs/EvmTransactionsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"evm.transactions\",\"default\":\"evm.transactions\",\"description\":\"always 'evm.transactions'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"EvmTransactionsIndexConfig\",\"type\":\"object\"},\"HasuraConfig\":{\"additionalProperties\":false,\"description\":\"Config for the Hasura integration.\",\"properties\":{\"admin_secret\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Admin secret of the Hasura instance.\",\"title\":\"admin_secret\"},\"allow_aggregations\":{\"default\":true,\"description\":\"Whether to allow aggregations in unauthenticated queries.\",\"title\":\"allow_aggregations\",\"type\":\"boolean\"},\"allow_inconsistent_metadata\":{\"default\":false,\"description\":\"Whether to ignore errors when applying Hasura metadata.\",\"title\":\"allow_inconsistent_metadata\",\"type\":\"boolean\"},\"camel_case\":{\"default\":false,\"description\":\"Whether to use camelCase instead of default pascal_case for the field names.\",\"title\":\"camel_case\",\"type\":\"boolean\"},\"create_source\":{\"default\":false,\"description\":\"Whether source should be added to Hasura if missing.\",\"title\":\"create_source\",\"type\":\"boolean\"},\"hide\":{\"description\":\"List of table/view names to make private.\",\"items\":{\"type\":\"string\"},\"title\":\"hide\",\"type\":\"array\"},\"hide_internal\":{\"default\":false,\"description\":\"Whether to make internal tables (prefixed with \\\"dipdup\\\") private.\",\"title\":\"hide_internal\",\"type\":\"boolean\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP connection tunables\",\"title\":\"http\"},\"rest\":{\"default\":true,\"description\":\"Enable REST API both for autogenerated and custom queries.\",\"title\":\"rest\",\"type\":\"boolean\"},\"select_limit\":{\"default\":1000,\"description\":\"Row limit for unauthenticated queries.\",\"title\":\"select_limit\",\"type\":\"integer\"},\"source\":{\"default\":\"default\",\"description\":\"Hasura source for DipDup to configure, others will be left untouched.\",\"title\":\"source\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"URL of the Hasura instance.\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"HasuraConfig\",\"type\":\"object\"},\"Hex\":{\"type\":\"string\"},\"HookConfig\":{\"additionalProperties\":false,\"description\":\"Hook config\",\"properties\":{\"args\":{\"additionalProperties\":{\"type\":\"string\"},\"description\":\"Mapping of argument names and annotations (checked lazily when possible)\",\"title\":\"args\",\"type\":\"object\"},\"atomic\":{\"default\":false,\"description\":\"Wrap hook in a single database transaction\",\"title\":\"atomic\",\"type\":\"boolean\"},\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"}},\"required\":[\"callback\"],\"title\":\"HookConfig\",\"type\":\"object\"},\"HttpConfig\":{\"additionalProperties\":false,\"description\":\"Advanced configuration of HTTP client\",\"properties\":{\"alias\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for this HTTP client (dev only)\",\"title\":\"alias\"},\"batch_size\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Number of items fetched in a single paginated request (when applicable)\",\"title\":\"batch_size\"},\"connection_limit\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Number of simultaneous connections\",\"title\":\"connection_limit\"},\"connection_timeout\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Connection timeout in seconds\",\"title\":\"connection_timeout\"},\"polling_interval\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Interval between polling requests in seconds (when applicable)\",\"title\":\"polling_interval\"},\"ratelimit_period\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Time period for rate limiting in seconds\",\"title\":\"ratelimit_period\"},\"ratelimit_rate\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Number of requests per period (\\\"drops\\\" in leaky bucket)\",\"title\":\"ratelimit_rate\"},\"ratelimit_sleep\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Sleep time between requests when rate limit is reached\",\"title\":\"ratelimit_sleep\"},\"replay\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Use cached HTTP responses instead of making real requests (dev only)\",\"title\":\"replay\"},\"replay_path\":{\"anyOf\":[{\"type\":\"string\"},{\"format\":\"path\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Use cached HTTP responses instead of making real requests (dev only)\",\"title\":\"replay_path\"},\"request_timeout\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Request timeout in seconds\",\"title\":\"request_timeout\"},\"retry_count\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Number of retries after request failed before giving up\",\"title\":\"retry_count\"},\"retry_multiplier\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Multiplier for sleep time between retries\",\"title\":\"retry_multiplier\"},\"retry_sleep\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Sleep time between retries\",\"title\":\"retry_sleep\"}},\"title\":\"HttpConfig\",\"type\":\"object\"},\"HttpDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Generic HTTP datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"http\",\"default\":\"http\",\"description\":\"always 'http'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"URL to fetch data from\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"HttpDatasourceConfig\",\"type\":\"object\"},\"IndexTemplateConfig\":{\"additionalProperties\":false,\"description\":\"Index template config\",\"properties\":{\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"kind\":{\"const\":\"template\",\"default\":\"template\",\"description\":\"always 'template'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"},\"template\":{\"description\":\"Template alias in `templates` section\",\"title\":\"template\",\"type\":\"string\"},\"values\":{\"description\":\"Values to be substituted in template (`<key>` -> `value`)\",\"title\":\"values\",\"type\":\"object\"}},\"required\":[\"template\",\"values\"],\"title\":\"IndexTemplateConfig\",\"type\":\"object\"},\"IpfsDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"IPFS datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"ipfs\",\"default\":\"ipfs\",\"description\":\"always 'ipfs'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"default\":\"https://ipfs.io/ipfs\",\"description\":\"IPFS node URL, e.g. https://ipfs.io/ipfs/\",\"title\":\"url\"}},\"title\":\"IpfsDatasourceConfig\",\"type\":\"object\"},\"JobConfig\":{\"additionalProperties\":false,\"description\":\"Job schedule config\",\"properties\":{\"args\":{\"description\":\"Arguments to pass to the hook\",\"title\":\"args\",\"type\":\"object\"},\"crontab\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Schedule with crontab syntax (`* * * * *`)\",\"title\":\"crontab\"},\"daemon\":{\"default\":false,\"description\":\"Run hook as a daemon (never stops)\",\"title\":\"daemon\",\"type\":\"boolean\"},\"hook\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/HookConfig\"}],\"description\":\"Name of hook to run\",\"title\":\"hook\"},\"interval\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Schedule with interval in seconds\",\"title\":\"interval\"}},\"required\":[\"hook\"],\"title\":\"JobConfig\",\"type\":\"object\"},\"McpConfig\":{\"additionalProperties\":false,\"description\":\"Config for MCP server\",\"properties\":{\"api_url\":{\"anyOf\":[{\"$ref\":\"#/$defs/Url\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL of the management API\",\"title\":\"api_url\"},\"compatibility\":{\"default\":true,\"description\":\"Whether to expose resources as tools for clients that don't support MCP resources\",\"title\":\"compatibility\",\"type\":\"boolean\"},\"host\":{\"default\":\"127.0.0.1\",\"description\":\"Host to bind to\",\"title\":\"host\",\"type\":\"string\"},\"port\":{\"default\":9999,\"description\":\"Port to bind to\",\"title\":\"port\",\"type\":\"integer\"}},\"title\":\"McpConfig\",\"type\":\"object\"},\"PostgresDatabaseConfig\":{\"additionalProperties\":false,\"description\":\"Postgres database connection config\",\"properties\":{\"connection_timeout\":{\"default\":60,\"description\":\"Connection timeout\",\"title\":\"connection_timeout\",\"type\":\"integer\"},\"database\":{\"default\":\"postgres\",\"description\":\"Database name\",\"title\":\"database\",\"type\":\"string\"},\"host\":{\"description\":\"Host\",\"title\":\"host\",\"type\":\"string\"},\"immune_tables\":{\"description\":\"List of tables to preserve during reindexing\",\"items\":{\"type\":\"string\"},\"title\":\"immune_tables\",\"type\":\"array\",\"uniqueItems\":true},\"kind\":{\"const\":\"postgres\",\"default\":\"postgres\",\"description\":\"always 'postgres'\",\"title\":\"kind\",\"type\":\"string\"},\"password\":{\"default\":\"\",\"description\":\"Password\",\"title\":\"password\",\"type\":\"string\"},\"port\":{\"default\":5432,\"description\":\"Port\",\"title\":\"port\",\"type\":\"integer\"},\"schema_name\":{\"default\":\"public\",\"description\":\"Schema name\",\"title\":\"schema_name\",\"type\":\"string\"},\"user\":{\"default\":\"postgres\",\"description\":\"User\",\"title\":\"user\",\"type\":\"string\"}},\"required\":[\"host\"],\"title\":\"PostgresDatabaseConfig\",\"type\":\"object\"},\"PrometheusConfig\":{\"additionalProperties\":false,\"description\":\"Config for Prometheus integration.\",\"properties\":{\"host\":{\"default\":\"127.0.0.1\",\"description\":\"Host to bind to\",\"title\":\"host\",\"type\":\"string\"},\"port\":{\"default\":8000,\"description\":\"Port to bind to\",\"title\":\"port\",\"type\":\"integer\"},\"update_interval\":{\"default\":1.0,\"description\":\"Interval to update some metrics in seconds\",\"title\":\"update_interval\",\"type\":\"number\"}},\"title\":\"PrometheusConfig\",\"type\":\"object\"},\"ReindexingAction\":{\"description\":\"Action that should be performed on reindexing\\n\\n:param exception: Raise `ReindexingRequiredError` exception.\\n:param wipe: Wipe the database and reindex from scratch. (WARNING: This action is irreversible! All indexed data will be lost!)\\n:param ignore: Ignore the reindexing cause and continue.\",\"enum\":[\"exception\",\"wipe\",\"ignore\"],\"title\":\"ReindexingAction\",\"type\":\"string\"},\"ReindexingReason\":{\"description\":\"Reason that caused reindexing\\n\\n:param manual: Manual reindexing.\\n:param migration: Migration of the database schema.\\n:param rollback: Rollback that couldn't be handled automatically.\\n:param config_modified: Index config was modified.\\n:param schema_modified: Project models or database schema were modified.\",\"enum\":[\"manual\",\"migration\",\"rollback\",\"config_modified\",\"schema_modified\"],\"title\":\"ReindexingReason\",\"type\":\"string\"},\"SentryConfig\":{\"additionalProperties\":false,\"description\":\"Config for Sentry integration.\",\"properties\":{\"debug\":{\"default\":false,\"description\":\"Catch warning messages, increase verbosity.\",\"title\":\"debug\",\"type\":\"boolean\"},\"dsn\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"DSN of the Sentry instance\",\"title\":\"dsn\"},\"environment\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Environment; if not set, guessed from docker/ci/gha/local.\",\"title\":\"environment\"},\"release\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Release version; defaults to DipDup package version.\",\"title\":\"release\"},\"server_name\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Server name; defaults to obfuscated hostname.\",\"title\":\"server_name\"},\"user_id\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"User ID; defaults to obfuscated package/environment.\",\"title\":\"user_id\"}},\"title\":\"SentryConfig\",\"type\":\"object\"},\"SkipHistory\":{\"description\":\"Whether to skip indexing big map history and use only current state\\n\\n:param never: Always index big map historical updates.\\n:param once: Skip history once after reindexing; process updates as usual on the next resync.\\n:param always: Always skip big map history.\",\"enum\":[\"never\",\"once\",\"always\"],\"title\":\"SkipHistory\",\"type\":\"string\"},\"SqliteDatabaseConfig\":{\"additionalProperties\":false,\"description\":\"SQLite connection config\",\"properties\":{\"immune_tables\":{\"description\":\"List of tables to preserve during reindexing\",\"items\":{\"type\":\"string\"},\"title\":\"immune_tables\",\"type\":\"array\",\"uniqueItems\":true},\"kind\":{\"const\":\"sqlite\",\"default\":\"sqlite\",\"description\":\"always 'sqlite'\",\"title\":\"kind\",\"type\":\"string\"},\"path\":{\"default\":\":memory:\",\"description\":\"Path to .sqlite file, leave default for in-memory database (`:memory:`)\",\"title\":\"path\",\"type\":\"string\"}},\"title\":\"SqliteDatabaseConfig\",\"type\":\"object\"},\"StarknetAddress\":{\"$ref\":\"#/$defs/Hex\"},\"StarknetContractConfig\":{\"additionalProperties\":false,\"description\":\"Starknet contract config\",\"properties\":{\"abi\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract ABI\",\"title\":\"abi\"},\"address\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract address\",\"title\":\"address\"},\"kind\":{\"const\":\"starknet\",\"default\":\"starknet\",\"description\":\"Always `starknet`\",\"title\":\"kind\",\"type\":\"string\"},\"typename\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for the contract script\",\"title\":\"typename\"}},\"title\":\"StarknetContractConfig\",\"type\":\"object\"},\"StarknetEventsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid event handler\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/StarknetContractConfig\"}],\"description\":\"Starknet contract\",\"title\":\"contract\"},\"name\":{\"description\":\"Event name\",\"title\":\"name\",\"type\":\"string\"}},\"required\":[\"callback\",\"contract\",\"name\"],\"title\":\"StarknetEventsHandlerConfig\",\"type\":\"object\"},\"StarknetEventsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Starknet events index config\",\"properties\":{\"datasources\":{\"description\":\"Aliases of index datasources in `datasources` section\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/StarknetSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/StarknetNodeDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Event handlers\",\"items\":{\"$ref\":\"#/$defs/StarknetEventsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"starknet.events\",\"default\":\"starknet.events\",\"description\":\"Always 'starknet.events'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"StarknetEventsIndexConfig\",\"type\":\"object\"},\"StarknetNodeDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Starknet node datasource config\",\"properties\":{\"fetch_block_headers\":{\"default\":false,\"description\":\"Flag signalling that this datasource can be used for block headers fetching\",\"title\":\"fetch_block_headers\",\"type\":\"boolean\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"starknet.node\",\"default\":\"starknet.node\",\"description\":\"Always 'starknet.node'\",\"title\":\"kind\",\"type\":\"string\"},\"rollback_depth\":{\"default\":32,\"description\":\"A number of blocks to store in database for rollback\",\"title\":\"rollback_depth\",\"type\":\"integer\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"Starknet node URL\",\"title\":\"url\"},\"ws_url\":{\"anyOf\":[{\"$ref\":\"#/$defs/WsUrl\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Starknet node WebSocket URL\",\"title\":\"ws_url\"}},\"required\":[\"url\"],\"title\":\"StarknetNodeDatasourceConfig\",\"type\":\"object\"},\"StarknetSubsquidDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"starknet.subsquid\",\"default\":\"starknet.subsquid\",\"description\":\"always 'starknet.subsquid'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"URL of Subsquid Network API\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"StarknetSubsquidDatasourceConfig\",\"type\":\"object\"},\"SubstrateEventsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid event handler\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"name\":{\"description\":\"Event name (pallet.event)\",\"title\":\"name\",\"type\":\"string\"}},\"required\":[\"callback\",\"name\"],\"title\":\"SubstrateEventsHandlerConfig\",\"type\":\"object\"},\"SubstrateEventsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid datasource config\",\"properties\":{\"datasources\":{\"description\":\"`substrate` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/SubstrateSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/SubstrateSubscanDatasourceConfig\"},{\"$ref\":\"#/$defs/SubstrateNodeDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Event handlers\",\"items\":{\"$ref\":\"#/$defs/SubstrateEventsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"substrate.events\",\"default\":\"substrate.events\",\"description\":\"Always 'substrate.events'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing and disable this index\",\"title\":\"last_level\",\"type\":\"integer\"},\"runtime\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/SubstrateRuntimeConfig\"}],\"description\":\"Substrate runtime\",\"title\":\"runtime\"}},\"required\":[\"datasources\",\"runtime\",\"handlers\"],\"title\":\"SubstrateEventsIndexConfig\",\"type\":\"object\"},\"SubstrateNodeDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Substrate node datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"substrate.node\",\"default\":\"substrate.node\",\"description\":\"Always 'substrate.node'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"Substrate node URL\",\"title\":\"url\"},\"ws_url\":{\"anyOf\":[{\"$ref\":\"#/$defs/WsUrl\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Substrate node WebSocket URL\",\"title\":\"ws_url\"}},\"required\":[\"url\"],\"title\":\"SubstrateNodeDatasourceConfig\",\"type\":\"object\"},\"SubstrateRuntimeConfig\":{\"additionalProperties\":false,\"description\":\"Substrate runtime config\",\"properties\":{\"kind\":{\"const\":\"substrate\",\"default\":\"substrate\",\"description\":\"Always 'substrate'\",\"title\":\"kind\",\"type\":\"string\"},\"type_registry\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Path to type registry or its alias\",\"title\":\"type_registry\"}},\"title\":\"SubstrateRuntimeConfig\",\"type\":\"object\"},\"SubstrateSubscanDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Subscan datasource config\",\"properties\":{\"api_key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"API key\",\"title\":\"api_key\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"substrate.subscan\",\"default\":\"substrate.subscan\",\"description\":\"always 'substrate.subscan'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"API URL\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"SubstrateSubscanDatasourceConfig\",\"type\":\"object\"},\"SubstrateSubsquidDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"Subsquid datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"substrate.subsquid\",\"default\":\"substrate.subsquid\",\"description\":\"always 'substrate.subsquid'\",\"title\":\"kind\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"description\":\"URL of Subsquid Network API\",\"title\":\"url\"}},\"required\":[\"url\"],\"title\":\"SubstrateSubsquidDatasourceConfig\",\"type\":\"object\"},\"TezosAddress\":{\"type\":\"string\"},\"TezosBigMapsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Big map handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"}],\"description\":\"Contract to fetch big map from\",\"title\":\"contract\"},\"path\":{\"description\":\"Path to big map (alphanumeric string with dots)\",\"title\":\"path\",\"type\":\"string\"}},\"required\":[\"callback\",\"contract\",\"path\"],\"title\":\"TezosBigMapsHandlerConfig\",\"type\":\"object\"},\"TezosBigMapsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Big map index config\",\"properties\":{\"datasources\":{\"description\":\"Tezos datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Mapping of big map diff handlers\",\"items\":{\"$ref\":\"#/$defs/TezosBigMapsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.big_maps\",\"default\":\"tezos.big_maps\",\"description\":\"always 'tezos.big_maps'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"},\"skip_history\":{\"$ref\":\"#/$defs/SkipHistory\",\"default\":\"never\",\"description\":\"Fetch only current big map keys ignoring historical changes\",\"title\":\"skip_history\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"TezosBigMapsIndexConfig\",\"type\":\"object\"},\"TezosContractConfig\":{\"additionalProperties\":false,\"description\":\"Tezos contract config.\",\"properties\":{\"address\":{\"anyOf\":[{\"$ref\":\"#/$defs/TezosAddress\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract address\",\"title\":\"address\"},\"code_hash\":{\"anyOf\":[{\"type\":\"integer\"},{\"$ref\":\"#/$defs/TezosAddress\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Contract code hash or address to fetch it from\",\"title\":\"code_hash\"},\"kind\":{\"const\":\"tezos\",\"default\":\"tezos\",\"description\":\"Always `tezos`\",\"title\":\"kind\",\"type\":\"string\"},\"typename\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for the contract script\",\"title\":\"typename\"}},\"title\":\"TezosContractConfig\",\"type\":\"object\"},\"TezosEventsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Event handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"}],\"description\":\"Contract which emits event\",\"title\":\"contract\"},\"tag\":{\"description\":\"Event tag\",\"title\":\"tag\",\"type\":\"string\"}},\"required\":[\"callback\",\"contract\",\"tag\"],\"title\":\"TezosEventsHandlerConfig\",\"type\":\"object\"},\"TezosEventsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Event index config\",\"properties\":{\"datasources\":{\"description\":\"`evm` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"First block level to index\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Event handlers\",\"items\":{\"anyOf\":[{\"$ref\":\"#/$defs/TezosEventsHandlerConfig\"},{\"$ref\":\"#/$defs/TezosEventsUnknownEventHandlerConfig\"}]},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.events\",\"default\":\"tezos.events\",\"description\":\"always 'tezos.events'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Last block level to index\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"TezosEventsIndexConfig\",\"type\":\"object\"},\"TezosEventsUnknownEventHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Unknown event handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"}],\"description\":\"Contract which emits event\",\"title\":\"contract\"}},\"required\":[\"callback\",\"contract\"],\"title\":\"TezosEventsUnknownEventHandlerConfig\",\"type\":\"object\"},\"TezosHeadIndexConfig\":{\"additionalProperties\":false,\"description\":\"Head block index config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"datasources\":{\"description\":\"`tezos` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.head\",\"default\":\"tezos.head\",\"description\":\"always 'tezos.head'\",\"title\":\"kind\",\"type\":\"string\"}},\"required\":[\"datasources\",\"callback\"],\"title\":\"TezosHeadIndexConfig\",\"type\":\"object\"},\"TezosOperationType\":{\"description\":\"Type of blockchain operation\\n\\n:param transaction: transaction\\n:param origination: origination\\n:param migration: migration\\n:param sr_execute: sr_execute\\n:param sr_cement: sr_cement\",\"enum\":[\"transaction\",\"origination\",\"migration\",\"sr_execute\",\"sr_cement\"],\"title\":\"TezosOperationType\",\"type\":\"string\"},\"TezosOperationsHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Operation handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"pattern\":{\"description\":\"Filters to match operation groups\",\"items\":{\"anyOf\":[{\"$ref\":\"#/$defs/TezosOperationsHandlerTransactionPatternConfig\"},{\"$ref\":\"#/$defs/TezosOperationsHandlerOriginationPatternConfig\"},{\"$ref\":\"#/$defs/TezosOperationsHandlerSmartRollupCementPatternConfig\"},{\"$ref\":\"#/$defs/TezosOperationsHandlerSmartRollupExecutePatternConfig\"}]},\"title\":\"pattern\",\"type\":\"array\"}},\"required\":[\"callback\",\"pattern\"],\"title\":\"TezosOperationsHandlerConfig\",\"type\":\"object\"},\"TezosOperationsHandlerOriginationPatternConfig\":{\"additionalProperties\":false,\"description\":\"Origination handler pattern config\",\"properties\":{\"alias\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for operation (helps to avoid duplicates)\",\"title\":\"alias\"},\"optional\":{\"default\":false,\"description\":\"Whether can operation be missing in operation group\",\"title\":\"optional\",\"type\":\"boolean\"},\"originated_contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match origination of exact contract\",\"title\":\"originated_contract\"},\"source\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by source contract alias\",\"title\":\"source\"},\"strict\":{\"default\":false,\"description\":\"Match operations by storage only or by the whole code\",\"title\":\"strict\",\"type\":\"boolean\"},\"type\":{\"const\":\"origination\",\"default\":\"origination\",\"description\":\"always 'origination'\",\"title\":\"type\",\"type\":\"string\"}},\"title\":\"TezosOperationsHandlerOriginationPatternConfig\",\"type\":\"object\"},\"TezosOperationsHandlerSmartRollupCementPatternConfig\":{\"additionalProperties\":false,\"description\":\"Operation handler pattern config\",\"properties\":{\"alias\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for operation (helps to avoid duplicates)\",\"title\":\"alias\"},\"destination\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by destination contract alias\",\"title\":\"destination\"},\"optional\":{\"default\":false,\"description\":\"Whether can operation be missing in operation group\",\"title\":\"optional\",\"type\":\"boolean\"},\"source\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by source contract alias\",\"title\":\"source\"},\"type\":{\"const\":\"sr_cement\",\"default\":\"sr_cement\",\"description\":\"always 'sr_cement'\",\"title\":\"type\",\"type\":\"string\"}},\"title\":\"TezosOperationsHandlerSmartRollupCementPatternConfig\",\"type\":\"object\"},\"TezosOperationsHandlerSmartRollupExecutePatternConfig\":{\"additionalProperties\":false,\"description\":\"Operation handler pattern config\",\"properties\":{\"alias\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for operation (helps to avoid duplicates)\",\"title\":\"alias\"},\"destination\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by destination contract alias\",\"title\":\"destination\"},\"optional\":{\"default\":false,\"description\":\"Whether can operation be missing in operation group\",\"title\":\"optional\",\"type\":\"boolean\"},\"source\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by source contract alias\",\"title\":\"source\"},\"type\":{\"const\":\"sr_execute\",\"default\":\"sr_execute\",\"description\":\"always 'sr_execute'\",\"title\":\"type\",\"type\":\"string\"}},\"title\":\"TezosOperationsHandlerSmartRollupExecutePatternConfig\",\"type\":\"object\"},\"TezosOperationsHandlerTransactionPatternConfig\":{\"additionalProperties\":false,\"description\":\"Transaction handler pattern config\",\"properties\":{\"alias\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Alias for operation (helps to avoid duplicates)\",\"title\":\"alias\"},\"destination\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by destination contract alias\",\"title\":\"destination\"},\"entrypoint\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by contract entrypoint\",\"title\":\"entrypoint\"},\"optional\":{\"default\":false,\"description\":\"Whether can operation be missing in operation group\",\"title\":\"optional\",\"type\":\"boolean\"},\"source\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Match operations by source contract alias\",\"title\":\"source\"},\"type\":{\"const\":\"transaction\",\"default\":\"transaction\",\"description\":\"always 'transaction'\",\"title\":\"type\",\"type\":\"string\"}},\"title\":\"TezosOperationsHandlerTransactionPatternConfig\",\"type\":\"object\"},\"TezosOperationsIndexConfig\":{\"additionalProperties\":false,\"description\":\"Operation index config\",\"properties\":{\"contracts\":{\"description\":\"Aliases of contracts being indexed in `contracts` section\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"}]},\"title\":\"contracts\",\"type\":\"array\"},\"datasources\":{\"description\":\"`tezos` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"List of indexer handlers\",\"items\":{\"$ref\":\"#/$defs/TezosOperationsHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.operations\",\"default\":\"tezos.operations\",\"description\":\"always 'tezos.operations'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"},\"types\":{\"default\":[\"transaction\"],\"description\":\"Types of transaction to fetch\",\"items\":{\"$ref\":\"#/$defs/TezosOperationType\"},\"title\":\"types\",\"type\":\"array\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"TezosOperationsIndexConfig\",\"type\":\"object\"},\"TezosOperationsUnfilteredIndexConfig\":{\"additionalProperties\":false,\"description\":\"Operation index config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"datasources\":{\"description\":\"`tezos` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"kind\":{\"const\":\"tezos.operations_unfiltered\",\"default\":\"tezos.operations_unfiltered\",\"description\":\"always 'tezos.operations_unfiltered'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"},\"types\":{\"default\":[\"transaction\"],\"description\":\"Types of transaction to fetch\",\"items\":{\"$ref\":\"#/$defs/TezosOperationType\"},\"title\":\"types\",\"type\":\"array\"}},\"required\":[\"datasources\",\"callback\"],\"title\":\"TezosOperationsUnfilteredIndexConfig\",\"type\":\"object\"},\"TezosTokenBalancesHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Token balance handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by contract\",\"title\":\"contract\"},\"token_id\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by token ID\",\"title\":\"token_id\"}},\"required\":[\"callback\"],\"title\":\"TezosTokenBalancesHandlerConfig\",\"type\":\"object\"},\"TezosTokenBalancesIndexConfig\":{\"additionalProperties\":false,\"description\":\"Token balance index config\",\"properties\":{\"datasources\":{\"description\":\"`tezos` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Mapping of token transfer handlers\",\"items\":{\"$ref\":\"#/$defs/TezosTokenBalancesHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.token_balances\",\"default\":\"tezos.token_balances\",\"description\":\"always 'tezos.token_balances'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"TezosTokenBalancesIndexConfig\",\"type\":\"object\"},\"TezosTokenTransfersHandlerConfig\":{\"additionalProperties\":false,\"description\":\"Token transfer handler config\",\"properties\":{\"callback\":{\"description\":\"Callback name\",\"title\":\"callback\",\"type\":\"string\"},\"contract\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by contract\",\"title\":\"contract\"},\"from\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by sender\",\"title\":\"from\"},\"to\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by recipient\",\"title\":\"to\"},\"token_id\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Filter by token ID\",\"title\":\"token_id\"}},\"required\":[\"callback\"],\"title\":\"TezosTokenTransfersHandlerConfig\",\"type\":\"object\"},\"TezosTokenTransfersIndexConfig\":{\"additionalProperties\":false,\"description\":\"Token transfer index config\",\"properties\":{\"datasources\":{\"description\":\"`tezos` datasources to use\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"}]},\"title\":\"datasources\",\"type\":\"array\"},\"first_level\":{\"default\":0,\"description\":\"Level to start indexing from\",\"title\":\"first_level\",\"type\":\"integer\"},\"handlers\":{\"description\":\"Mapping of token transfer handlers\",\"items\":{\"$ref\":\"#/$defs/TezosTokenTransfersHandlerConfig\"},\"title\":\"handlers\",\"type\":\"array\"},\"kind\":{\"const\":\"tezos.token_transfers\",\"default\":\"tezos.token_transfers\",\"description\":\"always 'tezos.token_transfers'\",\"title\":\"kind\",\"type\":\"string\"},\"last_level\":{\"default\":0,\"description\":\"Level to stop indexing at\",\"title\":\"last_level\",\"type\":\"integer\"}},\"required\":[\"datasources\",\"handlers\"],\"title\":\"TezosTokenTransfersIndexConfig\",\"type\":\"object\"},\"TezosTzktDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"TzKT datasource config\",\"properties\":{\"buffer_size\":{\"default\":0,\"description\":\"Number of levels to keep in FIFO buffer before processing\",\"title\":\"buffer_size\",\"type\":\"integer\"},\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"tezos.tzkt\",\"default\":\"tezos.tzkt\",\"description\":\"always 'tezos.tzkt'\",\"title\":\"kind\",\"type\":\"string\"},\"merge_subscriptions\":{\"default\":false,\"description\":\"Whether to merge realtime subscriptions\",\"title\":\"merge_subscriptions\",\"type\":\"boolean\"},\"rollback_depth\":{\"default\":2,\"description\":\"Number of blocks to keep in the database to handle reorgs\",\"title\":\"rollback_depth\",\"type\":\"integer\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"default\":\"https://api.tzkt.io\",\"description\":\"Base API URL, e.g. https://api.tzkt.io/\",\"title\":\"url\"}},\"title\":\"TezosTzktDatasourceConfig\",\"type\":\"object\"},\"ToStr\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"}]},\"TzipMetadataDatasourceConfig\":{\"additionalProperties\":false,\"description\":\"DipDup Metadata datasource config\",\"properties\":{\"http\":{\"anyOf\":[{\"$ref\":\"#/$defs/HttpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"HTTP client configuration\",\"title\":\"http\"},\"kind\":{\"const\":\"tzip_metadata\",\"default\":\"tzip_metadata\",\"description\":\"always 'tzip_metadata'\",\"title\":\"kind\",\"type\":\"string\"},\"network\":{\"description\":\"Network name, e.g. mainnet, ghostnet, etc.\",\"title\":\"network\",\"type\":\"string\"},\"url\":{\"$ref\":\"#/$defs/Url\",\"default\":\"https://metadata.dipdup.net\",\"description\":\"GraphQL API URL, e.g. https://metadata.dipdup.net\",\"title\":\"url\"}},\"required\":[\"network\"],\"title\":\"TzipMetadataDatasourceConfig\",\"type\":\"object\"},\"Url\":{\"type\":\"string\"},\"WatchdogAction\":{\"enum\":[\"exception\",\"warning\",\"ignore\"],\"title\":\"WatchdogAction\",\"type\":\"string\"},\"WatchdogConfig\":{\"additionalProperties\":false,\"description\":\"Config for the watchdog\",\"properties\":{\"action\":{\"anyOf\":[{\"$ref\":\"#/$defs/WatchdogAction\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Action to perform when watchdog timeout is reached\",\"title\":\"action\"},\"timeout\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Watchdog timeout in seconds\",\"title\":\"timeout\"}},\"title\":\"WatchdogConfig\",\"type\":\"object\"},\"WatchdogTrigger\":{\"enum\":[\"callback\",\"transaction\",\"websocket\"],\"title\":\"WatchdogTrigger\",\"type\":\"string\"},\"WsUrl\":{\"type\":\"string\"}},\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"additionalProperties\":false,\"description\":\"DipDup project configuration file\",\"properties\":{\"advanced\":{\"$ref\":\"#/$defs/AdvancedConfig\",\"description\":\"Advanced config\",\"title\":\"advanced\"},\"api\":{\"anyOf\":[{\"$ref\":\"#/$defs/ApiConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Management API config\",\"title\":\"api\"},\"contracts\":{\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/$defs/EvmContractConfig\"},{\"$ref\":\"#/$defs/TezosContractConfig\"},{\"$ref\":\"#/$defs/StarknetContractConfig\"}]},\"description\":\"Mapping of contract aliases and contract configs\",\"title\":\"contracts\",\"type\":\"object\"},\"custom\":{\"description\":\"User-defined configuration to use in callbacks\",\"title\":\"custom\",\"type\":\"object\"},\"database\":{\"anyOf\":[{\"$ref\":\"#/$defs/SqliteDatabaseConfig\"},{\"$ref\":\"#/$defs/PostgresDatabaseConfig\"}],\"description\":\"Database config\",\"title\":\"database\"},\"datasources\":{\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/$defs/CoinbaseDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmEtherscanDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmSourcifyDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmBlockvisionDatasourceConfig\"},{\"$ref\":\"#/$defs/HttpDatasourceConfig\"},{\"$ref\":\"#/$defs/IpfsDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/EvmNodeDatasourceConfig\"},{\"$ref\":\"#/$defs/TzipMetadataDatasourceConfig\"},{\"$ref\":\"#/$defs/TezosTzktDatasourceConfig\"},{\"$ref\":\"#/$defs/StarknetSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/StarknetNodeDatasourceConfig\"},{\"$ref\":\"#/$defs/SubstrateSubsquidDatasourceConfig\"},{\"$ref\":\"#/$defs/SubstrateSubscanDatasourceConfig\"},{\"$ref\":\"#/$defs/SubstrateNodeDatasourceConfig\"}]},\"description\":\"Mapping of datasource aliases and datasource configs\",\"title\":\"datasources\",\"type\":\"object\"},\"hasura\":{\"anyOf\":[{\"$ref\":\"#/$defs/HasuraConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Hasura integration config\",\"title\":\"hasura\"},\"hooks\":{\"additionalProperties\":{\"$ref\":\"#/$defs/HookConfig\"},\"description\":\"Mapping of hook aliases and hook configs\",\"title\":\"hooks\",\"type\":\"object\"},\"indexes\":{\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/$defs/TezosBigMapsIndexConfig\"},{\"$ref\":\"#/$defs/TezosEventsIndexConfig\"},{\"$ref\":\"#/$defs/TezosHeadIndexConfig\"},{\"$ref\":\"#/$defs/TezosOperationsIndexConfig\"},{\"$ref\":\"#/$defs/TezosOperationsUnfilteredIndexConfig\"},{\"$ref\":\"#/$defs/TezosTokenTransfersIndexConfig\"},{\"$ref\":\"#/$defs/TezosTokenBalancesIndexConfig\"},{\"$ref\":\"#/$defs/EvmEventsIndexConfig\"},{\"$ref\":\"#/$defs/EvmTransactionsIndexConfig\"},{\"$ref\":\"#/$defs/StarknetEventsIndexConfig\"},{\"$ref\":\"#/$defs/SubstrateEventsIndexConfig\"},{\"$ref\":\"#/$defs/IndexTemplateConfig\"}]},\"description\":\"Mapping of index aliases and index configs\",\"title\":\"indexes\",\"type\":\"object\"},\"jobs\":{\"additionalProperties\":{\"$ref\":\"#/$defs/JobConfig\"},\"description\":\"Mapping of job aliases and job configs\",\"title\":\"jobs\",\"type\":\"object\"},\"logging\":{\"anyOf\":[{\"additionalProperties\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}]},\"type\":\"object\"},{\"type\":\"string\"},{\"type\":\"integer\"}],\"default\":\"INFO\",\"description\":\"Modify logging verbosity\",\"title\":\"logging\"},\"mcp\":{\"anyOf\":[{\"$ref\":\"#/$defs/McpConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"MCP server config\",\"title\":\"mcp\"},\"package\":{\"description\":\"Name of indexer's Python package, existing or not\",\"title\":\"package\",\"type\":\"string\"},\"prometheus\":{\"anyOf\":[{\"$ref\":\"#/$defs/PrometheusConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Prometheus integration config\",\"title\":\"prometheus\"},\"runtimes\":{\"additionalProperties\":{\"$ref\":\"#/$defs/SubstrateRuntimeConfig\"},\"description\":\"Mapping of runtime aliases and runtime configs\",\"title\":\"runtimes\",\"type\":\"object\"},\"sentry\":{\"anyOf\":[{\"$ref\":\"#/$defs/SentryConfig\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Sentry integration config\",\"title\":\"sentry\"},\"spec_version\":{\"$ref\":\"#/$defs/ToStr\",\"description\":\"Version of config specification, currently always `3.0`\",\"title\":\"spec_version\"},\"templates\":{\"additionalProperties\":{\"anyOf\":[{\"$ref\":\"#/$defs/TezosBigMapsIndexConfig\"},{\"$ref\":\"#/$defs/TezosEventsIndexConfig\"},{\"$ref\":\"#/$defs/TezosHeadIndexConfig\"},{\"$ref\":\"#/$defs/TezosOperationsIndexConfig\"},{\"$ref\":\"#/$defs/TezosOperationsUnfilteredIndexConfig\"},{\"$ref\":\"#/$defs/TezosTokenTransfersIndexConfig\"},{\"$ref\":\"#/$defs/TezosTokenBalancesIndexConfig\"},{\"$ref\":\"#/$defs/EvmEventsIndexConfig\"},{\"$ref\":\"#/$defs/EvmTransactionsIndexConfig\"},{\"$ref\":\"#/$defs/StarknetEventsIndexConfig\"},{\"$ref\":\"#/$defs/SubstrateEventsIndexConfig\"}]},\"description\":\"Mapping of template aliases and index templates\",\"title\":\"templates\",\"type\":\"object\"}},\"required\":[],\"title\":\"DipDup\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DipDup\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$defs":{"AdvancedConfig":{"additionalProperties":true,"description":"This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.","properties":{"alt_operation_matcher":{"default":false,"description":"Use different algorithm to match Tezos operations (dev only)","title":"alt_operation_matcher","type":"boolean"},"decimal_precision":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Overwrite precision if it's not guessed correctly based on project models.","title":"decimal_precision"},"early_realtime":{"default":false,"description":"Establish realtime connection and start collecting messages while sync is in progress (faster, but consumes more RAM).","title":"early_realtime","type":"boolean"},"postpone_jobs":{"default":false,"description":"Do not start job scheduler until all indexes reach the realtime state.","title":"postpone_jobs","type":"boolean"},"reindex":{"additionalProperties":{"$ref":"#/$defs/ReindexingAction"},"description":"Mapping of reindexing reasons and actions DipDup performs.","propertyNames":{"$ref":"#/$defs/ReindexingReason"},"title":"reindex","type":"object"},"rollback_depth":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"A number of blocks to keep for rollback (affects all datasources)","title":"rollback_depth"},"scheduler":{"anyOf":[{"type":"object"},{"type":"null"}],"default":null,"description":"`apscheduler` scheduler config.","title":"scheduler"},"unsafe_sqlite":{"default":false,"description":"Disable journaling and data integrity checks. Use only for testing.","title":"unsafe_sqlite","type":"boolean"},"watchdog":{"additionalProperties":{"$ref":"#/$defs/WatchdogConfig"},"description":"Mapping of watchdog triggers and actions DipDup performs.","propertyNames":{"$ref":"#/$defs/WatchdogTrigger"},"title":"watchdog","type":"object"}},"title":"AdvancedConfig","type":"object"},"ApiConfig":{"additionalProperties":false,"description":"Management API config","properties":{"host":{"default":"127.0.0.1","description":"Host to bind to","title":"host","type":"string"},"port":{"default":46339,"description":"Port to bind to","title":"port","type":"integer"}},"title":"ApiConfig","type":"object"},"CoinbaseDatasourceConfig":{"additionalProperties":false,"description":"Coinbase datasource config","properties":{"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API key","title":"api_key"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"coinbase","default":"coinbase","description":"always 'coinbase'","title":"kind","type":"string"},"passphrase":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API passphrase","title":"passphrase"},"secret_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API secret key","title":"secret_key"}},"title":"CoinbaseDatasourceConfig","type":"object"},"EvmAddress":{"$ref":"#/$defs/Hex"},"EvmBlockvisionDatasourceConfig":{"additionalProperties":false,"description":"Blockvision datasource config","properties":{"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API key","title":"api_key"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"evm.blockvision","default":"evm.blockvision","description":"always 'evm.blockvision'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"API URL","title":"url"}},"required":["url"],"title":"EvmBlockvisionDatasourceConfig","type":"object"},"EvmContractConfig":{"additionalProperties":false,"description":"EVM contract config","properties":{"abi":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"default":null,"description":"Contract ABI","title":"abi"},"address":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"default":null,"description":"Contract address","title":"address"},"kind":{"const":"evm","default":"evm","description":"Always `evm`","title":"kind","type":"string"},"typename":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for the contract script","title":"typename"}},"title":"EvmContractConfig","type":"object"},"EvmEtherscanDatasourceConfig":{"additionalProperties":false,"description":"Etherscan datasource config","properties":{"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API key","title":"api_key"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"anyOf":[{"const":"evm.etherscan","type":"string"},{"const":"abi.etherscan","type":"string"}],"default":"evm.etherscan","description":"always 'evm.etherscan'","title":"kind"},"url":{"$ref":"#/$defs/Url","description":"API URL","title":"url"}},"required":["url"],"title":"EvmEtherscanDatasourceConfig","type":"object"},"EvmEventsHandlerConfig":{"additionalProperties":false,"description":"Subsquid event handler","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/EvmContractConfig"}],"description":"EVM contract","title":"contract"},"name":{"description":"Event name","title":"name","type":"string"}},"required":["callback","contract","name"],"title":"EvmEventsHandlerConfig","type":"object"},"EvmEventsIndexConfig":{"additionalProperties":false,"description":"Subsquid datasource config","properties":{"datasources":{"description":"`evm` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/EvmSubsquidDatasourceConfig"},{"$ref":"#/$defs/EvmNodeDatasourceConfig"},{"$ref":"#/$defs/EvmSourcifyDatasourceConfig"},{"$ref":"#/$defs/EvmBlockvisionDatasourceConfig"},{"$ref":"#/$defs/EvmEtherscanDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Event handlers","items":{"$ref":"#/$defs/EvmEventsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"evm.events","default":"evm.events","description":"Always 'evm.events'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing and disable this index","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"EvmEventsIndexConfig","type":"object"},"EvmNodeDatasourceConfig":{"additionalProperties":false,"description":"EVM node datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"evm.node","default":"evm.node","description":"Always 'evm.node'","title":"kind","type":"string"},"rollback_depth":{"default":32,"description":"A number of blocks to store in database for rollback","title":"rollback_depth","type":"integer"},"url":{"$ref":"#/$defs/Url","description":"EVM node URL","title":"url"},"ws_url":{"anyOf":[{"$ref":"#/$defs/WsUrl"},{"type":"null"}],"default":null,"description":"EVM node WebSocket URL","title":"ws_url"}},"required":["url"],"title":"EvmNodeDatasourceConfig","type":"object"},"EvmSourcifyDatasourceConfig":{"additionalProperties":false,"description":"Sourcify datasource config","properties":{"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API key","title":"api_key"},"chain_id":{"description":"Chain ID","title":"chain_id","type":"integer"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"evm.sourcify","default":"evm.sourcify","description":"always 'evm.sourcify'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","default":"https://sourcify.dev/server","description":"API URL","title":"url"}},"required":["chain_id"],"title":"EvmSourcifyDatasourceConfig","type":"object"},"EvmSubsquidDatasourceConfig":{"additionalProperties":false,"description":"Subsquid datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"evm.subsquid","default":"evm.subsquid","description":"always 'evm.subsquid'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"URL of Subsquid Network API","title":"url"}},"required":["url"],"title":"EvmSubsquidDatasourceConfig","type":"object"},"EvmTransactionsHandlerConfig":{"additionalProperties":false,"description":"Subsquid transaction handler","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"from":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/EvmContractConfig"},{"type":"null"}],"default":null,"description":"Transaction sender","title":"from"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Method name","title":"method"},"signature":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Method signature","title":"signature"},"to":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/EvmContractConfig"},{"type":"null"}],"default":null,"description":"Transaction receiver","title":"to"}},"required":["callback"],"title":"EvmTransactionsHandlerConfig","type":"object"},"EvmTransactionsIndexConfig":{"additionalProperties":false,"description":"Index that uses Subsquid Network as a datasource for transactions","properties":{"datasources":{"description":"`evm` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/EvmSubsquidDatasourceConfig"},{"$ref":"#/$defs/EvmNodeDatasourceConfig"},{"$ref":"#/$defs/EvmSourcifyDatasourceConfig"},{"$ref":"#/$defs/EvmBlockvisionDatasourceConfig"},{"$ref":"#/$defs/EvmEtherscanDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Transaction handlers","items":{"$ref":"#/$defs/EvmTransactionsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"evm.transactions","default":"evm.transactions","description":"always 'evm.transactions'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"EvmTransactionsIndexConfig","type":"object"},"HasuraConfig":{"additionalProperties":false,"description":"Config for the Hasura integration.","properties":{"admin_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Admin secret of the Hasura instance.","title":"admin_secret"},"allow_aggregations":{"default":true,"description":"Whether to allow aggregations in unauthenticated queries.","title":"allow_aggregations","type":"boolean"},"allow_inconsistent_metadata":{"default":false,"description":"Whether to ignore errors when applying Hasura metadata.","title":"allow_inconsistent_metadata","type":"boolean"},"camel_case":{"default":false,"description":"Whether to use camelCase instead of default pascal_case for the field names.","title":"camel_case","type":"boolean"},"create_source":{"default":false,"description":"Whether source should be added to Hasura if missing.","title":"create_source","type":"boolean"},"hide":{"description":"List of table/view names to make private.","items":{"type":"string"},"title":"hide","type":"array"},"hide_internal":{"default":false,"description":"Whether to make internal tables (prefixed with \"dipdup\") private.","title":"hide_internal","type":"boolean"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP connection tunables","title":"http"},"rest":{"default":true,"description":"Enable REST API both for autogenerated and custom queries.","title":"rest","type":"boolean"},"select_limit":{"default":1000,"description":"Row limit for unauthenticated queries.","title":"select_limit","type":"integer"},"source":{"default":"default","description":"Hasura source for DipDup to configure, others will be left untouched.","title":"source","type":"string"},"url":{"$ref":"#/$defs/Url","description":"URL of the Hasura instance.","title":"url"}},"required":["url"],"title":"HasuraConfig","type":"object"},"Hex":{"type":"string"},"HookConfig":{"additionalProperties":false,"description":"Hook config","properties":{"args":{"additionalProperties":{"type":"string"},"description":"Mapping of argument names and annotations (checked lazily when possible)","title":"args","type":"object"},"atomic":{"default":false,"description":"Wrap hook in a single database transaction","title":"atomic","type":"boolean"},"callback":{"description":"Callback name","title":"callback","type":"string"}},"required":["callback"],"title":"HookConfig","type":"object"},"HttpConfig":{"additionalProperties":false,"description":"Advanced configuration of HTTP client","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for this HTTP client (dev only)","title":"alias"},"batch_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Number of items fetched in a single paginated request (when applicable)","title":"batch_size"},"connection_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Number of simultaneous connections","title":"connection_limit"},"connection_timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Connection timeout in seconds","title":"connection_timeout"},"polling_interval":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Interval between polling requests in seconds (when applicable)","title":"polling_interval"},"ratelimit_period":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Time period for rate limiting in seconds","title":"ratelimit_period"},"ratelimit_rate":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Number of requests per period (\"drops\" in leaky bucket)","title":"ratelimit_rate"},"ratelimit_sleep":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Sleep time between requests when rate limit is reached","title":"ratelimit_sleep"},"replay":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Use cached HTTP responses instead of making real requests (dev only)","title":"replay"},"replay_path":{"anyOf":[{"type":"string"},{"format":"path","type":"string"},{"type":"null"}],"default":null,"description":"Use cached HTTP responses instead of making real requests (dev only)","title":"replay_path"},"request_timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Request timeout in seconds","title":"request_timeout"},"retry_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Number of retries after request failed before giving up","title":"retry_count"},"retry_multiplier":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Multiplier for sleep time between retries","title":"retry_multiplier"},"retry_sleep":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Sleep time between retries","title":"retry_sleep"}},"title":"HttpConfig","type":"object"},"HttpDatasourceConfig":{"additionalProperties":false,"description":"Generic HTTP datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"http","default":"http","description":"always 'http'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"URL to fetch data from","title":"url"}},"required":["url"],"title":"HttpDatasourceConfig","type":"object"},"IndexTemplateConfig":{"additionalProperties":false,"description":"Index template config","properties":{"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"kind":{"const":"template","default":"template","description":"always 'template'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"},"template":{"description":"Template alias in `templates` section","title":"template","type":"string"},"values":{"description":"Values to be substituted in template (`<key>` -> `value`)","title":"values","type":"object"}},"required":["template","values"],"title":"IndexTemplateConfig","type":"object"},"IpfsDatasourceConfig":{"additionalProperties":false,"description":"IPFS datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"ipfs","default":"ipfs","description":"always 'ipfs'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","default":"https://ipfs.io/ipfs","description":"IPFS node URL, e.g. https://ipfs.io/ipfs/","title":"url"}},"title":"IpfsDatasourceConfig","type":"object"},"JobConfig":{"additionalProperties":false,"description":"Job schedule config","properties":{"args":{"description":"Arguments to pass to the hook","title":"args","type":"object"},"crontab":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Schedule with crontab syntax (`* * * * *`)","title":"crontab"},"daemon":{"default":false,"description":"Run hook as a daemon (never stops)","title":"daemon","type":"boolean"},"hook":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/HookConfig"}],"description":"Name of hook to run","title":"hook"},"interval":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Schedule with interval in seconds","title":"interval"}},"required":["hook"],"title":"JobConfig","type":"object"},"McpConfig":{"additionalProperties":false,"description":"Config for MCP server","properties":{"api_url":{"anyOf":[{"$ref":"#/$defs/Url"},{"type":"null"}],"default":null,"description":"URL of the management API","title":"api_url"},"compatibility":{"default":true,"description":"Whether to expose resources as tools for clients that don't support MCP resources","title":"compatibility","type":"boolean"},"host":{"default":"127.0.0.1","description":"Host to bind to","title":"host","type":"string"},"port":{"default":9999,"description":"Port to bind to","title":"port","type":"integer"}},"title":"McpConfig","type":"object"},"PostgresDatabaseConfig":{"additionalProperties":false,"description":"Postgres database connection config","properties":{"connection_timeout":{"default":60,"description":"Connection timeout","title":"connection_timeout","type":"integer"},"database":{"default":"postgres","description":"Database name","title":"database","type":"string"},"host":{"description":"Host","title":"host","type":"string"},"immune_tables":{"description":"List of tables to preserve during reindexing","items":{"type":"string"},"title":"immune_tables","type":"array","uniqueItems":true},"kind":{"const":"postgres","default":"postgres","description":"always 'postgres'","title":"kind","type":"string"},"password":{"default":"","description":"Password","title":"password","type":"string"},"port":{"default":5432,"description":"Port","title":"port","type":"integer"},"schema_name":{"default":"public","description":"Schema name","title":"schema_name","type":"string"},"user":{"default":"postgres","description":"User","title":"user","type":"string"}},"required":["host"],"title":"PostgresDatabaseConfig","type":"object"},"PrometheusConfig":{"additionalProperties":false,"description":"Config for Prometheus integration.","properties":{"host":{"default":"127.0.0.1","description":"Host to bind to","title":"host","type":"string"},"port":{"default":8000,"description":"Port to bind to","title":"port","type":"integer"},"update_interval":{"default":1.0,"description":"Interval to update some metrics in seconds","title":"update_interval","type":"number"}},"title":"PrometheusConfig","type":"object"},"ReindexingAction":{"description":"Action that should be performed on reindexing\n\n:param exception: Raise `ReindexingRequiredError` exception.\n:param wipe: Wipe the database and reindex from scratch. (WARNING: This action is irreversible! All indexed data will be lost!)\n:param ignore: Ignore the reindexing cause and continue.","enum":["exception","wipe","ignore"],"title":"ReindexingAction","type":"string"},"ReindexingReason":{"description":"Reason that caused reindexing\n\n:param manual: Manual reindexing.\n:param migration: Migration of the database schema.\n:param rollback: Rollback that couldn't be handled automatically.\n:param config_modified: Index config was modified.\n:param schema_modified: Project models or database schema were modified.","enum":["manual","migration","rollback","config_modified","schema_modified"],"title":"ReindexingReason","type":"string"},"SentryConfig":{"additionalProperties":false,"description":"Config for Sentry integration.","properties":{"debug":{"default":false,"description":"Catch warning messages, increase verbosity.","title":"debug","type":"boolean"},"dsn":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"DSN of the Sentry instance","title":"dsn"},"environment":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Environment; if not set, guessed from docker/ci/gha/local.","title":"environment"},"release":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Release version; defaults to DipDup package version.","title":"release"},"server_name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Server name; defaults to obfuscated hostname.","title":"server_name"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"User ID; defaults to obfuscated package/environment.","title":"user_id"}},"title":"SentryConfig","type":"object"},"SkipHistory":{"description":"Whether to skip indexing big map history and use only current state\n\n:param never: Always index big map historical updates.\n:param once: Skip history once after reindexing; process updates as usual on the next resync.\n:param always: Always skip big map history.","enum":["never","once","always"],"title":"SkipHistory","type":"string"},"SqliteDatabaseConfig":{"additionalProperties":false,"description":"SQLite connection config","properties":{"immune_tables":{"description":"List of tables to preserve during reindexing","items":{"type":"string"},"title":"immune_tables","type":"array","uniqueItems":true},"kind":{"const":"sqlite","default":"sqlite","description":"always 'sqlite'","title":"kind","type":"string"},"path":{"default":":memory:","description":"Path to .sqlite file, leave default for in-memory database (`:memory:`)","title":"path","type":"string"}},"title":"SqliteDatabaseConfig","type":"object"},"StarknetAddress":{"$ref":"#/$defs/Hex"},"StarknetContractConfig":{"additionalProperties":false,"description":"Starknet contract config","properties":{"abi":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"default":null,"description":"Contract ABI","title":"abi"},"address":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"default":null,"description":"Contract address","title":"address"},"kind":{"const":"starknet","default":"starknet","description":"Always `starknet`","title":"kind","type":"string"},"typename":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for the contract script","title":"typename"}},"title":"StarknetContractConfig","type":"object"},"StarknetEventsHandlerConfig":{"additionalProperties":false,"description":"Subsquid event handler","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/StarknetContractConfig"}],"description":"Starknet contract","title":"contract"},"name":{"description":"Event name","title":"name","type":"string"}},"required":["callback","contract","name"],"title":"StarknetEventsHandlerConfig","type":"object"},"StarknetEventsIndexConfig":{"additionalProperties":false,"description":"Starknet events index config","properties":{"datasources":{"description":"Aliases of index datasources in `datasources` section","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/StarknetSubsquidDatasourceConfig"},{"$ref":"#/$defs/StarknetNodeDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Event handlers","items":{"$ref":"#/$defs/StarknetEventsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"starknet.events","default":"starknet.events","description":"Always 'starknet.events'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"StarknetEventsIndexConfig","type":"object"},"StarknetNodeDatasourceConfig":{"additionalProperties":false,"description":"Starknet node datasource config","properties":{"fetch_block_headers":{"default":false,"description":"Flag signalling that this datasource can be used for block headers fetching","title":"fetch_block_headers","type":"boolean"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"starknet.node","default":"starknet.node","description":"Always 'starknet.node'","title":"kind","type":"string"},"rollback_depth":{"default":32,"description":"A number of blocks to store in database for rollback","title":"rollback_depth","type":"integer"},"url":{"$ref":"#/$defs/Url","description":"Starknet node URL","title":"url"},"ws_url":{"anyOf":[{"$ref":"#/$defs/WsUrl"},{"type":"null"}],"default":null,"description":"Starknet node WebSocket URL","title":"ws_url"}},"required":["url"],"title":"StarknetNodeDatasourceConfig","type":"object"},"StarknetSubsquidDatasourceConfig":{"additionalProperties":false,"description":"Subsquid datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"starknet.subsquid","default":"starknet.subsquid","description":"always 'starknet.subsquid'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"URL of Subsquid Network API","title":"url"}},"required":["url"],"title":"StarknetSubsquidDatasourceConfig","type":"object"},"SubstrateEventsHandlerConfig":{"additionalProperties":false,"description":"Subsquid event handler","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"name":{"description":"Event name (pallet.event)","title":"name","type":"string"}},"required":["callback","name"],"title":"SubstrateEventsHandlerConfig","type":"object"},"SubstrateEventsIndexConfig":{"additionalProperties":false,"description":"Subsquid datasource config","properties":{"datasources":{"description":"`substrate` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/SubstrateSubsquidDatasourceConfig"},{"$ref":"#/$defs/SubstrateSubscanDatasourceConfig"},{"$ref":"#/$defs/SubstrateNodeDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Event handlers","items":{"$ref":"#/$defs/SubstrateEventsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"substrate.events","default":"substrate.events","description":"Always 'substrate.events'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing and disable this index","title":"last_level","type":"integer"},"runtime":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/SubstrateRuntimeConfig"}],"description":"Substrate runtime","title":"runtime"}},"required":["datasources","runtime","handlers"],"title":"SubstrateEventsIndexConfig","type":"object"},"SubstrateNodeDatasourceConfig":{"additionalProperties":false,"description":"Substrate node datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"substrate.node","default":"substrate.node","description":"Always 'substrate.node'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"Substrate node URL","title":"url"},"ws_url":{"anyOf":[{"$ref":"#/$defs/WsUrl"},{"type":"null"}],"default":null,"description":"Substrate node WebSocket URL","title":"ws_url"}},"required":["url"],"title":"SubstrateNodeDatasourceConfig","type":"object"},"SubstrateRuntimeConfig":{"additionalProperties":false,"description":"Substrate runtime config","properties":{"kind":{"const":"substrate","default":"substrate","description":"Always 'substrate'","title":"kind","type":"string"},"type_registry":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Path to type registry or its alias","title":"type_registry"}},"title":"SubstrateRuntimeConfig","type":"object"},"SubstrateSubscanDatasourceConfig":{"additionalProperties":false,"description":"Subscan datasource config","properties":{"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"API key","title":"api_key"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"substrate.subscan","default":"substrate.subscan","description":"always 'substrate.subscan'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"API URL","title":"url"}},"required":["url"],"title":"SubstrateSubscanDatasourceConfig","type":"object"},"SubstrateSubsquidDatasourceConfig":{"additionalProperties":false,"description":"Subsquid datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"substrate.subsquid","default":"substrate.subsquid","description":"always 'substrate.subsquid'","title":"kind","type":"string"},"url":{"$ref":"#/$defs/Url","description":"URL of Subsquid Network API","title":"url"}},"required":["url"],"title":"SubstrateSubsquidDatasourceConfig","type":"object"},"TezosAddress":{"type":"string"},"TezosBigMapsHandlerConfig":{"additionalProperties":false,"description":"Big map handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"}],"description":"Contract to fetch big map from","title":"contract"},"path":{"description":"Path to big map (alphanumeric string with dots)","title":"path","type":"string"}},"required":["callback","contract","path"],"title":"TezosBigMapsHandlerConfig","type":"object"},"TezosBigMapsIndexConfig":{"additionalProperties":false,"description":"Big map index config","properties":{"datasources":{"description":"Tezos datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Mapping of big map diff handlers","items":{"$ref":"#/$defs/TezosBigMapsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"tezos.big_maps","default":"tezos.big_maps","description":"always 'tezos.big_maps'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"},"skip_history":{"$ref":"#/$defs/SkipHistory","default":"never","description":"Fetch only current big map keys ignoring historical changes","title":"skip_history"}},"required":["datasources","handlers"],"title":"TezosBigMapsIndexConfig","type":"object"},"TezosContractConfig":{"additionalProperties":false,"description":"Tezos contract config.","properties":{"address":{"anyOf":[{"$ref":"#/$defs/TezosAddress"},{"type":"null"}],"default":null,"description":"Contract address","title":"address"},"code_hash":{"anyOf":[{"type":"integer"},{"$ref":"#/$defs/TezosAddress"},{"type":"null"}],"default":null,"description":"Contract code hash or address to fetch it from","title":"code_hash"},"kind":{"const":"tezos","default":"tezos","description":"Always `tezos`","title":"kind","type":"string"},"typename":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for the contract script","title":"typename"}},"title":"TezosContractConfig","type":"object"},"TezosEventsHandlerConfig":{"additionalProperties":false,"description":"Event handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"}],"description":"Contract which emits event","title":"contract"},"tag":{"description":"Event tag","title":"tag","type":"string"}},"required":["callback","contract","tag"],"title":"TezosEventsHandlerConfig","type":"object"},"TezosEventsIndexConfig":{"additionalProperties":false,"description":"Event index config","properties":{"datasources":{"description":"`evm` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"First block level to index","title":"first_level","type":"integer"},"handlers":{"description":"Event handlers","items":{"anyOf":[{"$ref":"#/$defs/TezosEventsHandlerConfig"},{"$ref":"#/$defs/TezosEventsUnknownEventHandlerConfig"}]},"title":"handlers","type":"array"},"kind":{"const":"tezos.events","default":"tezos.events","description":"always 'tezos.events'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Last block level to index","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"TezosEventsIndexConfig","type":"object"},"TezosEventsUnknownEventHandlerConfig":{"additionalProperties":false,"description":"Unknown event handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"}],"description":"Contract which emits event","title":"contract"}},"required":["callback","contract"],"title":"TezosEventsUnknownEventHandlerConfig","type":"object"},"TezosHeadIndexConfig":{"additionalProperties":false,"description":"Head block index config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"datasources":{"description":"`tezos` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"kind":{"const":"tezos.head","default":"tezos.head","description":"always 'tezos.head'","title":"kind","type":"string"}},"required":["datasources","callback"],"title":"TezosHeadIndexConfig","type":"object"},"TezosOperationType":{"description":"Type of blockchain operation\n\n:param transaction: transaction\n:param origination: origination\n:param migration: migration\n:param sr_execute: sr_execute\n:param sr_cement: sr_cement","enum":["transaction","origination","migration","sr_execute","sr_cement"],"title":"TezosOperationType","type":"string"},"TezosOperationsHandlerConfig":{"additionalProperties":false,"description":"Operation handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"pattern":{"description":"Filters to match operation groups","items":{"anyOf":[{"$ref":"#/$defs/TezosOperationsHandlerTransactionPatternConfig"},{"$ref":"#/$defs/TezosOperationsHandlerOriginationPatternConfig"},{"$ref":"#/$defs/TezosOperationsHandlerSmartRollupCementPatternConfig"},{"$ref":"#/$defs/TezosOperationsHandlerSmartRollupExecutePatternConfig"}]},"title":"pattern","type":"array"}},"required":["callback","pattern"],"title":"TezosOperationsHandlerConfig","type":"object"},"TezosOperationsHandlerOriginationPatternConfig":{"additionalProperties":false,"description":"Origination handler pattern config","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for operation (helps to avoid duplicates)","title":"alias"},"optional":{"default":false,"description":"Whether can operation be missing in operation group","title":"optional","type":"boolean"},"originated_contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match origination of exact contract","title":"originated_contract"},"source":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by source contract alias","title":"source"},"strict":{"default":false,"description":"Match operations by storage only or by the whole code","title":"strict","type":"boolean"},"type":{"const":"origination","default":"origination","description":"always 'origination'","title":"type","type":"string"}},"title":"TezosOperationsHandlerOriginationPatternConfig","type":"object"},"TezosOperationsHandlerSmartRollupCementPatternConfig":{"additionalProperties":false,"description":"Operation handler pattern config","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for operation (helps to avoid duplicates)","title":"alias"},"destination":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by destination contract alias","title":"destination"},"optional":{"default":false,"description":"Whether can operation be missing in operation group","title":"optional","type":"boolean"},"source":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by source contract alias","title":"source"},"type":{"const":"sr_cement","default":"sr_cement","description":"always 'sr_cement'","title":"type","type":"string"}},"title":"TezosOperationsHandlerSmartRollupCementPatternConfig","type":"object"},"TezosOperationsHandlerSmartRollupExecutePatternConfig":{"additionalProperties":false,"description":"Operation handler pattern config","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for operation (helps to avoid duplicates)","title":"alias"},"destination":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by destination contract alias","title":"destination"},"optional":{"default":false,"description":"Whether can operation be missing in operation group","title":"optional","type":"boolean"},"source":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by source contract alias","title":"source"},"type":{"const":"sr_execute","default":"sr_execute","description":"always 'sr_execute'","title":"type","type":"string"}},"title":"TezosOperationsHandlerSmartRollupExecutePatternConfig","type":"object"},"TezosOperationsHandlerTransactionPatternConfig":{"additionalProperties":false,"description":"Transaction handler pattern config","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Alias for operation (helps to avoid duplicates)","title":"alias"},"destination":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by destination contract alias","title":"destination"},"entrypoint":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Match operations by contract entrypoint","title":"entrypoint"},"optional":{"default":false,"description":"Whether can operation be missing in operation group","title":"optional","type":"boolean"},"source":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Match operations by source contract alias","title":"source"},"type":{"const":"transaction","default":"transaction","description":"always 'transaction'","title":"type","type":"string"}},"title":"TezosOperationsHandlerTransactionPatternConfig","type":"object"},"TezosOperationsIndexConfig":{"additionalProperties":false,"description":"Operation index config","properties":{"contracts":{"description":"Aliases of contracts being indexed in `contracts` section","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"}]},"title":"contracts","type":"array"},"datasources":{"description":"`tezos` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"List of indexer handlers","items":{"$ref":"#/$defs/TezosOperationsHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"tezos.operations","default":"tezos.operations","description":"always 'tezos.operations'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"},"types":{"default":["transaction"],"description":"Types of transaction to fetch","items":{"$ref":"#/$defs/TezosOperationType"},"title":"types","type":"array"}},"required":["datasources","handlers"],"title":"TezosOperationsIndexConfig","type":"object"},"TezosOperationsUnfilteredIndexConfig":{"additionalProperties":false,"description":"Operation index config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"datasources":{"description":"`tezos` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"kind":{"const":"tezos.operations_unfiltered","default":"tezos.operations_unfiltered","description":"always 'tezos.operations_unfiltered'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"},"types":{"default":["transaction"],"description":"Types of transaction to fetch","items":{"$ref":"#/$defs/TezosOperationType"},"title":"types","type":"array"}},"required":["datasources","callback"],"title":"TezosOperationsUnfilteredIndexConfig","type":"object"},"TezosTokenBalancesHandlerConfig":{"additionalProperties":false,"description":"Token balance handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Filter by contract","title":"contract"},"token_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Filter by token ID","title":"token_id"}},"required":["callback"],"title":"TezosTokenBalancesHandlerConfig","type":"object"},"TezosTokenBalancesIndexConfig":{"additionalProperties":false,"description":"Token balance index config","properties":{"datasources":{"description":"`tezos` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Mapping of token transfer handlers","items":{"$ref":"#/$defs/TezosTokenBalancesHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"tezos.token_balances","default":"tezos.token_balances","description":"always 'tezos.token_balances'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"TezosTokenBalancesIndexConfig","type":"object"},"TezosTokenTransfersHandlerConfig":{"additionalProperties":false,"description":"Token transfer handler config","properties":{"callback":{"description":"Callback name","title":"callback","type":"string"},"contract":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Filter by contract","title":"contract"},"from":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Filter by sender","title":"from"},"to":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosContractConfig"},{"type":"null"}],"default":null,"description":"Filter by recipient","title":"to"},"token_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Filter by token ID","title":"token_id"}},"required":["callback"],"title":"TezosTokenTransfersHandlerConfig","type":"object"},"TezosTokenTransfersIndexConfig":{"additionalProperties":false,"description":"Token transfer index config","properties":{"datasources":{"description":"`tezos` datasources to use","items":{"anyOf":[{"type":"string"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"}]},"title":"datasources","type":"array"},"first_level":{"default":0,"description":"Level to start indexing from","title":"first_level","type":"integer"},"handlers":{"description":"Mapping of token transfer handlers","items":{"$ref":"#/$defs/TezosTokenTransfersHandlerConfig"},"title":"handlers","type":"array"},"kind":{"const":"tezos.token_transfers","default":"tezos.token_transfers","description":"always 'tezos.token_transfers'","title":"kind","type":"string"},"last_level":{"default":0,"description":"Level to stop indexing at","title":"last_level","type":"integer"}},"required":["datasources","handlers"],"title":"TezosTokenTransfersIndexConfig","type":"object"},"TezosTzktDatasourceConfig":{"additionalProperties":false,"description":"TzKT datasource config","properties":{"buffer_size":{"default":0,"description":"Number of levels to keep in FIFO buffer before processing","title":"buffer_size","type":"integer"},"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"tezos.tzkt","default":"tezos.tzkt","description":"always 'tezos.tzkt'","title":"kind","type":"string"},"merge_subscriptions":{"default":false,"description":"Whether to merge realtime subscriptions","title":"merge_subscriptions","type":"boolean"},"rollback_depth":{"default":2,"description":"Number of blocks to keep in the database to handle reorgs","title":"rollback_depth","type":"integer"},"url":{"$ref":"#/$defs/Url","default":"https://api.tzkt.io","description":"Base API URL, e.g. https://api.tzkt.io/","title":"url"}},"title":"TezosTzktDatasourceConfig","type":"object"},"ToStr":{"anyOf":[{"type":"string"},{"type":"number"}]},"TzipMetadataDatasourceConfig":{"additionalProperties":false,"description":"DipDup Metadata datasource config","properties":{"http":{"anyOf":[{"$ref":"#/$defs/HttpConfig"},{"type":"null"}],"default":null,"description":"HTTP client configuration","title":"http"},"kind":{"const":"tzip_metadata","default":"tzip_metadata","description":"always 'tzip_metadata'","title":"kind","type":"string"},"network":{"description":"Network name, e.g. mainnet, ghostnet, etc.","title":"network","type":"string"},"url":{"$ref":"#/$defs/Url","default":"https://metadata.dipdup.net","description":"GraphQL API URL, e.g. https://metadata.dipdup.net","title":"url"}},"required":["network"],"title":"TzipMetadataDatasourceConfig","type":"object"},"Url":{"type":"string"},"WatchdogAction":{"enum":["exception","warning","ignore"],"title":"WatchdogAction","type":"string"},"WatchdogConfig":{"additionalProperties":false,"description":"Config for the watchdog","properties":{"action":{"anyOf":[{"$ref":"#/$defs/WatchdogAction"},{"type":"null"}],"default":null,"description":"Action to perform when watchdog timeout is reached","title":"action"},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Watchdog timeout in seconds","title":"timeout"}},"title":"WatchdogConfig","type":"object"},"WatchdogTrigger":{"enum":["callback","transaction","websocket"],"title":"WatchdogTrigger","type":"string"},"WsUrl":{"type":"string"}},"$schema":"http://json-schema.org/draft-07/schema#","additionalProperties":false,"description":"DipDup project configuration file","properties":{"advanced":{"$ref":"#/$defs/AdvancedConfig","description":"Advanced config","title":"advanced"},"api":{"anyOf":[{"$ref":"#/$defs/ApiConfig"},{"type":"null"}],"default":null,"description":"Management API config","title":"api"},"contracts":{"additionalProperties":{"anyOf":[{"$ref":"#/$defs/EvmContractConfig"},{"$ref":"#/$defs/TezosContractConfig"},{"$ref":"#/$defs/StarknetContractConfig"}]},"description":"Mapping of contract aliases and contract configs","title":"contracts","type":"object"},"custom":{"description":"User-defined configuration to use in callbacks","title":"custom","type":"object"},"database":{"anyOf":[{"$ref":"#/$defs/SqliteDatabaseConfig"},{"$ref":"#/$defs/PostgresDatabaseConfig"}],"description":"Database config","title":"database"},"datasources":{"additionalProperties":{"anyOf":[{"$ref":"#/$defs/CoinbaseDatasourceConfig"},{"$ref":"#/$defs/EvmEtherscanDatasourceConfig"},{"$ref":"#/$defs/EvmSourcifyDatasourceConfig"},{"$ref":"#/$defs/EvmBlockvisionDatasourceConfig"},{"$ref":"#/$defs/HttpDatasourceConfig"},{"$ref":"#/$defs/IpfsDatasourceConfig"},{"$ref":"#/$defs/EvmSubsquidDatasourceConfig"},{"$ref":"#/$defs/EvmNodeDatasourceConfig"},{"$ref":"#/$defs/TzipMetadataDatasourceConfig"},{"$ref":"#/$defs/TezosTzktDatasourceConfig"},{"$ref":"#/$defs/StarknetSubsquidDatasourceConfig"},{"$ref":"#/$defs/StarknetNodeDatasourceConfig"},{"$ref":"#/$defs/SubstrateSubsquidDatasourceConfig"},{"$ref":"#/$defs/SubstrateSubscanDatasourceConfig"},{"$ref":"#/$defs/SubstrateNodeDatasourceConfig"}]},"description":"Mapping of datasource aliases and datasource configs","title":"datasources","type":"object"},"hasura":{"anyOf":[{"$ref":"#/$defs/HasuraConfig"},{"type":"null"}],"default":null,"description":"Hasura integration config","title":"hasura"},"hooks":{"additionalProperties":{"$ref":"#/$defs/HookConfig"},"description":"Mapping of hook aliases and hook configs","title":"hooks","type":"object"},"indexes":{"additionalProperties":{"anyOf":[{"$ref":"#/$defs/TezosBigMapsIndexConfig"},{"$ref":"#/$defs/TezosEventsIndexConfig"},{"$ref":"#/$defs/TezosHeadIndexConfig"},{"$ref":"#/$defs/TezosOperationsIndexConfig"},{"$ref":"#/$defs/TezosOperationsUnfilteredIndexConfig"},{"$ref":"#/$defs/TezosTokenTransfersIndexConfig"},{"$ref":"#/$defs/TezosTokenBalancesIndexConfig"},{"$ref":"#/$defs/EvmEventsIndexConfig"},{"$ref":"#/$defs/EvmTransactionsIndexConfig"},{"$ref":"#/$defs/StarknetEventsIndexConfig"},{"$ref":"#/$defs/SubstrateEventsIndexConfig"},{"$ref":"#/$defs/IndexTemplateConfig"}]},"description":"Mapping of index aliases and index configs","title":"indexes","type":"object"},"jobs":{"additionalProperties":{"$ref":"#/$defs/JobConfig"},"description":"Mapping of job aliases and job configs","title":"jobs","type":"object"},"logging":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"object"},{"type":"string"},{"type":"integer"}],"default":"INFO","description":"Modify logging verbosity","title":"logging"},"mcp":{"anyOf":[{"$ref":"#/$defs/McpConfig"},{"type":"null"}],"default":null,"description":"MCP server config","title":"mcp"},"package":{"description":"Name of indexer's Python package, existing or not","title":"package","type":"string"},"prometheus":{"anyOf":[{"$ref":"#/$defs/PrometheusConfig"},{"type":"null"}],"default":null,"description":"Prometheus integration config","title":"prometheus"},"runtimes":{"additionalProperties":{"$ref":"#/$defs/SubstrateRuntimeConfig"},"description":"Mapping of runtime aliases and runtime configs","title":"runtimes","type":"object"},"sentry":{"anyOf":[{"$ref":"#/$defs/SentryConfig"},{"type":"null"}],"default":null,"description":"Sentry integration config","title":"sentry"},"spec_version":{"$ref":"#/$defs/ToStr","description":"Version of config specification, currently always `3.0`","title":"spec_version"},"templates":{"additionalProperties":{"anyOf":[{"$ref":"#/$defs/TezosBigMapsIndexConfig"},{"$ref":"#/$defs/TezosEventsIndexConfig"},{"$ref":"#/$defs/TezosHeadIndexConfig"},{"$ref":"#/$defs/TezosOperationsIndexConfig"},{"$ref":"#/$defs/TezosOperationsUnfilteredIndexConfig"},{"$ref":"#/$defs/TezosTokenTransfersIndexConfig"},{"$ref":"#/$defs/TezosTokenBalancesIndexConfig"},{"$ref":"#/$defs/EvmEventsIndexConfig"},{"$ref":"#/$defs/EvmTransactionsIndexConfig"},{"$ref":"#/$defs/StarknetEventsIndexConfig"},{"$ref":"#/$defs/SubstrateEventsIndexConfig"}]},"description":"Mapping of template aliases and index templates","title":"templates","type":"object"}},"required":[],"title":"DipDup","type":"object"}
|
Provide a JSON object that satisfies the schema "DipDup". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
DipDup
|
schema-store
|
schema_store_263
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/djlint.json\",\"$comment\":\"Source: https://www.djlint.com/docs/configuration\",\"additionalProperties\":false,\"default\":{\"format_attribute_template_tags\":false,\"profile\":\"html\"},\"definitions\":{\"css-beautify\":{\"type\":\"object\"},\"js-beautify\":{\"type\":\"object\"}},\"description\":\"JSON schema fcor djLint's configuration file\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"blank_line_after_tag\":{\"type\":\"string\"},\"blank_line_before_tag\":{\"type\":\"string\"},\"close_void_tags\":{\"type\":\"boolean\"},\"css\":{\"$ref\":\"#/definitions/css-beautify\"},\"custom_blocks\":{\"type\":\"string\"},\"custom_html\":{\"type\":\"string\"},\"exclude\":{\"type\":\"string\"},\"extend_exclude\":{\"type\":\"string\"},\"extension\":{\"type\":\"string\"},\"files\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"format_attribute_template_tags\":{\"type\":\"boolean\"},\"format_css\":{\"type\":\"boolean\"},\"format_js\":{\"type\":\"boolean\"},\"ignore\":{\"type\":\"string\"},\"ignore_blocks\":{\"type\":\"string\"},\"ignore_case\":{\"type\":\"boolean\"},\"include\":{\"type\":\"string\"},\"indent\":{\"type\":\"number\"},\"js\":{\"$ref\":\"#/definitions/js-beautify\"},\"line_break_after_multiline_tag\":{\"type\":\"boolean\"},\"linter_output_format\":{\"examples\":[\"{filename}:{line}: {code} {message} {match}\"],\"type\":\"string\"},\"max_attribute_length\":{\"type\":\"number\"},\"max_blank_lines\":{\"type\":\"number\"},\"max_line_length\":{\"type\":\"number\"},\"no_function_formatting\":{\"type\":\"boolean\"},\"no_line_after_yaml\":{\"type\":\"boolean\"},\"no_set_formatting\":{\"type\":\"boolean\"},\"per-file-ignores\":{\"type\":\"object\"},\"preserve_blank_lines\":{\"type\":\"boolean\"},\"preserve_leading_space\":{\"type\":\"boolean\"},\"profile\":{\"enum\":[\"html\",\"django\",\"jinja\",\"nunjucks\",\"handlebars\",\"golang\",\"angular\"]},\"require_pragma\":{\"type\":\"boolean\"},\"use_gitignore\":{\"type\":\"boolean\"}},\"title\":\"djlint schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"djlint schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/djlint.json","$comment":"Source: https://www.djlint.com/docs/configuration","additionalProperties":false,"default":{"format_attribute_template_tags":false,"profile":"html"},"definitions":{"css-beautify":{"type":"object"},"js-beautify":{"type":"object"}},"description":"JSON schema fcor djLint's configuration file","properties":{"$schema":{"type":"string"},"blank_line_after_tag":{"type":"string"},"blank_line_before_tag":{"type":"string"},"close_void_tags":{"type":"boolean"},"css":{"$ref":"#/definitions/css-beautify"},"custom_blocks":{"type":"string"},"custom_html":{"type":"string"},"exclude":{"type":"string"},"extend_exclude":{"type":"string"},"extension":{"type":"string"},"files":{"items":{"type":"string"},"type":"array"},"format_attribute_template_tags":{"type":"boolean"},"format_css":{"type":"boolean"},"format_js":{"type":"boolean"},"ignore":{"type":"string"},"ignore_blocks":{"type":"string"},"ignore_case":{"type":"boolean"},"include":{"type":"string"},"indent":{"type":"number"},"js":{"$ref":"#/definitions/js-beautify"},"line_break_after_multiline_tag":{"type":"boolean"},"linter_output_format":{"examples":["{filename}:{line}: {code} {message} {match}"],"type":"string"},"max_attribute_length":{"type":"number"},"max_blank_lines":{"type":"number"},"max_line_length":{"type":"number"},"no_function_formatting":{"type":"boolean"},"no_line_after_yaml":{"type":"boolean"},"no_set_formatting":{"type":"boolean"},"per-file-ignores":{"type":"object"},"preserve_blank_lines":{"type":"boolean"},"preserve_leading_space":{"type":"boolean"},"profile":{"enum":["html","django","jinja","nunjucks","handlebars","golang","angular"]},"require_pragma":{"type":"boolean"},"use_gitignore":{"type":"boolean"}},"title":"djlint schema","type":"object"}
|
Provide a JSON object that satisfies the schema "djlint schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
djlint schema
|
schema-store
|
schema_store_264
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"buildConfig\":{\"type\":\"object\",\"properties\":{\"content\":{\"$ref\":\"#/definitions/fileMappingContent\"},\"resource\":{\"$ref\":\"#/definitions/fileMappingResource\"},\"overwrite\":{\"$ref\":\"#/definitions/fileMappingOverwrite\"},\"externalReference\":{\"$ref\":\"#/definitions/fileMappingExternalReferences\"},\"xref\":{\"$ref\":\"#/definitions/xref\"},\"dest\":{\"type\":\"string\"},\"globalMetadata\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Contains metadata that will be applied to every file, in key-value pair format.\"},\"globalMetadataFiles\":{\"$ref\":\"#/definitions/globalMetadataFiles\"},\"fileMetadata\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Contains metadata that will be applied to specific files.\"},\"fileMetadataFiles\":{\"$ref\":\"#/definitions/fileMetadataFiles\"},\"template\":{\"$ref\":\"#/definitions/template\"},\"theme\":{\"$ref\":\"#/definitions/theme\"},\"postProcessors\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"serve\":{\"type\":\"boolean\",\"description\":\"\"},\"force\":{\"type\":\"boolean\",\"description\":\"\"},\"forcePostProcess\":{\"type\":\"boolean\",\"description\":\"Force to re-process the documentation in post processors. It will be cascaded from force option.\"},\"debug\":{\"type\":\"boolean\",\"description\":\"Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false.\"},\"debugOutput\":{\"type\":\"string\",\"description\":\"The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx.\"},\"port\":{\"type\":\"string\",\"description\":\"Specify the port of the hosted website.\"},\"exportRawModel\":{\"type\":\"boolean\",\"description\":\"If set to true, data model to run template script will be extracted in `.raw.json` extension.\"},\"rawModelOutputFolder\":{\"type\":\"string\",\"description\":\"Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation.\"},\"exportViewModel\":{\"type\":\"boolean\",\"description\":\"If set to true, data model to apply template will be extracted in `.view.json` extension.\"},\"viewModelOutputFolder\":{\"type\":\"string\",\"description\":\"Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation.\"},\"dryRun\":{\"type\":\"boolean\",\"description\":\"If set to true, template will not be actually applied to the documents. This option is always used with `--exportRawModel` or `--exportViewModel`, so that only raw model files or view model files are generated.\"},\"maxParallelism\":{\"type\":\"integer\",\"minimum\":0,\"description\":\"Set the max parallelism, 0 (default) is same as the count of CPU cores.\"},\"lruSize\":{\"type\":\"integer\",\"minimum\":0,\"description\":\"Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled.\"},\"markdownEngineName\":{\"type\":\"string\",\"description\":\"Set the name of markdown engine, default is dfm, and another built-in engine is gfm.\"},\"markdownEngineProperties\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Set the parameters for markdown engine.\"},\"noLangKeyword\":{\"type\":\"boolean\",\"description\":\"Disable default lang keyword, e.g. `null`.\"},\"intermediateFolder\":{\"type\":\"string\"},\"changesFile\":{\"type\":\"string\"},\"disableGitFeatures\":{\"$ref\":\"#/definitions/disableGitFeatures\"},\"keepFileLink\":{\"type\":\"boolean\",\"description\":\"If set to true, DocFX does not copy file to the output folder. Instead, it saves a link_to_path property inside manifest.json.\"},\"cleanupCacheHistory\":{\"type\":\"boolean\",\"description\":\"If set to true, cleans up historical cache data when building.\"}},\"description\":\"Build section defines configuration values for the build command.\",\"additionalProperties\":false},\"metadataConfig\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/metadataConfigItem\"},\"description\":\"Metadata section defines an array of source projects and their output folder.\"},\"metadataConfigItem\":{\"type\":\"object\",\"properties\":{\"src\":{\"$ref\":\"#/definitions/fileMappingSrc\"},\"dest\":{\"type\":\"string\",\"description\":\"Defines the output folder of the generated metadata files.\"},\"disableGitFeatures\":{\"$ref\":\"#/definitions/disableGitFeatures\"},\"disableDefaultFilter\":{\"type\":\"boolean\",\"description\":\"If set to true, disables default API visibility filter rule.\"},\"force\":{\"type\":\"boolean\",\"description\":\"If set to true, it would disable incremental build.\"},\"shouldSkipMarkup\":{\"type\":\"boolean\",\"description\":\"If set to true, DocFX would not render triple-slash-comments in source code as markdown.\"},\"raw\":{\"type\":\"boolean\"},\"filter\":{\"type\":\"string\",\"description\":\"Defines the filter configuration file.\"},\"useCompatibilityFileName\":{\"type\":\"boolean\",\"description\":\" If set to true, DocFX would keep ` in comment id instead of replacing it with -.\"}},\"additionalProperties\":false,\"required\":[\"src\",\"dest\"]},\"fileMappingContent\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/fileMappingItem\"}}],\"description\":\"Contains all the files to generate documentation, including metadata `yml` files and conceptual `md` files.\"},\"fileMappingResource\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/fileMappingItem\"}}],\"description\":\"Contains all the resource files that conceptual and metadata files dependent on, e.g. image files.\"},\"fileMappingOverwrite\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/fileMappingItem\"}}],\"description\":\"Contains all the conceptual files which contains yaml header with `uid` and is intended to override the existing metadata `yml` files.\"},\"fileMappingExternalReferences\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/fileMappingItem\"}}],\"description\":\"[Obsoleted] Contains `rpk` files that define the external references.\"},\"fileMappingSrc\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/fileMappingItem\"}}],\"description\":\"Defines the source projects to have metadata generated.\"},\"fileMappingItem\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of current item, the value is not used for now.\"},\"files\":{\"$ref\":\"#/definitions/files\"},\"exclude\":{\"$ref\":\"#/definitions/exclude\"},\"src\":{\"type\":\"string\",\"description\":\"Defines the root folder for the source files, it has the same meaning as `cwd`\"},\"cwd\":{\"type\":\"string\",\"description\":\"[Obsoleted] Defines the root folder for the source files, it has the same meaning as `src`\"},\"dest\":{\"type\":\"string\",\"description\":\"The destination folder for the files if copy/transform is used.\"},\"version\":{\"type\":\"string\",\"description\":\"Version name for the current file-mapping item.\\nIf not set, treat the current file-mapping item as in default version.\\nMappings with the same version name will be built together.\\nCross reference doesn't support cross different versions.\"},\"rootTocPath\":{\"type\":\"string\",\"description\":\"The Root TOC Path used for navbar in current version, relative to output root.\\nIf not set, will use the toc in output root in current version if exists.\"},\"case\":{\"type\":\"boolean\",\"description\":\"Pattern match will be case sensitive.\\nBy default the pattern is case insensitive.\"},\"noNegate\":{\"type\":\"boolean\",\"description\":\"Disable pattern begin with `!` to mean negate.\\nBy default the usage is enabled.\"},\"noExpand\":{\"type\":\"boolean\",\"description\":\"Disable `{a,b}c` => `[\\\"ac\\\", \\\"bc\\\"]`. By default the usage is enabled.\"},\"noEscape\":{\"type\":\"boolean\",\"description\":\"Disable the usage of `\\\\` to escape values.\\nBy default the usage is enabled.\"},\"noGlobStar\":{\"type\":\"boolean\",\"description\":\"Disable the usage of `**` to match everything including `/` when it is the beginning of the pattern or is after `/`.\\nBy default the usage is enable.\"},\"dot\":{\"type\":\"boolean\",\"description\":\"Allow files start with `.` to be matched even if `.` is not explicitly specified in the pattern.\\nBy default files start with `.` will not be matched by `*` unless the pattern starts with `.`.\"}},\"additionalProperties\":false,\"required\":[\"files\"]},\"xref\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded.\"},\"globalMetadataFiles\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"Specify a list of JSON file path containing globalMetadata settings, as similar to `{\\\"key\\\":\\\"value\\\"}`.\"},\"fileMetadataFiles\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"Specify a list of JSON file path containing fileMetadata settings, as similar to `{\\\"key\\\":\\\"value\\\"}`.\"},\"template\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"The latter ones will override the former ones if the name of the file inside the template collides. If omitted, embedded default template will be used.\"},\"theme\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"The themes applied to the documentation. Theme is used to customize the styles generated by `template`. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If omitted, no theme will be applied, the default theme inside the template will be used.\"},\"files\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"The file glob pattern collection, with path relative to property `src`/`cwd` if value is set.\"},\"exclude\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}],\"description\":\"The file glob pattern collection for files that should be excluded, with path relative to property `src`/`cwd` if value is set.\"},\"disableGitFeatures\":{\"type\":\"boolean\",\"description\":\"If set to true, DocFX would not fetch Git related information for articles.\"}},\"id\":\"https://json.schemastore.org/docfx.json\",\"properties\":{\"metadata\":{\"$ref\":\"#/definitions/metadataConfig\"},\"build\":{\"$ref\":\"#/definitions/buildConfig\"}},\"title\":\"DocFx configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DocFx configuration file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"buildConfig":{"type":"object","properties":{"content":{"$ref":"#/definitions/fileMappingContent"},"resource":{"$ref":"#/definitions/fileMappingResource"},"overwrite":{"$ref":"#/definitions/fileMappingOverwrite"},"externalReference":{"$ref":"#/definitions/fileMappingExternalReferences"},"xref":{"$ref":"#/definitions/xref"},"dest":{"type":"string"},"globalMetadata":{"type":"object","additionalProperties":true,"description":"Contains metadata that will be applied to every file, in key-value pair format."},"globalMetadataFiles":{"$ref":"#/definitions/globalMetadataFiles"},"fileMetadata":{"type":"object","additionalProperties":true,"description":"Contains metadata that will be applied to specific files."},"fileMetadataFiles":{"$ref":"#/definitions/fileMetadataFiles"},"template":{"$ref":"#/definitions/template"},"theme":{"$ref":"#/definitions/theme"},"postProcessors":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"serve":{"type":"boolean","description":""},"force":{"type":"boolean","description":""},"forcePostProcess":{"type":"boolean","description":"Force to re-process the documentation in post processors. It will be cascaded from force option."},"debug":{"type":"boolean","description":"Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false."},"debugOutput":{"type":"string","description":"The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx."},"port":{"type":"string","description":"Specify the port of the hosted website."},"exportRawModel":{"type":"boolean","description":"If set to true, data model to run template script will be extracted in `.raw.json` extension."},"rawModelOutputFolder":{"type":"string","description":"Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation."},"exportViewModel":{"type":"boolean","description":"If set to true, data model to apply template will be extracted in `.view.json` extension."},"viewModelOutputFolder":{"type":"string","description":"Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation."},"dryRun":{"type":"boolean","description":"If set to true, template will not be actually applied to the documents. This option is always used with `--exportRawModel` or `--exportViewModel`, so that only raw model files or view model files are generated."},"maxParallelism":{"type":"integer","minimum":0,"description":"Set the max parallelism, 0 (default) is same as the count of CPU cores."},"lruSize":{"type":"integer","minimum":0,"description":"Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled."},"markdownEngineName":{"type":"string","description":"Set the name of markdown engine, default is dfm, and another built-in engine is gfm."},"markdownEngineProperties":{"type":"object","additionalProperties":true,"description":"Set the parameters for markdown engine."},"noLangKeyword":{"type":"boolean","description":"Disable default lang keyword, e.g. `null`."},"intermediateFolder":{"type":"string"},"changesFile":{"type":"string"},"disableGitFeatures":{"$ref":"#/definitions/disableGitFeatures"},"keepFileLink":{"type":"boolean","description":"If set to true, DocFX does not copy file to the output folder. Instead, it saves a link_to_path property inside manifest.json."},"cleanupCacheHistory":{"type":"boolean","description":"If set to true, cleans up historical cache data when building."}},"description":"Build section defines configuration values for the build command.","additionalProperties":false},"metadataConfig":{"type":"array","items":{"$ref":"#/definitions/metadataConfigItem"},"description":"Metadata section defines an array of source projects and their output folder."},"metadataConfigItem":{"type":"object","properties":{"src":{"$ref":"#/definitions/fileMappingSrc"},"dest":{"type":"string","description":"Defines the output folder of the generated metadata files."},"disableGitFeatures":{"$ref":"#/definitions/disableGitFeatures"},"disableDefaultFilter":{"type":"boolean","description":"If set to true, disables default API visibility filter rule."},"force":{"type":"boolean","description":"If set to true, it would disable incremental build."},"shouldSkipMarkup":{"type":"boolean","description":"If set to true, DocFX would not render triple-slash-comments in source code as markdown."},"raw":{"type":"boolean"},"filter":{"type":"string","description":"Defines the filter configuration file."},"useCompatibilityFileName":{"type":"boolean","description":" If set to true, DocFX would keep ` in comment id instead of replacing it with -."}},"additionalProperties":false,"required":["src","dest"]},"fileMappingContent":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/definitions/fileMappingItem"}}],"description":"Contains all the files to generate documentation, including metadata `yml` files and conceptual `md` files."},"fileMappingResource":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/definitions/fileMappingItem"}}],"description":"Contains all the resource files that conceptual and metadata files dependent on, e.g. image files."},"fileMappingOverwrite":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/definitions/fileMappingItem"}}],"description":"Contains all the conceptual files which contains yaml header with `uid` and is intended to override the existing metadata `yml` files."},"fileMappingExternalReferences":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/definitions/fileMappingItem"}}],"description":"[Obsoleted] Contains `rpk` files that define the external references."},"fileMappingSrc":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/definitions/fileMappingItem"}}],"description":"Defines the source projects to have metadata generated."},"fileMappingItem":{"type":"object","properties":{"name":{"type":"string","description":"The name of current item, the value is not used for now."},"files":{"$ref":"#/definitions/files"},"exclude":{"$ref":"#/definitions/exclude"},"src":{"type":"string","description":"Defines the root folder for the source files, it has the same meaning as `cwd`"},"cwd":{"type":"string","description":"[Obsoleted] Defines the root folder for the source files, it has the same meaning as `src`"},"dest":{"type":"string","description":"The destination folder for the files if copy/transform is used."},"version":{"type":"string","description":"Version name for the current file-mapping item.\nIf not set, treat the current file-mapping item as in default version.\nMappings with the same version name will be built together.\nCross reference doesn't support cross different versions."},"rootTocPath":{"type":"string","description":"The Root TOC Path used for navbar in current version, relative to output root.\nIf not set, will use the toc in output root in current version if exists."},"case":{"type":"boolean","description":"Pattern match will be case sensitive.\nBy default the pattern is case insensitive."},"noNegate":{"type":"boolean","description":"Disable pattern begin with `!` to mean negate.\nBy default the usage is enabled."},"noExpand":{"type":"boolean","description":"Disable `{a,b}c` => `[\"ac\", \"bc\"]`. By default the usage is enabled."},"noEscape":{"type":"boolean","description":"Disable the usage of `\\` to escape values.\nBy default the usage is enabled."},"noGlobStar":{"type":"boolean","description":"Disable the usage of `**` to match everything including `/` when it is the beginning of the pattern or is after `/`.\nBy default the usage is enable."},"dot":{"type":"boolean","description":"Allow files start with `.` to be matched even if `.` is not explicitly specified in the pattern.\nBy default files start with `.` will not be matched by `*` unless the pattern starts with `.`."}},"additionalProperties":false,"required":["files"]},"xref":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded."},"globalMetadataFiles":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Specify a list of JSON file path containing globalMetadata settings, as similar to `{\"key\":\"value\"}`."},"fileMetadataFiles":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Specify a list of JSON file path containing fileMetadata settings, as similar to `{\"key\":\"value\"}`."},"template":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The latter ones will override the former ones if the name of the file inside the template collides. If omitted, embedded default template will be used."},"theme":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The themes applied to the documentation. Theme is used to customize the styles generated by `template`. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If omitted, no theme will be applied, the default theme inside the template will be used."},"files":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The file glob pattern collection, with path relative to property `src`/`cwd` if value is set."},"exclude":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The file glob pattern collection for files that should be excluded, with path relative to property `src`/`cwd` if value is set."},"disableGitFeatures":{"type":"boolean","description":"If set to true, DocFX would not fetch Git related information for articles."}},"id":"https://json.schemastore.org/docfx.json","properties":{"metadata":{"$ref":"#/definitions/metadataConfig"},"build":{"$ref":"#/definitions/buildConfig"}},"title":"DocFx configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "DocFx configuration file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
DocFx configuration file
|
schema-store
|
schema_store_265
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/docker-bake.json\",\"title\":\"Docker Bake JSON Schema\",\"description\":\"The Bake file is a file for defining workflows that you run using docker buildx bake.\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"target\":{\"description\":\"A target reflects a single docker build invocation.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/target\"}},\"group\":{\"description\":\"Groups allow you to invoke multiple builds (targets) at once.\",\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/definitions/group\"}},\"additionalProperties\":{\"$ref\":\"#/definitions/group\"}},\"variable\":{\"description\":\"The HCL file format supports variable block definitions. You can use variables as build arguments in your Dockerfile, or interpolate them in attribute values in your Bake file.\\nYou can assign a default value for a variable in the Bake file, or assign a null value to it. If you assign a null value, Buildx uses the default value from the Dockerfile instead.\\nYou can override variable defaults set in the Bake file using environment variables.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"default\":{\"type\":[\"string\",\"null\"]}},\"additionalProperties\":false}},\"function\":{\"description\":\"Functions allow you to define custom functions that you can use in your Bake file. You can use functions to generate values for attributes in your targets.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"params\":{\"description\":\"Arguments for the function.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"variadic_params\":{\"description\":\"Variable-length argument list.\",\"type\":\"string\"},\"result\":{\"description\":\"Return value. It can take not only just string but also other functions, variables and etc.\\nIf you want to interpolate variables or logic, put them in ${}.\\nFor example, if you want to increment a number param, you can do it like this: ${number+1}\",\"type\":\"string\"}},\"required\":[\"result\"]}}},\"additionalProperties\":false,\"definitions\":{\"keyValue\":{\"type\":\"string\",\"pattern\":\"^[^=]+=[^=]+$\"},\"shmSize\":{\"type\":\"string\",\"pattern\":\"^[1-9][0-9]*[bkmg]?$\"},\"ulimit\":{\"type\":\"string\",\"pattern\":\"^[a-z]+=[0-9]+(?::[0-9]+)?$\"},\"group\":{\"type\":\"object\",\"properties\":{\"targets\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"targets\"]},\"target\":{\"type\":\"object\",\"properties\":{\"args\":{\"description\":\"Use the args attribute to define build arguments for the target. This has the same effect as passing a --build-arg flag to the build command.\\nYou can set args attributes to use null values. Doing so forces the target to use the ARG value specified in the Dockerfile.\",\"type\":\"object\",\"additionalProperties\":{\"type\":[\"string\",\"null\"]}},\"annotations\":{\"description\":\"The annotations attribute lets you add annotations to images built with bake. The key takes a list of annotations, in the format of KEY=VALUE.\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/keyValue\"},{\"type\":\"null\"}]}},\"attest\":{\"description\":\"The attest attribute lets you apply build attestations to the target. This attribute accepts the long-form CSV version of attestation parameters.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/keyValue\"}},\"cache-from\":{\"description\":\"Build cache sources. The builder imports cache from the locations you specify. It uses the Buildx cache storage backends, and it works the same way as the --cache-from flag. This takes a list value, so you can specify multiple cache sources.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"cache-to\":{\"description\":\"Build cache export destinations. The builder exports its build cache to the locations you specify. It uses the Buildx cache storage backends, and it works the same way as the --cache-to flag. This takes a list value, so you can specify multiple cache export targets.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"context\":{\"description\":\"Specifies the location of the build context to use for this target. Accepts a URL or a directory path. This is the same as the build context positional argument that you pass to the build command.\",\"type\":\"string\",\"default\":\".\"},\"contexts\":{\"description\":\"Additional build contexts. This is the same as the --build-context flag. This attribute takes a map, where keys result in named contexts that you can reference in your builds.\\nYou can specify different types of contexts, such local directories, Git URLs, and even other Bake targets. Bake automatically determines the type of a context based on the pattern of the context value.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"dockerfile-inline\":{\"description\":\"Uses the string value as an inline Dockerfile for the build target.\\nThe dockerfile-inline takes precedence over the dockerfile attribute. If you specify both, Bake uses the inline version.\",\"type\":\"string\"},\"dockerfile\":{\"description\":\"Name of the Dockerfile to use for the build. This is the same as the --file flag for the docker build command.\",\"type\":\"string\",\"default\":\"Dockerfile\"},\"inherits\":{\"description\":\"A target can inherit attributes from other targets. Use inherits to reference from one target to another.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"labels\":{\"description\":\"Assigns image labels to the build. This is the same as the --label flag for docker build.\\nt's possible to use a null value for labels. If you do, the builder uses the label value specified in the Dockerfile.\",\"type\":\"object\",\"additionalProperties\":{\"type\":[\"string\",\"null\"]}},\"matrix\":{\"description\":\"A matrix strategy lets you fork a single target into multiple different variants, based on parameters that you specify. This works in a similar way to [Matrix strategies for GitHub Actions]. You can use this to reduce duplication in your bake definition.\\nThe matrix attribute is a map of parameter names to lists of values. Bake builds each possible combination of values as a separate target.\\nEach generated target must have a unique name. To specify how target names should resolve, use the name attribute.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\"}},\"name\":{\"description\":\"Specify name resolution for targets that use a matrix strategy.\",\"type\":\"string\"},\"no-cache-filter\":{\"description\":\"Don't use build cache for the specified stages. This is the same as the --no-cache-filter flag for docker build.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"no-cache\":{\"description\":\"Don't use cache when building the image. This is the same as the --no-cache flag for docker build.\",\"type\":\"boolean\"},\"output\":{\"description\":\"Configuration for exporting the build output. This is the same as the --output flag.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"platforms\":{\"description\":\"Set target platforms for the build target. This is the same as the --platform flag.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"pull\":{\"description\":\"Configures whether the builder should attempt to pull images when building the target. This is the same as the --pull flag for docker build.\",\"type\":\"boolean\"},\"secret\":{\"description\":\"Defines secrets to expose to the build target. This is the same as the --secret flag.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"shm-size\":{\"$ref\":\"#/definitions/shmSize\",\"description\":\"Sets the size of the shared memory allocated for build containers when using RUN instructions.\\nThe format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m (megabytes), or g (gigabytes). If you omit the unit, the system uses bytes.\\nThis is the same as the --shm-size flag for docker build.\"},\"ssh\":{\"description\":\"Defines SSH agent sockets or keys to expose to the build. This is the same as the --ssh flag. This can be useful if you need to access private repositories during a build.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tags\":{\"description\":\"Image names and tags to use for the build target. This is the same as the --tag flag.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"target\":{\"description\":\"Set the target build stage to build. This is the same as the --target flag.\",\"type\":\"string\"},\"ulimits\":{\"description\":\"Ulimits overrides the default ulimits of build's containers when using RUN instructions and are specified with a soft and hard limit as such: <type>=<soft limit>[:<hard limit>].\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ulimit\"}}},\"additionalProperties\":false}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Docker Bake JSON Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/docker-bake.json","title":"Docker Bake JSON Schema","description":"The Bake file is a file for defining workflows that you run using docker buildx bake.","properties":{"$schema":{"type":"string"},"target":{"description":"A target reflects a single docker build invocation.","type":"object","additionalProperties":{"$ref":"#/definitions/target"}},"group":{"description":"Groups allow you to invoke multiple builds (targets) at once.","type":"object","properties":{"default":{"$ref":"#/definitions/group"}},"additionalProperties":{"$ref":"#/definitions/group"}},"variable":{"description":"The HCL file format supports variable block definitions. You can use variables as build arguments in your Dockerfile, or interpolate them in attribute values in your Bake file.\nYou can assign a default value for a variable in the Bake file, or assign a null value to it. If you assign a null value, Buildx uses the default value from the Dockerfile instead.\nYou can override variable defaults set in the Bake file using environment variables.","type":"object","additionalProperties":{"type":"object","properties":{"default":{"type":["string","null"]}},"additionalProperties":false}},"function":{"description":"Functions allow you to define custom functions that you can use in your Bake file. You can use functions to generate values for attributes in your targets.","type":"object","additionalProperties":{"type":"object","properties":{"params":{"description":"Arguments for the function.","type":"array","items":{"type":"string"}},"variadic_params":{"description":"Variable-length argument list.","type":"string"},"result":{"description":"Return value. It can take not only just string but also other functions, variables and etc.\nIf you want to interpolate variables or logic, put them in ${}.\nFor example, if you want to increment a number param, you can do it like this: ${number+1}","type":"string"}},"required":["result"]}}},"additionalProperties":false,"definitions":{"keyValue":{"type":"string","pattern":"^[^=]+=[^=]+$"},"shmSize":{"type":"string","pattern":"^[1-9][0-9]*[bkmg]?$"},"ulimit":{"type":"string","pattern":"^[a-z]+=[0-9]+(?::[0-9]+)?$"},"group":{"type":"object","properties":{"targets":{"type":"array","items":{"type":"string"}}},"required":["targets"]},"target":{"type":"object","properties":{"args":{"description":"Use the args attribute to define build arguments for the target. This has the same effect as passing a --build-arg flag to the build command.\nYou can set args attributes to use null values. Doing so forces the target to use the ARG value specified in the Dockerfile.","type":"object","additionalProperties":{"type":["string","null"]}},"annotations":{"description":"The annotations attribute lets you add annotations to images built with bake. The key takes a list of annotations, in the format of KEY=VALUE.","type":"array","items":{"oneOf":[{"$ref":"#/definitions/keyValue"},{"type":"null"}]}},"attest":{"description":"The attest attribute lets you apply build attestations to the target. This attribute accepts the long-form CSV version of attestation parameters.","type":"array","items":{"$ref":"#/definitions/keyValue"}},"cache-from":{"description":"Build cache sources. The builder imports cache from the locations you specify. It uses the Buildx cache storage backends, and it works the same way as the --cache-from flag. This takes a list value, so you can specify multiple cache sources.","type":"array","items":{"type":"string"}},"cache-to":{"description":"Build cache export destinations. The builder exports its build cache to the locations you specify. It uses the Buildx cache storage backends, and it works the same way as the --cache-to flag. This takes a list value, so you can specify multiple cache export targets.","type":"array","items":{"type":"string"}},"context":{"description":"Specifies the location of the build context to use for this target. Accepts a URL or a directory path. This is the same as the build context positional argument that you pass to the build command.","type":"string","default":"."},"contexts":{"description":"Additional build contexts. This is the same as the --build-context flag. This attribute takes a map, where keys result in named contexts that you can reference in your builds.\nYou can specify different types of contexts, such local directories, Git URLs, and even other Bake targets. Bake automatically determines the type of a context based on the pattern of the context value.","type":"object","additionalProperties":{"type":"string"}},"dockerfile-inline":{"description":"Uses the string value as an inline Dockerfile for the build target.\nThe dockerfile-inline takes precedence over the dockerfile attribute. If you specify both, Bake uses the inline version.","type":"string"},"dockerfile":{"description":"Name of the Dockerfile to use for the build. This is the same as the --file flag for the docker build command.","type":"string","default":"Dockerfile"},"inherits":{"description":"A target can inherit attributes from other targets. Use inherits to reference from one target to another.","type":"array","items":{"type":"string"}},"labels":{"description":"Assigns image labels to the build. This is the same as the --label flag for docker build.\nt's possible to use a null value for labels. If you do, the builder uses the label value specified in the Dockerfile.","type":"object","additionalProperties":{"type":["string","null"]}},"matrix":{"description":"A matrix strategy lets you fork a single target into multiple different variants, based on parameters that you specify. This works in a similar way to [Matrix strategies for GitHub Actions]. You can use this to reduce duplication in your bake definition.\nThe matrix attribute is a map of parameter names to lists of values. Bake builds each possible combination of values as a separate target.\nEach generated target must have a unique name. To specify how target names should resolve, use the name attribute.","type":"object","additionalProperties":{"type":"array"}},"name":{"description":"Specify name resolution for targets that use a matrix strategy.","type":"string"},"no-cache-filter":{"description":"Don't use build cache for the specified stages. This is the same as the --no-cache-filter flag for docker build.","type":"array","items":{"type":"string"}},"no-cache":{"description":"Don't use cache when building the image. This is the same as the --no-cache flag for docker build.","type":"boolean"},"output":{"description":"Configuration for exporting the build output. This is the same as the --output flag.","type":"array","items":{"type":"string"}},"platforms":{"description":"Set target platforms for the build target. This is the same as the --platform flag.","type":"array","items":{"type":"string"}},"pull":{"description":"Configures whether the builder should attempt to pull images when building the target. This is the same as the --pull flag for docker build.","type":"boolean"},"secret":{"description":"Defines secrets to expose to the build target. This is the same as the --secret flag.","type":"array","items":{"type":"string"}},"shm-size":{"$ref":"#/definitions/shmSize","description":"Sets the size of the shared memory allocated for build containers when using RUN instructions.\nThe format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m (megabytes), or g (gigabytes). If you omit the unit, the system uses bytes.\nThis is the same as the --shm-size flag for docker build."},"ssh":{"description":"Defines SSH agent sockets or keys to expose to the build. This is the same as the --ssh flag. This can be useful if you need to access private repositories during a build.","type":"array","items":{"type":"string"}},"tags":{"description":"Image names and tags to use for the build target. This is the same as the --tag flag.","type":"array","items":{"type":"string"}},"target":{"description":"Set the target build stage to build. This is the same as the --target flag.","type":"string"},"ulimits":{"description":"Ulimits overrides the default ulimits of build's containers when using RUN instructions and are specified with a soft and hard limit as such: <type>=<soft limit>[:<hard limit>].","type":"array","items":{"$ref":"#/definitions/ulimit"}}},"additionalProperties":false}},"type":"object"}
|
Provide a JSON object that satisfies the schema "Docker Bake JSON Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Docker Bake JSON Schema
|
schema-store
|
schema_store_266
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://example.com/product.schema.json\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"docker-seq\",\"description\":\"The schema for `docker-seq`\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"image\":{\"type\":\"string\",\"description\":\"The docker image name\"},\"workdir\":{\"type\":\"string\",\"description\":\"Working directory inside the container\"},\"user\":{\"type\":\"string\",\"description\":\"Username or UID (format: <name|uid>[:<group|gid>])\"},\"local_user\":{\"type\":\"boolean\",\"description\":\"Disables the `user` option and runs the container with the hosts uid and gid.\"},\"tty\":{\"type\":\"boolean\",\"description\":\"Allocate a pseudo-TTY\"},\"interactive\":{\"type\":\"boolean\",\"description\":\"Keep STDIN open even if not attached\"},\"pull\":{\"type\":\"string\",\"description\":\"Pull image before running (\\\"always\\\"|\\\"missing\\\"|\\\"never\\\") (default \\\"missing\\\")\",\"enum\":[\"always\",\"missing\",\"never\"]},\"rm\":{\"type\":\"boolean\",\"description\":\"Automatically remove the container when it exits\"},\"init\":{\"type\":\"boolean\",\"description\":\"Run an init inside the container that forwards signals and reaps processes\"},\"volumes\":{\"type\":\"array\",\"description\":\"Bind mount volumes\"},\"publish\":{\"type\":\"array\",\"description\":\"Publish a container's port(s) to the host\"},\"env\":{\"type\":\"array\",\"description\":\"Set environment variables\"},\"env_file\":{\"type\":\"array\",\"description\":\"Read in files of environment variables\"},\"cpus\":{\"type\":\"string\",\"description\":\"Number of CPUs\"},\"memory\":{\"type\":\"integer\",\"description\":\"Memory limit in bytes\"},\"entrypoint\":{\"type\":\"string\",\"description\":\"Overwrite the default ENTRYPOINT of the image\"},\"name\":{\"type\":\"string\",\"description\":\"Assign a name to the container\"},\"privileged\":{\"type\":\"boolean\",\"description\":\"Give extended privileges to this container\"},\"network\":{\"type\":\"string\"},\"mount\":{\"type\":\"array\",\"description\":\"Attach a filesystem mount to the container\"},\"read_only\":{\"type\":\"boolean\",\"description\":\"Mount the container's root filesystem as read only\"},\"platform\":{\"type\":\"string\",\"description\":\"Set platform if server is multi-platform capable\"},\"runtime\":{\"type\":\"string\",\"description\":\"Runtime to use for this container\"},\"security_opt\":{\"type\":\"array\",\"description\":\"Security Options\"},\"ulimit\":{\"type\":\"string\",\"description\":\"Ulimit options\"},\"volumes_from\":{\"type\":\"array\",\"description\":\"Mount volumes from the specified container(s)\"},\"background_task\":{\"type\":\"array\",\"description\":\"Task with which to keep the container alive while executing commands\"},\"docker_exec_shell\":{\"type\":\"array\",\"description\":\"Shell in which to execute each sequence step command\"},\"sequence\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Step\"}}},\"definitions\":{\"Step\":{\"type\":\"object\",\"description\":\"One step in the command sequence\",\"additionalProperties\":false,\"properties\":{\"workdir\":{\"type\":\"string\",\"description\":\"Working directory inside the container\"},\"user\":{\"type\":\"string\",\"description\":\"Username or UID (format: <name|uid>[:<group|gid>])\"},\"local_user\":{\"type\":\"boolean\",\"description\":\"Disables the `user` option and executes these commands with the hosts uid and gid.\"},\"tty\":{\"type\":\"boolean\",\"description\":\"Allocate a pseudo-TTY\"},\"privileged\":{\"type\":\"boolean\",\"description\":\"Give extended privileges to the commands\"},\"interactive\":{\"type\":\"boolean\",\"description\":\"Keep STDIN open even if not attached\"},\"commands\":{\"type\":\"array\",\"description\":\"A list of commands to execute within the container\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"docker-seq\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://example.com/product.schema.json","$schema":"http://json-schema.org/draft-07/schema#","title":"docker-seq","description":"The schema for `docker-seq`","type":"object","additionalProperties":false,"properties":{"image":{"type":"string","description":"The docker image name"},"workdir":{"type":"string","description":"Working directory inside the container"},"user":{"type":"string","description":"Username or UID (format: <name|uid>[:<group|gid>])"},"local_user":{"type":"boolean","description":"Disables the `user` option and runs the container with the hosts uid and gid."},"tty":{"type":"boolean","description":"Allocate a pseudo-TTY"},"interactive":{"type":"boolean","description":"Keep STDIN open even if not attached"},"pull":{"type":"string","description":"Pull image before running (\"always\"|\"missing\"|\"never\") (default \"missing\")","enum":["always","missing","never"]},"rm":{"type":"boolean","description":"Automatically remove the container when it exits"},"init":{"type":"boolean","description":"Run an init inside the container that forwards signals and reaps processes"},"volumes":{"type":"array","description":"Bind mount volumes"},"publish":{"type":"array","description":"Publish a container's port(s) to the host"},"env":{"type":"array","description":"Set environment variables"},"env_file":{"type":"array","description":"Read in files of environment variables"},"cpus":{"type":"string","description":"Number of CPUs"},"memory":{"type":"integer","description":"Memory limit in bytes"},"entrypoint":{"type":"string","description":"Overwrite the default ENTRYPOINT of the image"},"name":{"type":"string","description":"Assign a name to the container"},"privileged":{"type":"boolean","description":"Give extended privileges to this container"},"network":{"type":"string"},"mount":{"type":"array","description":"Attach a filesystem mount to the container"},"read_only":{"type":"boolean","description":"Mount the container's root filesystem as read only"},"platform":{"type":"string","description":"Set platform if server is multi-platform capable"},"runtime":{"type":"string","description":"Runtime to use for this container"},"security_opt":{"type":"array","description":"Security Options"},"ulimit":{"type":"string","description":"Ulimit options"},"volumes_from":{"type":"array","description":"Mount volumes from the specified container(s)"},"background_task":{"type":"array","description":"Task with which to keep the container alive while executing commands"},"docker_exec_shell":{"type":"array","description":"Shell in which to execute each sequence step command"},"sequence":{"type":"array","items":{"$ref":"#/definitions/Step"}}},"definitions":{"Step":{"type":"object","description":"One step in the command sequence","additionalProperties":false,"properties":{"workdir":{"type":"string","description":"Working directory inside the container"},"user":{"type":"string","description":"Username or UID (format: <name|uid>[:<group|gid>])"},"local_user":{"type":"boolean","description":"Disables the `user` option and executes these commands with the hosts uid and gid."},"tty":{"type":"boolean","description":"Allocate a pseudo-TTY"},"privileged":{"type":"boolean","description":"Give extended privileges to the commands"},"interactive":{"type":"boolean","description":"Keep STDIN open even if not attached"},"commands":{"type":"array","description":"A list of commands to execute within the container"}}}}}
|
Provide a JSON object that satisfies the schema "docker-seq". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
docker-seq
|
schema-store
|
schema_store_267
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dockerd.json\",\"description\":\"https://docs.docker.com/engine/reference/commandline/dockerd/#daemon\",\"properties\":{\"allow-nondistributable-artifacts\":{\"type\":\"array\",\"items\":{}},\"api-cors-header\":{\"type\":\"string\"},\"authorization-plugins\":{\"type\":\"array\",\"items\":{}},\"bip\":{\"type\":\"string\"},\"bridge\":{\"type\":\"string\"},\"cgroup-parent\":{\"type\":\"string\"},\"cluster-advertise\":{\"type\":\"string\"},\"cluster-store\":{\"type\":\"string\"},\"cluster-store-opts\":{\"type\":\"object\"},\"containerd\":{\"type\":\"string\",\"examples\":[\"/run/containerd/containerd.sock\"]},\"containerd-namespace\":{\"type\":\"string\",\"examples\":[\"docker\"]},\"containerd-plugin-namespace\":{\"type\":\"string\",\"examples\":[\"docker-plugins\"]},\"data-root\":{\"type\":\"string\"},\"debug\":{\"type\":\"boolean\",\"default\":false,\"examples\":[true]},\"default-address-pools\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"base\":{\"type\":\"string\",\"examples\":[\"172.30.0.0/16\",\"172.31.0.0/16\"]},\"size\":{\"type\":\"number\",\"examples\":[24]}},\"examples\":[{\"base\":\"172.30.0.0/16\",\"size\":24},{\"base\":\"172.31.0.0/16\",\"size\":24}]},\"examples\":[[{\"base\":\"172.30.0.0/16\",\"size\":24},{\"base\":\"172.31.0.0/16\",\"size\":24}]]},\"default-cgroupns-mode\":{\"type\":\"string\",\"default\":\"host\",\"examples\":[\"host\",\"private\"],\"enum\":[\"private\",\"host\"]},\"default-ipc-mode\":{\"type\":\"string\",\"default\":\"private\",\"examples\":[\"shareable\",\"private\"],\"enum\":[\"shareable\",\"private\"]},\"default-gateway\":{\"type\":\"string\"},\"default-gateway-v6\":{\"type\":\"string\"},\"default-runtime\":{\"type\":\"string\",\"default\":\"containerd\",\"examples\":[\"runc\",\"containerd\"]},\"default-shm-size\":{\"type\":\"string\",\"examples\":[\"64M\"]},\"default-ulimits\":{\"type\":\"object\",\"properties\":{\"nofile\":{\"type\":\"object\",\"properties\":{\"Hard\":{\"type\":\"number\",\"default\":0,\"examples\":[64000]},\"Name\":{\"type\":\"string\",\"examples\":[\"nofile\"]},\"Soft\":{\"type\":\"number\",\"default\":0,\"examples\":[64000]}},\"examples\":[{\"Hard\":64000,\"Name\":\"nofile\",\"Soft\":64000}]}},\"examples\":[{\"nofile\":{\"Hard\":64000,\"Name\":\"nofile\",\"Soft\":64000}}]},\"dns\":{\"type\":\"array\",\"items\":{}},\"dns-opts\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"dns-search\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"exec-opts\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"exec-root\":{\"type\":\"string\"},\"experimental\":{\"type\":\"boolean\",\"default\":false,\"examples\":[true]},\"features\":{\"type\":\"object\"},\"fixed-cidr\":{\"type\":\"string\"},\"fixed-cidr-v6\":{\"type\":\"string\"},\"group\":{\"type\":\"string\"},\"hosts\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"icc\":{\"type\":\"boolean\",\"default\":false},\"init\":{\"type\":\"boolean\",\"default\":false},\"init-path\":{\"type\":\"string\",\"examples\":[\"/usr/libexec/docker-init\"]},\"insecure-registries\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ip\":{\"type\":\"string\",\"examples\":[\"0.0.0.0\"]},\"ip-forward\":{\"type\":\"boolean\",\"default\":false},\"ip-masq\":{\"type\":\"boolean\",\"default\":false},\"iptables\":{\"type\":\"boolean\",\"default\":false},\"ip6tables\":{\"type\":\"boolean\",\"default\":false},\"ipv6\":{\"type\":\"boolean\",\"default\":false},\"labels\":{\"type\":\"array\",\"items\":{}},\"live-restore\":{\"type\":\"boolean\",\"default\":false,\"examples\":[true]},\"log-driver\":{\"type\":\"string\",\"examples\":[\"json-file\"]},\"log-level\":{\"type\":\"string\"},\"log-opts\":{\"type\":\"object\",\"properties\":{\"cache-disabled\":{\"type\":\"string\",\"examples\":[\"false\"]},\"cache-max-file\":{\"type\":\"string\",\"examples\":[\"5\"]},\"cache-max-size\":{\"type\":\"string\",\"examples\":[\"20m\"]},\"cache-compress\":{\"type\":\"string\",\"examples\":[\"true\"]},\"env\":{\"type\":\"string\",\"examples\":[\"os,customer\"]},\"labels\":{\"type\":\"string\",\"examples\":[\"somelabel\"]},\"max-file\":{\"type\":\"string\",\"examples\":[\"5\"]},\"max-size\":{\"type\":\"string\",\"examples\":[\"10m\"]}},\"examples\":[{\"cache-disabled\":\"false\",\"cache-max-file\":\"5\",\"cache-max-size\":\"20m\",\"cache-compress\":\"true\",\"env\":\"os,customer\",\"labels\":\"somelabel\",\"max-file\":\"5\",\"max-size\":\"10m\"}]},\"max-concurrent-downloads\":{\"type\":\"number\",\"default\":0,\"examples\":[3]},\"max-concurrent-uploads\":{\"type\":\"number\",\"default\":0,\"examples\":[5]},\"max-download-attempts\":{\"type\":\"number\",\"default\":0,\"examples\":[5]},\"mtu\":{\"type\":\"number\",\"default\":0,\"examples\":[0]},\"no-new-privileges\":{\"type\":\"boolean\",\"default\":false},\"node-generic-resources\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"examples\":[\"NVIDIA-GPU=UUID1\",\"NVIDIA-GPU=UUID2\"]},\"examples\":[[\"NVIDIA-GPU=UUID1\",\"NVIDIA-GPU=UUID2\"]]},\"oom-score-adjust\":{\"type\":\"number\",\"examples\":[-500]},\"pidfile\":{\"type\":\"string\"},\"raw-logs\":{\"type\":\"boolean\",\"default\":false},\"registry-mirrors\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"runtimes\":{\"type\":\"object\",\"properties\":{\"cc-runtime\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\",\"examples\":[\"/usr/bin/cc-runtime\"]}},\"examples\":[{\"path\":\"/usr/bin/cc-runtime\"}]},\"custom\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\",\"examples\":[\"/usr/local/bin/my-runc-replacement\"]},\"runtimeArgs\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"examples\":[\"--debug\"]},\"examples\":[[\"--debug\"]]}},\"examples\":[{\"path\":\"/usr/local/bin/my-runc-replacement\",\"runtimeArgs\":[\"--debug\"]}]}},\"examples\":[{\"cc-runtime\":{\"path\":\"/usr/bin/cc-runtime\"},\"custom\":{\"path\":\"/usr/local/bin/my-runc-replacement\",\"runtimeArgs\":[\"--debug\"]}}]},\"seccomp-profile\":{\"type\":\"string\"},\"selinux-enabled\":{\"type\":\"boolean\",\"default\":false},\"shutdown-timeout\":{\"type\":\"number\",\"default\":0,\"examples\":[15]},\"storage-driver\":{\"type\":\"string\"},\"storage-opts\":{\"type\":\"array\",\"items\":{}},\"swarm-default-advertise-addr\":{\"type\":\"string\"},\"tls\":{\"type\":\"boolean\",\"default\":false,\"examples\":[true]},\"tlscacert\":{\"type\":\"string\"},\"tlscert\":{\"type\":\"string\"},\"tlskey\":{\"type\":\"string\"},\"tlsverify\":{\"type\":\"boolean\",\"default\":false,\"examples\":[true]},\"userland-proxy\":{\"type\":\"boolean\",\"default\":false},\"userland-proxy-path\":{\"type\":\"string\",\"examples\":[\"/usr/libexec/docker-proxy\"]},\"userns-remap\":{\"type\":\"string\"}},\"title\":\"Docker Daemon configuration schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Docker Daemon configuration schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dockerd.json","description":"https://docs.docker.com/engine/reference/commandline/dockerd/#daemon","properties":{"allow-nondistributable-artifacts":{"type":"array","items":{}},"api-cors-header":{"type":"string"},"authorization-plugins":{"type":"array","items":{}},"bip":{"type":"string"},"bridge":{"type":"string"},"cgroup-parent":{"type":"string"},"cluster-advertise":{"type":"string"},"cluster-store":{"type":"string"},"cluster-store-opts":{"type":"object"},"containerd":{"type":"string","examples":["/run/containerd/containerd.sock"]},"containerd-namespace":{"type":"string","examples":["docker"]},"containerd-plugin-namespace":{"type":"string","examples":["docker-plugins"]},"data-root":{"type":"string"},"debug":{"type":"boolean","default":false,"examples":[true]},"default-address-pools":{"type":"array","items":{"type":"object","properties":{"base":{"type":"string","examples":["172.30.0.0/16","172.31.0.0/16"]},"size":{"type":"number","examples":[24]}},"examples":[{"base":"172.30.0.0/16","size":24},{"base":"172.31.0.0/16","size":24}]},"examples":[[{"base":"172.30.0.0/16","size":24},{"base":"172.31.0.0/16","size":24}]]},"default-cgroupns-mode":{"type":"string","default":"host","examples":["host","private"],"enum":["private","host"]},"default-ipc-mode":{"type":"string","default":"private","examples":["shareable","private"],"enum":["shareable","private"]},"default-gateway":{"type":"string"},"default-gateway-v6":{"type":"string"},"default-runtime":{"type":"string","default":"containerd","examples":["runc","containerd"]},"default-shm-size":{"type":"string","examples":["64M"]},"default-ulimits":{"type":"object","properties":{"nofile":{"type":"object","properties":{"Hard":{"type":"number","default":0,"examples":[64000]},"Name":{"type":"string","examples":["nofile"]},"Soft":{"type":"number","default":0,"examples":[64000]}},"examples":[{"Hard":64000,"Name":"nofile","Soft":64000}]}},"examples":[{"nofile":{"Hard":64000,"Name":"nofile","Soft":64000}}]},"dns":{"type":"array","items":{}},"dns-opts":{"type":"array","items":{"type":"string"}},"dns-search":{"type":"array","items":{"type":"string"}},"exec-opts":{"type":"array","items":{"type":"string"}},"exec-root":{"type":"string"},"experimental":{"type":"boolean","default":false,"examples":[true]},"features":{"type":"object"},"fixed-cidr":{"type":"string"},"fixed-cidr-v6":{"type":"string"},"group":{"type":"string"},"hosts":{"type":"array","items":{"type":"string"}},"icc":{"type":"boolean","default":false},"init":{"type":"boolean","default":false},"init-path":{"type":"string","examples":["/usr/libexec/docker-init"]},"insecure-registries":{"type":"array","items":{"type":"string"}},"ip":{"type":"string","examples":["0.0.0.0"]},"ip-forward":{"type":"boolean","default":false},"ip-masq":{"type":"boolean","default":false},"iptables":{"type":"boolean","default":false},"ip6tables":{"type":"boolean","default":false},"ipv6":{"type":"boolean","default":false},"labels":{"type":"array","items":{}},"live-restore":{"type":"boolean","default":false,"examples":[true]},"log-driver":{"type":"string","examples":["json-file"]},"log-level":{"type":"string"},"log-opts":{"type":"object","properties":{"cache-disabled":{"type":"string","examples":["false"]},"cache-max-file":{"type":"string","examples":["5"]},"cache-max-size":{"type":"string","examples":["20m"]},"cache-compress":{"type":"string","examples":["true"]},"env":{"type":"string","examples":["os,customer"]},"labels":{"type":"string","examples":["somelabel"]},"max-file":{"type":"string","examples":["5"]},"max-size":{"type":"string","examples":["10m"]}},"examples":[{"cache-disabled":"false","cache-max-file":"5","cache-max-size":"20m","cache-compress":"true","env":"os,customer","labels":"somelabel","max-file":"5","max-size":"10m"}]},"max-concurrent-downloads":{"type":"number","default":0,"examples":[3]},"max-concurrent-uploads":{"type":"number","default":0,"examples":[5]},"max-download-attempts":{"type":"number","default":0,"examples":[5]},"mtu":{"type":"number","default":0,"examples":[0]},"no-new-privileges":{"type":"boolean","default":false},"node-generic-resources":{"type":"array","items":{"type":"string","examples":["NVIDIA-GPU=UUID1","NVIDIA-GPU=UUID2"]},"examples":[["NVIDIA-GPU=UUID1","NVIDIA-GPU=UUID2"]]},"oom-score-adjust":{"type":"number","examples":[-500]},"pidfile":{"type":"string"},"raw-logs":{"type":"boolean","default":false},"registry-mirrors":{"type":"array","items":{"type":"string"}},"runtimes":{"type":"object","properties":{"cc-runtime":{"type":"object","properties":{"path":{"type":"string","examples":["/usr/bin/cc-runtime"]}},"examples":[{"path":"/usr/bin/cc-runtime"}]},"custom":{"type":"object","properties":{"path":{"type":"string","examples":["/usr/local/bin/my-runc-replacement"]},"runtimeArgs":{"type":"array","items":{"type":"string","examples":["--debug"]},"examples":[["--debug"]]}},"examples":[{"path":"/usr/local/bin/my-runc-replacement","runtimeArgs":["--debug"]}]}},"examples":[{"cc-runtime":{"path":"/usr/bin/cc-runtime"},"custom":{"path":"/usr/local/bin/my-runc-replacement","runtimeArgs":["--debug"]}}]},"seccomp-profile":{"type":"string"},"selinux-enabled":{"type":"boolean","default":false},"shutdown-timeout":{"type":"number","default":0,"examples":[15]},"storage-driver":{"type":"string"},"storage-opts":{"type":"array","items":{}},"swarm-default-advertise-addr":{"type":"string"},"tls":{"type":"boolean","default":false,"examples":[true]},"tlscacert":{"type":"string"},"tlscert":{"type":"string"},"tlskey":{"type":"string"},"tlsverify":{"type":"boolean","default":false,"examples":[true]},"userland-proxy":{"type":"boolean","default":false},"userland-proxy-path":{"type":"string","examples":["/usr/libexec/docker-proxy"]},"userns-remap":{"type":"string"}},"title":"Docker Daemon configuration schema","type":"object"}
|
Provide a JSON object that satisfies the schema "Docker Daemon configuration schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Docker Daemon configuration schema
|
schema-store
|
schema_store_268
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dofigen.json\",\"title\":\"Dofigen\",\"description\":\"Dofigen is a Dockerfile generator using a simplified description in YAML or JSON format\",\"anyOf\":[{\"$ref\":\"#/definitions/FromContext\"},{\"type\":\"object\",\"properties\":{\"arg\":{\"anyOf\":[{\"$ref\":\"#/definitions/HashMapPatch<String, String>\"},{\"type\":\"null\"}]},\"bind\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Bind>>\"},{\"type\":\"null\"}]},\"builders\":{\"anyOf\":[{\"$ref\":\"#/definitions/HashMapDeepPatch<String, Stage>\"},{\"type\":\"null\"}]},\"cache\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Cache>>\"},{\"type\":\"null\"}]},\"cmd\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"context\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"copy\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<CopyResourcePatch>>\"},{\"type\":\"null\"}]},\"entrypoint\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"env\":{\"anyOf\":[{\"$ref\":\"#/definitions/HashMapPatch<String, String>\"},{\"type\":\"null\"}]},\"expose\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Port>>\"},{\"type\":\"null\"}]},\"extend\":{\"$ref\":\"#/definitions/OneOrMany<Resource>\"},\"healthcheck\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Healthcheck\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"ignore\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"label\":{\"anyOf\":[{\"$ref\":\"#/definitions/NestedMap_for_String\"},{\"type\":\"null\"}]},\"root\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Run\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"run\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"user\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ParsableStruct<User>\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"volume\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"workdir\":{\"default\":null,\"type\":[\"string\",\"null\"]}}}],\"definitions\":{\"Add\":{\"title\":\"Add\",\"type\":\"object\",\"properties\":{\"checksum\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<Resource>\"},{\"type\":\"null\"}]},\"link\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}},\"AddGitRepo\":{\"title\":\"AddGitRepo\",\"type\":\"object\",\"properties\":{\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"exclude\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"keepGitDir\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"link\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"repo\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}},\"Bind\":{\"title\":\"Bind\",\"anyOf\":[{\"$ref\":\"#/definitions/FromContext\"},{\"type\":\"object\",\"properties\":{\"readwrite\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"source\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}}]},\"Cache\":{\"title\":\"Cache\",\"anyOf\":[{\"$ref\":\"#/definitions/FromContext\"},{\"type\":\"object\",\"properties\":{\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"id\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"readonly\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"sharing\":{\"default\":null,\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/CacheSharing\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"source\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}}]},\"CacheSharing\":{\"description\":\"Represents a cache sharing strategy\",\"type\":\"string\",\"enum\":[\"shared\",\"private\",\"locked\"]},\"Copy\":{\"title\":\"Copy\",\"anyOf\":[{\"$ref\":\"#/definitions/FromContext\"},{\"type\":\"object\",\"properties\":{\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"exclude\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"link\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"parents\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"paths\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}}]},\"CopyContent\":{\"title\":\"CopyContent\",\"type\":\"object\",\"properties\":{\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"content\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"link\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"substitute\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}},\"additionalProperties\":false},\"CopyResourcePatch\":{\"anyOf\":[{\"$ref\":\"#/definitions/Copy\"},{\"$ref\":\"#/definitions/CopyContent\"},{\"$ref\":\"#/definitions/AddGitRepo\"},{\"$ref\":\"#/definitions/Add\"},{\"$ref\":\"#/definitions/UnknownPatch\"}]},\"HashMapDeepPatch<String, Stage>\":{\"title\":\"HashMapDeepPatch<String, Stage>\",\"type\":\"object\",\"patternProperties\":{\"^.+$\":{\"anyOf\":[{\"$ref\":\"#/definitions/Stage\"},{\"type\":\"null\"}]}}},\"HashMapPatch<String, String>\":{\"title\":\"HashMapPatch<String, String>\",\"type\":\"object\",\"patternProperties\":{\"^.+$\":{\"type\":[\"string\",\"null\"]}}},\"Healthcheck\":{\"title\":\"Healthcheck\",\"type\":\"object\",\"properties\":{\"cmd\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"interval\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"retries\":{\"default\":null,\"type\":[\"integer\",\"null\"],\"minimum\":0.0},\"start\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"timeout\":{\"default\":null,\"type\":[\"string\",\"null\"]}}},\"ImageName\":{\"title\":\"ImageName\",\"description\":\"Represents a Docker image version\",\"type\":\"object\",\"oneOf\":[{\"type\":\"object\",\"required\":[\"tag\"],\"properties\":{\"tag\":{\"type\":\"string\"}}},{\"type\":\"object\",\"required\":[\"digest\"],\"properties\":{\"digest\":{\"type\":\"string\"}}}],\"properties\":{\"host\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"path\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"port\":{\"default\":null,\"type\":[\"integer\",\"null\"],\"minimum\":0.0}}},\"NestedMapValue_for_String\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/NestedMap_for_String\"},{\"type\":\"null\"}]},\"NestedMap_for_String\":{\"description\":\"A multilevel key map\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/NestedMapValue_for_String\"}},\"OneOrMany<Resource>\":{\"title\":\"OneOrMany<Resource>\",\"oneOf\":[{\"$ref\":\"#/definitions/Resource\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}}]},\"ParsableStruct<Bind>\":{\"title\":\"ParsableStruct<Bind>\",\"oneOf\":[{\"$ref\":\"#/definitions/Bind\"},{\"type\":\"string\"}]},\"ParsableStruct<Cache>\":{\"title\":\"ParsableStruct<Cache>\",\"oneOf\":[{\"$ref\":\"#/definitions/Cache\"},{\"type\":\"string\"}]},\"ParsableStruct<CopyResourcePatch>\":{\"title\":\"ParsableStruct<CopyResourcePatch>\",\"oneOf\":[{\"$ref\":\"#/definitions/CopyResourcePatch\"},{\"type\":\"string\"}]},\"ParsableStruct<ImageName>\":{\"title\":\"ParsableStruct<ImageName>\",\"oneOf\":[{\"$ref\":\"#/definitions/ImageName\"},{\"type\":\"string\"}]},\"ParsableStruct<Port>\":{\"title\":\"ParsableStruct<Port>\",\"oneOf\":[{\"$ref\":\"#/definitions/Port\"},{\"type\":\"string\"}]},\"ParsableStruct<User>\":{\"title\":\"ParsableStruct<User>\",\"oneOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"string\"}]},\"Port\":{\"title\":\"Port\",\"type\":\"object\",\"properties\":{\"port\":{\"default\":null,\"type\":[\"integer\",\"null\"],\"minimum\":0.0},\"protocol\":{\"default\":null,\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/PortProtocol\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]}}},\"PortProtocol\":{\"description\":\"Represents a port protocol\",\"type\":\"string\",\"enum\":[\"tcp\",\"udp\"]},\"Resource\":{\"description\":\"Represents a resource\",\"anyOf\":[{\"type\":\"string\",\"format\":\"uri\"},{\"type\":\"string\"}]},\"Run\":{\"title\":\"Run\",\"type\":\"object\",\"properties\":{\"bind\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Bind>>\"},{\"type\":\"null\"}]},\"cache\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Cache>>\"},{\"type\":\"null\"}]},\"run\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]}}},\"Stage\":{\"title\":\"Stage\",\"anyOf\":[{\"$ref\":\"#/definitions/FromContext\"},{\"type\":\"object\",\"properties\":{\"arg\":{\"anyOf\":[{\"$ref\":\"#/definitions/HashMapPatch<String, String>\"},{\"type\":\"null\"}]},\"bind\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Bind>>\"},{\"type\":\"null\"}]},\"cache\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<Cache>>\"},{\"type\":\"null\"}]},\"copy\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecDeepPatch<ParsableStruct<CopyResourcePatch>>\"},{\"type\":\"null\"}]},\"env\":{\"anyOf\":[{\"$ref\":\"#/definitions/HashMapPatch<String, String>\"},{\"type\":\"null\"}]},\"root\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/Run\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"run\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"user\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ParsableStruct<User>\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"workdir\":{\"default\":null,\"type\":[\"string\",\"null\"]}}}]},\"UnknownPatch\":{\"title\":\"CopyOptions\",\"type\":\"object\",\"properties\":{\"chmod\":{\"default\":null,\"type\":[\"string\",\"number\",\"null\"]},\"chown\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/User\"},{\"type\":\"null\"}]},{\"type\":\"null\"}]},\"exclude\":{\"anyOf\":[{\"$ref\":\"#/definitions/VecPatch<String>\"},{\"type\":\"null\"}]},\"link\":{\"default\":null,\"type\":[\"boolean\",\"null\"]},\"target\":{\"default\":null,\"type\":[\"string\",\"null\"]}}},\"User\":{\"title\":\"User\",\"type\":\"object\",\"properties\":{\"group\":{\"default\":null,\"type\":[\"string\",\"null\"]},\"user\":{\"default\":null,\"type\":[\"string\",\"null\"]}}},\"VecDeepPatch<ParsableStruct<Bind>>\":{\"title\":\"VecDeepPatch<ParsableStruct<Bind>>\",\"oneOf\":[{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"}},\"^\\\\d+$\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"},\"^\\\\d+<$\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"}},\"_\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Bind>\"}}}}]},\"VecDeepPatch<ParsableStruct<Cache>>\":{\"title\":\"VecDeepPatch<ParsableStruct<Cache>>\",\"oneOf\":[{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"}},\"^\\\\d+$\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"},\"^\\\\d+<$\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"}},\"_\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Cache>\"}}}}]},\"VecDeepPatch<ParsableStruct<CopyResourcePatch>>\":{\"title\":\"VecDeepPatch<ParsableStruct<CopyResourcePatch>>\",\"oneOf\":[{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"}},\"^\\\\d+$\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"},\"^\\\\d+<$\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"}},\"_\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<CopyResourcePatch>\"}}}}]},\"VecDeepPatch<ParsableStruct<Port>>\":{\"title\":\"VecDeepPatch<ParsableStruct<Port>>\",\"oneOf\":[{\"$ref\":\"#/definitions/ParsableStruct<Port>\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"}},\"^\\\\d+$\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"},\"^\\\\d+<$\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"}},\"_\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ParsableStruct<Port>\"}}}}]},\"VecPatch<Resource>\":{\"title\":\"VecPatch<Resource>\",\"oneOf\":[{\"$ref\":\"#/definitions/Resource\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}},\"^\\\\d+$\":{\"$ref\":\"#/definitions/Resource\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}},\"_\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Resource\"}}}}]},\"FromContext\":{\"title\":\"FromContext\",\"oneOf\":[{\"type\":\"object\",\"required\":[\"fromImage\"],\"properties\":{\"fromImage\":{\"$ref\":\"#/definitions/ParsableStruct<ImageName>\"}}},{\"type\":\"object\",\"required\":[\"fromBuilder\"],\"properties\":{\"fromBuilder\":{\"type\":\"string\"}}},{\"type\":\"object\",\"required\":[\"fromContext\"],\"properties\":{\"fromContext\":{\"type\":[\"string\",\"null\"]}}}]},\"VecPatch<String>\":{\"title\":\"VecPatch<String>\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\",\"patternProperties\":{\"^\\\\+$\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"^\\\\+\\\\d+$\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"^\\\\d+$\":{\"type\":\"string\"},\"^\\\\d+\\\\+$\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"_\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Dofigen\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dofigen.json","title":"Dofigen","description":"Dofigen is a Dockerfile generator using a simplified description in YAML or JSON format","anyOf":[{"$ref":"#/definitions/FromContext"},{"type":"object","properties":{"arg":{"anyOf":[{"$ref":"#/definitions/HashMapPatch<String, String>"},{"type":"null"}]},"bind":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Bind>>"},{"type":"null"}]},"builders":{"anyOf":[{"$ref":"#/definitions/HashMapDeepPatch<String, Stage>"},{"type":"null"}]},"cache":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Cache>>"},{"type":"null"}]},"cmd":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"context":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"copy":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<CopyResourcePatch>>"},{"type":"null"}]},"entrypoint":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"env":{"anyOf":[{"$ref":"#/definitions/HashMapPatch<String, String>"},{"type":"null"}]},"expose":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Port>>"},{"type":"null"}]},"extend":{"$ref":"#/definitions/OneOrMany<Resource>"},"healthcheck":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Healthcheck"},{"type":"null"}]},{"type":"null"}]},"ignore":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"label":{"anyOf":[{"$ref":"#/definitions/NestedMap_for_String"},{"type":"null"}]},"root":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Run"},{"type":"null"}]},{"type":"null"}]},"run":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"user":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ParsableStruct<User>"},{"type":"null"}]},{"type":"null"}]},"volume":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"workdir":{"default":null,"type":["string","null"]}}}],"definitions":{"Add":{"title":"Add","type":"object","properties":{"checksum":{"default":null,"type":["string","null"]},"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"files":{"anyOf":[{"$ref":"#/definitions/VecPatch<Resource>"},{"type":"null"}]},"link":{"default":null,"type":["boolean","null"]},"target":{"default":null,"type":["string","null"]}}},"AddGitRepo":{"title":"AddGitRepo","type":"object","properties":{"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"exclude":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"keepGitDir":{"default":null,"type":["boolean","null"]},"link":{"default":null,"type":["boolean","null"]},"repo":{"default":null,"type":["string","null"]},"target":{"default":null,"type":["string","null"]}}},"Bind":{"title":"Bind","anyOf":[{"$ref":"#/definitions/FromContext"},{"type":"object","properties":{"readwrite":{"default":null,"type":["boolean","null"]},"source":{"default":null,"type":["string","null"]},"target":{"default":null,"type":["string","null"]}}}]},"Cache":{"title":"Cache","anyOf":[{"$ref":"#/definitions/FromContext"},{"type":"object","properties":{"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"id":{"default":null,"type":["string","null"]},"readonly":{"default":null,"type":["boolean","null"]},"sharing":{"default":null,"anyOf":[{"anyOf":[{"$ref":"#/definitions/CacheSharing"},{"type":"null"}]},{"type":"null"}]},"source":{"default":null,"type":["string","null"]},"target":{"default":null,"type":["string","null"]}}}]},"CacheSharing":{"description":"Represents a cache sharing strategy","type":"string","enum":["shared","private","locked"]},"Copy":{"title":"Copy","anyOf":[{"$ref":"#/definitions/FromContext"},{"type":"object","properties":{"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"exclude":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"link":{"default":null,"type":["boolean","null"]},"parents":{"default":null,"type":["boolean","null"]},"paths":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"target":{"default":null,"type":["string","null"]}}}]},"CopyContent":{"title":"CopyContent","type":"object","properties":{"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"content":{"default":null,"type":["string","null"]},"link":{"default":null,"type":["boolean","null"]},"substitute":{"default":null,"type":["boolean","null"]},"target":{"default":null,"type":["string","null"]}},"additionalProperties":false},"CopyResourcePatch":{"anyOf":[{"$ref":"#/definitions/Copy"},{"$ref":"#/definitions/CopyContent"},{"$ref":"#/definitions/AddGitRepo"},{"$ref":"#/definitions/Add"},{"$ref":"#/definitions/UnknownPatch"}]},"HashMapDeepPatch<String, Stage>":{"title":"HashMapDeepPatch<String, Stage>","type":"object","patternProperties":{"^.+$":{"anyOf":[{"$ref":"#/definitions/Stage"},{"type":"null"}]}}},"HashMapPatch<String, String>":{"title":"HashMapPatch<String, String>","type":"object","patternProperties":{"^.+$":{"type":["string","null"]}}},"Healthcheck":{"title":"Healthcheck","type":"object","properties":{"cmd":{"default":null,"type":["string","null"]},"interval":{"default":null,"type":["string","null"]},"retries":{"default":null,"type":["integer","null"],"minimum":0.0},"start":{"default":null,"type":["string","null"]},"timeout":{"default":null,"type":["string","null"]}}},"ImageName":{"title":"ImageName","description":"Represents a Docker image version","type":"object","oneOf":[{"type":"object","required":["tag"],"properties":{"tag":{"type":"string"}}},{"type":"object","required":["digest"],"properties":{"digest":{"type":"string"}}}],"properties":{"host":{"default":null,"type":["string","null"]},"path":{"default":null,"type":["string","null"]},"port":{"default":null,"type":["integer","null"],"minimum":0.0}}},"NestedMapValue_for_String":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/NestedMap_for_String"},{"type":"null"}]},"NestedMap_for_String":{"description":"A multilevel key map","type":"object","additionalProperties":{"$ref":"#/definitions/NestedMapValue_for_String"}},"OneOrMany<Resource>":{"title":"OneOrMany<Resource>","oneOf":[{"$ref":"#/definitions/Resource"},{"type":"array","items":{"$ref":"#/definitions/Resource"}}]},"ParsableStruct<Bind>":{"title":"ParsableStruct<Bind>","oneOf":[{"$ref":"#/definitions/Bind"},{"type":"string"}]},"ParsableStruct<Cache>":{"title":"ParsableStruct<Cache>","oneOf":[{"$ref":"#/definitions/Cache"},{"type":"string"}]},"ParsableStruct<CopyResourcePatch>":{"title":"ParsableStruct<CopyResourcePatch>","oneOf":[{"$ref":"#/definitions/CopyResourcePatch"},{"type":"string"}]},"ParsableStruct<ImageName>":{"title":"ParsableStruct<ImageName>","oneOf":[{"$ref":"#/definitions/ImageName"},{"type":"string"}]},"ParsableStruct<Port>":{"title":"ParsableStruct<Port>","oneOf":[{"$ref":"#/definitions/Port"},{"type":"string"}]},"ParsableStruct<User>":{"title":"ParsableStruct<User>","oneOf":[{"$ref":"#/definitions/User"},{"type":"string"}]},"Port":{"title":"Port","type":"object","properties":{"port":{"default":null,"type":["integer","null"],"minimum":0.0},"protocol":{"default":null,"anyOf":[{"anyOf":[{"$ref":"#/definitions/PortProtocol"},{"type":"null"}]},{"type":"null"}]}}},"PortProtocol":{"description":"Represents a port protocol","type":"string","enum":["tcp","udp"]},"Resource":{"description":"Represents a resource","anyOf":[{"type":"string","format":"uri"},{"type":"string"}]},"Run":{"title":"Run","type":"object","properties":{"bind":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Bind>>"},{"type":"null"}]},"cache":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Cache>>"},{"type":"null"}]},"run":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]}}},"Stage":{"title":"Stage","anyOf":[{"$ref":"#/definitions/FromContext"},{"type":"object","properties":{"arg":{"anyOf":[{"$ref":"#/definitions/HashMapPatch<String, String>"},{"type":"null"}]},"bind":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Bind>>"},{"type":"null"}]},"cache":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<Cache>>"},{"type":"null"}]},"copy":{"anyOf":[{"$ref":"#/definitions/VecDeepPatch<ParsableStruct<CopyResourcePatch>>"},{"type":"null"}]},"env":{"anyOf":[{"$ref":"#/definitions/HashMapPatch<String, String>"},{"type":"null"}]},"root":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/Run"},{"type":"null"}]},{"type":"null"}]},"run":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"user":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ParsableStruct<User>"},{"type":"null"}]},{"type":"null"}]},"workdir":{"default":null,"type":["string","null"]}}}]},"UnknownPatch":{"title":"CopyOptions","type":"object","properties":{"chmod":{"default":null,"type":["string","number","null"]},"chown":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/User"},{"type":"null"}]},{"type":"null"}]},"exclude":{"anyOf":[{"$ref":"#/definitions/VecPatch<String>"},{"type":"null"}]},"link":{"default":null,"type":["boolean","null"]},"target":{"default":null,"type":["string","null"]}}},"User":{"title":"User","type":"object","properties":{"group":{"default":null,"type":["string","null"]},"user":{"default":null,"type":["string","null"]}}},"VecDeepPatch<ParsableStruct<Bind>>":{"title":"VecDeepPatch<ParsableStruct<Bind>>","oneOf":[{"$ref":"#/definitions/ParsableStruct<Bind>"},{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Bind>"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Bind>"}},"^\\+\\d+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Bind>"}},"^\\d+$":{"$ref":"#/definitions/ParsableStruct<Bind>"},"^\\d+<$":{"$ref":"#/definitions/ParsableStruct<Bind>"},"^\\d+\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Bind>"}},"_":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Bind>"}}}}]},"VecDeepPatch<ParsableStruct<Cache>>":{"title":"VecDeepPatch<ParsableStruct<Cache>>","oneOf":[{"$ref":"#/definitions/ParsableStruct<Cache>"},{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Cache>"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Cache>"}},"^\\+\\d+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Cache>"}},"^\\d+$":{"$ref":"#/definitions/ParsableStruct<Cache>"},"^\\d+<$":{"$ref":"#/definitions/ParsableStruct<Cache>"},"^\\d+\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Cache>"}},"_":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Cache>"}}}}]},"VecDeepPatch<ParsableStruct<CopyResourcePatch>>":{"title":"VecDeepPatch<ParsableStruct<CopyResourcePatch>>","oneOf":[{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"},{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"}},"^\\+\\d+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"}},"^\\d+$":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"},"^\\d+<$":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"},"^\\d+\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"}},"_":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<CopyResourcePatch>"}}}}]},"VecDeepPatch<ParsableStruct<Port>>":{"title":"VecDeepPatch<ParsableStruct<Port>>","oneOf":[{"$ref":"#/definitions/ParsableStruct<Port>"},{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Port>"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Port>"}},"^\\+\\d+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Port>"}},"^\\d+$":{"$ref":"#/definitions/ParsableStruct<Port>"},"^\\d+<$":{"$ref":"#/definitions/ParsableStruct<Port>"},"^\\d+\\+$":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Port>"}},"_":{"type":"array","items":{"$ref":"#/definitions/ParsableStruct<Port>"}}}}]},"VecPatch<Resource>":{"title":"VecPatch<Resource>","oneOf":[{"$ref":"#/definitions/Resource"},{"type":"array","items":{"$ref":"#/definitions/Resource"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"$ref":"#/definitions/Resource"}},"^\\+\\d+$":{"type":"array","items":{"$ref":"#/definitions/Resource"}},"^\\d+$":{"$ref":"#/definitions/Resource"},"^\\d+\\+$":{"type":"array","items":{"$ref":"#/definitions/Resource"}},"_":{"type":"array","items":{"$ref":"#/definitions/Resource"}}}}]},"FromContext":{"title":"FromContext","oneOf":[{"type":"object","required":["fromImage"],"properties":{"fromImage":{"$ref":"#/definitions/ParsableStruct<ImageName>"}}},{"type":"object","required":["fromBuilder"],"properties":{"fromBuilder":{"type":"string"}}},{"type":"object","required":["fromContext"],"properties":{"fromContext":{"type":["string","null"]}}}]},"VecPatch<String>":{"title":"VecPatch<String>","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","patternProperties":{"^\\+$":{"type":"array","items":{"type":"string"}},"^\\+\\d+$":{"type":"array","items":{"type":"string"}},"^\\d+$":{"type":"string"},"^\\d+\\+$":{"type":"array","items":{"type":"string"}},"_":{"type":"array","items":{"type":"string"}}}}]}}}
|
Provide a JSON object that satisfies the schema "Dofigen". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Dofigen
|
schema-store
|
schema_store_269
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$comment\":\"Schema derived from https://raw.githubusercontent.com/dotnet/core/main/release-notes/releases-index.json and https://github.com/dotnet/deployment-tools/blob/main/src/Microsoft.Deployment.DotNet.Releases/src/Product.cs\",\"additionalProperties\":false,\"definitions\":{\"dateYYYYMMDD\":{\"$comment\":\"If we targeted draft-07 we could use the 'date' format instead of this format pattern. We cannot use the 'date-time' format because our existing values don't validate against it.\",\"type\":\"string\",\"pattern\":\"^[0-9]{4}-[0-9]{2}-[0-9]{2}$\",\"description\":\"A date in the format YYYY-MM-DD\"},\"releaseVersion\":{\"type\":\"string\",\"description\":\"A SemVer-compatible version string\",\"pattern\":\"^(0|[1-9]\\\\d*)\\\\.(0|[1-9]\\\\d*)\\\\.(0|[1-9]\\\\d*)(?:-((?:0|[1-9]\\\\d*|\\\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\\\.(?:0|[1-9]\\\\d*|\\\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\\\+([0-9a-zA-Z-]+(?:\\\\.[0-9a-zA-Z-]+)*))?$\"},\"releaseType\":{\"$comment\":\"If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values\",\"type\":\"string\",\"enum\":[\"sts\",\"lts\"],\"description\":\"An enumeration describing the different release types of a product\"},\"supportPhase\":{\"$comment\":\"If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values\",\"type\":\"string\",\"enum\":[\"preview\",\"go-live\",\"active\",\"maintenance\",\"eol\"],\"description\":\"An enumeration describing the different support phases of a product\"},\"product\":{\"type\":\"object\",\"properties\":{\"channel-version\":{\"type\":\"string\",\"title\":\"ProductVersion\",\"description\":\"The version of the product, e.g '5.0' or '1.1'\",\"pattern\":\"^[0-9]+\\\\.[0-9]+$\"},\"eol-date\":{\"oneOf\":[{\"$ref\":\"#/definitions/dateYYYYMMDD\"},{\"type\":\"null\"}],\"title\":\"EndOfLifeDate\",\"description\":\"The end-of-life (EOL) date for this Product when it is considered to be out of support. The value may be `null` if the EOL date is undetermined, e.g. when a product is still a prerelease.\"},\"security\":{\"type\":\"boolean\",\"title\":\"LatestReleaseIncludesSecurityUpdate\",\"description\":\"`true` if the latest release of this product includes a security update, `false` otherwise.\"},\"latest-release-date\":{\"$ref\":\"#/definitions/dateYYYYMMDD\",\"title\":\"LatestReleaseDate\",\"description\":\"The date of the latest release of this product.\"},\"latest-release\":{\"$ref\":\"#/definitions/releaseVersion\",\"title\":\"LatestReleaseVersion\",\"description\":\"The version of the latest release\"},\"latest-runtime\":{\"$ref\":\"#/definitions/releaseVersion\",\"title\":\"LatestRuntimeVersion\",\"description\":\"The version of the runtime included in the latest release\"},\"latest-sdk\":{\"$ref\":\"#/definitions/releaseVersion\",\"title\":\"LatestSdkVersion\",\"description\":\"The version of the SDK included in the latest release. This is usually the SDK with the highest feature band. A ProductRelease may include multiple SDKs across different feature bands, all of which carry the same runtime version.\"},\"product\":{\"type\":\"string\",\"title\":\"ProductName\",\"description\":\"The name of the product.\"},\"releases.json\":{\"$comment\":\"Since this is always an absolute uri, the 'uri' format is unambiguous\",\"description\":\"The URL pointing to the releases.json file that contains information about all the releases associated with this Product.\",\"type\":\"string\",\"format\":\"uri\"},\"release-type\":{\"$ref\":\"#/definitions/releaseType\",\"description\":\"The type of Product release indicating whether the release is Standard Term Support (sts) or Long Term Support (lts).\"},\"support-phase\":{\"$ref\":\"#/definitions/supportPhase\",\"description\":\"The support phase of the Product.\"},\"supported-os.json\":{\"$comment\":\"Since this is always an absolute uri, the 'uri' format is unambiguous\",\"description\":\"The URL pointing to the supported-os.json file that contains information about the operating systems supported by this Product.\",\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"channel-version\",\"security\",\"latest-release-date\",\"latest-release\",\"latest-runtime\",\"latest-sdk\",\"product\",\"releases.json\",\"release-type\",\"support-phase\"],\"additionalProperties\":false}},\"description\":\"A collection of manifests for .NET products, which is updated with each preview and stable release of the .NET SDK and/or Runtime\",\"id\":\"https://json.schemastore.org/dotnet-releases-index.json\",\"properties\":{\"releases-index\":{\"type\":\"array\",\"description\":\"A collection of all released products\",\"items\":{\"$ref\":\"#/definitions/product\"}}},\"required\":[\"releases-index\"],\"title\":\"JSON schema for .NET product collection manifests\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for .NET product collection manifests\". Here are the required top‑level fields: releases-index. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$comment":"Schema derived from https://raw.githubusercontent.com/dotnet/core/main/release-notes/releases-index.json and https://github.com/dotnet/deployment-tools/blob/main/src/Microsoft.Deployment.DotNet.Releases/src/Product.cs","additionalProperties":false,"definitions":{"dateYYYYMMDD":{"$comment":"If we targeted draft-07 we could use the 'date' format instead of this format pattern. We cannot use the 'date-time' format because our existing values don't validate against it.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"A date in the format YYYY-MM-DD"},"releaseVersion":{"type":"string","description":"A SemVer-compatible version string","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"},"releaseType":{"$comment":"If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values","type":"string","enum":["sts","lts"],"description":"An enumeration describing the different release types of a product"},"supportPhase":{"$comment":"If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values","type":"string","enum":["preview","go-live","active","maintenance","eol"],"description":"An enumeration describing the different support phases of a product"},"product":{"type":"object","properties":{"channel-version":{"type":"string","title":"ProductVersion","description":"The version of the product, e.g '5.0' or '1.1'","pattern":"^[0-9]+\\.[0-9]+$"},"eol-date":{"oneOf":[{"$ref":"#/definitions/dateYYYYMMDD"},{"type":"null"}],"title":"EndOfLifeDate","description":"The end-of-life (EOL) date for this Product when it is considered to be out of support. The value may be `null` if the EOL date is undetermined, e.g. when a product is still a prerelease."},"security":{"type":"boolean","title":"LatestReleaseIncludesSecurityUpdate","description":"`true` if the latest release of this product includes a security update, `false` otherwise."},"latest-release-date":{"$ref":"#/definitions/dateYYYYMMDD","title":"LatestReleaseDate","description":"The date of the latest release of this product."},"latest-release":{"$ref":"#/definitions/releaseVersion","title":"LatestReleaseVersion","description":"The version of the latest release"},"latest-runtime":{"$ref":"#/definitions/releaseVersion","title":"LatestRuntimeVersion","description":"The version of the runtime included in the latest release"},"latest-sdk":{"$ref":"#/definitions/releaseVersion","title":"LatestSdkVersion","description":"The version of the SDK included in the latest release. This is usually the SDK with the highest feature band. A ProductRelease may include multiple SDKs across different feature bands, all of which carry the same runtime version."},"product":{"type":"string","title":"ProductName","description":"The name of the product."},"releases.json":{"$comment":"Since this is always an absolute uri, the 'uri' format is unambiguous","description":"The URL pointing to the releases.json file that contains information about all the releases associated with this Product.","type":"string","format":"uri"},"release-type":{"$ref":"#/definitions/releaseType","description":"The type of Product release indicating whether the release is Standard Term Support (sts) or Long Term Support (lts)."},"support-phase":{"$ref":"#/definitions/supportPhase","description":"The support phase of the Product."},"supported-os.json":{"$comment":"Since this is always an absolute uri, the 'uri' format is unambiguous","description":"The URL pointing to the supported-os.json file that contains information about the operating systems supported by this Product.","type":"string","format":"uri"}},"required":["channel-version","security","latest-release-date","latest-release","latest-runtime","latest-sdk","product","releases.json","release-type","support-phase"],"additionalProperties":false}},"description":"A collection of manifests for .NET products, which is updated with each preview and stable release of the .NET SDK and/or Runtime","id":"https://json.schemastore.org/dotnet-releases-index.json","properties":{"releases-index":{"type":"array","description":"A collection of all released products","items":{"$ref":"#/definitions/product"}}},"required":["releases-index"],"title":"JSON schema for .NET product collection manifests","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for .NET product collection manifests". Here are the required top‑level fields: releases-index. Return only the valid JSON object.
|
JSON schema for .NET product collection manifests
|
schema-store
|
schema_store_270
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dotnet-tools.json\",\"allowTrailingCommas\":false,\"type\":\"object\",\"required\":[\"version\",\"isRoot\",\"tools\"],\"additionalProperties\":true,\"properties\":{\"version\":{\"type\":\"integer\",\"title\":\".NET Tools Manifest Version\",\"description\":\"Specifies the version of the local tool manifest file format.\"},\"isRoot\":{\"type\":\"boolean\",\"title\":\"Root/Top-Most Manifest File Indicator\",\"description\":\"Indicates whether this is the root manifest file. If true, dotnet will not continue to search parent directories for additional dotnet-tools.json files.\"},\"tools\":{\"type\":\"object\",\"title\":\"Local Tools\",\"description\":\"Mappings of .NET CLI tools that are available locally for the project. Each entry specifies a tool accessible by its NuGet package ID.\",\"patternProperties\":{\"^.*$\":{\"type\":\"object\",\"title\":\"Tool Configuration\",\"description\":\"Represents a single .NET CLI tool with its specific settings and commands.\",\"required\":[\"version\",\"commands\"],\"additionalProperties\":true,\"properties\":{\"version\":{\"type\":[\"string\",\"null\"],\"title\":\"Tool NuGet Version\",\"description\":\"Specifies the version of the NuGet package of the tool. If null, the latest version will be used.\"},\"commands\":{\"type\":[\"array\",\"null\"],\"title\":\"Available Tool Commands\",\"description\":\"Lists all of the available commands provided by this tool. The way to invoke a command depends on the naming format of its executable. If the command is in the format `dotnet-<toolName>`, it should be invoked using 'dotnet <toolName>'. If the command is in the format '<toolName>', it can be directly invoked using just '<toolName>'. If null, no specific commands are specified.\",\"items\":{\"type\":[\"string\",\"null\"],\"title\":\"Tool Command\",\"description\":\"A command made available by this tool which can be invoked according to the naming convention of its executable. If the command is in the format `dotnet-<toolName>`, it should be invoked using 'dotnet <toolName>'. If the command is in the format '<toolName>', it can be directly invoked using just '<toolName>'. If null, no specific commands are specified.\"}}}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dotnet-tools\". Here are the required top‑level fields: version, isRoot, tools. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dotnet-tools.json","allowTrailingCommas":false,"type":"object","required":["version","isRoot","tools"],"additionalProperties":true,"properties":{"version":{"type":"integer","title":".NET Tools Manifest Version","description":"Specifies the version of the local tool manifest file format."},"isRoot":{"type":"boolean","title":"Root/Top-Most Manifest File Indicator","description":"Indicates whether this is the root manifest file. If true, dotnet will not continue to search parent directories for additional dotnet-tools.json files."},"tools":{"type":"object","title":"Local Tools","description":"Mappings of .NET CLI tools that are available locally for the project. Each entry specifies a tool accessible by its NuGet package ID.","patternProperties":{"^.*$":{"type":"object","title":"Tool Configuration","description":"Represents a single .NET CLI tool with its specific settings and commands.","required":["version","commands"],"additionalProperties":true,"properties":{"version":{"type":["string","null"],"title":"Tool NuGet Version","description":"Specifies the version of the NuGet package of the tool. If null, the latest version will be used."},"commands":{"type":["array","null"],"title":"Available Tool Commands","description":"Lists all of the available commands provided by this tool. The way to invoke a command depends on the naming format of its executable. If the command is in the format `dotnet-<toolName>`, it should be invoked using 'dotnet <toolName>'. If the command is in the format '<toolName>', it can be directly invoked using just '<toolName>'. If null, no specific commands are specified.","items":{"type":["string","null"],"title":"Tool Command","description":"A command made available by this tool which can be invoked according to the naming convention of its executable. If the command is in the format `dotnet-<toolName>`, it should be invoked using 'dotnet <toolName>'. If the command is in the format '<toolName>', it can be directly invoked using just '<toolName>'. If null, no specific commands are specified."}}}}}}}}
|
Provide a JSON object that satisfies the schema "dotnet-tools". Here are the required top‑level fields: version, isRoot, tools. Return only the valid JSON object.
|
dotnet-tools
|
schema-store
|
schema_store_271
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"symbolInfo\":{\"properties\":{\"isHidden\":{\"anyOf\":[{\"type\":\"boolean\"},{\"pattern\":\"^(true|false)$\"}]},\"longName\":{\"type\":\"string\"},\"shortName\":{\"type\":\"string\"}}}},\"id\":\"https://json.schemastore.org/dotnetcli.host.json\",\"properties\":{\"symbolInfo\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/symbolInfo\"}},\"usageExamples\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"title\":\"JSON schema for .NET CLI template host files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for .NET CLI template host files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"symbolInfo":{"properties":{"isHidden":{"anyOf":[{"type":"boolean"},{"pattern":"^(true|false)$"}]},"longName":{"type":"string"},"shortName":{"type":"string"}}}},"id":"https://json.schemastore.org/dotnetcli.host.json","properties":{"symbolInfo":{"type":"object","additionalProperties":{"$ref":"#/definitions/symbolInfo"}},"usageExamples":{"type":"array","items":{"type":"string"}}},"title":"JSON schema for .NET CLI template host files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for .NET CLI template host files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for .NET CLI template host files
|
schema-store
|
schema_store_272
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$comment\":\"See https://github.com/rstudio/renv\",\"title\":\"renv.lock file\",\"description\":\"A schema for renv.lock files generated by the R package {renv}\",\"type\":\"object\",\"properties\":{\"R\":{\"description\":\"Version of R used in the project\",\"type\":\"object\",\"properties\":{\"Version\":{\"description\":\"The version of R used\",\"type\":\"string\",\"examples\":[\"4.4.3\"]},\"Repositories\":{\"description\":\"The R repositories used in this project\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"description\":\"Name of the repository\",\"type\":\"string\",\"examples\":[\"CRAN\"]},\"URL\":{\"description\":\"URL of the repository\",\"type\":\"string\",\"format\":\"uri\",\"examples\":[\"https://cloud.r-project.org\"]}},\"required\":[\"Name\",\"URL\"]}}},\"required\":[\"Version\",\"Repositories\"]},\"Bioconductor\":{\"description\":\"Bioconductor release used in the project\",\"type\":\"object\",\"properties\":{\"Version\":{\"description\":\"Release of Bioconductor\",\"type\":\"string\",\"examples\":[\"3.18\"]}},\"required\":[\"Version\"]},\"Python\":{\"description\":\"Version of Python used in the project\",\"type\":\"object\",\"properties\":{\"Name\":{\"description\":\"Path to the Python environment\",\"type\":\"string\",\"examples\":[\".venv\",\"./renv/python/virtualenvs/renv-python-3.10\"]},\"Type\":{\"description\":\"Type of Python environment\",\"type\":\"string\",\"examples\":[\"virtualenv\"]},\"Version\":{\"description\":\"Version of Python required\",\"type\":\"string\",\"examples\":[\"3.10.12\",\"3.9.0\"]}},\"required\":[\"Name\",\"Type\",\"Version\"]},\"Packages\":{\"description\":\"Packages required by the R project\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"Package\":{\"description\":\"The package name\",\"type\":\"string\",\"examples\":[\"ggplot2\",\"dplyr\"]},\"Version\":{\"description\":\"The package version\",\"type\":\"string\",\"examples\":[\"1.0.0\",\"3.4.6\"]},\"Source\":{\"description\":\"The location from which this package was retrieved\",\"type\":\"string\",\"examples\":[\"Repository\",\"GitHub\",\"Bioconductor\",\"/mnt/r/pkg/package_name_1.0.1.tar.gz\"]},\"Repository\":{\"description\":\"The name of the repository (if any)\",\"type\":\"string\",\"examples\":[\"CRAN\"]},\"Hash\":{\"description\":\"A unique hash for this package\",\"type\":\"string\",\"pattern\":\"^[a-fA-F0-9]{32}$\",\"examples\":[\"06230136b2d2b9ba5805e1963fa6e890\"]},\"biocViews\":{\"description\":\"Bioconductor package dependencies\",\"type\":\"string\"},\"RemoteType\":{\"description\":\"Type of remote, typically written for packages installed by the devtools, remotes and pak packages\",\"type\":\"string\",\"examples\":[\"standard\",\"github\"]},\"RemoteHost\":{\"description\":\"Host for the remote\",\"type\":\"string\",\"format\":\"hostname\",\"examples\":[\"api.github.com\"]},\"RemoteUsername\":{\"description\":\"Username for the remote repo\",\"type\":\"string\"},\"RemoteRepo\":{\"description\":\"Repository URL for the remote package\",\"type\":\"string\",\"examples\":[\"https://cran.rstudio.com\",\"https://cloud.r-project.org\"]},\"RemoteRepos\":{\"description\":\"Remote repositories URIs\",\"type\":\"string\",\"format\":\"uri\",\"examples\":[\"https://cran.rstudio.com\",\"https://cloud.r-project.org\"]},\"RemoteRef\":{\"description\":\"Git reference (branch, tag) of remote\",\"type\":\"string\"},\"RemotePkgRef\":{\"description\":\"Package name reference on remote\",\"type\":\"string\"},\"RemotePkgPlatform\":{\"description\":\"Platform of remote binary\",\"type\":\"string\",\"examples\":[\"aarch64-apple-darwin20\"]},\"RemoteSha\":{\"description\":\"SHA of remote commit\",\"type\":\"string\",\"examples\":[\"1763e0dcb72fb58d97bab97bb834fc71f1e012bc\"]},\"Title\":{\"description\":\"Package title from DESCRIPTION\",\"type\":\"string\",\"examples\":[\"Read Rectangular Text Data\"]},\"Authors@R\":{\"description\":\"Authors field in DESCRIPTION syntax\",\"type\":\"string\"},\"Description\":{\"description\":\"Long description from DESCRIPTION file\",\"type\":\"string\"},\"License\":{\"description\":\"License declared by the package\",\"type\":\"string\",\"examples\":[\"MIT + file LICENSE\"]},\"URL\":{\"description\":\"Homepage or URL fields from DESCRIPTION\",\"type\":\"string\",\"examples\":[\"https://github.com/tidyverse/readr\"]},\"BugReports\":{\"description\":\"URL for reporting bugs/issues\",\"type\":\"string\",\"examples\":[\"https://github.com/tidyverse/readr/issues\"]},\"Author\":{\"description\":\"Formatted Author field\",\"type\":\"string\"},\"Maintainer\":{\"description\":\"Package maintainer with email\",\"type\":\"string\",\"examples\":[\"Jennifer Bryan <[email protected]>\"]},\"Depends\":{\"description\":\"Package dependencies\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"examples\":[[\"R (>= 3.6)\",\"jsonlite\",\"lifecycle\",\"magrittr\",\"stringi\"]]},\"Imports\":{\"description\":\"Imported packages\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"LinkingTo\":{\"description\":\"Packages linked at compile time\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"Suggests\":{\"description\":\"Suggested packages\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"Enhances\":{\"description\":\"Enhanced packages\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"SystemRequirements\":{\"description\":\"System requirements for compilation\",\"type\":\"string\"},\"VignetteBuilder\":{\"description\":\"Builder used for vignettes\",\"type\":\"string\",\"examples\":[\"knitr\",\"rmakrdown\"]},\"Type\":{\"description\":\"Type flag from DESCRIPTION\",\"type\":\"string\",\"examples\":[\"Package\"]},\"Date\":{\"description\":\"Publication date of this version. Generally considered deprecated in DESCRIPTION\",\"type\":\"string\",\"format\":\"date\",\"examples\":[\"2024-05-06\"]},\"ByteCompile\":{\"description\":\"Whether package is byte-compiled\",\"type\":\"string\",\"examples\":[\"true\"]},\"Biarch\":{\"description\":\"Whether binaries built for multiple architectures\",\"type\":\"string\",\"examples\":[\"TRUE\"]},\"Encoding\":{\"description\":\"File encoding used by the package\",\"type\":\"string\",\"examples\":[\"UTF-8\"]},\"Language\":{\"description\":\"Primary language of the package documentation\",\"type\":\"string\",\"examples\":[\"en-US\"]},\"RoxygenNote\":{\"description\":\"RoxygenNote from DESCRIPTION\",\"type\":\"string\",\"examples\":[\"7.3.2\"]},\"NeedsCompilation\":{\"description\":\"Flag whether package needs compilation\",\"type\":\"string\",\"examples\":[\"yes\"]},\"Copyright\":{\"description\":\"Copyright notes from DESCRIPTION\",\"type\":\"string\"},\"Config/Needs/website\":{\"description\":\"Configuration for website dependencies\",\"type\":\"string\"},\"Config/testthat/edition\":{\"description\":\"Which edition of testthat to use\",\"type\":\"string\"},\"Config/testthat/parallel\":{\"description\":\"Whether testthat runs in parallel\",\"type\":\"string\"},\"Config/testthat/start-first\":{\"description\":\"testthat start-first phases\",\"type\":\"string\"},\"Config/autostyle/scope\":{\"description\":\"autostyle configuration scope\",\"type\":\"string\"},\"Config/autostyle/strict\":{\"description\":\"autostyle strictness flag\",\"type\":\"string\"},\"Config/autostyle/rmd\":{\"description\":\"autostyle R Markdown support flag\",\"type\":\"string\"}},\"required\":[\"Package\"]}}},\"required\":[\"R\",\"Packages\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"renv.lock file\". Here are the required top‑level fields: R, Packages. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$comment":"See https://github.com/rstudio/renv","title":"renv.lock file","description":"A schema for renv.lock files generated by the R package {renv}","type":"object","properties":{"R":{"description":"Version of R used in the project","type":"object","properties":{"Version":{"description":"The version of R used","type":"string","examples":["4.4.3"]},"Repositories":{"description":"The R repositories used in this project","type":"array","items":{"type":"object","properties":{"Name":{"description":"Name of the repository","type":"string","examples":["CRAN"]},"URL":{"description":"URL of the repository","type":"string","format":"uri","examples":["https://cloud.r-project.org"]}},"required":["Name","URL"]}}},"required":["Version","Repositories"]},"Bioconductor":{"description":"Bioconductor release used in the project","type":"object","properties":{"Version":{"description":"Release of Bioconductor","type":"string","examples":["3.18"]}},"required":["Version"]},"Python":{"description":"Version of Python used in the project","type":"object","properties":{"Name":{"description":"Path to the Python environment","type":"string","examples":[".venv","./renv/python/virtualenvs/renv-python-3.10"]},"Type":{"description":"Type of Python environment","type":"string","examples":["virtualenv"]},"Version":{"description":"Version of Python required","type":"string","examples":["3.10.12","3.9.0"]}},"required":["Name","Type","Version"]},"Packages":{"description":"Packages required by the R project","type":"object","additionalProperties":{"type":"object","properties":{"Package":{"description":"The package name","type":"string","examples":["ggplot2","dplyr"]},"Version":{"description":"The package version","type":"string","examples":["1.0.0","3.4.6"]},"Source":{"description":"The location from which this package was retrieved","type":"string","examples":["Repository","GitHub","Bioconductor","/mnt/r/pkg/package_name_1.0.1.tar.gz"]},"Repository":{"description":"The name of the repository (if any)","type":"string","examples":["CRAN"]},"Hash":{"description":"A unique hash for this package","type":"string","pattern":"^[a-fA-F0-9]{32}$","examples":["06230136b2d2b9ba5805e1963fa6e890"]},"biocViews":{"description":"Bioconductor package dependencies","type":"string"},"RemoteType":{"description":"Type of remote, typically written for packages installed by the devtools, remotes and pak packages","type":"string","examples":["standard","github"]},"RemoteHost":{"description":"Host for the remote","type":"string","format":"hostname","examples":["api.github.com"]},"RemoteUsername":{"description":"Username for the remote repo","type":"string"},"RemoteRepo":{"description":"Repository URL for the remote package","type":"string","examples":["https://cran.rstudio.com","https://cloud.r-project.org"]},"RemoteRepos":{"description":"Remote repositories URIs","type":"string","format":"uri","examples":["https://cran.rstudio.com","https://cloud.r-project.org"]},"RemoteRef":{"description":"Git reference (branch, tag) of remote","type":"string"},"RemotePkgRef":{"description":"Package name reference on remote","type":"string"},"RemotePkgPlatform":{"description":"Platform of remote binary","type":"string","examples":["aarch64-apple-darwin20"]},"RemoteSha":{"description":"SHA of remote commit","type":"string","examples":["1763e0dcb72fb58d97bab97bb834fc71f1e012bc"]},"Title":{"description":"Package title from DESCRIPTION","type":"string","examples":["Read Rectangular Text Data"]},"Authors@R":{"description":"Authors field in DESCRIPTION syntax","type":"string"},"Description":{"description":"Long description from DESCRIPTION file","type":"string"},"License":{"description":"License declared by the package","type":"string","examples":["MIT + file LICENSE"]},"URL":{"description":"Homepage or URL fields from DESCRIPTION","type":"string","examples":["https://github.com/tidyverse/readr"]},"BugReports":{"description":"URL for reporting bugs/issues","type":"string","examples":["https://github.com/tidyverse/readr/issues"]},"Author":{"description":"Formatted Author field","type":"string"},"Maintainer":{"description":"Package maintainer with email","type":"string","examples":["Jennifer Bryan <[email protected]>"]},"Depends":{"description":"Package dependencies","type":"array","items":{"type":"string"},"examples":[["R (>= 3.6)","jsonlite","lifecycle","magrittr","stringi"]]},"Imports":{"description":"Imported packages","type":"array","items":{"type":"string"}},"LinkingTo":{"description":"Packages linked at compile time","type":"array","items":{"type":"string"}},"Suggests":{"description":"Suggested packages","type":"array","items":{"type":"string"}},"Enhances":{"description":"Enhanced packages","type":"array","items":{"type":"string"}},"SystemRequirements":{"description":"System requirements for compilation","type":"string"},"VignetteBuilder":{"description":"Builder used for vignettes","type":"string","examples":["knitr","rmakrdown"]},"Type":{"description":"Type flag from DESCRIPTION","type":"string","examples":["Package"]},"Date":{"description":"Publication date of this version. Generally considered deprecated in DESCRIPTION","type":"string","format":"date","examples":["2024-05-06"]},"ByteCompile":{"description":"Whether package is byte-compiled","type":"string","examples":["true"]},"Biarch":{"description":"Whether binaries built for multiple architectures","type":"string","examples":["TRUE"]},"Encoding":{"description":"File encoding used by the package","type":"string","examples":["UTF-8"]},"Language":{"description":"Primary language of the package documentation","type":"string","examples":["en-US"]},"RoxygenNote":{"description":"RoxygenNote from DESCRIPTION","type":"string","examples":["7.3.2"]},"NeedsCompilation":{"description":"Flag whether package needs compilation","type":"string","examples":["yes"]},"Copyright":{"description":"Copyright notes from DESCRIPTION","type":"string"},"Config/Needs/website":{"description":"Configuration for website dependencies","type":"string"},"Config/testthat/edition":{"description":"Which edition of testthat to use","type":"string"},"Config/testthat/parallel":{"description":"Whether testthat runs in parallel","type":"string"},"Config/testthat/start-first":{"description":"testthat start-first phases","type":"string"},"Config/autostyle/scope":{"description":"autostyle configuration scope","type":"string"},"Config/autostyle/strict":{"description":"autostyle strictness flag","type":"string"},"Config/autostyle/rmd":{"description":"autostyle R Markdown support flag","type":"string"}},"required":["Package"]}}},"required":["R","Packages"]}
|
Provide a JSON object that satisfies the schema "renv.lock file". Here are the required top‑level fields: R, Packages. Return only the valid JSON object.
|
renv.lock file
|
schema-store
|
schema_store_273
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drone.json\",\"definitions\":{\"nonEmptyString\":{\"type\":\"string\",\"minLength\":1},\"platform\":{\"type\":\"object\",\"properties\":{\"os\":{\"type\":\"string\",\"enum\":[\"linux\",\"windows\",\"darwin\",\"freebsd\",\"netbsd\",\"openbsd\",\"dragonfly\",\"solaris\"]},\"arch\":{\"type\":\"string\",\"enum\":[\"arm\",\"arm64\",\"amd64\",\"386\"]},\"variant\":{\"type\":\"string\"},\"version\":{\"type\":\"string\"}}},\"commands\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/nonEmptyString\"}},\"environment\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/secret\"}]}},\"condition\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"conditions\":{\"anyOf\":[{\"$ref\":\"#/definitions/condition\"},{\"type\":\"object\",\"properties\":{\"include\":{\"$ref\":\"#/definitions/condition\"}}},{\"type\":\"object\",\"properties\":{\"exclude\":{\"$ref\":\"#/definitions/condition\"}}}]},\"allConditions\":{\"type\":\"object\",\"properties\":{\"branch\":{\"$ref\":\"#/definitions/conditions\"},\"cron\":{\"$ref\":\"#/definitions/conditions\"},\"event\":{\"$ref\":\"#/definitions/conditions\"},\"paths\":{\"$ref\":\"#/definitions/conditions\"},\"ref\":{\"$ref\":\"#/definitions/conditions\"},\"repo\":{\"$ref\":\"#/definitions/conditions\"},\"status\":{\"$ref\":\"#/definitions/condition\"},\"target\":{\"$ref\":\"#/definitions/conditions\"},\"instance\":{\"$ref\":\"#/definitions/conditions\"}}},\"volumes\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"oneOf\":[{\"required\":[\"name\",\"host\"]},{\"required\":[\"name\",\"path\"]},{\"required\":[\"name\",\"temp\"]},{\"required\":[\"name\",\"claim\"]},{\"required\":[\"name\",\"config_map\"]}],\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"host\":{\"type\":\"object\",\"properties\":{\"path\":{\"$ref\":\"#/definitions/nonEmptyString\"}}},\"temp\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"medium\":{\"type\":\"string\",\"enum\":[\"memory\"]}}},\"claim\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"read_only\":{\"type\":\"boolean\"}}},\"config_map\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"default_mode\":{\"type\":\"integer\"},\"optional\":{\"type\":\"boolean\"}}}}}},\"services\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"image\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"image\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"command\":{\"$ref\":\"#/definitions/commands\"},\"entrypoint\":{\"$ref\":\"#/definitions/commands\"},\"environment\":{\"$ref\":\"#/definitions/environment\"},\"privileged\":{\"type\":\"boolean\"},\"pull\":{\"const\":\"always\"},\"volumes\":{\"$ref\":\"#/definitions/volumes\"},\"working_dir\":{\"$ref\":\"#/definitions/nonEmptyString\"}}}},\"secret\":{\"type\":\"object\",\"required\":[\"from_secret\"],\"properties\":{\"from_secret\":{\"type\":\"string\"}}},\"stringOrSecret\":{\"oneOf\":[{\"$ref\":\"#/definitions/nonEmptyString\"},{\"$ref\":\"#/definitions/secret\"}]},\"node\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"concurrency\":{\"type\":\"object\",\"required\":[\"limit\"],\"properties\":{\"limit\":{\"type\":\"number\"}}},\"kind_signature\":{\"type\":\"object\",\"required\":[\"hmac\"],\"properties\":{\"kind\":{\"const\":\"signature\"},\"hmac\":{\"type\":\"string\",\"minLength\":40,\"maxLength\":64}}},\"kind_secret\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"kind\":{\"const\":\"secret\"},\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"data\":{\"type\":\"string\"},\"get\":{\"type\":\"object\",\"required\":[\"path\",\"name\"],\"properties\":{\"path\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"}}}}},\"kind_template\":{\"type\":\"object\",\"required\":[\"load\"],\"properties\":{\"load\":{\"type\":\"string\"},\"data\":{\"type\":\"object\"}}},\"kind_pipeline\":{\"type\":\"object\",\"required\":[\"type\",\"name\",\"steps\"],\"properties\":{\"kind\":{\"const\":\"pipeline\"},\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"type\":{\"enum\":[\"docker\",\"kubernetes\",\"ssh\",\"exec\",\"digitalocean\",\"macstadium\"]},\"platform\":{\"$ref\":\"#/definitions/platform\"},\"workspace\":{\"type\":\"object\",\"required\":[\"path\"],\"properties\":{\"path\":{\"$ref\":\"#/definitions/nonEmptyString\"}}},\"clone\":{\"type\":\"object\",\"properties\":{\"depth\":{\"type\":\"integer\"},\"disable\":{\"const\":true},\"retries\":{\"type\":\"integer\"}}},\"steps\":{\"type\":\"array\",\"minLength\":1},\"trigger\":{\"$ref\":\"#/definitions/allConditions\"},\"depends_on\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/nonEmptyString\"}}}},\"pipeline_docker\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"docker\"},\"environment\":{\"$ref\":\"#/definitions/environment\"},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_docker\"}},\"volumes\":{\"$ref\":\"#/definitions/volumes\"},\"services\":{\"$ref\":\"#/definitions/services\"},\"image_pull_secrets\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"node\":{\"$ref\":\"#/definitions/node\"},\"concurrency\":{\"$ref\":\"#/definitions/concurrency\"},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"pipeline_kubernetes\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"kubernetes\"},\"metadata\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta\"},\"node\":{\"$ref\":\"#/definitions/node\"},\"tolerations\":{\"description\":\"If specified, the pod's tolerations.\",\"items\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.Toleration\"},\"type\":\"array\"},\"dns_config\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.PodDNSConfig\",\"description\":\"Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.\"},\"host_aliases\":{\"description\":\"HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.\",\"items\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.HostAlias\"},\"type\":\"array\"},\"node_selector\":{\"description\":\"A list of node selector terms.\",\"items\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.NodeSelectorTerm\"}},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_kubernetes\"}},\"volumes\":{\"$ref\":\"#/definitions/volumes\"},\"services\":{\"$ref\":\"#/definitions/services\"},\"image_pull_secrets\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"service_account_name\":{\"description\":\"The name of the service account to use when running the kubernetes pipeline\",\"type\":\"string\"},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"pipeline_exec\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"exec\"},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_exec\"}},\"node\":{\"$ref\":\"#/definitions/node\"},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"pipeline_ssh\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"server\"],\"properties\":{\"type\":{\"const\":\"ssh\"},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_ssh\"}},\"server\":{\"required\":[\"host\",\"user\"],\"properties\":{\"host\":{\"$ref\":\"#/definitions/stringOrSecret\"},\"user\":{\"$ref\":\"#/definitions/stringOrSecret\"},\"password\":{\"$ref\":\"#/definitions/stringOrSecret\"},\"ssh_key\":{\"$ref\":\"#/definitions/stringOrSecret\"}}},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"pipeline_digitalocean\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"token\"],\"properties\":{\"type\":{\"const\":\"digitalocean\"},\"token\":{\"$ref\":\"#/definitions/stringOrSecret\"},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_digitalocean\"}},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"pipeline_macstadium\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"macstadium\"},\"steps\":{\"items\":{\"$ref\":\"#/definitions/step_macstadium\"}},\"kind\":{},\"name\":{},\"platform\":{},\"workspace\":{},\"clone\":{},\"trigger\":{},\"depends_on\":{}}},\"step\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"failure\":{\"type\":\"string\",\"enum\":[\"always\",\"ignore\"]},\"commands\":{\"$ref\":\"#/definitions/commands\"},\"detach\":{\"type\":\"boolean\"},\"environment\":{\"$ref\":\"#/definitions/environment\"},\"when\":{\"$ref\":\"#/definitions/allConditions\"},\"depends_on\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/nonEmptyString\"}}}},\"step_docker\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"image\"],\"properties\":{\"image\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"network_mode\":{\"type\":\"string\",\"enum\":[\"bridge\",\"host\"]},\"privileged\":{\"type\":\"boolean\"},\"pull\":{\"type\":\"string\",\"enum\":[\"always\",\"never\",\"if-not-exists\"]},\"volumes\":{\"$ref\":\"#/definitions/steps_volumes\"},\"settings\":{\"type\":\"object\"},\"name\":{},\"detach\":{\"type\":\"boolean\"},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{},\"user\":{}}}]},\"step_kubernetes\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"image\"],\"properties\":{\"image\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"privileged\":{\"type\":\"boolean\"},\"pull\":{\"type\":\"string\",\"enum\":[\"always\",\"never\",\"if-not-exists\"]},\"resources\":{\"$ref\":\"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements\"},\"volumes\":{\"$ref\":\"#/definitions/steps_volumes\"},\"settings\":{\"type\":\"object\"},\"name\":{},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{}}}]},\"step_exec\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{}}}]},\"step_ssh\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{}}}]},\"step_digitalocean\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{}}}]},\"step_macstadium\":{\"allOf\":[{\"$ref\":\"#/definitions/step\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{},\"failure\":{},\"commands\":{},\"environment\":{},\"when\":{},\"depends_on\":{}}}]},\"steps_volumes\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"path\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"path\":{\"$ref\":\"#/definitions/nonEmptyString\"}}}}},\"oneOf\":[{\"$ref\":\"#/definitions/kind_signature\"},{\"$ref\":\"#/definitions/kind_secret\"},{\"$ref\":\"#/definitions/kind_template\"},{\"allOf\":[{\"$ref\":\"#/definitions/kind_pipeline\"},{\"oneOf\":[{\"$ref\":\"#/definitions/pipeline_docker\"},{\"$ref\":\"#/definitions/pipeline_kubernetes\"},{\"$ref\":\"#/definitions/pipeline_exec\"},{\"$ref\":\"#/definitions/pipeline_ssh\"},{\"$ref\":\"#/definitions/pipeline_digitalocean\"},{\"$ref\":\"#/definitions/pipeline_macstadium\"}]}]}],\"properties\":{\"kind\":{\"enum\":[\"signature\",\"secret\",\"template\",\"pipeline\"]}},\"required\":[\"kind\"],\"title\":\"Drone CI configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Drone CI configuration file\". Here are the required top‑level fields: kind. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drone.json","definitions":{"nonEmptyString":{"type":"string","minLength":1},"platform":{"type":"object","properties":{"os":{"type":"string","enum":["linux","windows","darwin","freebsd","netbsd","openbsd","dragonfly","solaris"]},"arch":{"type":"string","enum":["arm","arm64","amd64","386"]},"variant":{"type":"string"},"version":{"type":"string"}}},"commands":{"type":"array","items":{"$ref":"#/definitions/nonEmptyString"}},"environment":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/secret"}]}},"condition":{"type":"array","items":{"type":"string"}},"conditions":{"anyOf":[{"$ref":"#/definitions/condition"},{"type":"object","properties":{"include":{"$ref":"#/definitions/condition"}}},{"type":"object","properties":{"exclude":{"$ref":"#/definitions/condition"}}}]},"allConditions":{"type":"object","properties":{"branch":{"$ref":"#/definitions/conditions"},"cron":{"$ref":"#/definitions/conditions"},"event":{"$ref":"#/definitions/conditions"},"paths":{"$ref":"#/definitions/conditions"},"ref":{"$ref":"#/definitions/conditions"},"repo":{"$ref":"#/definitions/conditions"},"status":{"$ref":"#/definitions/condition"},"target":{"$ref":"#/definitions/conditions"},"instance":{"$ref":"#/definitions/conditions"}}},"volumes":{"type":"array","items":{"type":"object","oneOf":[{"required":["name","host"]},{"required":["name","path"]},{"required":["name","temp"]},{"required":["name","claim"]},{"required":["name","config_map"]}],"properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"host":{"type":"object","properties":{"path":{"$ref":"#/definitions/nonEmptyString"}}},"temp":{"type":"object","additionalProperties":false,"properties":{"medium":{"type":"string","enum":["memory"]}}},"claim":{"type":"object","properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"read_only":{"type":"boolean"}}},"config_map":{"type":"object","properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"default_mode":{"type":"integer"},"optional":{"type":"boolean"}}}}}},"services":{"type":"array","items":{"type":"object","required":["name","image"],"properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"image":{"$ref":"#/definitions/nonEmptyString"},"command":{"$ref":"#/definitions/commands"},"entrypoint":{"$ref":"#/definitions/commands"},"environment":{"$ref":"#/definitions/environment"},"privileged":{"type":"boolean"},"pull":{"const":"always"},"volumes":{"$ref":"#/definitions/volumes"},"working_dir":{"$ref":"#/definitions/nonEmptyString"}}}},"secret":{"type":"object","required":["from_secret"],"properties":{"from_secret":{"type":"string"}}},"stringOrSecret":{"oneOf":[{"$ref":"#/definitions/nonEmptyString"},{"$ref":"#/definitions/secret"}]},"node":{"type":"object","additionalProperties":{"type":"string"}},"concurrency":{"type":"object","required":["limit"],"properties":{"limit":{"type":"number"}}},"kind_signature":{"type":"object","required":["hmac"],"properties":{"kind":{"const":"signature"},"hmac":{"type":"string","minLength":40,"maxLength":64}}},"kind_secret":{"type":"object","required":["name"],"properties":{"kind":{"const":"secret"},"name":{"$ref":"#/definitions/nonEmptyString"},"data":{"type":"string"},"get":{"type":"object","required":["path","name"],"properties":{"path":{"$ref":"#/definitions/nonEmptyString"},"name":{"$ref":"#/definitions/nonEmptyString"}}}}},"kind_template":{"type":"object","required":["load"],"properties":{"load":{"type":"string"},"data":{"type":"object"}}},"kind_pipeline":{"type":"object","required":["type","name","steps"],"properties":{"kind":{"const":"pipeline"},"name":{"$ref":"#/definitions/nonEmptyString"},"type":{"enum":["docker","kubernetes","ssh","exec","digitalocean","macstadium"]},"platform":{"$ref":"#/definitions/platform"},"workspace":{"type":"object","required":["path"],"properties":{"path":{"$ref":"#/definitions/nonEmptyString"}}},"clone":{"type":"object","properties":{"depth":{"type":"integer"},"disable":{"const":true},"retries":{"type":"integer"}}},"steps":{"type":"array","minLength":1},"trigger":{"$ref":"#/definitions/allConditions"},"depends_on":{"type":"array","items":{"$ref":"#/definitions/nonEmptyString"}}}},"pipeline_docker":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"docker"},"environment":{"$ref":"#/definitions/environment"},"steps":{"items":{"$ref":"#/definitions/step_docker"}},"volumes":{"$ref":"#/definitions/volumes"},"services":{"$ref":"#/definitions/services"},"image_pull_secrets":{"type":"array","items":{"type":"string"}},"node":{"$ref":"#/definitions/node"},"concurrency":{"$ref":"#/definitions/concurrency"},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"pipeline_kubernetes":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"kubernetes"},"metadata":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"},"node":{"$ref":"#/definitions/node"},"tolerations":{"description":"If specified, the pod's tolerations.","items":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.Toleration"},"type":"array"},"dns_config":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.PodDNSConfig","description":"Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy."},"host_aliases":{"description":"HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.","items":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.HostAlias"},"type":"array"},"node_selector":{"description":"A list of node selector terms.","items":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"}},"steps":{"items":{"$ref":"#/definitions/step_kubernetes"}},"volumes":{"$ref":"#/definitions/volumes"},"services":{"$ref":"#/definitions/services"},"image_pull_secrets":{"type":"array","items":{"type":"string"}},"service_account_name":{"description":"The name of the service account to use when running the kubernetes pipeline","type":"string"},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"pipeline_exec":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"exec"},"steps":{"items":{"$ref":"#/definitions/step_exec"}},"node":{"$ref":"#/definitions/node"},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"pipeline_ssh":{"type":"object","additionalProperties":false,"required":["server"],"properties":{"type":{"const":"ssh"},"steps":{"items":{"$ref":"#/definitions/step_ssh"}},"server":{"required":["host","user"],"properties":{"host":{"$ref":"#/definitions/stringOrSecret"},"user":{"$ref":"#/definitions/stringOrSecret"},"password":{"$ref":"#/definitions/stringOrSecret"},"ssh_key":{"$ref":"#/definitions/stringOrSecret"}}},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"pipeline_digitalocean":{"type":"object","additionalProperties":false,"required":["token"],"properties":{"type":{"const":"digitalocean"},"token":{"$ref":"#/definitions/stringOrSecret"},"steps":{"items":{"$ref":"#/definitions/step_digitalocean"}},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"pipeline_macstadium":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"macstadium"},"steps":{"items":{"$ref":"#/definitions/step_macstadium"}},"kind":{},"name":{},"platform":{},"workspace":{},"clone":{},"trigger":{},"depends_on":{}}},"step":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"failure":{"type":"string","enum":["always","ignore"]},"commands":{"$ref":"#/definitions/commands"},"detach":{"type":"boolean"},"environment":{"$ref":"#/definitions/environment"},"when":{"$ref":"#/definitions/allConditions"},"depends_on":{"type":"array","items":{"$ref":"#/definitions/nonEmptyString"}}}},"step_docker":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"required":["image"],"properties":{"image":{"$ref":"#/definitions/nonEmptyString"},"network_mode":{"type":"string","enum":["bridge","host"]},"privileged":{"type":"boolean"},"pull":{"type":"string","enum":["always","never","if-not-exists"]},"volumes":{"$ref":"#/definitions/steps_volumes"},"settings":{"type":"object"},"name":{},"detach":{"type":"boolean"},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{},"user":{}}}]},"step_kubernetes":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"required":["image"],"properties":{"image":{"$ref":"#/definitions/nonEmptyString"},"privileged":{"type":"boolean"},"pull":{"type":"string","enum":["always","never","if-not-exists"]},"resources":{"$ref":"https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"},"volumes":{"$ref":"#/definitions/steps_volumes"},"settings":{"type":"object"},"name":{},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{}}}]},"step_exec":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"properties":{"name":{},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{}}}]},"step_ssh":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"properties":{"name":{},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{}}}]},"step_digitalocean":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"properties":{"name":{},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{}}}]},"step_macstadium":{"allOf":[{"$ref":"#/definitions/step"},{"type":"object","additionalProperties":false,"properties":{"name":{},"failure":{},"commands":{},"environment":{},"when":{},"depends_on":{}}}]},"steps_volumes":{"type":"array","items":{"type":"object","required":["name","path"],"properties":{"name":{"$ref":"#/definitions/nonEmptyString"},"path":{"$ref":"#/definitions/nonEmptyString"}}}}},"oneOf":[{"$ref":"#/definitions/kind_signature"},{"$ref":"#/definitions/kind_secret"},{"$ref":"#/definitions/kind_template"},{"allOf":[{"$ref":"#/definitions/kind_pipeline"},{"oneOf":[{"$ref":"#/definitions/pipeline_docker"},{"$ref":"#/definitions/pipeline_kubernetes"},{"$ref":"#/definitions/pipeline_exec"},{"$ref":"#/definitions/pipeline_ssh"},{"$ref":"#/definitions/pipeline_digitalocean"},{"$ref":"#/definitions/pipeline_macstadium"}]}]}],"properties":{"kind":{"enum":["signature","secret","template","pipeline"]}},"required":["kind"],"title":"Drone CI configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "Drone CI configuration file". Here are the required top‑level fields: kind. Return only the valid JSON object.
|
Drone CI configuration file
|
schema-store
|
schema_store_274
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-breakpoints.json\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"label\":{\"title\":\"A human readable label for the breakpoint\",\"type\":\"string\"},\"mediaQuery\":{\"title\":\"Media query text proper\",\"examples\":[\"all and (min-width: 851px)\"],\"type\":\"string\"},\"weight\":{\"title\":\"Positional weight (order) for the breakpoint\",\"type\":\"integer\"},\"multipliers\":{\"title\":\" Supported pixel resolution multipliers\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^\\\\d+(\\\\.\\\\d+)?x$\"},\"uniqueItems\":true},\"group\":{\"title\":\"Breakpoint group\",\"type\":\"string\"}}},\"title\":\"JSON schema for Drupal breakpoints file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal breakpoints file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-breakpoints.json","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"label":{"title":"A human readable label for the breakpoint","type":"string"},"mediaQuery":{"title":"Media query text proper","examples":["all and (min-width: 851px)"],"type":"string"},"weight":{"title":"Positional weight (order) for the breakpoint","type":"integer"},"multipliers":{"title":" Supported pixel resolution multipliers","type":"array","items":{"type":"string","pattern":"^\\d+(\\.\\d+)?x$"},"uniqueItems":true},"group":{"title":"Breakpoint group","type":"string"}}},"title":"JSON schema for Drupal breakpoints file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal breakpoints file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal breakpoints file
|
schema-store
|
schema_store_275
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-config.json\",\"additionalProperties\":{\"$ref\":\"#/definitions/configItem\",\"title\":\"Configuration item\"},\"definitions\":{\"configItem\":{\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"The type of the value\",\"type\":\"string\",\"examples\":[\"boolean\",\"integer\",\"float\",\"string\",\"uri\",\"email\",\"mapping\",\"sequence\",\"label\",\"text\",\"config_object\",\"config_entity\"]},\"label\":{\"title\":\"User interface label for the value\",\"type\":\"string\"},\"translatable\":{\"title\":\"Whether the defined type is translatable\",\"type\":\"boolean\"},\"translation context\":{\"title\":\"The translation context the source string belongs to\",\"type\":\"string\"},\"nullable\":{\"title\":\"Whether the value can be empty\",\"type\":\"boolean\"},\"class\":{\"title\":\"The class implementing parsing\",\"type\":\"string\"},\"definition_class\":{\"title\":\"The definition class\",\"type\":\"string\"},\"orderby\":{\"title\":\"Determines how the sequence should be sorted\",\"type\":\"string\"},\"constraints\":{\"title\":\"Validation constrains\",\"type\":\"object\"},\"sequence\":{\"$ref\":\"#/definitions/configItem\"},\"mapping\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/configItem\"}}},\"additionalProperties\":false}},\"title\":\"JSON schema for Drupal configuration schema file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal configuration schema file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-config.json","additionalProperties":{"$ref":"#/definitions/configItem","title":"Configuration item"},"definitions":{"configItem":{"type":"object","properties":{"type":{"title":"The type of the value","type":"string","examples":["boolean","integer","float","string","uri","email","mapping","sequence","label","text","config_object","config_entity"]},"label":{"title":"User interface label for the value","type":"string"},"translatable":{"title":"Whether the defined type is translatable","type":"boolean"},"translation context":{"title":"The translation context the source string belongs to","type":"string"},"nullable":{"title":"Whether the value can be empty","type":"boolean"},"class":{"title":"The class implementing parsing","type":"string"},"definition_class":{"title":"The definition class","type":"string"},"orderby":{"title":"Determines how the sequence should be sorted","type":"string"},"constraints":{"title":"Validation constrains","type":"object"},"sequence":{"$ref":"#/definitions/configItem"},"mapping":{"type":"object","additionalProperties":{"$ref":"#/definitions/configItem"}}},"additionalProperties":false}},"title":"JSON schema for Drupal configuration schema file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal configuration schema file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal configuration schema file
|
schema-store
|
schema_store_276
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-info.json\",\"allOf\":[{\"if\":{\"properties\":{\"type\":{\"const\":\"module\"}}},\"then\":{\"properties\":{\"configure\":{\"title\":\"A route name of the configuration form\",\"type\":\"string\"},\"dependencies\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dependency\"}},\"test_dependencies\":{\"title\":\"Dependencies that are needed to run certain automated tests for this extension\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dependency\"}}}}},{\"if\":{\"properties\":{\"type\":{\"const\":\"theme\"}}},\"then\":{\"properties\":{\"base theme\":{\"title\":\"Base theme\",\"default\":\"classy\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"boolean\"}]},\"libraries\":{\"title\":\"A list of libraries to add to all pages where the theme is active\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^[a-z0-9_]+/[a-z0-9_\\\\-.]+$\"}},\"libraries-override\":{\"title\":\"A collection of libraries and assets to override\",\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"type\":\"object\"},{\"type\":\"string\"},{\"type\":\"boolean\"}]}},\"libraries-extend\":{\"title\":\"A collection of libraries and assets to add whenever a library is attached\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\"}},\"engine\":{\"title\":\"The theme engine\",\"default\":\"twig\",\"type\":\"string\"},\"logo\":{\"title\":\"The path to logo relative to the theme's .info.yml\",\"type\":\"string\"},\"screenshot\":{\"title\":\"The path to screenshot relative to the theme's .info.yml file\",\"type\":\"string\"},\"regions\":{\"title\":\"A list of theme regions\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"regions_hidden\":{\"title\":\"A list of inherited regions to remove\",\"type\":\"array\",\"uniqueItems\":true},\"features\":{\"title\":\"A list of features to expose on the theme 'Settings' page\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"stylesheets-remove\":{\"title\":\"A list of stylesheets from other modules or themes to remove from all pages where the theme is active\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"ckeditor_stylesheets\":{\"title\":\"A list of stylesheets to add to the CKEditor frame\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}},{\"if\":{\"properties\":{\"type\":{\"const\":\"profile\"}}},\"then\":{\"properties\":{\"distribution\":{\"title\":\"Declare the installation profile as a distribution\",\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"The distribution name\",\"type\":\"string\"},\"install\":{\"type\":\"object\",\"properties\":{\"theme\":{\"$ref\":\"#/definitions/machine_name\",\"title\":\"The theme for the distribution installation\"}}},\"langcode\":{\"type\":\"string\"}}},\"dependencies\":{\"title\":\"Required modules\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/machine_name\"},\"uniqueItems\":true},\"install\":{\"title\":\"Modules to install to support the profile\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dependency\"},\"uniqueItems\":true},\"theme\":{\"title\":\"List any themes that should be installed as part of the profile installation\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/machine_name\"},\"uniqueItems\":true}}}}],\"definitions\":{\"dependency\":{\"title\":\"Extension dependency\",\"type\":\"string\",\"pattern\":\"^[a-z0-9_]+:[a-z0-9_]+( \\\\(.+\\\\))?$\"},\"machine_name\":{\"title\":\"Machine name\",\"type\":\"string\",\"pattern\":\"^[a-z0-9_]+$\"}},\"properties\":{\"name\":{\"title\":\"The human-readable name\",\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"module\",\"theme\",\"profile\",\"theme_engine\"]},\"core\":{\"type\":\"string\",\"pattern\":\"^\\\\d+\\\\.x$\"},\"core_version_requirement\":{\"title\":\"Semantic core version requirement\",\"type\":\"string\"},\"description\":{\"title\":\"Extension description\",\"type\":\"string\"},\"package\":{\"title\":\"A key that allows to group extension together an administrative pages\",\"type\":\"string\"},\"version\":{\"title\":\"The version of the extension\",\"type\":\"string\"},\"project\":{\"title\":\"The machine name of extension project on drupal.org\",\"type\":\"string\"},\"datestamp\":{\"title\":\"The date and time when the extension was packaged\",\"type\":\"integer\"},\"hidden\":{\"title\":\"Do not the extension in admin interface\",\"type\":\"boolean\"},\"php\":{\"title\":\"The minimal PHP version that is required for this extension\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\d+\\\\.\\\\d+(\\\\.\\\\d+)$\"},{\"type\":\"number\"}]}},\"required\":[\"type\",\"core_version_requirement\",\"name\"],\"title\":\"JSON schema for Drupal extension info file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal extension info file\". Here are the required top‑level fields: type, core_version_requirement, name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-info.json","allOf":[{"if":{"properties":{"type":{"const":"module"}}},"then":{"properties":{"configure":{"title":"A route name of the configuration form","type":"string"},"dependencies":{"type":"array","items":{"$ref":"#/definitions/dependency"}},"test_dependencies":{"title":"Dependencies that are needed to run certain automated tests for this extension","type":"array","items":{"$ref":"#/definitions/dependency"}}}}},{"if":{"properties":{"type":{"const":"theme"}}},"then":{"properties":{"base theme":{"title":"Base theme","default":"classy","oneOf":[{"type":"string"},{"type":"boolean"}]},"libraries":{"title":"A list of libraries to add to all pages where the theme is active","type":"array","items":{"type":"string","pattern":"^[a-z0-9_]+/[a-z0-9_\\-.]+$"}},"libraries-override":{"title":"A collection of libraries and assets to override","type":"object","additionalProperties":{"oneOf":[{"type":"object"},{"type":"string"},{"type":"boolean"}]}},"libraries-extend":{"title":"A collection of libraries and assets to add whenever a library is attached","type":"object","additionalProperties":{"type":"array"}},"engine":{"title":"The theme engine","default":"twig","type":"string"},"logo":{"title":"The path to logo relative to the theme's .info.yml","type":"string"},"screenshot":{"title":"The path to screenshot relative to the theme's .info.yml file","type":"string"},"regions":{"title":"A list of theme regions","type":"object","additionalProperties":{"type":"string"}},"regions_hidden":{"title":"A list of inherited regions to remove","type":"array","uniqueItems":true},"features":{"title":"A list of features to expose on the theme 'Settings' page","type":"array","items":{"type":"string"},"uniqueItems":true},"stylesheets-remove":{"title":"A list of stylesheets from other modules or themes to remove from all pages where the theme is active","type":"array","items":{"type":"string"},"uniqueItems":true},"ckeditor_stylesheets":{"title":"A list of stylesheets to add to the CKEditor frame","type":"array","items":{"type":"string"}}}}},{"if":{"properties":{"type":{"const":"profile"}}},"then":{"properties":{"distribution":{"title":"Declare the installation profile as a distribution","type":"object","properties":{"name":{"title":"The distribution name","type":"string"},"install":{"type":"object","properties":{"theme":{"$ref":"#/definitions/machine_name","title":"The theme for the distribution installation"}}},"langcode":{"type":"string"}}},"dependencies":{"title":"Required modules","type":"array","items":{"$ref":"#/definitions/machine_name"},"uniqueItems":true},"install":{"title":"Modules to install to support the profile","type":"array","items":{"$ref":"#/definitions/dependency"},"uniqueItems":true},"theme":{"title":"List any themes that should be installed as part of the profile installation","type":"array","items":{"$ref":"#/definitions/machine_name"},"uniqueItems":true}}}}],"definitions":{"dependency":{"title":"Extension dependency","type":"string","pattern":"^[a-z0-9_]+:[a-z0-9_]+( \\(.+\\))?$"},"machine_name":{"title":"Machine name","type":"string","pattern":"^[a-z0-9_]+$"}},"properties":{"name":{"title":"The human-readable name","type":"string"},"type":{"type":"string","enum":["module","theme","profile","theme_engine"]},"core":{"type":"string","pattern":"^\\d+\\.x$"},"core_version_requirement":{"title":"Semantic core version requirement","type":"string"},"description":{"title":"Extension description","type":"string"},"package":{"title":"A key that allows to group extension together an administrative pages","type":"string"},"version":{"title":"The version of the extension","type":"string"},"project":{"title":"The machine name of extension project on drupal.org","type":"string"},"datestamp":{"title":"The date and time when the extension was packaged","type":"integer"},"hidden":{"title":"Do not the extension in admin interface","type":"boolean"},"php":{"title":"The minimal PHP version that is required for this extension","oneOf":[{"type":"string","pattern":"^\\d+\\.\\d+(\\.\\d+)$"},{"type":"number"}]}},"required":["type","core_version_requirement","name"],"title":"JSON schema for Drupal extension info file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal extension info file". Here are the required top‑level fields: type, core_version_requirement, name. Return only the valid JSON object.
|
JSON schema for Drupal extension info file
|
schema-store
|
schema_store_277
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-layouts.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"label\":{\"title\":\"The human-readable name\",\"type\":\"string\"},\"description\":{\"title\":\"A description for advanced layouts\",\"type\":\"string\"},\"category\":{\"title\":\"The human-readable category name\",\"type\":\"string\"},\"template\":{\"title\":\"The template file to render this layout\",\"type\":\"string\"},\"theme_hook\":{\"title\":\"The theme hook used to render this layout\",\"default\":\"layout\",\"type\":\"string\"},\"path\":{\"title\":\"Path to resources like icon or template\",\"type\":\"string\"},\"library\":{\"title\":\"The asset library\",\"type\":\"string\"},\"icon\":{\"title\":\"The path to the preview image\",\"type\":\"string\"},\"icon_map\":{\"title\":\"The icon map\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"regions\":{\"title\":\"List of regions in this layout\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"label\":{\"title\":\"The human-readable name\",\"type\":\"string\"}},\"additionalProperties\":true}},\"default_region\":{\"title\":\"The default region\",\"type\":\"string\"},\"class\":{\"title\":\"Plugin class\",\"type\":\"string\"}},\"additionalProperties\":false},\"title\":\"JSON schema for Drupal layouts file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal layouts file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-layouts.json","additionalProperties":{"type":"object","properties":{"label":{"title":"The human-readable name","type":"string"},"description":{"title":"A description for advanced layouts","type":"string"},"category":{"title":"The human-readable category name","type":"string"},"template":{"title":"The template file to render this layout","type":"string"},"theme_hook":{"title":"The theme hook used to render this layout","default":"layout","type":"string"},"path":{"title":"Path to resources like icon or template","type":"string"},"library":{"title":"The asset library","type":"string"},"icon":{"title":"The path to the preview image","type":"string"},"icon_map":{"title":"The icon map","type":"array","items":{"type":"array","items":{"type":"string"}}},"regions":{"title":"List of regions in this layout","type":"object","additionalProperties":{"type":"object","properties":{"label":{"title":"The human-readable name","type":"string"}},"additionalProperties":true}},"default_region":{"title":"The default region","type":"string"},"class":{"title":"Plugin class","type":"string"}},"additionalProperties":false},"title":"JSON schema for Drupal layouts file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal layouts file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal layouts file
|
schema-store
|
schema_store_278
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-libraries.json\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"version\":{\"title\":\"The library version\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"number\"}]},\"remote\":{\"title\":\"The library repository URL\",\"type\":\"string\"},\"license\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"The human-readable name of the license\",\"type\":\"string\"},\"url\":{\"title\":\"The URL of the license file/information for the version of the library used\",\"type\":\"string\"},\"gpl-compatible\":{\"title\":\"A boolean for whether this library is GPL compatible\",\"type\":\"boolean\"}}},\"header\":{\"title\":\"A boolean for whether the script must be included in the header\",\"type\":\"boolean\"},\"drupalSettings\":{\"title\":\"Settings that needs to be attached to drupalSettings object in JavaScript\",\"type\":\"object\"},\"js\":{\"title\":\"List of JavaScript files to load\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/file\",\"type\":\"object\",\"properties\":{\"cache\":{\"type\":\"boolean\"}},\"additionalProperties\":false}},\"css\":{\"title\":\"List of CSS files to load\",\"type\":\"object\",\"properties\":{\"base\":{\"$ref\":\"#/definitions/cssFiles\"},\"layout\":{\"$ref\":\"#/definitions/cssFiles\"},\"component\":{\"$ref\":\"#/definitions/cssFiles\"},\"theme\":{\"$ref\":\"#/definitions/cssFiles\"},\"state\":{\"$ref\":\"#/definitions/cssFiles\"}}},\"dependencies\":{\"title\":\"List libraries that should be loaded along with this library\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^.+/.+$\"}}}},\"definitions\":{\"file\":{\"type\":\"object\",\"properties\":{\"attributes\":{\"title\":\"Optional attributes\",\"type\":\"object\"},\"browsers\":{\"title\":\"Load asset conditionally based on browser\",\"type\":\"object\"},\"minified\":{\"title\":\"Whether the asset is already minified\",\"type\":\"boolean\"},\"external\":{\"type\":\"boolean\"},\"type\":{\"title\":\"The source of the asset\",\"type\":\"string\"},\"preprocess\":{\"title\":\"Whether the assets should be aggregated\",\"type\":\"boolean\"},\"weight\":{\"title\":\"The order relative to other assets\",\"type\":\"integer\"}}},\"cssFiles\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/file\",\"type\":\"object\",\"properties\":{\"group\":{\"title\":\"The SMACSS group in which the asset is placed\",\"type\":\"integer\"},\"media\":{\"title\":\"Media type\",\"type\":\"string\",\"enum\":[\"all\",\"screen\",\"print\",\"speech\"]}},\"additionalProperties\":false}}},\"title\":\"JSON schema for Drupal libraries file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal libraries file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-libraries.json","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"version":{"title":"The library version","oneOf":[{"type":"string"},{"type":"number"}]},"remote":{"title":"The library repository URL","type":"string"},"license":{"type":"object","additionalProperties":false,"properties":{"name":{"title":"The human-readable name of the license","type":"string"},"url":{"title":"The URL of the license file/information for the version of the library used","type":"string"},"gpl-compatible":{"title":"A boolean for whether this library is GPL compatible","type":"boolean"}}},"header":{"title":"A boolean for whether the script must be included in the header","type":"boolean"},"drupalSettings":{"title":"Settings that needs to be attached to drupalSettings object in JavaScript","type":"object"},"js":{"title":"List of JavaScript files to load","type":"object","additionalProperties":{"$ref":"#/definitions/file","type":"object","properties":{"cache":{"type":"boolean"}},"additionalProperties":false}},"css":{"title":"List of CSS files to load","type":"object","properties":{"base":{"$ref":"#/definitions/cssFiles"},"layout":{"$ref":"#/definitions/cssFiles"},"component":{"$ref":"#/definitions/cssFiles"},"theme":{"$ref":"#/definitions/cssFiles"},"state":{"$ref":"#/definitions/cssFiles"}}},"dependencies":{"title":"List libraries that should be loaded along with this library","type":"array","items":{"type":"string","pattern":"^.+/.+$"}}}},"definitions":{"file":{"type":"object","properties":{"attributes":{"title":"Optional attributes","type":"object"},"browsers":{"title":"Load asset conditionally based on browser","type":"object"},"minified":{"title":"Whether the asset is already minified","type":"boolean"},"external":{"type":"boolean"},"type":{"title":"The source of the asset","type":"string"},"preprocess":{"title":"Whether the assets should be aggregated","type":"boolean"},"weight":{"title":"The order relative to other assets","type":"integer"}}},"cssFiles":{"type":"object","additionalProperties":{"$ref":"#/definitions/file","type":"object","properties":{"group":{"title":"The SMACSS group in which the asset is placed","type":"integer"},"media":{"title":"Media type","type":"string","enum":["all","screen","print","speech"]}},"additionalProperties":false}}},"title":"JSON schema for Drupal libraries file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal libraries file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal libraries file
|
schema-store
|
schema_store_279
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-links-action.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"The static title for the local action\",\"type\":\"string\"},\"title_context\":{\"title\":\"The translation context for the title value.\",\"type\":\"string\"},\"route_name\":{\"title\":\"The route name used to generate a link\",\"type\":\"string\"},\"route_parameters\":{\"title\":\"Route parameters for generating a link\",\"type\":\"object\"},\"weight\":{\"title\":\"The weight of the local action\",\"type\":\"integer\"},\"options\":{\"title\":\"Array of link options\",\"type\":\"object\"},\"appears_on\":{\"title\":\"The route names where this local action appears\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"class\":{\"title\":\"Class for local action implementations\",\"type\":\"string\"},\"deriver\":{\"title\":\"Deriver class\",\"type\":\"string\"},\"cache_tags\":{\"title\":\"Cache tags\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"title\":\"JSON schema for Drupal action links file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal action links file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-links-action.json","additionalProperties":{"type":"object","properties":{"title":{"title":"The static title for the local action","type":"string"},"title_context":{"title":"The translation context for the title value.","type":"string"},"route_name":{"title":"The route name used to generate a link","type":"string"},"route_parameters":{"title":"Route parameters for generating a link","type":"object"},"weight":{"title":"The weight of the local action","type":"integer"},"options":{"title":"Array of link options","type":"object"},"appears_on":{"title":"The route names where this local action appears","type":"array","items":{"type":"string"}},"class":{"title":"Class for local action implementations","type":"string"},"deriver":{"title":"Deriver class","type":"string"},"cache_tags":{"title":"Cache tags","type":"array","items":{"type":"string"}}}},"title":"JSON schema for Drupal action links file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal action links file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal action links file
|
schema-store
|
schema_store_280
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-links-contextual.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"The static title for the local action\",\"type\":\"string\"},\"title_context\":{\"title\":\"The translation context for the title value.\",\"type\":\"string\"},\"route_name\":{\"title\":\"The route name used to generate a link\",\"type\":\"string\"},\"route_parameters\":{\"title\":\"Route parameters for generating a link\",\"type\":\"object\"},\"group\":{\"title\":\"The contextual links group\",\"type\":\"string\"},\"weight\":{\"title\":\"The weight of the local action\",\"type\":\"integer\"},\"options\":{\"title\":\"Array of link options\",\"type\":\"object\"},\"class\":{\"title\":\"Class for local action implementations\",\"type\":\"string\"},\"deriver\":{\"title\":\"Deriver class\",\"type\":\"string\"},\"cache_tags\":{\"title\":\"Cache tags\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"title\":\"JSON schema for Drupal contextual links file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal contextual links file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-links-contextual.json","additionalProperties":{"type":"object","properties":{"title":{"title":"The static title for the local action","type":"string"},"title_context":{"title":"The translation context for the title value.","type":"string"},"route_name":{"title":"The route name used to generate a link","type":"string"},"route_parameters":{"title":"Route parameters for generating a link","type":"object"},"group":{"title":"The contextual links group","type":"string"},"weight":{"title":"The weight of the local action","type":"integer"},"options":{"title":"Array of link options","type":"object"},"class":{"title":"Class for local action implementations","type":"string"},"deriver":{"title":"Deriver class","type":"string"},"cache_tags":{"title":"Cache tags","type":"array","items":{"type":"string"}}},"additionalProperties":false},"title":"JSON schema for Drupal contextual links file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal contextual links file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal contextual links file
|
schema-store
|
schema_store_281
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-links-menu.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"The static title for the menu link\",\"type\":\"string\"},\"title_context\":{\"title\":\"The translation context for the title value.\",\"type\":\"string\"},\"description\":{\"title\":\"The description\",\"type\":\"string\"},\"description_context\":{\"title\":\"The translation context for the description value.\",\"type\":\"string\"},\"route_name\":{\"title\":\"The name of the route this links to, unless it's external\",\"type\":\"string\"},\"route_parameters\":{\"title\":\"Parameters for route variables when generating a link\",\"type\":\"object\"},\"parent\":{\"title\":\"The plugin ID of the parent tab\",\"type\":\"string\"},\"menu_name\":{\"title\":\"The name of the menu for this link\",\"default\":\"tools\",\"type\":\"string\"},\"url\":{\"title\":\"The external URL if this link has one\",\"type\":\"string\"},\"weight\":{\"title\":\"The weight of the link\",\"type\":\"integer\"},\"options\":{\"title\":\"Array of link options\",\"type\":\"object\"},\"class\":{\"title\":\"Class for task implementations\",\"type\":\"string\"},\"form_class\":{\"title\":\"Class for task implementations\",\"type\":\"string\"},\"provider\":{\"title\":\"The name of the module providing this link\",\"type\":\"string\"},\"metadata\":{\"$comment\":\"@todo Add a title\",\"type\":\"array\"},\"expanded\":{\"title\":\"Show the link as expanded\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"integer\"}]},\"enabled\":{\"title\":\"The status of the link\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"integer\"}]},\"deriver\":{\"title\":\"Deriver class\",\"type\":\"string\"},\"position\":{\"$comment\":\"@todo Add a title and enum if needed\",\"type\":\"string\"},\"cache_tags\":{\"title\":\"Cache tags\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"title\":\"JSON schema for Drupal menu links file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal menu links file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-links-menu.json","additionalProperties":{"type":"object","properties":{"title":{"title":"The static title for the menu link","type":"string"},"title_context":{"title":"The translation context for the title value.","type":"string"},"description":{"title":"The description","type":"string"},"description_context":{"title":"The translation context for the description value.","type":"string"},"route_name":{"title":"The name of the route this links to, unless it's external","type":"string"},"route_parameters":{"title":"Parameters for route variables when generating a link","type":"object"},"parent":{"title":"The plugin ID of the parent tab","type":"string"},"menu_name":{"title":"The name of the menu for this link","default":"tools","type":"string"},"url":{"title":"The external URL if this link has one","type":"string"},"weight":{"title":"The weight of the link","type":"integer"},"options":{"title":"Array of link options","type":"object"},"class":{"title":"Class for task implementations","type":"string"},"form_class":{"title":"Class for task implementations","type":"string"},"provider":{"title":"The name of the module providing this link","type":"string"},"metadata":{"$comment":"@todo Add a title","type":"array"},"expanded":{"title":"Show the link as expanded","oneOf":[{"type":"boolean"},{"type":"integer"}]},"enabled":{"title":"The status of the link","oneOf":[{"type":"boolean"},{"type":"integer"}]},"deriver":{"title":"Deriver class","type":"string"},"position":{"$comment":"@todo Add a title and enum if needed","type":"string"},"cache_tags":{"title":"Cache tags","type":"array","items":{"type":"string"}}},"additionalProperties":false},"title":"JSON schema for Drupal menu links file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal menu links file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal menu links file
|
schema-store
|
schema_store_282
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-links-task.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"The static title for the local task\",\"type\":\"string\"},\"title_context\":{\"title\":\"The translation context for the title value.\",\"type\":\"string\"},\"route_name\":{\"title\":\"The name of the route this task links to\",\"type\":\"string\"},\"route_parameters\":{\"title\":\"Parameters for route variables when generating a link\",\"type\":\"object\"},\"base_route\":{\"title\":\"The route name where the root tab appears\",\"type\":\"string\"},\"parent_id\":{\"title\":\"The plugin ID of the parent tab\",\"type\":\"string\"},\"weight\":{\"title\":\"The weight of the tab\",\"type\":\"integer\"},\"options\":{\"title\":\"Array of link options\",\"type\":\"object\"},\"class\":{\"title\":\"Class for task implementations\",\"type\":\"string\"},\"deriver\":{\"title\":\"Deriver class\",\"type\":\"string\"},\"cache_tags\":{\"title\":\"Cache tags\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"title\":\"JSON schema for Drupal task links file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal task links file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-links-task.json","additionalProperties":{"type":"object","properties":{"title":{"title":"The static title for the local task","type":"string"},"title_context":{"title":"The translation context for the title value.","type":"string"},"route_name":{"title":"The name of the route this task links to","type":"string"},"route_parameters":{"title":"Parameters for route variables when generating a link","type":"object"},"base_route":{"title":"The route name where the root tab appears","type":"string"},"parent_id":{"title":"The plugin ID of the parent tab","type":"string"},"weight":{"title":"The weight of the tab","type":"integer"},"options":{"title":"Array of link options","type":"object"},"class":{"title":"Class for task implementations","type":"string"},"deriver":{"title":"Deriver class","type":"string"},"cache_tags":{"title":"Cache tags","type":"array","items":{"type":"string"}}},"additionalProperties":false},"title":"JSON schema for Drupal task links file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal task links file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal task links file
|
schema-store
|
schema_store_283
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-migration.json\",\"properties\":{\"id\":{\"title\":\"The migration ID (machine name)\",\"type\":\"string\"},\"label\":{\"title\":\"The human-readable label for the migration\",\"type\":\"string\"},\"audit\":{\"title\":\"Whether the migration is auditable\",\"type\":\"boolean\"},\"migration_tags\":{\"title\":\"List of tags, used by the plugin manager for filtering\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"deriver\":{\"title\":\"Deriver class\",\"type\":\"string\"},\"source\":{\"title\":\"The source plugin configuration\",\"type\":\"object\",\"properties\":{\"plugin\":{\"title\":\"Source plugin ID\",\"type\":\"string\"}},\"required\":[\"plugin\"]},\"process\":{\"title\":\"The configuration describing the process plugins\",\"type\":\"object\"},\"destination\":{\"title\":\"The destination plugin configuration\",\"type\":[\"object\"],\"properties\":{\"plugin\":{\"title\":\"Destination plugin ID\",\"type\":[\"string\",\"null\"]}},\"required\":[\"plugin\"]},\"migration_dependencies\":{\"title\":\"Migrations to run before this migration\",\"type\":\"object\",\"properties\":{\"required\":{\"title\":\"List of migration IDs that must be run before this migration\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"optional\":{\"title\":\"List of migration IDs that, if they exist, must be run before\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}}},\"dependencies\":{\"title\":\"The migration's dependencies\",\"type\":\"object\",\"properties\":{\"config\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"module\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"theme\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"content\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"enforced\":{\"type\":\"object\",\"properties\":{\"config\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"module\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"theme\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"content\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}},\"additionalProperties\":false}},\"additionalProperties\":false},\"provider\":{\"title\":\"List of plugin providers\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"class\":{\"title\":\"Class for migration implementation\",\"type\":[\"string\",\"null\"]}},\"title\":\"JSON schema for Drupal migration files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal migration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-migration.json","properties":{"id":{"title":"The migration ID (machine name)","type":"string"},"label":{"title":"The human-readable label for the migration","type":"string"},"audit":{"title":"Whether the migration is auditable","type":"boolean"},"migration_tags":{"title":"List of tags, used by the plugin manager for filtering","type":"array","items":{"type":"string"},"uniqueItems":true},"deriver":{"title":"Deriver class","type":"string"},"source":{"title":"The source plugin configuration","type":"object","properties":{"plugin":{"title":"Source plugin ID","type":"string"}},"required":["plugin"]},"process":{"title":"The configuration describing the process plugins","type":"object"},"destination":{"title":"The destination plugin configuration","type":["object"],"properties":{"plugin":{"title":"Destination plugin ID","type":["string","null"]}},"required":["plugin"]},"migration_dependencies":{"title":"Migrations to run before this migration","type":"object","properties":{"required":{"title":"List of migration IDs that must be run before this migration","type":"array","items":{"type":"string"},"uniqueItems":true},"optional":{"title":"List of migration IDs that, if they exist, must be run before","type":"array","items":{"type":"string"},"uniqueItems":true}}},"dependencies":{"title":"The migration's dependencies","type":"object","properties":{"config":{"type":"array","items":{"type":"string"},"uniqueItems":true},"module":{"type":"array","items":{"type":"string"},"uniqueItems":true},"theme":{"type":"array","items":{"type":"string"},"uniqueItems":true},"content":{"type":"array","items":{"type":"string"},"uniqueItems":true},"enforced":{"type":"object","properties":{"config":{"type":"array","items":{"type":"string"},"uniqueItems":true},"module":{"type":"array","items":{"type":"string"},"uniqueItems":true},"theme":{"type":"array","items":{"type":"string"},"uniqueItems":true},"content":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"additionalProperties":false}},"additionalProperties":false},"provider":{"title":"List of plugin providers","type":"array","items":{"type":"string"},"uniqueItems":true},"class":{"title":"Class for migration implementation","type":["string","null"]}},"title":"JSON schema for Drupal migration files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal migration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal migration files
|
schema-store
|
schema_store_284
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-permissions.json\",\"additionalProperties\":{\"title\":\"Permission definition\",\"type\":\"object\",\"required\":[\"title\"],\"properties\":{\"title\":{\"title\":\"The human-readable name of the permission\",\"type\":\"string\"},\"description\":{\"title\":\"A description of what the permission does\",\"type\":\"string\"},\"restrict access\":{\"title\":\"Restrict access to this permission to trusted users\",\"description\":\"This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the \\\"administer filters\\\" and \\\"bypass node access\\\" permissions provided by Drupal core).\",\"type\":\"boolean\"}},\"additionalProperties\":false},\"properties\":{\"permission_callbacks\":{\"title\":\"List of permission callbacks\",\"type\":\"array\",\"items\":{\"title\":\"A callback that return array of permissions\",\"type\":\"string\"},\"uniqueItems\":true}},\"title\":\"JSON schema for Drupal permissions file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal permissions file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-permissions.json","additionalProperties":{"title":"Permission definition","type":"object","required":["title"],"properties":{"title":{"title":"The human-readable name of the permission","type":"string"},"description":{"title":"A description of what the permission does","type":"string"},"restrict access":{"title":"Restrict access to this permission to trusted users","description":"This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the \"administer filters\" and \"bypass node access\" permissions provided by Drupal core).","type":"boolean"}},"additionalProperties":false},"properties":{"permission_callbacks":{"title":"List of permission callbacks","type":"array","items":{"title":"A callback that return array of permissions","type":"string"},"uniqueItems":true}},"title":"JSON schema for Drupal permissions file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal permissions file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal permissions file
|
schema-store
|
schema_store_285
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-recipe.json\",\"$defs\":{\"theme\":{\"defaultRegions\":{\"enum\":[\"sidebar_first\",\"sidebar_second\",\"content\",\"header\",\"primary_menu\",\"secondary_menu\",\"footer\",\"highlighted\",\"help\",\"page_top\",\"page_bottom\",\"breadcrumb\"]}},\"recipeTypes\":{\"type\":\"string\",\"enum\":[\"Administration\",\"Block type\",\"Comment type\",\"Contact form\",\"Content field\",\"Content type\",\"Editor\",\"Maintenance\",\"Media type\",\"Performance\",\"Responsive image\",\"Search\",\"Site\",\"Taxonomy\",\"Text format\",\"Text format editor\",\"Theme\",\"User role\",\"User type\",\"Users\",\"Workflow\"]},\"actionsList\":{\"generic\":{\"cloneAs\":{\"description\":\"Creates a clone of any config entity with a new ID.\",\"type\":\"string\"},\"create\":{\"description\":\"Creates a config entity.\",\"type\":\"object\"},\"createIfNotExists\":{\"description\":\"Creates a config entity if it does not exist. Existence is determined by it having the same ID.\",\"type\":\"object\"},\"createForEach\":{\"description\":\"Loop over bundle config entities to create other config entities that are coupled to those bundles.\",\"type\":\"object\"},\"createForEachIfNotExists\":{\"description\":\"Extends createForEach, to create only when it doesn't exist.\",\"type\":\"object\"},\"set\":{\"description\":\"Changes a property of a config entity. This is a pretty low-level method and should generally only be used if no dedicated method exists. Works on all config entities.\",\"type\":\"object\",\"properties\":{\"property_name\":{\"description\":\"The property name i.e. label\",\"type\":\"string\"},\"value\":{\"description\":\"The property value i.e. Logged-in user\",\"type\":[\"string\",\"number\",\"boolean\",\"array\"]}},\"required\":[\"property_name\",\"value\"]},\"setMultiple\":{\"type\":\"array\",\"description\":\"The same as set, but accepts multiple property/value pairs.\",\"items\":[{\"$ref\":\"#/$defs/actionsList/generic/set\"}]},\"setThirdPartySetting\":{\"description\":\"Set third-party settings values for any config entity that can carry third-party settings.\",\"type\":\"object\",\"properties\":{\"module\":{\"description\":\"The module name\",\"type\":\"string\"},\"key\":{\"description\":\"The key i.e. enabled\",\"type\":\"string\"},\"value\":{\"description\":\"The property value i.e. true\",\"type\":[\"string\",\"number\",\"boolean\",\"array\"]}},\"required\":[\"module\",\"key\",\"value\"]},\"setThirdPartySettings\":{\"type\":\"array\",\"description\":\"The same as setThirdPartySetting, but accepts multiple property/value pairs.\",\"items\":[{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"}]},\"simpleConfigUpdate\":{\"description\":\"Used to make updates to any configuration value.\",\"type\":\"object\"}},\"specific\":{\"block.block.*\":{\"type\":\"object\",\"properties\":{\"setRegion\":{\"$ref\":\"#/$defs/theme/defaultRegions\",\"description\":\"Sets the region in which a block should be. Which regions are available depends on which theme the block is in. Only works on blocks.\",\"type\":\"string\",\"default\":\"content\"},\"setStatus\":{\"description\":\"Sets status\",\"type\":\"boolean\"},\"setWeight\":{\"description\":\"Sets the weight (position relative to other blocks in the same region of the same theme) of a block. Accepts any number. Works on Blocks.\",\"type\":\"number\"},\"placeBlockInDefaultTheme\":{\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"The block id\",\"type\":\"string\"},\"region\":{\"description\":\"The region accepts an array keyed by theme name.\",\"type\":\"object\",\"default\":{\"bootstrap\":\"footer\",\"olivero\":\"footer_top\"}},\"default_region\":{\"description\":\"A fallback used if no match found in the region array.\",\"type\":\"string\",\"default\":\"content\"},\"position\":{\"description\":\"Place the block before/after any blocks already in the region.\",\"type\":\"string\",\"enum\":[\"first\",\"last\"],\"default\":\"first\"},\"plugin\":{\"description\":\"The plugin id\",\"type\":\"string\",\"default\":\"system_powered_by_block\"}},\"required\":[\"id\",\"region\",\"default_region\",\"position\",\"plugin\"]},\"placeBlockInAdminTheme\":{\"$ref\":\"#/$defs/actionsList/specific/block.block.*/properties/placeBlockInDefaultTheme\"},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"core.entity_form_display.*.*.*\":{\"$comment\":\"\",\"type\":\"object\",\"title\":\"Form/View display\",\"description\":\"\",\"properties\":{\"hideComponent\":{\"type\":\"string\",\"title\":\"Hides a component from an entity view display or entity form display.\",\"description\":\"Value: The component id\",\"default\":\"uid\"},\"hideComponents\":{\"type\":\"array\",\"description\":\"Value: The list of component ids\",\"items\":[{\"type\":\"string\"}]},\"setComponent\":{\"type\":\"object\",\"description\":\"Allows adding a field to an entity's view or form displays.\",\"properties\":{\"name\":{\"description\":\"The field id. i.e. field_tags\",\"type\":\"string\"},\"options\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The field type. i.e. entity_reference_label\",\"type\":\"string\"},\"label\":{\"description\":\"Label position. i.e. above\",\"type\":\"string\",\"enum\":[\"above\",\"below\",\"hidden\",\"inline\"]},\"settings\":{\"type\":\"object\",\"properties\":{\"link\":{\"type\":\"boolean\"}}},\"third_party_settings\":{\"type\":\"object\"},\"weight\":{\"type\":\"number\"},\"region\":{\"$ref\":\"#/$defs/theme/defaultRegions\",\"type\":\"string\"}}}},\"additionalProperties\":false},\"setComponents\":{\"type\":\"array\",\"description\":\"Allows adding adding the configuration for multiple fields.\",\"items\":[{\"$ref\":\"#/$defs/actionsList/specific/core.entity_form_display.*.*.*/properties/setComponent\"}]},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"core.entity_view_display.*.*.*\":{\"$ref\":\"#/$defs/actionsList/specific/core.entity_form_display.*.*.*\"},\"contact.form.*\":{\"type\":\"object\",\"properties\":{\"setMessage\":{\"description\":\"Sets the message that a contact form should display to users when they submit the form. Only works on contact forms.\",\"type\":\"string\",\"default\":\"'Hello world'\"},\"setRecipients\":{\"description\":\"Sets the email addresses that should be notified when a user submits a contact form. Accepts an array of email addresses. Only works on contact forms.\",\"type\":\"array\",\"items\":[{\"type\":\"string\",\"format\":\"email\",\"default\":\"[email protected]\"}]},\"setRedirectPath\":{\"description\":\"Sets the path (URL) where users should be redirected when they submit a contact form. Must start with a slash. Only works on contact forms.\",\"type\":\"string\",\"default\":\"'/thank-you'\"},\"setReply\":{\"description\":\"Sets a message to be emailed to the person who submitted a contact form. Only works on contact forms.\",\"type\":\"string\",\"default\":\"'Thanks for your message.'\"},\"setWeight\":{\"description\":\"Sets the weight (position relative to other blocks in the same region of the same theme) of a block. Accepts any number. Works on Blocks.\",\"type\":\"number\"},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"editor.editor.*\":{\"properties\":{\"addItemToToolbar\":{\"description\":\"Add a new toolbar item.\",\"type\":\"object\",\"properties\":{\"item_name\":{\"description\":\"The toolbar item name\",\"type\":\"string\"},\"position\":{\"description\":\"Specific the position, optionally replacing the item that's already in that position.\",\"type\":\"number\",\"minimum\":0},\"replace\":{\"description\":\"If there's already something at that position, replace it.\",\"type\":\"boolean\"}},\"required\":[\"item_name\"]},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"field.field.*.*.*\":{\"properties\":{\"setDefaultValue\":{\"description\":\"Sets the default value of a field, which can be changed by users when editing content. Exactly what the default value should look like, varies by field type. Works on fields and base field overrides.\",\"type\":\"string\",\"default\":\"''\"},\"setDescription\":{\"description\":\"Changes the user-facing description of a field. Works on fields and base field overrides.\",\"type\":\"string\",\"default\":\"''\"},\"setLabel\":{\"description\":\"Changes the human-readable label of a field. Works on fields and base field overrides.\",\"type\":\"string\",\"default\":\"''\"},\"setRequired\":{\"description\":\"Sets whether users must enter a value for a field. Works on fields and base field overrides.\",\"type\":\"boolean\",\"default\":true},\"setTranslatable\":{\"description\":\"Sets whether a field should be translatable in the UI, or not. Works on fields and base field overrides. (Note that most fields are translatable by default.)\",\"type\":\"boolean\",\"default\":true},\"setSettings\":{\"description\":\"Changes field settings. Exactly which settings are available, and what they mean, varies by the field type. Any preexisting settings are added automatically, with the incoming settings taking precedence. Works on fields and base field overrides.\",\"type\":\"object\",\"properties\":{\"display_summary\":{\"type\":\"boolean\",\"default\":true},\"required_summary\":{\"type\":\"boolean\",\"default\":true}}},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"field.storage.*.*\":{\"properties\":{\"addToAllBundles\":{\"description\":\"If you have a field that you want to add to every content type, but you don't know how many content types there are, or what they're called, there's an addToAllBundles config action that will automatically add a field to every content type.\",\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\",\"default\":\"''\"},\"description\":{\"type\":\"string\",\"default\":\"''\"},\"fail_if_exists\":{\"description\":\"If field_meta_tags already exists on any content type, you'll get an error.\",\"type\":\"boolean\",\"default\":false}}},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"workflows.workflow.*\":{\"type\":\"object\",\"properties\":{\"addNodeTypes\":{\"description\":\"If you have an entity type or entity bundle that you want to add to a content moderation workflow, you can use config actions.\",\"type\":\"array\",\"items\":[{\"description\":\"Opt only certain content types into moderation.\",\"type\":\"string\"}]},\"addTaxonomyVocabularies\":{\"description\":\"Opt every taxonomy vocabulary into moderation.\",\"type\":\"string\",\"default\":\"'*'\"},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false},\"user.role.*\":{\"type\":\"object\",\"properties\":{\"grantPermission\":{\"description\":\"Used to add permissions to user roles.\",\"type\":\"string\",\"default\":\"''\"},\"grantPermissions\":{\"description\":\"Add multiple roles.\",\"type\":\"array\",\"items\":[{\"$ref\":\"#/$defs/actionsList/specific/user.role.*/properties/grantPermission\"}]},\"grantPermissionsForEachNodeType\":{\"description\":\"Grants permissions for every bundle of an entity type.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"grantPermissionsForEachTaxonomyVocabulary\":{\"description\":\"Grants permissions for every taxonomy vocabulary.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"grantPermissionsForEachMediaType\":{\"description\":\"Grants permissions for every media type.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\"},\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\"}},\"additionalProperties\":false}}}},\"type\":\"object\",\"required\":[\"name\",\"description\",\"type\"],\"title\":\"New recipe\",\"additionalProperties\":true,\"properties\":{\"name\":{\"title\":\"User interface name for the recipe\",\"type\":\"string\",\"default\":\"''\"},\"description\":{\"type\":\"string\",\"default\":\"''\"},\"type\":{\"$ref\":\"#/$defs/recipeTypes\",\"title\":\"The type of the recipe. Used for administrative purposes.\",\"type\":\"string\"},\"recipes\":{\"type\":\"array\",\"title\":\"List of recipes that this recipe depends on. Recipes must be installed relative to the Drupal root directory.\",\"items\":{\"type\":\"string\"},\"examples\":[\"core/recipes/remote_video_media_type\",\"starshot_admin_theme\"]},\"install\":{\"title\":\"List of modules to be installed.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"config\":{\"type\":\"object\",\"properties\":{\"import\":{\"title\":\"A list of configurations to be installed.\",\"description\":\"The key is the configuration provider and the value is the list of configuration names.\",\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]}},\"actions\":{\"title\":\"Key/Value\",\"description\":\"The key is the configuration object targeted and the value is the action to be performed. For each action additional properties can be provided.\",\"type\":\"object\",\"patternProperties\":{\"block.block.*\":{\"$ref\":\"#/$defs/actionsList/specific/block.block.*\"},\"core.entity_form_display.*.*.*\":{\"$ref\":\"#/$defs/actionsList/specific/core.entity_form_display.*.*.*\"},\"core.entity_view_display.*.*.*\":{\"$ref\":\"#/$defs/actionsList/specific/core.entity_view_display.*.*.*\"},\"contact.form.*\":{\"$ref\":\"#/$defs/actionsList/specific/contact.form.*\"},\"editor.editor.*\":{\"$ref\":\"#/$defs/actionsList/specific/editor.editor.*\"},\"field.field.*.*.*\":{\"$ref\":\"#/$defs/actionsList/specific/field.field.*.*.*\"},\"field.storage.*.*\":{\"$ref\":\"#/$defs/actionsList/specific/field.storage.*.*\"},\"workflows.workflow.*\":{\"$ref\":\"#/$defs/actionsList/specific/workflows.workflow.*\"},\"user.role.*\":{\"$ref\":\"#/$defs/actionsList/specific/user.role.*\"}},\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"set\":{\"$ref\":\"#/$defs/actionsList/generic/set\",\"type\":\"object\"},\"setMultiple\":{\"$ref\":\"#/$defs/actionsList/generic/setMultiple\",\"type\":\"array\"},\"cloneAs\":{\"$ref\":\"#/$defs/actionsList/generic/cloneAs\",\"type\":\"string\"},\"create\":{\"$ref\":\"#/$defs/actionsList/generic/create\",\"type\":\"object\"},\"createIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createIfNotExists\",\"type\":\"object\"},\"createForEach\":{\"$ref\":\"#/$defs/actionsList/generic/createForEach\",\"type\":\"object\"},\"createForEachIfNotExists\":{\"$ref\":\"#/$defs/actionsList/generic/createForEachIfNotExists\",\"type\":\"object\"},\"setThirdPartySetting\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySetting\",\"type\":\"object\"},\"setThirdPartySettings\":{\"$ref\":\"#/$defs/actionsList/generic/setThirdPartySettings\",\"type\":\"array\"},\"simpleConfigUpdate\":{\"$ref\":\"#/$defs/actionsList/generic/simpleConfigUpdate\",\"type\":\"object\"}}}}}},\"content\":{\"title\":\"List of content to be created.\",\"description\":\"The contents are stored in a directory relative to the recipe file.\",\"type\":\"array\",\"items\":[{\"type\":\"string\"}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"New recipe\". Here are the required top‑level fields: name, description, type. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-recipe.json","$defs":{"theme":{"defaultRegions":{"enum":["sidebar_first","sidebar_second","content","header","primary_menu","secondary_menu","footer","highlighted","help","page_top","page_bottom","breadcrumb"]}},"recipeTypes":{"type":"string","enum":["Administration","Block type","Comment type","Contact form","Content field","Content type","Editor","Maintenance","Media type","Performance","Responsive image","Search","Site","Taxonomy","Text format","Text format editor","Theme","User role","User type","Users","Workflow"]},"actionsList":{"generic":{"cloneAs":{"description":"Creates a clone of any config entity with a new ID.","type":"string"},"create":{"description":"Creates a config entity.","type":"object"},"createIfNotExists":{"description":"Creates a config entity if it does not exist. Existence is determined by it having the same ID.","type":"object"},"createForEach":{"description":"Loop over bundle config entities to create other config entities that are coupled to those bundles.","type":"object"},"createForEachIfNotExists":{"description":"Extends createForEach, to create only when it doesn't exist.","type":"object"},"set":{"description":"Changes a property of a config entity. This is a pretty low-level method and should generally only be used if no dedicated method exists. Works on all config entities.","type":"object","properties":{"property_name":{"description":"The property name i.e. label","type":"string"},"value":{"description":"The property value i.e. Logged-in user","type":["string","number","boolean","array"]}},"required":["property_name","value"]},"setMultiple":{"type":"array","description":"The same as set, but accepts multiple property/value pairs.","items":[{"$ref":"#/$defs/actionsList/generic/set"}]},"setThirdPartySetting":{"description":"Set third-party settings values for any config entity that can carry third-party settings.","type":"object","properties":{"module":{"description":"The module name","type":"string"},"key":{"description":"The key i.e. enabled","type":"string"},"value":{"description":"The property value i.e. true","type":["string","number","boolean","array"]}},"required":["module","key","value"]},"setThirdPartySettings":{"type":"array","description":"The same as setThirdPartySetting, but accepts multiple property/value pairs.","items":[{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"}]},"simpleConfigUpdate":{"description":"Used to make updates to any configuration value.","type":"object"}},"specific":{"block.block.*":{"type":"object","properties":{"setRegion":{"$ref":"#/$defs/theme/defaultRegions","description":"Sets the region in which a block should be. Which regions are available depends on which theme the block is in. Only works on blocks.","type":"string","default":"content"},"setStatus":{"description":"Sets status","type":"boolean"},"setWeight":{"description":"Sets the weight (position relative to other blocks in the same region of the same theme) of a block. Accepts any number. Works on Blocks.","type":"number"},"placeBlockInDefaultTheme":{"type":"object","properties":{"id":{"description":"The block id","type":"string"},"region":{"description":"The region accepts an array keyed by theme name.","type":"object","default":{"bootstrap":"footer","olivero":"footer_top"}},"default_region":{"description":"A fallback used if no match found in the region array.","type":"string","default":"content"},"position":{"description":"Place the block before/after any blocks already in the region.","type":"string","enum":["first","last"],"default":"first"},"plugin":{"description":"The plugin id","type":"string","default":"system_powered_by_block"}},"required":["id","region","default_region","position","plugin"]},"placeBlockInAdminTheme":{"$ref":"#/$defs/actionsList/specific/block.block.*/properties/placeBlockInDefaultTheme"},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"core.entity_form_display.*.*.*":{"$comment":"","type":"object","title":"Form/View display","description":"","properties":{"hideComponent":{"type":"string","title":"Hides a component from an entity view display or entity form display.","description":"Value: The component id","default":"uid"},"hideComponents":{"type":"array","description":"Value: The list of component ids","items":[{"type":"string"}]},"setComponent":{"type":"object","description":"Allows adding a field to an entity's view or form displays.","properties":{"name":{"description":"The field id. i.e. field_tags","type":"string"},"options":{"type":"object","properties":{"type":{"description":"The field type. i.e. entity_reference_label","type":"string"},"label":{"description":"Label position. i.e. above","type":"string","enum":["above","below","hidden","inline"]},"settings":{"type":"object","properties":{"link":{"type":"boolean"}}},"third_party_settings":{"type":"object"},"weight":{"type":"number"},"region":{"$ref":"#/$defs/theme/defaultRegions","type":"string"}}}},"additionalProperties":false},"setComponents":{"type":"array","description":"Allows adding adding the configuration for multiple fields.","items":[{"$ref":"#/$defs/actionsList/specific/core.entity_form_display.*.*.*/properties/setComponent"}]},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"core.entity_view_display.*.*.*":{"$ref":"#/$defs/actionsList/specific/core.entity_form_display.*.*.*"},"contact.form.*":{"type":"object","properties":{"setMessage":{"description":"Sets the message that a contact form should display to users when they submit the form. Only works on contact forms.","type":"string","default":"'Hello world'"},"setRecipients":{"description":"Sets the email addresses that should be notified when a user submits a contact form. Accepts an array of email addresses. Only works on contact forms.","type":"array","items":[{"type":"string","format":"email","default":"[email protected]"}]},"setRedirectPath":{"description":"Sets the path (URL) where users should be redirected when they submit a contact form. Must start with a slash. Only works on contact forms.","type":"string","default":"'/thank-you'"},"setReply":{"description":"Sets a message to be emailed to the person who submitted a contact form. Only works on contact forms.","type":"string","default":"'Thanks for your message.'"},"setWeight":{"description":"Sets the weight (position relative to other blocks in the same region of the same theme) of a block. Accepts any number. Works on Blocks.","type":"number"},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"editor.editor.*":{"properties":{"addItemToToolbar":{"description":"Add a new toolbar item.","type":"object","properties":{"item_name":{"description":"The toolbar item name","type":"string"},"position":{"description":"Specific the position, optionally replacing the item that's already in that position.","type":"number","minimum":0},"replace":{"description":"If there's already something at that position, replace it.","type":"boolean"}},"required":["item_name"]},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"field.field.*.*.*":{"properties":{"setDefaultValue":{"description":"Sets the default value of a field, which can be changed by users when editing content. Exactly what the default value should look like, varies by field type. Works on fields and base field overrides.","type":"string","default":"''"},"setDescription":{"description":"Changes the user-facing description of a field. Works on fields and base field overrides.","type":"string","default":"''"},"setLabel":{"description":"Changes the human-readable label of a field. Works on fields and base field overrides.","type":"string","default":"''"},"setRequired":{"description":"Sets whether users must enter a value for a field. Works on fields and base field overrides.","type":"boolean","default":true},"setTranslatable":{"description":"Sets whether a field should be translatable in the UI, or not. Works on fields and base field overrides. (Note that most fields are translatable by default.)","type":"boolean","default":true},"setSettings":{"description":"Changes field settings. Exactly which settings are available, and what they mean, varies by the field type. Any preexisting settings are added automatically, with the incoming settings taking precedence. Works on fields and base field overrides.","type":"object","properties":{"display_summary":{"type":"boolean","default":true},"required_summary":{"type":"boolean","default":true}}},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"field.storage.*.*":{"properties":{"addToAllBundles":{"description":"If you have a field that you want to add to every content type, but you don't know how many content types there are, or what they're called, there's an addToAllBundles config action that will automatically add a field to every content type.","type":"object","properties":{"label":{"type":"string","default":"''"},"description":{"type":"string","default":"''"},"fail_if_exists":{"description":"If field_meta_tags already exists on any content type, you'll get an error.","type":"boolean","default":false}}},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"workflows.workflow.*":{"type":"object","properties":{"addNodeTypes":{"description":"If you have an entity type or entity bundle that you want to add to a content moderation workflow, you can use config actions.","type":"array","items":[{"description":"Opt only certain content types into moderation.","type":"string"}]},"addTaxonomyVocabularies":{"description":"Opt every taxonomy vocabulary into moderation.","type":"string","default":"'*'"},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false},"user.role.*":{"type":"object","properties":{"grantPermission":{"description":"Used to add permissions to user roles.","type":"string","default":"''"},"grantPermissions":{"description":"Add multiple roles.","type":"array","items":[{"$ref":"#/$defs/actionsList/specific/user.role.*/properties/grantPermission"}]},"grantPermissionsForEachNodeType":{"description":"Grants permissions for every bundle of an entity type.","type":"array","items":{"type":"string"}},"grantPermissionsForEachTaxonomyVocabulary":{"description":"Grants permissions for every taxonomy vocabulary.","type":"array","items":{"type":"string"}},"grantPermissionsForEachMediaType":{"description":"Grants permissions for every media type.","type":"array","items":{"type":"string"}},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs"},"create":{"$ref":"#/$defs/actionsList/generic/create"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists"},"set":{"$ref":"#/$defs/actionsList/generic/set"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate"}},"additionalProperties":false}}}},"type":"object","required":["name","description","type"],"title":"New recipe","additionalProperties":true,"properties":{"name":{"title":"User interface name for the recipe","type":"string","default":"''"},"description":{"type":"string","default":"''"},"type":{"$ref":"#/$defs/recipeTypes","title":"The type of the recipe. Used for administrative purposes.","type":"string"},"recipes":{"type":"array","title":"List of recipes that this recipe depends on. Recipes must be installed relative to the Drupal root directory.","items":{"type":"string"},"examples":["core/recipes/remote_video_media_type","starshot_admin_theme"]},"install":{"title":"List of modules to be installed.","type":"array","items":{"type":"string"}},"config":{"type":"object","properties":{"import":{"title":"A list of configurations to be installed.","description":"The key is the configuration provider and the value is the list of configuration names.","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"actions":{"title":"Key/Value","description":"The key is the configuration object targeted and the value is the action to be performed. For each action additional properties can be provided.","type":"object","patternProperties":{"block.block.*":{"$ref":"#/$defs/actionsList/specific/block.block.*"},"core.entity_form_display.*.*.*":{"$ref":"#/$defs/actionsList/specific/core.entity_form_display.*.*.*"},"core.entity_view_display.*.*.*":{"$ref":"#/$defs/actionsList/specific/core.entity_view_display.*.*.*"},"contact.form.*":{"$ref":"#/$defs/actionsList/specific/contact.form.*"},"editor.editor.*":{"$ref":"#/$defs/actionsList/specific/editor.editor.*"},"field.field.*.*.*":{"$ref":"#/$defs/actionsList/specific/field.field.*.*.*"},"field.storage.*.*":{"$ref":"#/$defs/actionsList/specific/field.storage.*.*"},"workflows.workflow.*":{"$ref":"#/$defs/actionsList/specific/workflows.workflow.*"},"user.role.*":{"$ref":"#/$defs/actionsList/specific/user.role.*"}},"additionalProperties":{"type":"object","properties":{"set":{"$ref":"#/$defs/actionsList/generic/set","type":"object"},"setMultiple":{"$ref":"#/$defs/actionsList/generic/setMultiple","type":"array"},"cloneAs":{"$ref":"#/$defs/actionsList/generic/cloneAs","type":"string"},"create":{"$ref":"#/$defs/actionsList/generic/create","type":"object"},"createIfNotExists":{"$ref":"#/$defs/actionsList/generic/createIfNotExists","type":"object"},"createForEach":{"$ref":"#/$defs/actionsList/generic/createForEach","type":"object"},"createForEachIfNotExists":{"$ref":"#/$defs/actionsList/generic/createForEachIfNotExists","type":"object"},"setThirdPartySetting":{"$ref":"#/$defs/actionsList/generic/setThirdPartySetting","type":"object"},"setThirdPartySettings":{"$ref":"#/$defs/actionsList/generic/setThirdPartySettings","type":"array"},"simpleConfigUpdate":{"$ref":"#/$defs/actionsList/generic/simpleConfigUpdate","type":"object"}}}}}},"content":{"title":"List of content to be created.","description":"The contents are stored in a directory relative to the recipe file.","type":"array","items":[{"type":"string"}]}}}
|
Provide a JSON object that satisfies the schema "New recipe". Here are the required top‑level fields: name, description, type. Return only the valid JSON object.
|
New recipe
|
schema-store
|
schema_store_286
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-routing.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"path\":{\"title\":\"Route path\",\"type\":\"string\"},\"defaults\":{\"title\":\"Default route parameters\",\"type\":\"object\",\"properties\":{\"_controller\":{\"title\":\"A controller to execute when the route is matched\",\"type\":\"string\"},\"_form\":{\"type\":\"string\"},\"_title\":{\"type\":\"string\"},\"_title_callback\":{\"type\":\"string\"},\"_access\":{\"type\":\"string\"},\"_entity_list\":{\"type\":\"string\"},\"_entity_form\":{\"type\":\"string\"},\"_entity_view\":{\"type\":\"string\"}}},\"requirements\":{\"title\":\"List of requirements that makes a specific route only match under specific conditions\",\"type\":\"object\",\"properties\":{\"_access\":{\"type\":\"string\"},\"_custom_access\":{\"type\":\"string\"},\"_format\":{\"type\":\"string\"},\"_entity_access\":{\"type\":\"string\"},\"_entity_create_access\":{\"type\":\"string\"},\"_entity_delete_multiple_access\":{\"type\":\"string\"},\"_module_dependencies\":{\"type\":\"string\"},\"_csrf_token\":{\"type\":\"string\"},\"_user_is_logged_in\":{\"type\":\"string\"},\"_access_theme\":{\"type\":\"string\"},\"_permission\":{\"type\":\"string\"}}},\"methods\":{\"title\":\"Method of the incoming request to match the route\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"GET\",\"POST\",\"PATCH\",\"PUT\",\"DELETE\"]},\"uniqueItems\":true},\"options\":{\"title\":\"Additional route options\",\"type\":\"object\",\"properties\":{\"no_cache\":{\"type\":\"boolean\"},\"_admin_route\":{\"type\":\"boolean\"},\"_no_path\":{\"type\":\"boolean\"},\"_maintenance_access\":{\"type\":\"boolean\"},\"_node_operation_route\":{\"type\":\"boolean\"},\"parameters\":{\"type\":\"object\"},\"_auth\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}}}},\"additionalProperties\":false},\"properties\":{\"route_callbacks\":{\"title\":\"List of callbacks to provide routes\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}},\"title\":\"JSON schema for Drupal routing file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal routing file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-routing.json","additionalProperties":{"type":"object","properties":{"path":{"title":"Route path","type":"string"},"defaults":{"title":"Default route parameters","type":"object","properties":{"_controller":{"title":"A controller to execute when the route is matched","type":"string"},"_form":{"type":"string"},"_title":{"type":"string"},"_title_callback":{"type":"string"},"_access":{"type":"string"},"_entity_list":{"type":"string"},"_entity_form":{"type":"string"},"_entity_view":{"type":"string"}}},"requirements":{"title":"List of requirements that makes a specific route only match under specific conditions","type":"object","properties":{"_access":{"type":"string"},"_custom_access":{"type":"string"},"_format":{"type":"string"},"_entity_access":{"type":"string"},"_entity_create_access":{"type":"string"},"_entity_delete_multiple_access":{"type":"string"},"_module_dependencies":{"type":"string"},"_csrf_token":{"type":"string"},"_user_is_logged_in":{"type":"string"},"_access_theme":{"type":"string"},"_permission":{"type":"string"}}},"methods":{"title":"Method of the incoming request to match the route","type":"array","items":{"type":"string","enum":["GET","POST","PATCH","PUT","DELETE"]},"uniqueItems":true},"options":{"title":"Additional route options","type":"object","properties":{"no_cache":{"type":"boolean"},"_admin_route":{"type":"boolean"},"_no_path":{"type":"boolean"},"_maintenance_access":{"type":"boolean"},"_node_operation_route":{"type":"boolean"},"parameters":{"type":"object"},"_auth":{"type":"array","items":{"type":"string"},"uniqueItems":true}}}},"additionalProperties":false},"properties":{"route_callbacks":{"title":"List of callbacks to provide routes","type":"array","items":{"type":"string"},"uniqueItems":true}},"title":"JSON schema for Drupal routing file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal routing file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal routing file
|
schema-store
|
schema_store_287
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drupal-services.json\",\"additionalProperties\":false,\"properties\":{\"parameters\":{\"title\":\"Service parameters\",\"type\":\"object\"},\"services\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"class\":{\"title\":\"Service class\",\"type\":\"string\"},\"parent\":{\"title\":\"Parent service to extend\",\"type\":\"string\"},\"factory\":{\"title\":\"A factory to create the object\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\"}]},\"decorates\":{\"title\":\"Service name to decorate\",\"type\":\"string\"},\"deprecated\":{\"title\":\"A flag indicating that the service is deprecated\",\"type\":\"string\"},\"lazy\":{\"title\":\"Lazy service instantiation\",\"type\":\"boolean\"},\"shared\":{\"title\":\"Shared service\",\"type\":\"boolean\"},\"abstract\":{\"title\":\"Abstract service\",\"type\":\"boolean\"},\"public\":{\"title\":\"A flag indication that the service cannot be accessed directly from the container object\",\"type\":\"boolean\"},\"alias\":{\"title\":\"A shortcut to access some services\",\"type\":\"string\"},\"arguments\":{\"title\":\"Service arguments\",\"type\":\"array\",\"uniqueItems\":true},\"configurator\":{\"title\":\"A callable to configure a service after its instantiation\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"tags\":{\"title\":\"List of tags tell Drupal that your service can be processed in some special way\",\"examples\":[\"event_subscriber\",\"service_collector\",\"theme_negotiator\",\"twig.extension\",\"access_check\"],\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"call\":{\"type\":\"string\"},\"alias\":{\"type\":\"string\"},\"required\":{\"type\":\"boolean\"},\"tag\":{\"type\":\"string\"},\"priority\":{\"type\":\"integer\"},\"default_backend\":{\"type\":\"string\"},\"responder\":{\"type\":\"boolean\"},\"format\":{\"type\":\"string\"},\"applies_to\":{\"type\":\"string\"},\"provider_id\":{\"type\":\"string\"},\"needs_incoming_request\":{\"type\":\"boolean\"},\"scheme\":{\"type\":\"string\"}}}},\"calls\":{\"title\":\"Methods to set optional dependencies\",\"type\":\"array\",\"uniqueItems\":true}}}}},\"title\":\"JSON schema for Drupal services file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Drupal services file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drupal-services.json","additionalProperties":false,"properties":{"parameters":{"title":"Service parameters","type":"object"},"services":{"type":"object","additionalProperties":{"type":"object","properties":{"class":{"title":"Service class","type":"string"},"parent":{"title":"Parent service to extend","type":"string"},"factory":{"title":"A factory to create the object","oneOf":[{"type":"string"},{"type":"array"}]},"decorates":{"title":"Service name to decorate","type":"string"},"deprecated":{"title":"A flag indicating that the service is deprecated","type":"string"},"lazy":{"title":"Lazy service instantiation","type":"boolean"},"shared":{"title":"Shared service","type":"boolean"},"abstract":{"title":"Abstract service","type":"boolean"},"public":{"title":"A flag indication that the service cannot be accessed directly from the container object","type":"boolean"},"alias":{"title":"A shortcut to access some services","type":"string"},"arguments":{"title":"Service arguments","type":"array","uniqueItems":true},"configurator":{"title":"A callable to configure a service after its instantiation","type":"array","items":{"type":"string"}},"tags":{"title":"List of tags tell Drupal that your service can be processed in some special way","examples":["event_subscriber","service_collector","theme_negotiator","twig.extension","access_check"],"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"call":{"type":"string"},"alias":{"type":"string"},"required":{"type":"boolean"},"tag":{"type":"string"},"priority":{"type":"integer"},"default_backend":{"type":"string"},"responder":{"type":"boolean"},"format":{"type":"string"},"applies_to":{"type":"string"},"provider_id":{"type":"string"},"needs_incoming_request":{"type":"boolean"},"scheme":{"type":"string"}}}},"calls":{"title":"Methods to set optional dependencies","type":"array","uniqueItems":true}}}}},"title":"JSON schema for Drupal services file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Drupal services file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Drupal services file
|
schema-store
|
schema_store_288
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/drush.site.yml.json\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"root\":{\"title\":\"The Drupal root for this site\",\"default\":\"/path/to/drupal/root\",\"type\":\"string\"},\"host\":{\"title\":\"The fully-qualified domain name of the remote system hosting the Drupal instance\",\"default\":\"my-server.com\",\"type\":\"string\"},\"uri\":{\"title\":\"Site URI\",\"description\":\"The value of uri should always be the same as when the site is being accessed from a web browser\",\"default\":\"https://example.com\",\"type\":\"string\"},\"user\":{\"title\":\"The username to log in as when using ssh or rsync\",\"type\":\"string\"},\"os\":{\"title\":\"The operating system of the remote server\",\"type\":\"string\",\"enum\":[\"Windows\",\"Linux\"]},\"ssh\":{\"title\":\"Contains settings used to control how ssh commands are generated when running remote commands\",\"type\":\"object\",\"properties\":{\"options\":{\"title\":\"Additional commandline options for the ssh command itself\",\"type\":\"string\"},\"tty\":{\"title\":\"A flag to force Drush to always or never create a tty\",\"type\":\"boolean\"}}},\"paths\":{\"title\":\"Aliases for common rsync targets\",\"type\":\"object\",\"properties\":{\"drush-script\":{\"title\":\"Path to the remote Drush command\",\"default\":\"/path/to/drush\",\"type\":\"string\"},\"alias-path\":{\"title\":\"A list of paths where Drush will search for alias files\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"files\":{\"titles\":\"Path to 'files' directory\",\"type\":\"string\"}},\"additionalProperties\":{\"type\":\"string\"}},\"command\":{\"title\":\"Contains options for specific commands\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}},\"docker\":{\"type\":\"object\",\"properties\":{\"service\":{\"title\":\"The name of the container to run on\",\"type\":\"string\"},\"exec\":{\"type\":\"object\",\"options\":{\"title\":\"Options for exec command\",\"type\":\"string\"}}}},\"vagrant\":{\"title\":\"Vagrant transport\",\"type\":\"null\"}}},\"title\":\"JSON Schema for Drush site aliases\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Drush site aliases\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/drush.site.yml.json","additionalProperties":{"type":"object","properties":{"root":{"title":"The Drupal root for this site","default":"/path/to/drupal/root","type":"string"},"host":{"title":"The fully-qualified domain name of the remote system hosting the Drupal instance","default":"my-server.com","type":"string"},"uri":{"title":"Site URI","description":"The value of uri should always be the same as when the site is being accessed from a web browser","default":"https://example.com","type":"string"},"user":{"title":"The username to log in as when using ssh or rsync","type":"string"},"os":{"title":"The operating system of the remote server","type":"string","enum":["Windows","Linux"]},"ssh":{"title":"Contains settings used to control how ssh commands are generated when running remote commands","type":"object","properties":{"options":{"title":"Additional commandline options for the ssh command itself","type":"string"},"tty":{"title":"A flag to force Drush to always or never create a tty","type":"boolean"}}},"paths":{"title":"Aliases for common rsync targets","type":"object","properties":{"drush-script":{"title":"Path to the remote Drush command","default":"/path/to/drush","type":"string"},"alias-path":{"title":"A list of paths where Drush will search for alias files","type":"array","items":{"type":"string"}},"files":{"titles":"Path to 'files' directory","type":"string"}},"additionalProperties":{"type":"string"}},"command":{"title":"Contains options for specific commands","type":"object","additionalProperties":{"type":"object"}},"docker":{"type":"object","properties":{"service":{"title":"The name of the container to run on","type":"string"},"exec":{"type":"object","options":{"title":"Options for exec command","type":"string"}}}},"vagrant":{"title":"Vagrant transport","type":"null"}}},"title":"JSON Schema for Drush site aliases","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON Schema for Drush site aliases". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Drush site aliases
|
schema-store
|
schema_store_289
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"dss2-SignRequestType\":{\"$xsd-full-type\":\"dss2:SignRequestType\",\"$xsd-type\":\"SignRequestType\",\"type\":\"object\",\"properties\":{\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"inDocs\":{\"$ref\":\"#/definitions/dss2-InputDocumentsType\"},\"optInp\":{\"$ref\":\"#/definitions/dss2-OptionalInputsSignType\"}}},\"dss2-InputDocumentsType\":{\"$xsd-full-type\":\"dss2:InputDocumentsType\",\"$xsd-type\":\"InputDocumentsType\",\"type\":\"object\",\"properties\":{\"doc\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}},\"transformed\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-TransformedDataType\"}},\"docHash\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentHashType\"}}}},\"dss2-DocumentType\":{\"$xsd-full-type\":\"dss2:DocumentType\",\"$xsd-type\":\"DocumentType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"refURI\":{\"type\":\"string\"},\"refType\":{\"type\":\"string\"},\"schemaRefs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}},\"b64Data\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"}},\"required\":[\"b64Data\"]},\"dsb-Base64DataType\":{\"$xsd-full-type\":\"dsb:Base64DataType\",\"$xsd-type\":\"Base64DataType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"val\":{\"type\":\"string\"},\"attRef\":{\"$ref\":\"#/definitions/dsb-AttachmentReferenceType\"},\"mimeType\":{\"type\":\"string\"},\"idRef\":{\"type\":\"string\"}},\"minProperties\":0},\"dsb-AttachmentReferenceType\":{\"$xsd-full-type\":\"dsb:AttachmentReferenceType\",\"$xsd-type\":\"AttachmentReferenceType\",\"type\":\"object\",\"properties\":{\"di\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-DigestInfoType\"}},\"attURI\":{\"type\":\"string\"}},\"required\":[\"attURI\"]},\"dsb-DigestInfoType\":{\"$xsd-full-type\":\"dsb:DigestInfoType\",\"$xsd-type\":\"DigestInfoType\",\"type\":\"object\",\"properties\":{\"alg\":{\"type\":\"string\"},\"val\":{\"type\":\"string\"}},\"required\":[\"alg\",\"val\"]},\"dss2-TransformedDataType\":{\"$xsd-full-type\":\"dss2:TransformedDataType\",\"$xsd-type\":\"TransformedDataType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"refURI\":{\"type\":\"string\"},\"refType\":{\"type\":\"string\"},\"schemaRefs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}},\"transforms\":{\"$ref\":\"#/definitions/dsigrw-TransformsType\"},\"b64Data\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"whichRef\":{\"type\":\"integer\"}},\"required\":[\"b64Data\"]},\"dsigrw-TransformsType\":{\"$xsd-full-type\":\"ds-rw:TransformsType\",\"$xsd-type\":\"TransformsType\",\"type\":\"object\",\"properties\":{\"transform\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsigrw-TransformType\"}}},\"required\":[\"transform\"]},\"dsigrw-TransformType\":{\"$xsd-full-type\":\"ds-rw:TransformType\",\"$xsd-type\":\"TransformType\",\"type\":\"object\",\"properties\":{\"xpath\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"val\":{\"type\":\"string\"},\"b64Content\":{\"type\":\"string\"},\"xPath\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"nsDecl\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-NsPrefixMappingType\"}},\"alg\":{\"type\":\"string\"}},\"required\":[\"alg\"]},\"dsb-NsPrefixMappingType\":{\"$xsd-full-type\":\"dsb:NsPrefixMappingType\",\"$xsd-type\":\"NsPrefixMappingType\",\"type\":\"object\",\"properties\":{\"uri\":{\"type\":\"string\"},\"pre\":{\"type\":\"string\"}},\"required\":[\"uri\",\"pre\"]},\"dss2-DocumentHashType\":{\"$xsd-full-type\":\"dss2:DocumentHashType\",\"$xsd-type\":\"DocumentHashType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"refURI\":{\"type\":\"string\"},\"refType\":{\"type\":\"string\"},\"schemaRefs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}},\"transforms\":{\"$ref\":\"#/definitions/dsigrw-TransformsType\"},\"dis\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-DigestInfoType\"}},\"whichRef\":{\"type\":\"integer\"}},\"required\":[\"dis\"]},\"dss2-OptionalInputsSignType\":{\"$xsd-full-type\":\"dss2:OptionalInputsSignType\",\"$xsd-type\":\"OptionalInputsSignType\",\"type\":\"object\",\"properties\":{\"policy\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lang\":{\"type\":\"string\"},\"other\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"claimedIdentity\":{\"$ref\":\"#/definitions/dss2-ClaimedIdentityType\"},\"schemas\":{\"$ref\":\"#/definitions/dss2-SchemasType\"},\"addTimestamp\":{\"$ref\":\"#/definitions/dss2-AugmentSignatureInstructionType\"},\"sigType\":{\"type\":\"string\"},\"aud\":{\"$ref\":\"#/definitions/dss2-IntendedAudienceType\"},\"keySel\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-KeySelectorType\"}},\"props\":{\"$ref\":\"#/definitions/dss2-PropertiesHolderType\"},\"incObj\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-IncludeObjectType\"}},\"incContent\":{\"type\":\"boolean\",\"default\":\"false\"},\"sigPlacement\":{\"$ref\":\"#/definitions/dss2-SignaturePlacementType\"},\"signedRefs\":{\"$ref\":\"#/definitions/dss2-SignedReferencesType\"},\"nonce\":{\"type\":\"integer\"},\"sigAlgo\":{\"type\":\"string\"},\"quality\":{\"type\":\"string\"}}},\"dsb-AnyType\":{\"$xsd-full-type\":\"dsb:AnyType\",\"$xsd-type\":\"AnyType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"val\":{\"type\":\"string\"},\"attRef\":{\"$ref\":\"#/definitions/dsb-AttachmentReferenceType\"},\"mimeType\":{\"type\":\"string\"},\"idRef\":{\"type\":\"string\"}}},\"dss2-ClaimedIdentityType\":{\"$xsd-full-type\":\"dss2:ClaimedIdentityType\",\"$xsd-type\":\"ClaimedIdentityType\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/saml2rw-NameIDType\"},\"suppInfo\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"required\":[\"name\"]},\"saml2rw-NameIDType\":{\"$xsd-full-type\":\"saml2-rw:NameIDType\",\"$xsd-type\":\"NameIDType\",\"type\":\"object\",\"properties\":{\"spprovidedID\":{\"type\":\"string\"},\"spnameQualifier\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"},\"format\":{\"type\":\"string\"},\"provId\":{\"type\":\"string\"},\"nameQual\":{\"type\":\"string\"},\"spNameQual\":{\"type\":\"string\"}}},\"dss2-SchemasType\":{\"$xsd-full-type\":\"dss2:SchemasType\",\"$xsd-type\":\"SchemasType\",\"type\":\"object\",\"properties\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}}},\"required\":[\"schema\"]},\"dss2-AugmentSignatureInstructionType\":{\"$xsd-full-type\":\"dss2:AugmentSignatureInstructionType\",\"$xsd-type\":\"AugmentSignatureInstructionType\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"format\":\"uri\"}}},\"dss2-IntendedAudienceType\":{\"$xsd-full-type\":\"dss2:IntendedAudienceType\",\"$xsd-type\":\"IntendedAudienceType\",\"type\":\"object\",\"properties\":{\"recipient\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/saml2rw-NameIDType\"}}},\"required\":[\"recipient\"]},\"dss2-KeySelectorType\":{\"$xsd-full-type\":\"dss2:KeySelectorType\",\"$xsd-type\":\"KeySelectorType\",\"type\":\"object\",\"properties\":{\"x509Digest\":{\"$ref\":\"#/definitions/dss2-X509DigestType\"},\"sub\":{\"type\":\"string\"},\"ski\":{\"type\":\"string\"},\"cert\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}},\"minProperties\":1,\"maxProperties\":1},\"dss2-X509DigestType\":{\"$xsd-full-type\":\"dss2:X509DigestType\",\"$xsd-type\":\"X509DigestType\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"string\"},\"alg\":{\"type\":\"string\"}},\"required\":[\"alg\"]},\"dss2-PropertiesHolderType\":{\"$xsd-full-type\":\"dss2:PropertiesHolderType\",\"$xsd-type\":\"PropertiesHolderType\",\"type\":\"object\",\"properties\":{\"signedProps\":{\"$ref\":\"#/definitions/dss2-PropertiesType\"},\"unsignedProps\":{\"$ref\":\"#/definitions/dss2-PropertiesType\"}}},\"dss2-PropertiesType\":{\"$xsd-full-type\":\"dss2:PropertiesType\",\"$xsd-type\":\"PropertiesType\",\"type\":\"object\",\"properties\":{\"prop\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-PropertyType\"}}},\"required\":[\"prop\"]},\"dss2-PropertyType\":{\"$xsd-full-type\":\"dss2:PropertyType\",\"$xsd-type\":\"PropertyType\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"val\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"required\":[\"id\"]},\"dss2-IncludeObjectType\":{\"$xsd-full-type\":\"dss2:IncludeObjectType\",\"$xsd-type\":\"IncludeObjectType\",\"type\":\"object\",\"properties\":{\"whichDoc\":{\"$ref\":\"#/definitions/dss2-DocumentBaseType\"},\"hasObjectTagsAndAttributesSet\":{\"type\":\"boolean\",\"default\":\"false\"},\"objId\":{\"type\":\"string\"},\"createRef\":{\"type\":\"boolean\",\"default\":\"true\"}}},\"dss2-DocumentBaseType\":{\"$xsd-full-type\":\"dss2:DocumentBaseType\",\"$xsd-type\":\"DocumentBaseType\",\"type\":\"object\",\"properties\":{\"ID\":{\"type\":\"string\"},\"refURI\":{\"type\":\"string\"},\"refType\":{\"type\":\"string\"},\"schemaRefs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}}}},\"dss2-SignaturePlacementType\":{\"$xsd-full-type\":\"dss2:SignaturePlacementType\",\"$xsd-type\":\"SignaturePlacementType\",\"type\":\"object\",\"properties\":{\"xpathAfter\":{\"type\":\"string\"},\"xpathFirstChildOf\":{\"type\":\"string\"},\"xPathAfter\":{\"type\":\"string\"},\"xPathFirstChildOf\":{\"type\":\"string\"},\"nsDecl\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-NsPrefixMappingType\"}},\"whichDoc\":{\"$ref\":\"#/definitions/dss2-DocumentBaseType\"},\"createEnvelopedSignature\":{\"type\":\"boolean\",\"default\":\"true\"}}},\"dss2-SignedReferencesType\":{\"$xsd-full-type\":\"dss2:SignedReferencesType\",\"$xsd-type\":\"SignedReferencesType\",\"type\":\"object\",\"properties\":{\"signedRef\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-SignedReferenceType\"}}},\"required\":[\"signedRef\"]},\"dss2-SignedReferenceType\":{\"$xsd-full-type\":\"dss2:SignedReferenceType\",\"$xsd-type\":\"SignedReferenceType\",\"type\":\"object\",\"properties\":{\"transforms\":{\"$ref\":\"#/definitions/dsigrw-TransformsType\"},\"whichDoc\":{\"$ref\":\"#/definitions/dss2-DocumentBaseType\"},\"refURI\":{\"type\":\"string\"},\"refId\":{\"type\":\"string\"}},\"required\":[\"whichDoc\"]},\"dss2-SignResponseType\":{\"$xsd-full-type\":\"dss2:SignResponseType\",\"$xsd-type\":\"SignResponseType\",\"type\":\"object\",\"properties\":{\"result\":{\"$ref\":\"#/definitions/dsb-ResultType\"},\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"respID\":{\"type\":\"string\"},\"optOutp\":{\"$ref\":\"#/definitions/dss2-OptionalOutputsSignType\"},\"sigObj\":{\"$ref\":\"#/definitions/dss2-SignatureObjectType\"}}},\"dsb-ResultType\":{\"$xsd-full-type\":\"dsb:ResultType\",\"$xsd-type\":\"ResultType\",\"type\":\"object\",\"properties\":{\"maj\":{\"type\":\"string\",\"enum\":[\"urn:oasis:names:tc:dss:1.0:resultmajor:Success\",\"urn:oasis:names:tc:dss:1.0:resultmajor:RequesterError\",\"urn:oasis:names:tc:dss:1.0:resultmajor:ResponderError\",\"urn:oasis:names:tc:dss:1.0:resultmajor:InsufficientInformation\",\"urn:oasis:names:tc:dss:1.0:profiles:asynchronousprocessing:resultmajor:Pending\"]},\"min\":{\"type\":\"string\"},\"msg\":{\"$ref\":\"#/definitions/dsb-InternationalStringType\"},\"pRef\":{\"type\":\"string\"}},\"required\":[\"maj\"]},\"dsb-InternationalStringType\":{\"$xsd-full-type\":\"dsb:InternationalStringType\",\"$xsd-type\":\"InternationalStringType\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"string\"},\"lang\":{\"type\":\"string\"}},\"required\":[\"lang\"]},\"dss2-OptionalOutputsSignType\":{\"$xsd-full-type\":\"dss2:OptionalOutputsSignType\",\"$xsd-type\":\"OptionalOutputsSignType\",\"type\":\"object\",\"properties\":{\"policy\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"other\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"transformed\":{\"$ref\":\"#/definitions/dss2-TransformedDocumentType\"},\"schemas\":{\"$ref\":\"#/definitions/dss2-SchemasType\"},\"docWithSignature\":{\"$ref\":\"#/definitions/dss2-DocumentWithSignatureType\"}}},\"dss2-TransformedDocumentType\":{\"$xsd-full-type\":\"dss2:TransformedDocumentType\",\"$xsd-type\":\"TransformedDocumentType\",\"type\":\"object\",\"properties\":{\"doc\":{\"$ref\":\"#/definitions/dss2-DocumentType\"},\"whichRef\":{\"type\":\"integer\"}},\"required\":[\"doc\",\"whichRef\"]},\"dss2-DocumentWithSignatureType\":{\"$xsd-full-type\":\"dss2:DocumentWithSignatureType\",\"$xsd-type\":\"DocumentWithSignatureType\",\"type\":\"object\",\"properties\":{\"doc\":{\"$ref\":\"#/definitions/dss2-DocumentType\"}},\"required\":[\"doc\"]},\"dss2-SignatureObjectType\":{\"$xsd-full-type\":\"dss2:SignatureObjectType\",\"$xsd-type\":\"SignatureObjectType\",\"type\":\"object\",\"properties\":{\"b64Sig\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"sigPtr\":{\"$ref\":\"#/definitions/dss2-SignaturePtrType\"},\"schemaRefs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DocumentBaseType\"}}},\"minProperties\":1},\"dss2-SignaturePtrType\":{\"$xsd-full-type\":\"dss2:SignaturePtrType\",\"$xsd-type\":\"SignaturePtrType\",\"type\":\"object\",\"properties\":{\"xpath\":{\"type\":\"string\"},\"nsDecl\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-NsPrefixMappingType\"}},\"whichDoc\":{\"$ref\":\"#/definitions/dss2-DocumentBaseType\"},\"xPath\":{\"type\":\"string\"}},\"required\":[\"whichDoc\"]},\"dss2-VerifyRequestType\":{\"$xsd-full-type\":\"dss2:VerifyRequestType\",\"$xsd-type\":\"VerifyRequestType\",\"type\":\"object\",\"properties\":{\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"inDocs\":{\"$ref\":\"#/definitions/dss2-InputDocumentsType\"},\"optInp\":{\"$ref\":\"#/definitions/dss2-OptionalInputsVerifyType\"},\"sigObj\":{\"$ref\":\"#/definitions/dss2-SignatureObjectType\"}}},\"dss2-OptionalInputsVerifyType\":{\"$xsd-full-type\":\"dss2:OptionalInputsVerifyType\",\"$xsd-type\":\"OptionalInputsVerifyType\",\"type\":\"object\",\"properties\":{\"policy\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lang\":{\"type\":\"string\"},\"other\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"claimedIdentity\":{\"$ref\":\"#/definitions/dss2-ClaimedIdentityType\"},\"schemas\":{\"$ref\":\"#/definitions/dss2-SchemasType\"},\"addTimestamp\":{\"$ref\":\"#/definitions/dss2-AugmentSignatureInstructionType\"},\"useVerificationTime\":{\"$ref\":\"#/definitions/dss2-UseVerificationTimeType\"},\"returnVerificationTime\":{\"type\":\"boolean\",\"default\":\"false\"},\"addKeyInfo\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-AdditionalKeyInfoType\"}},\"returnProcDetails\":{\"type\":\"boolean\",\"default\":\"false\"},\"returnSigningTime\":{\"type\":\"boolean\",\"default\":\"false\"},\"returnSigner\":{\"type\":\"boolean\",\"default\":\"false\"},\"returnAugmented\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-AugmentSignatureInstructionType\"}},\"returnTransformed\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-ReturnTransformedDocumentType\"}},\"returnTimestamped\":{\"$ref\":\"#/definitions/dss2-AugmentSignatureInstructionType\"},\"verifyManifests\":{\"type\":\"boolean\",\"default\":\"false\"}}},\"dss2-UseVerificationTimeType\":{\"$xsd-full-type\":\"dss2:UseVerificationTimeType\",\"$xsd-type\":\"UseVerificationTimeType\",\"type\":\"object\",\"properties\":{\"currTime\":{\"type\":\"boolean\",\"default\":\"false\"},\"specTime\":{\"type\":\"integer\",\"format\":\"utc-millisec\"},\"b64Content\":{\"type\":\"string\"}},\"minProperties\":1,\"maxProperties\":1},\"dss2-AdditionalKeyInfoType\":{\"$xsd-full-type\":\"dss2:AdditionalKeyInfoType\",\"$xsd-type\":\"AdditionalKeyInfoType\",\"type\":\"object\",\"properties\":{\"ocspresponse\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"x509Digest\":{\"$ref\":\"#/definitions/dss2-X509DigestType\"},\"sub\":{\"type\":\"string\"},\"ski\":{\"type\":\"string\"},\"cert\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"name\":{\"type\":\"string\"},\"crl\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"ocsp\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"},\"poe\":{\"$ref\":\"#/definitions/dsb-Base64DataType\"}},\"minProperties\":1,\"maxProperties\":1},\"dss2-ReturnTransformedDocumentType\":{\"$xsd-full-type\":\"dss2:ReturnTransformedDocumentType\",\"$xsd-type\":\"ReturnTransformedDocumentType\",\"type\":\"object\",\"properties\":{\"whichRef\":{\"type\":\"integer\"}},\"required\":[\"whichRef\"]},\"dss2-VerifyResponseType\":{\"$xsd-full-type\":\"dss2:VerifyResponseType\",\"$xsd-type\":\"VerifyResponseType\",\"type\":\"object\",\"properties\":{\"result\":{\"$ref\":\"#/definitions/dsb-ResultType\"},\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"respID\":{\"type\":\"string\"},\"optOutp\":{\"$ref\":\"#/definitions/dss2-OptionalOutputsVerifyType\"}}},\"dss2-OptionalOutputsVerifyType\":{\"$xsd-full-type\":\"dss2:OptionalOutputsVerifyType\",\"$xsd-type\":\"OptionalOutputsVerifyType\",\"type\":\"object\",\"properties\":{\"policy\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"other\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-AnyType\"}},\"transformed\":{\"$ref\":\"#/definitions/dss2-TransformedDocumentType\"},\"schemas\":{\"$ref\":\"#/definitions/dss2-SchemasType\"},\"docWithSignature\":{\"$ref\":\"#/definitions/dss2-DocumentWithSignatureType\"},\"result\":{\"$ref\":\"#/definitions/dss2-VerifyManifestResultsType\"},\"signingTimeInfo\":{\"$ref\":\"#/definitions/dss2-SigningTimeInfoType\"},\"verificationTimeInfo\":{\"$ref\":\"#/definitions/dss2-VerificationTimeInfoType\"},\"procDetails\":{\"$ref\":\"#/definitions/dss2-ProcessingDetailsType\"},\"signerIdentity\":{\"$ref\":\"#/definitions/saml2rw-NameIDType\"},\"augSig\":{\"$ref\":\"#/definitions/dss2-AugmentedSignatureType\"},\"timestampedSig\":{\"$ref\":\"#/definitions/dss2-AugmentedSignatureType\"}}},\"dss2-VerifyManifestResultsType\":{\"$xsd-full-type\":\"dss2:VerifyManifestResultsType\",\"$xsd-type\":\"VerifyManifestResultsType\",\"type\":\"object\",\"properties\":{\"result\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-ManifestResultType\"}}},\"required\":[\"result\"]},\"dss2-ManifestResultType\":{\"$xsd-full-type\":\"dss2:ManifestResultType\",\"$xsd-type\":\"ManifestResultType\",\"type\":\"object\",\"properties\":{\"xPath\":{\"type\":\"string\"},\"status\":{\"type\":\"string\",\"enum\":[\"urn:oasis:names:tc:dss:1.0:manifeststatus:Valid\",\"urn:oasis:names:tc:dss:1.0:manifeststatus:Invalid\"]},\"nsDecl\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dsb-NsPrefixMappingType\"}}},\"required\":[\"xPath\",\"status\"]},\"dss2-SigningTimeInfoType\":{\"$xsd-full-type\":\"dss2:SigningTimeInfoType\",\"$xsd-type\":\"SigningTimeInfoType\",\"type\":\"object\",\"properties\":{\"signingTime\":{\"type\":\"integer\",\"format\":\"utc-millisec\"},\"signingTimeBounds\":{\"$ref\":\"#/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries\"}},\"required\":[\"signingTime\"]},\"dss2-SigningTimeInfoType:SigningTimeBoundaries\":{\"$xsd-full-type\":\"\",\"$xsd-type\":\"\",\"type\":\"object\",\"properties\":{\"lowerBound\":{\"type\":\"integer\",\"format\":\"utc-millisec\"},\"upperBound\":{\"type\":\"integer\",\"format\":\"utc-millisec\"}}},\"dss2-VerificationTimeInfoType\":{\"$xsd-full-type\":\"dss2:VerificationTimeInfoType\",\"$xsd-type\":\"VerificationTimeInfoType\",\"type\":\"object\",\"properties\":{\"verificationTime\":{\"type\":\"integer\",\"format\":\"utc-millisec\"},\"additionalTimeInfo\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-AdditionalTimeInfoType\"}}},\"required\":[\"verificationTime\"]},\"dss2-AdditionalTimeInfoType\":{\"$xsd-full-type\":\"dss2:AdditionalTimeInfoType\",\"$xsd-type\":\"AdditionalTimeInfoType\",\"type\":\"object\",\"properties\":{\"value\":{\"type\":\"integer\",\"format\":\"utc-millisec\"},\"type\":{\"type\":\"string\",\"format\":\"uri\"},\"ref\":{\"type\":\"string\"}},\"required\":[\"type\"]},\"dss2-ProcessingDetailsType\":{\"$xsd-full-type\":\"dss2:ProcessingDetailsType\",\"$xsd-type\":\"ProcessingDetailsType\",\"type\":\"object\",\"properties\":{\"valid\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DetailType\"}},\"indeterminate\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DetailType\"}},\"invalid\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dss2-DetailType\"}}}},\"dss2-DetailType\":{\"$xsd-full-type\":\"dss2:DetailType\",\"$xsd-type\":\"DetailType\",\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\"},\"msg\":{\"$ref\":\"#/definitions/dsb-InternationalStringType\"},\"b64Content\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"type\"]},\"dss2-AugmentedSignatureType\":{\"$xsd-full-type\":\"dss2:AugmentedSignatureType\",\"$xsd-type\":\"AugmentedSignatureType\",\"type\":\"object\",\"properties\":{\"sigObj\":{\"$ref\":\"#/definitions/dss2-SignatureObjectType\"},\"type\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"sigObj\"]},\"dss2-PendingRequestType\":{\"$xsd-full-type\":\"dss2:PendingRequestType\",\"$xsd-type\":\"PendingRequestType\",\"type\":\"object\",\"properties\":{\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"claimedIdentity\":{\"$ref\":\"#/definitions/dss2-ClaimedIdentityType\"}}},\"dsb-ResponseBaseType\":{\"$xsd-full-type\":\"dsb:ResponseBaseType\",\"$xsd-type\":\"ResponseBaseType\",\"type\":\"object\",\"properties\":{\"result\":{\"$ref\":\"#/definitions/dsb-ResultType\"},\"profile\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"reqID\":{\"type\":\"string\"},\"respID\":{\"type\":\"string\"}},\"required\":[\"result\"]}},\"id\":\"https://json.schemastore.org/dss-2.0.0.json\",\"properties\":{\"signReq\":{\"$ref\":\"#/definitions/dss2-SignRequestType\"},\"signResp\":{\"$ref\":\"#/definitions/dss2-SignResponseType\"},\"verifyReq\":{\"$ref\":\"#/definitions/dss2-VerifyRequestType\"},\"verifyResp\":{\"$ref\":\"#/definitions/dss2-VerifyResponseType\"},\"pendingReq\":{\"$ref\":\"#/definitions/dss2-PendingRequestType\"},\"genericResp\":{\"$ref\":\"#/definitions/dsb-ResponseBaseType\"}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"dss-2.0.0\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"dss2-SignRequestType":{"$xsd-full-type":"dss2:SignRequestType","$xsd-type":"SignRequestType","type":"object","properties":{"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"inDocs":{"$ref":"#/definitions/dss2-InputDocumentsType"},"optInp":{"$ref":"#/definitions/dss2-OptionalInputsSignType"}}},"dss2-InputDocumentsType":{"$xsd-full-type":"dss2:InputDocumentsType","$xsd-type":"InputDocumentsType","type":"object","properties":{"doc":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}},"transformed":{"type":"array","items":{"$ref":"#/definitions/dss2-TransformedDataType"}},"docHash":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentHashType"}}}},"dss2-DocumentType":{"$xsd-full-type":"dss2:DocumentType","$xsd-type":"DocumentType","type":"object","properties":{"ID":{"type":"string"},"refURI":{"type":"string"},"refType":{"type":"string"},"schemaRefs":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}},"b64Data":{"$ref":"#/definitions/dsb-Base64DataType"}},"required":["b64Data"]},"dsb-Base64DataType":{"$xsd-full-type":"dsb:Base64DataType","$xsd-type":"Base64DataType","type":"object","properties":{"ID":{"type":"string"},"val":{"type":"string"},"attRef":{"$ref":"#/definitions/dsb-AttachmentReferenceType"},"mimeType":{"type":"string"},"idRef":{"type":"string"}},"minProperties":0},"dsb-AttachmentReferenceType":{"$xsd-full-type":"dsb:AttachmentReferenceType","$xsd-type":"AttachmentReferenceType","type":"object","properties":{"di":{"type":"array","items":{"$ref":"#/definitions/dsb-DigestInfoType"}},"attURI":{"type":"string"}},"required":["attURI"]},"dsb-DigestInfoType":{"$xsd-full-type":"dsb:DigestInfoType","$xsd-type":"DigestInfoType","type":"object","properties":{"alg":{"type":"string"},"val":{"type":"string"}},"required":["alg","val"]},"dss2-TransformedDataType":{"$xsd-full-type":"dss2:TransformedDataType","$xsd-type":"TransformedDataType","type":"object","properties":{"ID":{"type":"string"},"refURI":{"type":"string"},"refType":{"type":"string"},"schemaRefs":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}},"transforms":{"$ref":"#/definitions/dsigrw-TransformsType"},"b64Data":{"$ref":"#/definitions/dsb-Base64DataType"},"whichRef":{"type":"integer"}},"required":["b64Data"]},"dsigrw-TransformsType":{"$xsd-full-type":"ds-rw:TransformsType","$xsd-type":"TransformsType","type":"object","properties":{"transform":{"type":"array","items":{"$ref":"#/definitions/dsigrw-TransformType"}}},"required":["transform"]},"dsigrw-TransformType":{"$xsd-full-type":"ds-rw:TransformType","$xsd-type":"TransformType","type":"object","properties":{"xpath":{"type":"array","items":{"type":"string"}},"val":{"type":"string"},"b64Content":{"type":"string"},"xPath":{"type":"array","items":{"type":"string"}},"nsDecl":{"type":"array","items":{"$ref":"#/definitions/dsb-NsPrefixMappingType"}},"alg":{"type":"string"}},"required":["alg"]},"dsb-NsPrefixMappingType":{"$xsd-full-type":"dsb:NsPrefixMappingType","$xsd-type":"NsPrefixMappingType","type":"object","properties":{"uri":{"type":"string"},"pre":{"type":"string"}},"required":["uri","pre"]},"dss2-DocumentHashType":{"$xsd-full-type":"dss2:DocumentHashType","$xsd-type":"DocumentHashType","type":"object","properties":{"ID":{"type":"string"},"refURI":{"type":"string"},"refType":{"type":"string"},"schemaRefs":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}},"transforms":{"$ref":"#/definitions/dsigrw-TransformsType"},"dis":{"type":"array","items":{"$ref":"#/definitions/dsb-DigestInfoType"}},"whichRef":{"type":"integer"}},"required":["dis"]},"dss2-OptionalInputsSignType":{"$xsd-full-type":"dss2:OptionalInputsSignType","$xsd-type":"OptionalInputsSignType","type":"object","properties":{"policy":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"},"other":{"type":"array","items":{"$ref":"#/definitions/dsb-AnyType"}},"claimedIdentity":{"$ref":"#/definitions/dss2-ClaimedIdentityType"},"schemas":{"$ref":"#/definitions/dss2-SchemasType"},"addTimestamp":{"$ref":"#/definitions/dss2-AugmentSignatureInstructionType"},"sigType":{"type":"string"},"aud":{"$ref":"#/definitions/dss2-IntendedAudienceType"},"keySel":{"type":"array","items":{"$ref":"#/definitions/dss2-KeySelectorType"}},"props":{"$ref":"#/definitions/dss2-PropertiesHolderType"},"incObj":{"type":"array","items":{"$ref":"#/definitions/dss2-IncludeObjectType"}},"incContent":{"type":"boolean","default":"false"},"sigPlacement":{"$ref":"#/definitions/dss2-SignaturePlacementType"},"signedRefs":{"$ref":"#/definitions/dss2-SignedReferencesType"},"nonce":{"type":"integer"},"sigAlgo":{"type":"string"},"quality":{"type":"string"}}},"dsb-AnyType":{"$xsd-full-type":"dsb:AnyType","$xsd-type":"AnyType","type":"object","properties":{"ID":{"type":"string"},"val":{"type":"string"},"attRef":{"$ref":"#/definitions/dsb-AttachmentReferenceType"},"mimeType":{"type":"string"},"idRef":{"type":"string"}}},"dss2-ClaimedIdentityType":{"$xsd-full-type":"dss2:ClaimedIdentityType","$xsd-type":"ClaimedIdentityType","type":"object","properties":{"name":{"$ref":"#/definitions/saml2rw-NameIDType"},"suppInfo":{"$ref":"#/definitions/dsb-AnyType"}},"required":["name"]},"saml2rw-NameIDType":{"$xsd-full-type":"saml2-rw:NameIDType","$xsd-type":"NameIDType","type":"object","properties":{"spprovidedID":{"type":"string"},"spnameQualifier":{"type":"string"},"value":{"type":"string"},"format":{"type":"string"},"provId":{"type":"string"},"nameQual":{"type":"string"},"spNameQual":{"type":"string"}}},"dss2-SchemasType":{"$xsd-full-type":"dss2:SchemasType","$xsd-type":"SchemasType","type":"object","properties":{"schema":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}}},"required":["schema"]},"dss2-AugmentSignatureInstructionType":{"$xsd-full-type":"dss2:AugmentSignatureInstructionType","$xsd-type":"AugmentSignatureInstructionType","type":"object","properties":{"type":{"type":"string","format":"uri"}}},"dss2-IntendedAudienceType":{"$xsd-full-type":"dss2:IntendedAudienceType","$xsd-type":"IntendedAudienceType","type":"object","properties":{"recipient":{"type":"array","items":{"$ref":"#/definitions/saml2rw-NameIDType"}}},"required":["recipient"]},"dss2-KeySelectorType":{"$xsd-full-type":"dss2:KeySelectorType","$xsd-type":"KeySelectorType","type":"object","properties":{"x509Digest":{"$ref":"#/definitions/dss2-X509DigestType"},"sub":{"type":"string"},"ski":{"type":"string"},"cert":{"type":"string"},"name":{"type":"string"}},"minProperties":1,"maxProperties":1},"dss2-X509DigestType":{"$xsd-full-type":"dss2:X509DigestType","$xsd-type":"X509DigestType","type":"object","properties":{"value":{"type":"string"},"alg":{"type":"string"}},"required":["alg"]},"dss2-PropertiesHolderType":{"$xsd-full-type":"dss2:PropertiesHolderType","$xsd-type":"PropertiesHolderType","type":"object","properties":{"signedProps":{"$ref":"#/definitions/dss2-PropertiesType"},"unsignedProps":{"$ref":"#/definitions/dss2-PropertiesType"}}},"dss2-PropertiesType":{"$xsd-full-type":"dss2:PropertiesType","$xsd-type":"PropertiesType","type":"object","properties":{"prop":{"type":"array","items":{"$ref":"#/definitions/dss2-PropertyType"}}},"required":["prop"]},"dss2-PropertyType":{"$xsd-full-type":"dss2:PropertyType","$xsd-type":"PropertyType","type":"object","properties":{"id":{"type":"string"},"val":{"$ref":"#/definitions/dsb-AnyType"}},"required":["id"]},"dss2-IncludeObjectType":{"$xsd-full-type":"dss2:IncludeObjectType","$xsd-type":"IncludeObjectType","type":"object","properties":{"whichDoc":{"$ref":"#/definitions/dss2-DocumentBaseType"},"hasObjectTagsAndAttributesSet":{"type":"boolean","default":"false"},"objId":{"type":"string"},"createRef":{"type":"boolean","default":"true"}}},"dss2-DocumentBaseType":{"$xsd-full-type":"dss2:DocumentBaseType","$xsd-type":"DocumentBaseType","type":"object","properties":{"ID":{"type":"string"},"refURI":{"type":"string"},"refType":{"type":"string"},"schemaRefs":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentType"}}}},"dss2-SignaturePlacementType":{"$xsd-full-type":"dss2:SignaturePlacementType","$xsd-type":"SignaturePlacementType","type":"object","properties":{"xpathAfter":{"type":"string"},"xpathFirstChildOf":{"type":"string"},"xPathAfter":{"type":"string"},"xPathFirstChildOf":{"type":"string"},"nsDecl":{"type":"array","items":{"$ref":"#/definitions/dsb-NsPrefixMappingType"}},"whichDoc":{"$ref":"#/definitions/dss2-DocumentBaseType"},"createEnvelopedSignature":{"type":"boolean","default":"true"}}},"dss2-SignedReferencesType":{"$xsd-full-type":"dss2:SignedReferencesType","$xsd-type":"SignedReferencesType","type":"object","properties":{"signedRef":{"type":"array","items":{"$ref":"#/definitions/dss2-SignedReferenceType"}}},"required":["signedRef"]},"dss2-SignedReferenceType":{"$xsd-full-type":"dss2:SignedReferenceType","$xsd-type":"SignedReferenceType","type":"object","properties":{"transforms":{"$ref":"#/definitions/dsigrw-TransformsType"},"whichDoc":{"$ref":"#/definitions/dss2-DocumentBaseType"},"refURI":{"type":"string"},"refId":{"type":"string"}},"required":["whichDoc"]},"dss2-SignResponseType":{"$xsd-full-type":"dss2:SignResponseType","$xsd-type":"SignResponseType","type":"object","properties":{"result":{"$ref":"#/definitions/dsb-ResultType"},"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"respID":{"type":"string"},"optOutp":{"$ref":"#/definitions/dss2-OptionalOutputsSignType"},"sigObj":{"$ref":"#/definitions/dss2-SignatureObjectType"}}},"dsb-ResultType":{"$xsd-full-type":"dsb:ResultType","$xsd-type":"ResultType","type":"object","properties":{"maj":{"type":"string","enum":["urn:oasis:names:tc:dss:1.0:resultmajor:Success","urn:oasis:names:tc:dss:1.0:resultmajor:RequesterError","urn:oasis:names:tc:dss:1.0:resultmajor:ResponderError","urn:oasis:names:tc:dss:1.0:resultmajor:InsufficientInformation","urn:oasis:names:tc:dss:1.0:profiles:asynchronousprocessing:resultmajor:Pending"]},"min":{"type":"string"},"msg":{"$ref":"#/definitions/dsb-InternationalStringType"},"pRef":{"type":"string"}},"required":["maj"]},"dsb-InternationalStringType":{"$xsd-full-type":"dsb:InternationalStringType","$xsd-type":"InternationalStringType","type":"object","properties":{"value":{"type":"string"},"lang":{"type":"string"}},"required":["lang"]},"dss2-OptionalOutputsSignType":{"$xsd-full-type":"dss2:OptionalOutputsSignType","$xsd-type":"OptionalOutputsSignType","type":"object","properties":{"policy":{"type":"array","items":{"type":"string"}},"other":{"type":"array","items":{"$ref":"#/definitions/dsb-AnyType"}},"transformed":{"$ref":"#/definitions/dss2-TransformedDocumentType"},"schemas":{"$ref":"#/definitions/dss2-SchemasType"},"docWithSignature":{"$ref":"#/definitions/dss2-DocumentWithSignatureType"}}},"dss2-TransformedDocumentType":{"$xsd-full-type":"dss2:TransformedDocumentType","$xsd-type":"TransformedDocumentType","type":"object","properties":{"doc":{"$ref":"#/definitions/dss2-DocumentType"},"whichRef":{"type":"integer"}},"required":["doc","whichRef"]},"dss2-DocumentWithSignatureType":{"$xsd-full-type":"dss2:DocumentWithSignatureType","$xsd-type":"DocumentWithSignatureType","type":"object","properties":{"doc":{"$ref":"#/definitions/dss2-DocumentType"}},"required":["doc"]},"dss2-SignatureObjectType":{"$xsd-full-type":"dss2:SignatureObjectType","$xsd-type":"SignatureObjectType","type":"object","properties":{"b64Sig":{"$ref":"#/definitions/dsb-Base64DataType"},"sigPtr":{"$ref":"#/definitions/dss2-SignaturePtrType"},"schemaRefs":{"type":"array","items":{"$ref":"#/definitions/dss2-DocumentBaseType"}}},"minProperties":1},"dss2-SignaturePtrType":{"$xsd-full-type":"dss2:SignaturePtrType","$xsd-type":"SignaturePtrType","type":"object","properties":{"xpath":{"type":"string"},"nsDecl":{"type":"array","items":{"$ref":"#/definitions/dsb-NsPrefixMappingType"}},"whichDoc":{"$ref":"#/definitions/dss2-DocumentBaseType"},"xPath":{"type":"string"}},"required":["whichDoc"]},"dss2-VerifyRequestType":{"$xsd-full-type":"dss2:VerifyRequestType","$xsd-type":"VerifyRequestType","type":"object","properties":{"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"inDocs":{"$ref":"#/definitions/dss2-InputDocumentsType"},"optInp":{"$ref":"#/definitions/dss2-OptionalInputsVerifyType"},"sigObj":{"$ref":"#/definitions/dss2-SignatureObjectType"}}},"dss2-OptionalInputsVerifyType":{"$xsd-full-type":"dss2:OptionalInputsVerifyType","$xsd-type":"OptionalInputsVerifyType","type":"object","properties":{"policy":{"type":"array","items":{"type":"string"}},"lang":{"type":"string"},"other":{"type":"array","items":{"$ref":"#/definitions/dsb-AnyType"}},"claimedIdentity":{"$ref":"#/definitions/dss2-ClaimedIdentityType"},"schemas":{"$ref":"#/definitions/dss2-SchemasType"},"addTimestamp":{"$ref":"#/definitions/dss2-AugmentSignatureInstructionType"},"useVerificationTime":{"$ref":"#/definitions/dss2-UseVerificationTimeType"},"returnVerificationTime":{"type":"boolean","default":"false"},"addKeyInfo":{"type":"array","items":{"$ref":"#/definitions/dss2-AdditionalKeyInfoType"}},"returnProcDetails":{"type":"boolean","default":"false"},"returnSigningTime":{"type":"boolean","default":"false"},"returnSigner":{"type":"boolean","default":"false"},"returnAugmented":{"type":"array","items":{"$ref":"#/definitions/dss2-AugmentSignatureInstructionType"}},"returnTransformed":{"type":"array","items":{"$ref":"#/definitions/dss2-ReturnTransformedDocumentType"}},"returnTimestamped":{"$ref":"#/definitions/dss2-AugmentSignatureInstructionType"},"verifyManifests":{"type":"boolean","default":"false"}}},"dss2-UseVerificationTimeType":{"$xsd-full-type":"dss2:UseVerificationTimeType","$xsd-type":"UseVerificationTimeType","type":"object","properties":{"currTime":{"type":"boolean","default":"false"},"specTime":{"type":"integer","format":"utc-millisec"},"b64Content":{"type":"string"}},"minProperties":1,"maxProperties":1},"dss2-AdditionalKeyInfoType":{"$xsd-full-type":"dss2:AdditionalKeyInfoType","$xsd-type":"AdditionalKeyInfoType","type":"object","properties":{"ocspresponse":{"$ref":"#/definitions/dsb-Base64DataType"},"x509Digest":{"$ref":"#/definitions/dss2-X509DigestType"},"sub":{"type":"string"},"ski":{"type":"string"},"cert":{"$ref":"#/definitions/dsb-Base64DataType"},"name":{"type":"string"},"crl":{"$ref":"#/definitions/dsb-Base64DataType"},"ocsp":{"$ref":"#/definitions/dsb-Base64DataType"},"poe":{"$ref":"#/definitions/dsb-Base64DataType"}},"minProperties":1,"maxProperties":1},"dss2-ReturnTransformedDocumentType":{"$xsd-full-type":"dss2:ReturnTransformedDocumentType","$xsd-type":"ReturnTransformedDocumentType","type":"object","properties":{"whichRef":{"type":"integer"}},"required":["whichRef"]},"dss2-VerifyResponseType":{"$xsd-full-type":"dss2:VerifyResponseType","$xsd-type":"VerifyResponseType","type":"object","properties":{"result":{"$ref":"#/definitions/dsb-ResultType"},"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"respID":{"type":"string"},"optOutp":{"$ref":"#/definitions/dss2-OptionalOutputsVerifyType"}}},"dss2-OptionalOutputsVerifyType":{"$xsd-full-type":"dss2:OptionalOutputsVerifyType","$xsd-type":"OptionalOutputsVerifyType","type":"object","properties":{"policy":{"type":"array","items":{"type":"string"}},"other":{"type":"array","items":{"$ref":"#/definitions/dsb-AnyType"}},"transformed":{"$ref":"#/definitions/dss2-TransformedDocumentType"},"schemas":{"$ref":"#/definitions/dss2-SchemasType"},"docWithSignature":{"$ref":"#/definitions/dss2-DocumentWithSignatureType"},"result":{"$ref":"#/definitions/dss2-VerifyManifestResultsType"},"signingTimeInfo":{"$ref":"#/definitions/dss2-SigningTimeInfoType"},"verificationTimeInfo":{"$ref":"#/definitions/dss2-VerificationTimeInfoType"},"procDetails":{"$ref":"#/definitions/dss2-ProcessingDetailsType"},"signerIdentity":{"$ref":"#/definitions/saml2rw-NameIDType"},"augSig":{"$ref":"#/definitions/dss2-AugmentedSignatureType"},"timestampedSig":{"$ref":"#/definitions/dss2-AugmentedSignatureType"}}},"dss2-VerifyManifestResultsType":{"$xsd-full-type":"dss2:VerifyManifestResultsType","$xsd-type":"VerifyManifestResultsType","type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/definitions/dss2-ManifestResultType"}}},"required":["result"]},"dss2-ManifestResultType":{"$xsd-full-type":"dss2:ManifestResultType","$xsd-type":"ManifestResultType","type":"object","properties":{"xPath":{"type":"string"},"status":{"type":"string","enum":["urn:oasis:names:tc:dss:1.0:manifeststatus:Valid","urn:oasis:names:tc:dss:1.0:manifeststatus:Invalid"]},"nsDecl":{"type":"array","items":{"$ref":"#/definitions/dsb-NsPrefixMappingType"}}},"required":["xPath","status"]},"dss2-SigningTimeInfoType":{"$xsd-full-type":"dss2:SigningTimeInfoType","$xsd-type":"SigningTimeInfoType","type":"object","properties":{"signingTime":{"type":"integer","format":"utc-millisec"},"signingTimeBounds":{"$ref":"#/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries"}},"required":["signingTime"]},"dss2-SigningTimeInfoType:SigningTimeBoundaries":{"$xsd-full-type":"","$xsd-type":"","type":"object","properties":{"lowerBound":{"type":"integer","format":"utc-millisec"},"upperBound":{"type":"integer","format":"utc-millisec"}}},"dss2-VerificationTimeInfoType":{"$xsd-full-type":"dss2:VerificationTimeInfoType","$xsd-type":"VerificationTimeInfoType","type":"object","properties":{"verificationTime":{"type":"integer","format":"utc-millisec"},"additionalTimeInfo":{"type":"array","items":{"$ref":"#/definitions/dss2-AdditionalTimeInfoType"}}},"required":["verificationTime"]},"dss2-AdditionalTimeInfoType":{"$xsd-full-type":"dss2:AdditionalTimeInfoType","$xsd-type":"AdditionalTimeInfoType","type":"object","properties":{"value":{"type":"integer","format":"utc-millisec"},"type":{"type":"string","format":"uri"},"ref":{"type":"string"}},"required":["type"]},"dss2-ProcessingDetailsType":{"$xsd-full-type":"dss2:ProcessingDetailsType","$xsd-type":"ProcessingDetailsType","type":"object","properties":{"valid":{"type":"array","items":{"$ref":"#/definitions/dss2-DetailType"}},"indeterminate":{"type":"array","items":{"$ref":"#/definitions/dss2-DetailType"}},"invalid":{"type":"array","items":{"$ref":"#/definitions/dss2-DetailType"}}}},"dss2-DetailType":{"$xsd-full-type":"dss2:DetailType","$xsd-type":"DetailType","type":"object","properties":{"code":{"type":"string"},"msg":{"$ref":"#/definitions/dsb-InternationalStringType"},"b64Content":{"type":"string"},"type":{"type":"string","format":"uri"}},"required":["type"]},"dss2-AugmentedSignatureType":{"$xsd-full-type":"dss2:AugmentedSignatureType","$xsd-type":"AugmentedSignatureType","type":"object","properties":{"sigObj":{"$ref":"#/definitions/dss2-SignatureObjectType"},"type":{"type":"string","format":"uri"}},"required":["sigObj"]},"dss2-PendingRequestType":{"$xsd-full-type":"dss2:PendingRequestType","$xsd-type":"PendingRequestType","type":"object","properties":{"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"claimedIdentity":{"$ref":"#/definitions/dss2-ClaimedIdentityType"}}},"dsb-ResponseBaseType":{"$xsd-full-type":"dsb:ResponseBaseType","$xsd-type":"ResponseBaseType","type":"object","properties":{"result":{"$ref":"#/definitions/dsb-ResultType"},"profile":{"type":"array","items":{"type":"string"}},"reqID":{"type":"string"},"respID":{"type":"string"}},"required":["result"]}},"id":"https://json.schemastore.org/dss-2.0.0.json","properties":{"signReq":{"$ref":"#/definitions/dss2-SignRequestType"},"signResp":{"$ref":"#/definitions/dss2-SignResponseType"},"verifyReq":{"$ref":"#/definitions/dss2-VerifyRequestType"},"verifyResp":{"$ref":"#/definitions/dss2-VerifyResponseType"},"pendingReq":{"$ref":"#/definitions/dss2-PendingRequestType"},"genericResp":{"$ref":"#/definitions/dsb-ResponseBaseType"}},"type":"object"}
|
Provide a JSON object that satisfies the schema "dss-2.0.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
dss-2.0.0
|
schema-store
|
schema_store_290
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/dtool-dataset-metadata-1.0.json\",\"title\":\"DToolDataset\",\"description\":\"Schema for metadata attached to a dtool dataset\",\"type\":\"object\",\"properties\":{\"uuid\":{\"type\":\"string\",\"format\":\"uuid\"},\"base_uri\":{\"type\":\"string\"},\"uri\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"readme\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"manifest\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"hash\":{\"type\":\"string\"},\"relpath\":{\"type\":\"string\"},\"size_in_bytes\":{\"type\":\"integer\"},\"utc_timestamp\":{\"type\":\"number\"}}}},\"hash_function\":{\"type\":\"string\"},\"dtoolcore_version\":{\"type\":\"string\"}}},\"creator_username\":{\"type\":\"string\"},\"frozen_at\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"}]},\"created_at\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"}]},\"annotations\":{\"type\":\"object\"},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"number_of_items\":{\"type\":\"integer\"},\"size_in_bytes\":{\"type\":\"integer\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"DToolDataset\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/dtool-dataset-metadata-1.0.json","title":"DToolDataset","description":"Schema for metadata attached to a dtool dataset","type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"base_uri":{"type":"string"},"uri":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"readme":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"manifest":{"type":"object","properties":{"items":{"type":"object","additionalProperties":{"type":"object","properties":{"hash":{"type":"string"},"relpath":{"type":"string"},"size_in_bytes":{"type":"integer"},"utc_timestamp":{"type":"number"}}}},"hash_function":{"type":"string"},"dtoolcore_version":{"type":"string"}}},"creator_username":{"type":"string"},"frozen_at":{"anyOf":[{"type":"string"},{"type":"number"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"number"}]},"annotations":{"type":"object"},"tags":{"type":"array","items":{"type":"string"}},"number_of_items":{"type":"integer"},"size_in_bytes":{"type":"integer"}}}
|
Provide a JSON object that satisfies the schema "DToolDataset". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
DToolDataset
|
schema-store
|
schema_store_291
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-06/schema\",\"type\":\"object\",\"description\":\"The EAS config (eas.json) validation and documentation.\",\"meta\":{\"updatedAt\":\"2022-07-18T15:00:00.000Z\"},\"properties\":{\"$schema\":{\"type\":\"string\"},\"cli\":{\"$ref\":\"#/definitions/Cli\"},\"build\":{\"$ref\":\"#/definitions/Build\"},\"submit\":{\"$ref\":\"#/definitions/Submit\"}},\"definitions\":{\"Cli\":{\"type\":\"object\",\"description\":\"Configure the basic behavior of your project with the EAS CLI\",\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"The compatible versions of EAS CLI with this config\",\"examples\":[\">=0.54.1\"]},\"requireCommit\":{\"type\":\"boolean\",\"description\":\"If all changes required to be committed before building or submitting\"},\"appVersionSource\":{\"enum\":[\"local\",\"remote\"],\"markdownDescription\":\"Version policy defines whether version of your app should be based on your local project or values stored on EAS servers (remote).\\n\\nThis is the configuration required for `eas build:version:set` and works with the `autoIncrement` options per platform.\",\"markdownEnumDescriptions\":[\"When using local, the `autoIncrement` is based on your local project values.\",\"When using remote, the `autoIncrement` is based on the values stored on EAS servers.\"]},\"promptToConfigurePushNotifications\":{\"type\":\"boolean\",\"description\":\"Specifies where EAS CLI should prompt to configure Push Notifications credentials. It defaults to true if expo-notifications is in your project dependencies, otherwise it defaults to false.\",\"default\":true}}},\"Build\":{\"type\":\"object\",\"description\":\"EAS Build configuration. Learn more: https://docs.expo.dev/build-reference/eas-json/\",\"markdownDescription\":\"EAS Build configuration. [Learn more](https://docs.expo.dev/build-reference/eas-json/)\",\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/BuildProfile\"}}},\"BuildCache\":{\"type\":\"object\",\"properties\":{\"disabled\":{\"type\":\"boolean\",\"description\":\"Disables caching. Defaults to false.\"},\"key\":{\"type\":\"string\",\"description\":\"Cache key. You can invalidate the cache by changing this value.\"},\"customPaths\":{\"type\":\"array\",\"description\":\"[DEPRECATED] Use `paths` instead. List of the paths that will be saved after a successful build and restored at the beginning of the next one.\",\"markdownDescription\":\"[DEPRECATED] Use `paths` instead. List of the paths that will be saved after a successful build and restored at the beginning of the next one. Both absolute and relative paths are supported, where relative paths are resolved from the directory with `eas.json`.\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"},\"deprecated\":true},\"paths\":{\"type\":\"array\",\"description\":\"List of the paths that will be saved after a successful build and restored at the beginning of the next one.\",\"markdownDescription\":\"List of the paths that will be saved after a successful build and restored at the beginning of the next one. Both absolute and relative paths are supported, where relative paths are resolved from the directory with `eas.json`.\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}}},\"BuildProfile\":{\"type\":\"object\",\"description\":\"The build profile configuration.\",\"properties\":{\"withoutCredentials\":{\"type\":\"boolean\",\"description\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.\",\"markdownDescription\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.\",\"default\":false},\"extends\":{\"type\":\"string\",\"description\":\"The name of the build profile that the current one should inherit values from. This value can't be specified per platform.\"},\"credentialsSource\":{\"enum\":[\"remote\",\"local\"],\"description\":\"The source of credentials used to sign build artifacts. Learn more: https://docs.expo.dev/app-signing/local-credentials/\",\"markdownDescription\":\"The source of credentials used to sign build artifacts.\\n\\n- `remote` - if you want to use the credentials managed by EAS.\\n- `local` - if you want to provide your own `credentials.json` file. [learn more](https://docs.expo.dev/app-signing/local-credentials/)\",\"default\":\"remote\",\"markdownEnumDescriptions\":[\"Use the credentials managed by EAS.\",\"Provide your own `credentials.json` file. [learn more](https://docs.expo.dev/app-signing/local-credentials/)\"]},\"channel\":{\"type\":\"string\",\"description\":\"The channel name identifies which EAS Update channel a build belongs to. Learn more: https://docs.expo.dev/eas-update/how-eas-update-works/\",\"markdownDescription\":\"The channel name identifies which EAS Update channel a build belongs to. [Learn more](https://docs.expo.dev/eas-update/how-eas-update-works/)\"},\"distribution\":{\"enum\":[\"internal\",\"store\"],\"description\":\"The method of distributing your app. Learn more: https://docs.expo.dev/build/internal-distribution/\",\"markdownDescription\":\"The method of distributing your app.\\n\\n- `internal` - with this option you'll be able to share your build URLs with anyone, and they will be able to install the builds to their devices straight from the Expo website. When using `internal`, make sure the build produces an APK or IPA file. Otherwise, the shareable URL will be useless. [Learn more](https://docs.expo.dev/build/internal-distribution/)\\n- `store` - produces builds for store uploads, your build URLs won't be shareable.\",\"markdownEnumDescriptions\":[\"With this option you'll be able to share your build URLs with anyone, and they will be able to install the builds to their devices straight from the Expo website. When using `internal`, make sure the build produces an APK or IPA file. Otherwise, the shareable URL will be useless. [Learn more](https://docs.expo.dev/build/internal-distribution/)\",\"Produces builds for store uploads, your build URLs won't be shareable.\"]},\"developmentClient\":{\"type\":\"boolean\",\"description\":\"If set to true, this field expresses the intent to produce a development client build. Learn more: https://docs.expo.dev/development/introduction/\",\"markdownDescription\":\"If set to true, this field expresses the intent to produce a development client build.\\n\\nFor the build to be successful, the project must have `expo-dev-client` installed and configured.\\n> This field is sugar for setting the iOS `buildConfiguration` to `Debug` and Android `gradleCommand` to `:app:assembleDebug`. Those fields, if provided for the same build profile, will take precedence.\\n\\n[Learn more](https://docs.expo.dev/development/introduction/)\",\"default\":false},\"prebuildCommand\":{\"type\":\"string\",\"description\":\"Optional override of the prebuild command used by EAS. Learn more: https://docs.expo.dev/workflow/expo-cli/#expo-prebuild\",\"markdownDescription\":\"Optional override of the prebuild command used by EAS.\\n\\nFor example, you can specify `prebuild --template example-template` to use a custom template.\\n>`--platform` and `--non-interactive` will be added automatically by the build engine, so you do not need to specify them manually.\\n\\n[Learn more](https://docs.expo.dev/workflow/expo-cli/#expo-prebuild)\"},\"node\":{\"type\":\"string\",\"description\":\"The version of Node.js to use for the build. See: https://nodejs.org/en/about/releases/\",\"markdownDescription\":\"The exact version of [Node.js](https://nodejs.org/en/about/releases/) to use for the build.\"},\"corepack\":{\"type\":\"boolean\",\"description\":\"If set to true, corepack will be enabled at the beginning of the build process. Learn more: https://nodejs.org/api/corepack.html\",\"markdownDescription\":\"If set to true, [corepack](https://nodejs.org/api/corepack.html) will be enabled at the beginning of the build process.\",\"default\":false},\"yarn\":{\"type\":\"string\",\"description\":\"The version of Yarn to use for the build. See: https://www.npmjs.com/package/yarn\",\"markdownDescription\":\"The exact version of [Yarn](https://www.npmjs.com/package/yarn) to use for the build.\"},\"pnpm\":{\"type\":\"string\",\"description\":\"The version of pnpm to use for the build. See: https://www.npmjs.com/package/pnpm\",\"markdownDescription\":\"The exact version of [pnpm](https://www.npmjs.com/package/pnpm) to use for the build.\"},\"bun\":{\"type\":\"string\",\"description\":\"The version of Bun to use for the build. See: https://bun.sh/\",\"markdownDescription\":\"The exact version of [Bun](https://bun.sh/) to use for the build.\"},\"env\":{\"type\":\"object\",\"description\":\"Environment variables that should be set during the build process.\\n\\nShould only be used for values that you would commit to your git repository, i.e. not passwords or secrets.\",\"patternProperties\":{\".*\":{\"type\":\"string\",\"description\":\"This environment variable will be set during the build process.\"}}},\"cache\":{\"$ref\":\"#/definitions/BuildCache\",\"description\":\"The cache configuration.\",\"markdownDescription\":\"Cache configuration. This feature is intended for caching values that require a lot of computation, e.g. compilation results (both final binaries and any intermediate files), but it wouldn't work well for `node_modules` because the cache is not local to the machine, so the download speed is similar to downloading from the npm registry.\"},\"autoIncrement\":{\"type\":\"boolean\",\"description\":\"Controls how EAS CLI bumps your application build version.\",\"markdownDescription\":\"When enabled, for iOS, bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`) and for Android, bumps `expo.android.versionCode` (e.g. `3` -> `4`).\",\"default\":false},\"buildArtifactPaths\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"List of paths (or patterns) where EAS Build is going to look for the build artifacts. Use `applicationArchivePath` to specify the path for uploading the application archive. Build artifacts are uploaded even if the build fails. See: https://github.com/mrmlnc/fast-glob#pattern-syntax\",\"markdownDescription\":\"List of paths (or patterns) where EAS Build is going to look for the build artifacts. Use `applicationArchivePath` to specify the path for uploading the application archive. Build artifacts are uploaded even if the build fails. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\"},\"resourceClass\":{\"description\":\"The resource class that will be used to run this build, supported by both Android and iOS workers. Learn more: https://docs.expo.dev/build-reference/infrastructure/\",\"markdownDescription\":\"The resource class that will be used to run this build, supported by both Android and iOS workers. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)\",\"default\":\"default\",\"anyOf\":[{\"enum\":[\"default\",\"medium\",\"large\"]},{\"type\":\"string\"}]},\"config\":{\"description\":\"Custom workflow file name that will be used to run this build. You can also specify this property on platform level for platform-specific workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/\",\"type\":\"string\"},\"environment\":{\"description\":\"Environment to use for the server-side defined EAS environment variables during build process and command execution. Learn more: https://docs.expo.dev/eas/environment-variables/\",\"markdownDescription\":\"Environment to use for the server-side defined EAS environment variables during build process and command execution. [Learn more](https://docs.expo.dev/eas/environment-variables/)\",\"enum\":[\"production\",\"preview\",\"development\"]},\"android\":{\"$ref\":\"#/definitions/BuildProfileAndroid\"},\"ios\":{\"$ref\":\"#/definitions/BuildProfileIos\"}}},\"BuildProfileAndroid\":{\"type\":\"object\",\"description\":\"The Android-specific build profile configuration.\",\"properties\":{\"withoutCredentials\":{\"type\":\"boolean\",\"description\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when you want to build debug binaries and the debug keystore is checked in to the repository or working with custom builds.\",\"markdownDescription\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when you want to build debug binaries and the debug keystore is checked in to the repository or working with custom builds.\",\"default\":false},\"image\":{\"description\":\"Image with build environment. Learn more: https://docs.expo.dev/build-reference/infrastructure/\",\"markdownDescription\":\"Image with build environment. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)\",\"default\":\"default\",\"anyOf\":[{\"enum\":[\"auto\",\"latest\",\"sdk-52\",\"sdk-51\",\"sdk-50\",\"sdk-49\",\"ubuntu-22.04-jdk-17-ndk-r26b\",\"ubuntu-22.04-jdk-17-ndk-r25b\",\"ubuntu-22.04-jdk-11-ndk-r23b\",\"ubuntu-22.04-jdk-17-ndk-r21e\",\"ubuntu-22.04-jdk-11-ndk-r21e\"],\"markdownEnumDescriptions\":[\"When using this option the build image is selected automatically based on the project configuration, detected Expo SDK and React Native versions.\",\"The latest Android image currently available. It is resolved to `ubuntu-22.04-jdk-17-ndk-r26b`. The `latest` to image mapping will be updated as new images are released.\",\"The recommended image for SDK 52 builds\",\"The recommended image for SDK 51 builds\",\"The recommended image for SDK 50 builds\",\"The recommended image for SDK 49 builds\"]},{\"deprecated\":true,\"enum\":[\"default\",\"stable\",\"ubuntu-20.04-jdk-11-ndk-r23b\",\"ubuntu-20.04-jdk-11-ndk-r19c\",\"ubuntu-20.04-jdk-8-ndk-r19c\",\"ubuntu-20.04-jdk-11-ndk-r21e\",\"ubuntu-20.04-jdk-8-ndk-r21e\",\"ubuntu-22.04-jdk-8-ndk-r21e\"],\"markdownEnumDescriptions\":[\"This image tag is deprecated, please use other image tags or images directly instead.\",\"This image tag is deprecated, please use other image tags or images directly instead.\",\"This image is deprecated\",\"This image is deprecated\",\"This image is deprecated\",\"This image is deprecated\",\"This image is deprecated\",\"This image is deprecated\"]}]},\"resourceClass\":{\"description\":\"The Android-specific resource class that will be used to run this build. Learn more: https://docs.expo.dev/build-reference/infrastructure/\",\"markdownDescription\":\"The Android-specific resource class that will be used to run this build. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)\",\"default\":\"default\",\"anyOf\":[{\"enum\":[\"default\",\"medium\",\"large\"]},{\"type\":\"string\"}]},\"ndk\":{\"type\":\"string\",\"description\":\"The version of Android NDK.\"},\"autoIncrement\":{\"enum\":[false,true,\"versionCode\",\"version\"],\"description\":\"Controls how EAS CLI bumps your application build version.\",\"markdownDescription\":\"Controls how EAS CLI bumps your application build version.\\n\\nAllowed values:\\n- `\\\"version\\\"` - bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`).\\n- `\\\"versionCode\\\"` (or `true`) - bumps `expo.android.versionCode` (e.g. `3` -> `4`).\\n- `false` - versions won't be bumped automatically (default)\\n\\nIn the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `versionName` and `expo.android.versionCode` to `versionCode` in the `build.gradle`. Google Play uses these values to identify the app build, `versionName` is the version visible to users, whereas `versionCode` defines the version number. The combination of those needs to be unique, so you can bump either of them.\\n\\nThis feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.\",\"default\":false,\"markdownEnumDescriptions\":[\"Versions won't be bumped automatically (default).\",\"Bumps `expo.android.versionCode` (e.g. `3` -> `4`).\",\"Bumps `expo.android.versionCode` (e.g. `3` -> `4`).\",\"Bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`).\"]},\"buildType\":{\"enum\":[\"app-bundle\",\"apk\"],\"description\":\"Type of the artifact you want to build.\",\"markdownDescription\":\"Type of the artifact you want to build. It controls what Gradle task will be used, can be overridden by `gradleCommand` or `developmentClient: true` option.\\n- `app-bundle` - `:app:bundleRelease`\\n- `apk` - `:app:assembleRelease`\",\"markdownEnumDescriptions\":[\"Gradle task `:app:bundleRelease` is used\",\"Gradle task `:app:assembleRelease` is used\"]},\"gradleCommand\":{\"type\":\"string\",\"description\":\"Gradle task that will be used to build your project, e.g. `:app:assembleDebug` to build a debug binary.\",\"markdownDescription\":\"Gradle task that will be used to build your project, e.g. `:app:assembleDebug` to build a debug binary.\\n\\nIt's not recommended unless you need to run a task that `buildType` does not support, it takes priority over `buildType` and `developmentClient`.\"},\"applicationArchivePath\":{\"type\":\"string\",\"description\":\"Path (or pattern) where EAS Build is going to look for the application archive. See: https://github.com/mrmlnc/fast-glob#pattern-syntax\",\"markdownDescription\":\"Path (or pattern) where EAS Build is going to look for the application archive. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\",\"default\":\"android/app/build/outputs/**/*.{apk,aab}\"},\"artifactPath\":{\"type\":\"string\",\"description\":\"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. See: https://github.com/mrmlnc/fast-glob#pattern-syntax\",\"markdownDescription\":\"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\",\"default\":\"android/app/build/outputs/**/*.{apk,aab}\"},\"config\":{\"description\":\"Custom workflow file name that will be used to run this Android build. You can also specify this property on profile levle for platform-agnostic workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/\",\"type\":\"string\"}}},\"BuildProfileIos\":{\"type\":\"object\",\"description\":\"The iOS-specific build profile configuration.\",\"properties\":{\"withoutCredentials\":{\"type\":\"boolean\",\"description\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.\",\"markdownDescription\":\"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.\",\"default\":false},\"simulator\":{\"type\":\"boolean\",\"description\":\"If set to true, creates build for simulator.\",\"default\":false},\"enterpriseProvisioning\":{\"enum\":[\"universal\",\"adhoc\"],\"markdownDescription\":\"Provisioning method used for `\\\"distribution\\\": \\\"internal\\\"` when you have an Apple account with Apple Developer Enterprise Program membership.\\n\\nYou can choose if you want to use `adhoc` or `universal` provisioning. The latter is recommended as it does not require you to register each individual device. If you don't provide this option and you still authenticate with an enterprise team, you'll be prompted which provisioning method to use.\",\"markdownEnumDescriptions\":[\"Recommended as it does not require you to register each individual device\"]},\"autoIncrement\":{\"enum\":[false,true,\"buildNumber\",\"version\"],\"description\":\"Controls how EAS CLI bumps your application build version.\",\"markdownDescription\":\"Controls how EAS CLI bumps your application build version.\\n\\nAllowed values:\\n\\n- `\\\"version\\\"` - bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`).\\n- `\\\"buildNumber\\\"` (or `true`) - bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`).\\n- `false` - versions won't be bumped automatically (default)\\n\\nIn the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `CFBundleShortVersionString` and `expo.ios.buildNumber` to `CFBundleVersion` in the `Info.plist`. The App Store is using those values to identify the app build, `CFBundleShortVersionString` is the version visible to users, whereas `CFBundleVersion` defines the build number. The combination of those needs to be unique, so you can bump either of them.\\n\\nThis feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.\",\"default\":false,\"markdownEnumDescriptions\":[\"Versions won't be bumped automatically (default)\",\"Bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`)\",\"Bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`)\",\"Bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`)\"]},\"image\":{\"description\":\"Image with build environment. Learn more: https://docs.expo.dev/build-reference/infrastructure/\",\"markdownDescription\":\"Image with build environment. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)\",\"default\":\"default\",\"anyOf\":[{\"enum\":[\"auto\",\"latest\",\"sdk-52\",\"sdk-51\",\"sdk-50\",\"sdk-49\",\"macos-sonoma-14.6-xcode-16.1\",\"macos-sonoma-14.6-xcode-16.0\",\"macos-sonoma-14.5-xcode-15.4\",\"macos-sonoma-14.4-xcode-15.3\",\"macos-ventura-13.6-xcode-15.2\",\"macos-ventura-13.6-xcode-15.1\",\"macos-ventura-13.6-xcode-15.0\"],\"markdownEnumDescriptions\":[\"When using this option the build image is selected automatically based on the project configuration, detected Expo SDK and React Native versions.\",\"The latest iOS image currently available. It is resolved to `macos-sonoma-14.6-xcode-16.1`. The `latest` to image mapping will be updated as new images are released.\",\"The recommended image for SDK 52 builds\",\"The recommended image for SDK 51 builds\",\"The recommended image for SDK 50 builds\",\"The recommended image for SDK 49 builds\"]},{\"deprecated\":true,\"enum\":[\"default\",\"stable\"],\"markdownEnumDescriptions\":[\"This image tag is deprecated, please use other image tags or images directly instead.\",\"This image tag is deprecated, please use other image tags or images directly instead.\"]}]},\"resourceClass\":{\"description\":\"The iOS-specific resource class that will be used to run this build. Learn more: https://docs.expo.dev/build-reference/infrastructure/\",\"markdownDescription\":\"The iOS-specific resource class that will be used to run this build. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)\",\"default\":\"default\",\"anyOf\":[{\"enum\":[\"default\",\"medium\",\"large\",\"m-medium\"]},{\"type\":\"string\"}]},\"bundler\":{\"type\":\"string\",\"description\":\"The version of bundler to use for the build. See: https://bundler.io/.\",\"markdownDescription\":\"The version of [bundler](https://bundler.io/) to use for the build.\"},\"fastlane\":{\"type\":\"string\",\"description\":\"The version of fastlane to use for the build. See: https://fastlane.tools/\",\"markdownDescription\":\"The version of [fastlane](https://fastlane.tools/) to use for the build.\"},\"cocoapods\":{\"type\":\"string\",\"description\":\"The version of CocoaPods to use for the build. See: https://cocoapods.org/\",\"markdownDescription\":\"The version of [CocoaPods](https://cocoapods.org/) to use for the build.\"},\"scheme\":{\"type\":\"string\",\"description\":\"Xcode project's scheme.\",\"markdownDescription\":\"Xcode project's scheme.\\n- managed project: does not have any effect\\n- bare project\\n - If your project has multiple schemes, you should set this value.\\n - If the project has only one scheme, it will be detected automatically.\\n - If multiple schemes exist and this value is **not** set, EAS CLI will prompt you to select one of them.\"},\"buildConfiguration\":{\"type\":\"string\",\"description\":\"Xcode project's Build Configuration.\",\"markdownDescription\":\"Xcode project's Build Configuration.\\n- managed project: \\\"Release\\\" or \\\"Debug\\\", defaults to \\\"Release\\\"\\n- bare project: defaults to the value specified in the scheme\\n\\nIt takes priority over `developmentClient` field.\"},\"applicationArchivePath\":{\"type\":\"string\",\"description\":\"Path (or pattern) where EAS Build is going to look for the application archive. See: https://github.com/mrmlnc/fast-glob#pattern-syntax\",\"markdownDescription\":\"Path (or pattern) where EAS Build is going to look for the application archive.\\n\\nEAS Build uses the `fast-glob` npm package for pattern matching, ([See their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\\n\\nYou should modify that path only if you are using a custom `Gymfile`.\\n\\nThe default is `ios/build/Build/Products/*-iphonesimulator/*.app` when building for simulator and `ios/build/*.ipa` in other cases.\"},\"artifactPath\":{\"type\":\"string\",\"description\":\"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. See: https://github.com/mrmlnc/fast-glob#pattern-syntax\",\"markdownDescription\":\"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts.\\n\\nEAS Build uses the `fast-glob` npm package for pattern matching, ([See their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\\n\\nYou should modify that path only if you are using a custom `Gymfile`.\\n\\nThe default is `ios/build/Build/Products/*-iphonesimulator/*.app` when building for simulator and `ios/build/*.ipa` in other cases.\"},\"config\":{\"description\":\"Custom workflow file name that will be used to run this iOS build. You can also specify this property on profile levle for platform-agnostic workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/\",\"type\":\"string\"}}},\"Submit\":{\"type\":\"object\",\"description\":\"EAS Submit configuration. Learn more: https://docs.expo.dev/submit/eas-json/\",\"markdownDescription\":\"EAS Submit configuration. [Learn more](https://docs.expo.dev/submit/eas-json/)\",\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/SubmitProfile\",\"description\":\"The submit profile name with the configuration.\"}}},\"SubmitProfile\":{\"type\":\"object\",\"properties\":{\"extends\":{\"type\":\"string\",\"description\":\"The name of the submit profile that the current one should inherit values from.\"},\"android\":{\"$ref\":\"#/definitions/SubmitProfileAndroid\"},\"ios\":{\"$ref\":\"#/definitions/SubmitProfileIos\"}}},\"SubmitProfileAndroid\":{\"type\":\"object\",\"description\":\"The Android-specific submit profile configuration.\",\"properties\":{\"serviceAccountKeyPath\":{\"type\":\"string\",\"description\":\"Path to the JSON file with service account key used to authenticate with Google Play. Learn more: https://expo.fyi/creating-google-service-account\",\"markdownDescription\":\"Path to the JSON file with service account key used to authenticate with Google Play. [Learn more](https://expo.fyi/creating-google-service-account)\"},\"track\":{\"enum\":[\"beta\",\"alpha\",\"internal\",\"production\"],\"description\":\"The track of the application to use. Learn more: https://support.google.com/googleplay/android-developer/answer/9859348?hl=en\",\"markdownDescription\":\"The [track of the application](https://support.google.com/googleplay/android-developer/answer/9859348?hl=en) to use.\",\"markdownEnumDescriptions\":[\"**Open testing** releases are available to testers on Google Play. Users can join tests from your store listing.\",\"**Closed testing** releases are available to a limited number of testers that you choose, who can test a pre-release version of your app and submit feedback.\",\"**Internal testing** releases are available to up to 100 testers that you choose.\",\"**Production releases** are available to all Google Play users in your chosen countries.\"]},\"releaseStatus\":{\"enum\":[\"draft\",\"inProgress\",\"halted\",\"completed\"],\"description\":\"The status of a release. Learn more: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks\",\"markdownDescription\":\"The status of a release. [Learn more](https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks)\",\"enumDescriptions\":[\"The release's APKs are not being served to users.\",\"The release's APKs are being served to a fraction of users, if set.\",\"The release's APKs will no longer be served to users. Users who already have these APKs are unaffected.\",\"The release will have no further changes. Its APKs are being served to all users, unless they are eligible to APKs of a more recent release.\"]},\"rollout\":{\"type\":\"number\",\"description\":\"The initial fraction of users who are eligible to receive the release. Should be a value from 0 (no users) to 1 (all users). Works only with 'inProgress' release status. Learn more: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks\",\"markdownDescription\":\"The initial fraction of users who are eligible to receive the release. Should be a value from 0 (no users) to 1 (all users). Works only with `inProgress` release status. [Learn more](https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks)\"},\"changesNotSentForReview\":{\"type\":\"boolean\",\"description\":\"Indicates that the changes sent with this submission will not be reviewed until they are explicitly sent for review from the Google Play Console UI. Defaults to false.\",\"default\":false},\"applicationId\":{\"type\":\"string\",\"description\":\"The application id that will be used when accessing Service Account Keys managed by Expo, it does not have any effect if you are using local credentials. In most cases this value will be autodetected, but if you have multiple product flavors, this value might be necessary.\"}}},\"SubmitProfileIos\":{\"type\":\"object\",\"description\":\"The iOS-specific submit profile configuration.\",\"properties\":{\"appleId\":{\"type\":\"string\",\"description\":\"Your Apple ID username (you can also set the `EXPO_APPLE_ID` env variable).\",\"markdownDescription\":\"Your Apple ID username (you can also set the `EXPO_APPLE_ID` env variable).\"},\"ascAppId\":{\"type\":\"string\",\"description\":\"App Store Connect unique application Apple ID number. When set, results in skipping the app creation step. Learn more: https://expo.fyi/asc-app-id\",\"markdownDescription\":\"App Store Connect unique application Apple ID number. When set, results in skipping the app creation step. [Learn more](https://expo.fyi/asc-app-id)\"},\"appleTeamId\":{\"type\":\"string\",\"description\":\"Your Apple Developer Team ID.\"},\"sku\":{\"type\":\"string\",\"description\":\"An unique ID for your app that is not visible on the App Store, will be generated unless provided.\"},\"language\":{\"type\":\"string\",\"description\":\"Primary language. Defaults to `en-US`.\",\"markdownDescription\":\"Primary language. Defaults to `en-US`.\"},\"companyName\":{\"type\":\"string\",\"description\":\"The name of your company, needed only for the first submission of any app to the App Store.\"},\"appName\":{\"type\":\"string\",\"description\":\"The name of your app as it will appear on the App Store. Defaults to `expo.name` from the app config.\",\"markdownDescription\":\"The name of your app as it will appear on the App Store. Defaults to `expo.name` from the app config.\"},\"ascApiKeyPath\":{\"type\":\"string\",\"description\":\"The path to your App Store Connect Api Key .p8 file. Learn more: https://expo.fyi/creating-asc-api-key\",\"markdownDescription\":\"The path to your App Store Connect Api Key .p8 file. [Learn more](https://expo.fyi/creating-asc-api-key)\"},\"ascApiKeyIssuerId\":{\"type\":\"string\",\"description\":\"The Issuer ID of your App Store Connect Api Key. Learn more: https://expo.fyi/creating-asc-api-key\",\"markdownDescription\":\"The Issuer ID of your App Store Connect Api Key. [Learn more](https://expo.fyi/creating-asc-api-key)\"},\"ascApiKeyId\":{\"type\":\"string\",\"description\":\"The Key ID of your App Store Connect Api Key. Learn more: https://expo.fyi/creating-asc-api-key\",\"markdownDescription\":\"The Key ID of your App Store Connect Api Key. [Learn more](https://expo.fyi/creating-asc-api-key)\"},\"bundleIdentifier\":{\"type\":\"string\",\"description\":\"The Bundle identifier that will be used when accessing submit credentials managed by Expo, it does not have any effect if you are using local credentials. In most cases this value will be autodetected, but if you have multiple Xcode schemes and targets, this value might be necessary.\"},\"groups\":{\"type\":\"array\",\"description\":\"Internal TestFlight testing groups to add the build to (iOS only). Learn more: https://developer.apple.com/help/app-store-connect/test-a-beta-version/add-internal-testers\",\"markdownDescription\":\"Internal TestFlight testing groups to add the build to (iOS only). [Learn more](https://developer.apple.com/help/app-store-connect/test-a-beta-version/add-internal-testers)\"},\"metadataPath\":{\"type\":\"string\",\"description\":\"The path to your store configuration file. Learn more: https://docs.expo.dev/eas-metadata/introduction/\",\"markdownDescription\":\"The path to your store configuration file. [Learn more](https://docs.expo.dev/eas-metadata/introduction/)\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"eas.schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-06/schema","type":"object","description":"The EAS config (eas.json) validation and documentation.","meta":{"updatedAt":"2022-07-18T15:00:00.000Z"},"properties":{"$schema":{"type":"string"},"cli":{"$ref":"#/definitions/Cli"},"build":{"$ref":"#/definitions/Build"},"submit":{"$ref":"#/definitions/Submit"}},"definitions":{"Cli":{"type":"object","description":"Configure the basic behavior of your project with the EAS CLI","properties":{"version":{"type":"string","description":"The compatible versions of EAS CLI with this config","examples":[">=0.54.1"]},"requireCommit":{"type":"boolean","description":"If all changes required to be committed before building or submitting"},"appVersionSource":{"enum":["local","remote"],"markdownDescription":"Version policy defines whether version of your app should be based on your local project or values stored on EAS servers (remote).\n\nThis is the configuration required for `eas build:version:set` and works with the `autoIncrement` options per platform.","markdownEnumDescriptions":["When using local, the `autoIncrement` is based on your local project values.","When using remote, the `autoIncrement` is based on the values stored on EAS servers."]},"promptToConfigurePushNotifications":{"type":"boolean","description":"Specifies where EAS CLI should prompt to configure Push Notifications credentials. It defaults to true if expo-notifications is in your project dependencies, otherwise it defaults to false.","default":true}}},"Build":{"type":"object","description":"EAS Build configuration. Learn more: https://docs.expo.dev/build-reference/eas-json/","markdownDescription":"EAS Build configuration. [Learn more](https://docs.expo.dev/build-reference/eas-json/)","patternProperties":{".*":{"$ref":"#/definitions/BuildProfile"}}},"BuildCache":{"type":"object","properties":{"disabled":{"type":"boolean","description":"Disables caching. Defaults to false."},"key":{"type":"string","description":"Cache key. You can invalidate the cache by changing this value."},"customPaths":{"type":"array","description":"[DEPRECATED] Use `paths` instead. List of the paths that will be saved after a successful build and restored at the beginning of the next one.","markdownDescription":"[DEPRECATED] Use `paths` instead. List of the paths that will be saved after a successful build and restored at the beginning of the next one. Both absolute and relative paths are supported, where relative paths are resolved from the directory with `eas.json`.","uniqueItems":true,"items":{"type":"string"},"deprecated":true},"paths":{"type":"array","description":"List of the paths that will be saved after a successful build and restored at the beginning of the next one.","markdownDescription":"List of the paths that will be saved after a successful build and restored at the beginning of the next one. Both absolute and relative paths are supported, where relative paths are resolved from the directory with `eas.json`.","uniqueItems":true,"items":{"type":"string"}}}},"BuildProfile":{"type":"object","description":"The build profile configuration.","properties":{"withoutCredentials":{"type":"boolean","description":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.","markdownDescription":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.","default":false},"extends":{"type":"string","description":"The name of the build profile that the current one should inherit values from. This value can't be specified per platform."},"credentialsSource":{"enum":["remote","local"],"description":"The source of credentials used to sign build artifacts. Learn more: https://docs.expo.dev/app-signing/local-credentials/","markdownDescription":"The source of credentials used to sign build artifacts.\n\n- `remote` - if you want to use the credentials managed by EAS.\n- `local` - if you want to provide your own `credentials.json` file. [learn more](https://docs.expo.dev/app-signing/local-credentials/)","default":"remote","markdownEnumDescriptions":["Use the credentials managed by EAS.","Provide your own `credentials.json` file. [learn more](https://docs.expo.dev/app-signing/local-credentials/)"]},"channel":{"type":"string","description":"The channel name identifies which EAS Update channel a build belongs to. Learn more: https://docs.expo.dev/eas-update/how-eas-update-works/","markdownDescription":"The channel name identifies which EAS Update channel a build belongs to. [Learn more](https://docs.expo.dev/eas-update/how-eas-update-works/)"},"distribution":{"enum":["internal","store"],"description":"The method of distributing your app. Learn more: https://docs.expo.dev/build/internal-distribution/","markdownDescription":"The method of distributing your app.\n\n- `internal` - with this option you'll be able to share your build URLs with anyone, and they will be able to install the builds to their devices straight from the Expo website. When using `internal`, make sure the build produces an APK or IPA file. Otherwise, the shareable URL will be useless. [Learn more](https://docs.expo.dev/build/internal-distribution/)\n- `store` - produces builds for store uploads, your build URLs won't be shareable.","markdownEnumDescriptions":["With this option you'll be able to share your build URLs with anyone, and they will be able to install the builds to their devices straight from the Expo website. When using `internal`, make sure the build produces an APK or IPA file. Otherwise, the shareable URL will be useless. [Learn more](https://docs.expo.dev/build/internal-distribution/)","Produces builds for store uploads, your build URLs won't be shareable."]},"developmentClient":{"type":"boolean","description":"If set to true, this field expresses the intent to produce a development client build. Learn more: https://docs.expo.dev/development/introduction/","markdownDescription":"If set to true, this field expresses the intent to produce a development client build.\n\nFor the build to be successful, the project must have `expo-dev-client` installed and configured.\n> This field is sugar for setting the iOS `buildConfiguration` to `Debug` and Android `gradleCommand` to `:app:assembleDebug`. Those fields, if provided for the same build profile, will take precedence.\n\n[Learn more](https://docs.expo.dev/development/introduction/)","default":false},"prebuildCommand":{"type":"string","description":"Optional override of the prebuild command used by EAS. Learn more: https://docs.expo.dev/workflow/expo-cli/#expo-prebuild","markdownDescription":"Optional override of the prebuild command used by EAS.\n\nFor example, you can specify `prebuild --template example-template` to use a custom template.\n>`--platform` and `--non-interactive` will be added automatically by the build engine, so you do not need to specify them manually.\n\n[Learn more](https://docs.expo.dev/workflow/expo-cli/#expo-prebuild)"},"node":{"type":"string","description":"The version of Node.js to use for the build. See: https://nodejs.org/en/about/releases/","markdownDescription":"The exact version of [Node.js](https://nodejs.org/en/about/releases/) to use for the build."},"corepack":{"type":"boolean","description":"If set to true, corepack will be enabled at the beginning of the build process. Learn more: https://nodejs.org/api/corepack.html","markdownDescription":"If set to true, [corepack](https://nodejs.org/api/corepack.html) will be enabled at the beginning of the build process.","default":false},"yarn":{"type":"string","description":"The version of Yarn to use for the build. See: https://www.npmjs.com/package/yarn","markdownDescription":"The exact version of [Yarn](https://www.npmjs.com/package/yarn) to use for the build."},"pnpm":{"type":"string","description":"The version of pnpm to use for the build. See: https://www.npmjs.com/package/pnpm","markdownDescription":"The exact version of [pnpm](https://www.npmjs.com/package/pnpm) to use for the build."},"bun":{"type":"string","description":"The version of Bun to use for the build. See: https://bun.sh/","markdownDescription":"The exact version of [Bun](https://bun.sh/) to use for the build."},"env":{"type":"object","description":"Environment variables that should be set during the build process.\n\nShould only be used for values that you would commit to your git repository, i.e. not passwords or secrets.","patternProperties":{".*":{"type":"string","description":"This environment variable will be set during the build process."}}},"cache":{"$ref":"#/definitions/BuildCache","description":"The cache configuration.","markdownDescription":"Cache configuration. This feature is intended for caching values that require a lot of computation, e.g. compilation results (both final binaries and any intermediate files), but it wouldn't work well for `node_modules` because the cache is not local to the machine, so the download speed is similar to downloading from the npm registry."},"autoIncrement":{"type":"boolean","description":"Controls how EAS CLI bumps your application build version.","markdownDescription":"When enabled, for iOS, bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`) and for Android, bumps `expo.android.versionCode` (e.g. `3` -> `4`).","default":false},"buildArtifactPaths":{"type":"array","items":{"type":"string"},"description":"List of paths (or patterns) where EAS Build is going to look for the build artifacts. Use `applicationArchivePath` to specify the path for uploading the application archive. Build artifacts are uploaded even if the build fails. See: https://github.com/mrmlnc/fast-glob#pattern-syntax","markdownDescription":"List of paths (or patterns) where EAS Build is going to look for the build artifacts. Use `applicationArchivePath` to specify the path for uploading the application archive. Build artifacts are uploaded even if the build fails. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax))."},"resourceClass":{"description":"The resource class that will be used to run this build, supported by both Android and iOS workers. Learn more: https://docs.expo.dev/build-reference/infrastructure/","markdownDescription":"The resource class that will be used to run this build, supported by both Android and iOS workers. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)","default":"default","anyOf":[{"enum":["default","medium","large"]},{"type":"string"}]},"config":{"description":"Custom workflow file name that will be used to run this build. You can also specify this property on platform level for platform-specific workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/","type":"string"},"environment":{"description":"Environment to use for the server-side defined EAS environment variables during build process and command execution. Learn more: https://docs.expo.dev/eas/environment-variables/","markdownDescription":"Environment to use for the server-side defined EAS environment variables during build process and command execution. [Learn more](https://docs.expo.dev/eas/environment-variables/)","enum":["production","preview","development"]},"android":{"$ref":"#/definitions/BuildProfileAndroid"},"ios":{"$ref":"#/definitions/BuildProfileIos"}}},"BuildProfileAndroid":{"type":"object","description":"The Android-specific build profile configuration.","properties":{"withoutCredentials":{"type":"boolean","description":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when you want to build debug binaries and the debug keystore is checked in to the repository or working with custom builds.","markdownDescription":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when you want to build debug binaries and the debug keystore is checked in to the repository or working with custom builds.","default":false},"image":{"description":"Image with build environment. Learn more: https://docs.expo.dev/build-reference/infrastructure/","markdownDescription":"Image with build environment. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)","default":"default","anyOf":[{"enum":["auto","latest","sdk-52","sdk-51","sdk-50","sdk-49","ubuntu-22.04-jdk-17-ndk-r26b","ubuntu-22.04-jdk-17-ndk-r25b","ubuntu-22.04-jdk-11-ndk-r23b","ubuntu-22.04-jdk-17-ndk-r21e","ubuntu-22.04-jdk-11-ndk-r21e"],"markdownEnumDescriptions":["When using this option the build image is selected automatically based on the project configuration, detected Expo SDK and React Native versions.","The latest Android image currently available. It is resolved to `ubuntu-22.04-jdk-17-ndk-r26b`. The `latest` to image mapping will be updated as new images are released.","The recommended image for SDK 52 builds","The recommended image for SDK 51 builds","The recommended image for SDK 50 builds","The recommended image for SDK 49 builds"]},{"deprecated":true,"enum":["default","stable","ubuntu-20.04-jdk-11-ndk-r23b","ubuntu-20.04-jdk-11-ndk-r19c","ubuntu-20.04-jdk-8-ndk-r19c","ubuntu-20.04-jdk-11-ndk-r21e","ubuntu-20.04-jdk-8-ndk-r21e","ubuntu-22.04-jdk-8-ndk-r21e"],"markdownEnumDescriptions":["This image tag is deprecated, please use other image tags or images directly instead.","This image tag is deprecated, please use other image tags or images directly instead.","This image is deprecated","This image is deprecated","This image is deprecated","This image is deprecated","This image is deprecated","This image is deprecated"]}]},"resourceClass":{"description":"The Android-specific resource class that will be used to run this build. Learn more: https://docs.expo.dev/build-reference/infrastructure/","markdownDescription":"The Android-specific resource class that will be used to run this build. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)","default":"default","anyOf":[{"enum":["default","medium","large"]},{"type":"string"}]},"ndk":{"type":"string","description":"The version of Android NDK."},"autoIncrement":{"enum":[false,true,"versionCode","version"],"description":"Controls how EAS CLI bumps your application build version.","markdownDescription":"Controls how EAS CLI bumps your application build version.\n\nAllowed values:\n- `\"version\"` - bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`).\n- `\"versionCode\"` (or `true`) - bumps `expo.android.versionCode` (e.g. `3` -> `4`).\n- `false` - versions won't be bumped automatically (default)\n\nIn the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `versionName` and `expo.android.versionCode` to `versionCode` in the `build.gradle`. Google Play uses these values to identify the app build, `versionName` is the version visible to users, whereas `versionCode` defines the version number. The combination of those needs to be unique, so you can bump either of them.\n\nThis feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.","default":false,"markdownEnumDescriptions":["Versions won't be bumped automatically (default).","Bumps `expo.android.versionCode` (e.g. `3` -> `4`).","Bumps `expo.android.versionCode` (e.g. `3` -> `4`).","Bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`)."]},"buildType":{"enum":["app-bundle","apk"],"description":"Type of the artifact you want to build.","markdownDescription":"Type of the artifact you want to build. It controls what Gradle task will be used, can be overridden by `gradleCommand` or `developmentClient: true` option.\n- `app-bundle` - `:app:bundleRelease`\n- `apk` - `:app:assembleRelease`","markdownEnumDescriptions":["Gradle task `:app:bundleRelease` is used","Gradle task `:app:assembleRelease` is used"]},"gradleCommand":{"type":"string","description":"Gradle task that will be used to build your project, e.g. `:app:assembleDebug` to build a debug binary.","markdownDescription":"Gradle task that will be used to build your project, e.g. `:app:assembleDebug` to build a debug binary.\n\nIt's not recommended unless you need to run a task that `buildType` does not support, it takes priority over `buildType` and `developmentClient`."},"applicationArchivePath":{"type":"string","description":"Path (or pattern) where EAS Build is going to look for the application archive. See: https://github.com/mrmlnc/fast-glob#pattern-syntax","markdownDescription":"Path (or pattern) where EAS Build is going to look for the application archive. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).","default":"android/app/build/outputs/**/*.{apk,aab}"},"artifactPath":{"type":"string","description":"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. See: https://github.com/mrmlnc/fast-glob#pattern-syntax","markdownDescription":"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. EAS Build uses the `fast-glob` npm package for pattern matching ([see their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).","default":"android/app/build/outputs/**/*.{apk,aab}"},"config":{"description":"Custom workflow file name that will be used to run this Android build. You can also specify this property on profile levle for platform-agnostic workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/","type":"string"}}},"BuildProfileIos":{"type":"object","description":"The iOS-specific build profile configuration.","properties":{"withoutCredentials":{"type":"boolean","description":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.","markdownDescription":"When set to `true`, EAS CLI won't require you to configure credentials when building the app. This comes in handy when working with custom builds.","default":false},"simulator":{"type":"boolean","description":"If set to true, creates build for simulator.","default":false},"enterpriseProvisioning":{"enum":["universal","adhoc"],"markdownDescription":"Provisioning method used for `\"distribution\": \"internal\"` when you have an Apple account with Apple Developer Enterprise Program membership.\n\nYou can choose if you want to use `adhoc` or `universal` provisioning. The latter is recommended as it does not require you to register each individual device. If you don't provide this option and you still authenticate with an enterprise team, you'll be prompted which provisioning method to use.","markdownEnumDescriptions":["Recommended as it does not require you to register each individual device"]},"autoIncrement":{"enum":[false,true,"buildNumber","version"],"description":"Controls how EAS CLI bumps your application build version.","markdownDescription":"Controls how EAS CLI bumps your application build version.\n\nAllowed values:\n\n- `\"version\"` - bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`).\n- `\"buildNumber\"` (or `true`) - bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`).\n- `false` - versions won't be bumped automatically (default)\n\nIn the case of a bare project, it also updates versions in native code. `expo.version` corresponds to `CFBundleShortVersionString` and `expo.ios.buildNumber` to `CFBundleVersion` in the `Info.plist`. The App Store is using those values to identify the app build, `CFBundleShortVersionString` is the version visible to users, whereas `CFBundleVersion` defines the build number. The combination of those needs to be unique, so you can bump either of them.\n\nThis feature is not intended for use with dynamic configuration (app.config.js). EAS CLI will throw an error if you don't use app.json.","default":false,"markdownEnumDescriptions":["Versions won't be bumped automatically (default)","Bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`)","Bumps the last component of `expo.ios.buildNumber` (e.g. `1.2.3.39` -> `1.2.3.40`)","Bumps the patch of `expo.version` (e.g. `1.2.3` -> `1.2.4`)"]},"image":{"description":"Image with build environment. Learn more: https://docs.expo.dev/build-reference/infrastructure/","markdownDescription":"Image with build environment. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)","default":"default","anyOf":[{"enum":["auto","latest","sdk-52","sdk-51","sdk-50","sdk-49","macos-sonoma-14.6-xcode-16.1","macos-sonoma-14.6-xcode-16.0","macos-sonoma-14.5-xcode-15.4","macos-sonoma-14.4-xcode-15.3","macos-ventura-13.6-xcode-15.2","macos-ventura-13.6-xcode-15.1","macos-ventura-13.6-xcode-15.0"],"markdownEnumDescriptions":["When using this option the build image is selected automatically based on the project configuration, detected Expo SDK and React Native versions.","The latest iOS image currently available. It is resolved to `macos-sonoma-14.6-xcode-16.1`. The `latest` to image mapping will be updated as new images are released.","The recommended image for SDK 52 builds","The recommended image for SDK 51 builds","The recommended image for SDK 50 builds","The recommended image for SDK 49 builds"]},{"deprecated":true,"enum":["default","stable"],"markdownEnumDescriptions":["This image tag is deprecated, please use other image tags or images directly instead.","This image tag is deprecated, please use other image tags or images directly instead."]}]},"resourceClass":{"description":"The iOS-specific resource class that will be used to run this build. Learn more: https://docs.expo.dev/build-reference/infrastructure/","markdownDescription":"The iOS-specific resource class that will be used to run this build. [Learn more](https://docs.expo.dev/build-reference/infrastructure/)","default":"default","anyOf":[{"enum":["default","medium","large","m-medium"]},{"type":"string"}]},"bundler":{"type":"string","description":"The version of bundler to use for the build. See: https://bundler.io/.","markdownDescription":"The version of [bundler](https://bundler.io/) to use for the build."},"fastlane":{"type":"string","description":"The version of fastlane to use for the build. See: https://fastlane.tools/","markdownDescription":"The version of [fastlane](https://fastlane.tools/) to use for the build."},"cocoapods":{"type":"string","description":"The version of CocoaPods to use for the build. See: https://cocoapods.org/","markdownDescription":"The version of [CocoaPods](https://cocoapods.org/) to use for the build."},"scheme":{"type":"string","description":"Xcode project's scheme.","markdownDescription":"Xcode project's scheme.\n- managed project: does not have any effect\n- bare project\n - If your project has multiple schemes, you should set this value.\n - If the project has only one scheme, it will be detected automatically.\n - If multiple schemes exist and this value is **not** set, EAS CLI will prompt you to select one of them."},"buildConfiguration":{"type":"string","description":"Xcode project's Build Configuration.","markdownDescription":"Xcode project's Build Configuration.\n- managed project: \"Release\" or \"Debug\", defaults to \"Release\"\n- bare project: defaults to the value specified in the scheme\n\nIt takes priority over `developmentClient` field."},"applicationArchivePath":{"type":"string","description":"Path (or pattern) where EAS Build is going to look for the application archive. See: https://github.com/mrmlnc/fast-glob#pattern-syntax","markdownDescription":"Path (or pattern) where EAS Build is going to look for the application archive.\n\nEAS Build uses the `fast-glob` npm package for pattern matching, ([See their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\n\nYou should modify that path only if you are using a custom `Gymfile`.\n\nThe default is `ios/build/Build/Products/*-iphonesimulator/*.app` when building for simulator and `ios/build/*.ipa` in other cases."},"artifactPath":{"type":"string","description":"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts. See: https://github.com/mrmlnc/fast-glob#pattern-syntax","markdownDescription":"[DEPRECATED] Use `applicationArchivePath` instead. Path (or pattern) where EAS Build is going to look for the build artifacts.\n\nEAS Build uses the `fast-glob` npm package for pattern matching, ([See their README to learn more about the syntax you can use](https://github.com/mrmlnc/fast-glob#pattern-syntax)).\n\nYou should modify that path only if you are using a custom `Gymfile`.\n\nThe default is `ios/build/Build/Products/*-iphonesimulator/*.app` when building for simulator and `ios/build/*.ipa` in other cases."},"config":{"description":"Custom workflow file name that will be used to run this iOS build. You can also specify this property on profile levle for platform-agnostic workflows. Learn more: https://docs.expo.dev/custom-builds/get-started/","type":"string"}}},"Submit":{"type":"object","description":"EAS Submit configuration. Learn more: https://docs.expo.dev/submit/eas-json/","markdownDescription":"EAS Submit configuration. [Learn more](https://docs.expo.dev/submit/eas-json/)","patternProperties":{".*":{"$ref":"#/definitions/SubmitProfile","description":"The submit profile name with the configuration."}}},"SubmitProfile":{"type":"object","properties":{"extends":{"type":"string","description":"The name of the submit profile that the current one should inherit values from."},"android":{"$ref":"#/definitions/SubmitProfileAndroid"},"ios":{"$ref":"#/definitions/SubmitProfileIos"}}},"SubmitProfileAndroid":{"type":"object","description":"The Android-specific submit profile configuration.","properties":{"serviceAccountKeyPath":{"type":"string","description":"Path to the JSON file with service account key used to authenticate with Google Play. Learn more: https://expo.fyi/creating-google-service-account","markdownDescription":"Path to the JSON file with service account key used to authenticate with Google Play. [Learn more](https://expo.fyi/creating-google-service-account)"},"track":{"enum":["beta","alpha","internal","production"],"description":"The track of the application to use. Learn more: https://support.google.com/googleplay/android-developer/answer/9859348?hl=en","markdownDescription":"The [track of the application](https://support.google.com/googleplay/android-developer/answer/9859348?hl=en) to use.","markdownEnumDescriptions":["**Open testing** releases are available to testers on Google Play. Users can join tests from your store listing.","**Closed testing** releases are available to a limited number of testers that you choose, who can test a pre-release version of your app and submit feedback.","**Internal testing** releases are available to up to 100 testers that you choose.","**Production releases** are available to all Google Play users in your chosen countries."]},"releaseStatus":{"enum":["draft","inProgress","halted","completed"],"description":"The status of a release. Learn more: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks","markdownDescription":"The status of a release. [Learn more](https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks)","enumDescriptions":["The release's APKs are not being served to users.","The release's APKs are being served to a fraction of users, if set.","The release's APKs will no longer be served to users. Users who already have these APKs are unaffected.","The release will have no further changes. Its APKs are being served to all users, unless they are eligible to APKs of a more recent release."]},"rollout":{"type":"number","description":"The initial fraction of users who are eligible to receive the release. Should be a value from 0 (no users) to 1 (all users). Works only with 'inProgress' release status. Learn more: https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks","markdownDescription":"The initial fraction of users who are eligible to receive the release. Should be a value from 0 (no users) to 1 (all users). Works only with `inProgress` release status. [Learn more](https://developers.google.com/android-publisher/api-ref/rest/v3/edits.tracks)"},"changesNotSentForReview":{"type":"boolean","description":"Indicates that the changes sent with this submission will not be reviewed until they are explicitly sent for review from the Google Play Console UI. Defaults to false.","default":false},"applicationId":{"type":"string","description":"The application id that will be used when accessing Service Account Keys managed by Expo, it does not have any effect if you are using local credentials. In most cases this value will be autodetected, but if you have multiple product flavors, this value might be necessary."}}},"SubmitProfileIos":{"type":"object","description":"The iOS-specific submit profile configuration.","properties":{"appleId":{"type":"string","description":"Your Apple ID username (you can also set the `EXPO_APPLE_ID` env variable).","markdownDescription":"Your Apple ID username (you can also set the `EXPO_APPLE_ID` env variable)."},"ascAppId":{"type":"string","description":"App Store Connect unique application Apple ID number. When set, results in skipping the app creation step. Learn more: https://expo.fyi/asc-app-id","markdownDescription":"App Store Connect unique application Apple ID number. When set, results in skipping the app creation step. [Learn more](https://expo.fyi/asc-app-id)"},"appleTeamId":{"type":"string","description":"Your Apple Developer Team ID."},"sku":{"type":"string","description":"An unique ID for your app that is not visible on the App Store, will be generated unless provided."},"language":{"type":"string","description":"Primary language. Defaults to `en-US`.","markdownDescription":"Primary language. Defaults to `en-US`."},"companyName":{"type":"string","description":"The name of your company, needed only for the first submission of any app to the App Store."},"appName":{"type":"string","description":"The name of your app as it will appear on the App Store. Defaults to `expo.name` from the app config.","markdownDescription":"The name of your app as it will appear on the App Store. Defaults to `expo.name` from the app config."},"ascApiKeyPath":{"type":"string","description":"The path to your App Store Connect Api Key .p8 file. Learn more: https://expo.fyi/creating-asc-api-key","markdownDescription":"The path to your App Store Connect Api Key .p8 file. [Learn more](https://expo.fyi/creating-asc-api-key)"},"ascApiKeyIssuerId":{"type":"string","description":"The Issuer ID of your App Store Connect Api Key. Learn more: https://expo.fyi/creating-asc-api-key","markdownDescription":"The Issuer ID of your App Store Connect Api Key. [Learn more](https://expo.fyi/creating-asc-api-key)"},"ascApiKeyId":{"type":"string","description":"The Key ID of your App Store Connect Api Key. Learn more: https://expo.fyi/creating-asc-api-key","markdownDescription":"The Key ID of your App Store Connect Api Key. [Learn more](https://expo.fyi/creating-asc-api-key)"},"bundleIdentifier":{"type":"string","description":"The Bundle identifier that will be used when accessing submit credentials managed by Expo, it does not have any effect if you are using local credentials. In most cases this value will be autodetected, but if you have multiple Xcode schemes and targets, this value might be necessary."},"groups":{"type":"array","description":"Internal TestFlight testing groups to add the build to (iOS only). Learn more: https://developer.apple.com/help/app-store-connect/test-a-beta-version/add-internal-testers","markdownDescription":"Internal TestFlight testing groups to add the build to (iOS only). [Learn more](https://developer.apple.com/help/app-store-connect/test-a-beta-version/add-internal-testers)"},"metadataPath":{"type":"string","description":"The path to your store configuration file. Learn more: https://docs.expo.dev/eas-metadata/introduction/","markdownDescription":"The path to your store configuration file. [Learn more](https://docs.expo.dev/eas-metadata/introduction/)"}}}}}
|
Provide a JSON object that satisfies the schema "eas.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
eas.schema
|
schema-store
|
schema_store_292
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/easyvcr-net\",\"$comment\":\"https://github.com/EasyPost/easyvcr-csharp\",\"title\":\"EasyVCR .NET cassette\",\"description\":\"A schema for an EasyVCR .NET recording\\nhttps://github.com/EasyPost/easyvcr-csharp\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"Duration\":{\"title\":\"Duration\",\"description\":\"How long, in milliseconds, the recorded request took to complete\",\"type\":\"integer\"},\"RecordedAt\":{\"title\":\"Recorded at\",\"description\":\"When the request was recorded\",\"type\":\"string\",\"format\":\"date-time\"},\"Request\":{\"title\":\"Request\",\"description\":\"The request that was recorded\",\"type\":\"object\",\"properties\":{\"Body\":{\"title\":\"Body\",\"description\":\"The request body\",\"type\":\"string\"},\"BodyContentType\":{\"title\":\"Body content type\",\"description\":\"The type of content in the request body\",\"type\":\"string\"},\"ContentHeaders\":{\"title\":\"Content headers\",\"description\":\"The request content headers\",\"type\":\"object\"},\"Method\":{\"title\":\"Method\",\"description\":\"The HTTP method\",\"type\":\"string\"},\"RequestHeaders\":{\"title\":\"Request headers\",\"description\":\"The request headers\",\"type\":\"object\"},\"Uri\":{\"title\":\"Uri\",\"description\":\"The request URI\",\"type\":\"string\"}}},\"Response\":{\"title\":\"Response\",\"description\":\"The response that was recorded\",\"type\":\"object\",\"properties\":{\"Body\":{\"title\":\"Body\",\"description\":\"The response body\",\"type\":\"string\"},\"BodyContentType\":{\"title\":\"Body content type\",\"description\":\"The type of content in the response body\",\"type\":\"string\"},\"ContentHeaders\":{\"title\":\"Content headers\",\"description\":\"The response content headers\",\"type\":\"object\"},\"HttpVersion\":{\"title\":\"HTTP version\",\"description\":\"The HTTP version\",\"type\":\"string\"},\"ResponseHeaders\":{\"title\":\"Response headers\",\"description\":\"The response headers\",\"type\":\"object\"},\"Status\":{\"title\":\"Status\",\"description\":\"The HTTP status\",\"type\":\"object\",\"properties\":{\"Code\":{\"title\":\"Code\",\"description\":\"The HTTP status code\",\"type\":\"integer\"},\"Message\":{\"title\":\"Description\",\"description\":\"The HTTP status code description\",\"type\":\"string\"}}}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"EasyVCR .NET cassette\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/easyvcr-net","$comment":"https://github.com/EasyPost/easyvcr-csharp","title":"EasyVCR .NET cassette","description":"A schema for an EasyVCR .NET recording\nhttps://github.com/EasyPost/easyvcr-csharp","type":"array","items":{"type":"object","additionalProperties":true,"properties":{"Duration":{"title":"Duration","description":"How long, in milliseconds, the recorded request took to complete","type":"integer"},"RecordedAt":{"title":"Recorded at","description":"When the request was recorded","type":"string","format":"date-time"},"Request":{"title":"Request","description":"The request that was recorded","type":"object","properties":{"Body":{"title":"Body","description":"The request body","type":"string"},"BodyContentType":{"title":"Body content type","description":"The type of content in the request body","type":"string"},"ContentHeaders":{"title":"Content headers","description":"The request content headers","type":"object"},"Method":{"title":"Method","description":"The HTTP method","type":"string"},"RequestHeaders":{"title":"Request headers","description":"The request headers","type":"object"},"Uri":{"title":"Uri","description":"The request URI","type":"string"}}},"Response":{"title":"Response","description":"The response that was recorded","type":"object","properties":{"Body":{"title":"Body","description":"The response body","type":"string"},"BodyContentType":{"title":"Body content type","description":"The type of content in the response body","type":"string"},"ContentHeaders":{"title":"Content headers","description":"The response content headers","type":"object"},"HttpVersion":{"title":"HTTP version","description":"The HTTP version","type":"string"},"ResponseHeaders":{"title":"Response headers","description":"The response headers","type":"object"},"Status":{"title":"Status","description":"The HTTP status","type":"object","properties":{"Code":{"title":"Code","description":"The HTTP status code","type":"integer"},"Message":{"title":"Description","description":"The HTTP status code description","type":"string"}}}}}}}}
|
Provide a JSON object that satisfies the schema "EasyVCR .NET cassette". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
EasyVCR .NET cassette
|
schema-store
|
schema_store_293
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/electron-builder.json\",\"additionalProperties\":false,\"definitions\":{\"AppImageOptions\":{\"additionalProperties\":false,\"properties\":{\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"category\":{\"description\":\"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).\",\"type\":[\"null\",\"string\"]},\"description\":{\"description\":\"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.\",\"type\":[\"null\",\"string\"]},\"desktop\":{\"description\":\"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).\"},\"license\":{\"description\":\"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). Only plain text is supported.\",\"type\":[\"null\",\"string\"]},\"mimeTypes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"synopsis\":{\"description\":\"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).\",\"type\":[\"null\",\"string\"]},\"systemIntegration\":{\"default\":\"ask\",\"description\":\"The system integration installation.\",\"enum\":[\"ask\",\"doNotAsk\"],\"type\":\"string\"}},\"title\":\"AppImageOptions\",\"type\":\"object\"},\"AppXOptions\":{\"additionalProperties\":false,\"properties\":{\"addAutoLaunchExtension\":{\"description\":\"Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.\",\"type\":\"boolean\"},\"applicationId\":{\"description\":\"The application id. Defaults to `identityName`. Can't start with numbers.\",\"type\":\"string\"},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"backgroundColor\":{\"default\":\"#464646\",\"description\":\"The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).\",\"type\":[\"null\",\"string\"]},\"displayName\":{\"description\":\"A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).\\nDefaults to the application product name.\",\"type\":[\"null\",\"string\"]},\"electronUpdaterAware\":{\"default\":false,\"type\":\"boolean\"},\"identityName\":{\"description\":\"The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).\",\"type\":[\"null\",\"string\"]},\"languages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.\\nThe first entry (index 0) will be the default language.\\nDefaults to en-US if omitted.\"},\"makeappxArgs\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"publisher\":{\"description\":\"The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.\",\"type\":[\"null\",\"string\"]},\"publisherDisplayName\":{\"description\":\"A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).\\nDefaults to company name from the application metadata.\",\"type\":[\"null\",\"string\"]},\"showNameOnTiles\":{\"description\":\"Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.\",\"type\":\"boolean\"},\"setBuildNumber\":{\"description\":\"Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875\",\"type\":\"boolean\"}},\"title\":\"AppXOptions\",\"type\":\"object\"},\"AsarOptions\":{\"additionalProperties\":false,\"properties\":{\"externalAllowed\":{\"default\":false,\"description\":\"Allows external asar files.\",\"type\":\"boolean\"},\"ordering\":{\"type\":[\"null\",\"string\"]},\"smartUnpack\":{\"default\":true,\"description\":\"Whether to automatically unpack executables files.\",\"type\":\"boolean\"}},\"title\":\"AsarOptions\",\"type\":\"object\"},\"BintrayOptions\":{\"additionalProperties\":false,\"description\":\"[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page (\\\"Edit Your Profile\\\" -> API Key).\\nDefine `BT_TOKEN` environment variable.\",\"properties\":{\"component\":{\"description\":\"The Bintray component (Debian only).\",\"type\":[\"null\",\"string\"]},\"distribution\":{\"default\":\"stable\",\"description\":\"The Bintray distribution (Debian only).\",\"type\":[\"null\",\"string\"]},\"owner\":{\"description\":\"The owner.\",\"type\":[\"null\",\"string\"]},\"package\":{\"description\":\"The Bintray package name.\",\"type\":[\"null\",\"string\"]},\"provider\":{\"description\":\"The provider. Must be `bintray`.\",\"enum\":[\"bintray\"],\"type\":\"string\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"repo\":{\"default\":\"generic\",\"description\":\"The Bintray repository name.\",\"type\":[\"null\",\"string\"]},\"token\":{\"type\":[\"null\",\"string\"]},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]},\"user\":{\"description\":\"The Bintray user account. Used in cases where the owner is an organization.\",\"type\":[\"null\",\"string\"]}},\"required\":[\"provider\"],\"title\":\"BintrayOptions\",\"type\":\"object\"},\"CustomPublishOptions\":{\"additionalProperties\":{},\"properties\":{\"provider\":{\"$ref\":\"#/definitions/PublishProvider\",\"description\":\"The provider.\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]}},\"required\":[\"provider\"],\"title\":\"CustomPublishOptions\",\"type\":\"object\"},\"DebOptions\":{\"additionalProperties\":false,\"properties\":{\"afterInstall\":{\"type\":[\"null\",\"string\"]},\"afterRemove\":{\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"category\":{\"description\":\"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"bzip2\",\"gz\",\"xz\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"xz\",\"description\":\"The compression type.\"},\"depends\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"Package dependencies. Defaults to `[\\\"gconf2\\\", \\\"gconf-service\\\", \\\"libnotify4\\\", \\\"libappindicator1\\\", \\\"libxtst6\\\", \\\"libnss3\\\"]`.\"},\"description\":{\"description\":\"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.\",\"type\":[\"null\",\"string\"]},\"desktop\":{\"description\":\"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).\"},\"fpm\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\\n\\nExample: `[\\\"--before-install=build/deb-preinstall.sh\\\", \\\"--after-upgrade=build/deb-postinstall.sh\\\"]`\"},\"icon\":{\"type\":\"string\"},\"maintainer\":{\"type\":[\"null\",\"string\"]},\"mimeTypes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.\"},\"packageCategory\":{\"description\":\"The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section).\",\"type\":[\"null\",\"string\"]},\"priority\":{\"description\":\"The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute.\",\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"synopsis\":{\"description\":\"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).\",\"type\":[\"null\",\"string\"]},\"vendor\":{\"type\":[\"null\",\"string\"]}},\"title\":\"DebOptions\",\"type\":\"object\"},\"DmgContent\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"The name of the file within the DMG. Defaults to basename of `path`.\",\"type\":\"string\"},\"path\":{\"description\":\"The path of the file within the DMG.\",\"type\":\"string\"},\"type\":{\"enum\":[\"dir\",\"file\",\"link\"],\"type\":\"string\"},\"x\":{\"type\":\"number\"},\"y\":{\"type\":\"number\"}},\"required\":[\"x\",\"y\"],\"title\":\"DmgContent\",\"type\":\"object\"},\"DmgOptions\":{\"additionalProperties\":false,\"properties\":{\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"background\":{\"description\":\"The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.\\nIf background is not specified, use `window.size`. Default locations expected background size to be 540x380.\",\"type\":[\"null\",\"string\"]},\"backgroundColor\":{\"description\":\"The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.\",\"type\":[\"null\",\"string\"]},\"contents\":{\"description\":\"The content \\u2014 to customize icon locations.\",\"items\":{\"$ref\":\"#/definitions/DmgContent\"},\"type\":\"array\"},\"format\":{\"default\":\"UDZO\",\"description\":\"The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).\",\"enum\":[\"UDBZ\",\"UDCO\",\"UDRO\",\"UDRW\",\"UDZO\",\"ULFO\"],\"type\":\"string\"},\"icon\":{\"description\":\"The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to the application icon (`build/icon.icns`).\",\"type\":[\"null\",\"string\"]},\"iconSize\":{\"default\":80,\"description\":\"The size of all the icons inside the DMG.\",\"type\":[\"null\",\"number\"]},\"iconTextSize\":{\"default\":12,\"description\":\"The size of all the icon texts inside the DMG.\",\"type\":[\"null\",\"number\"]},\"internetEnabled\":{\"default\":false,\"description\":\"Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).\",\"type\":\"boolean\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"title\":{\"default\":\"${productName} ${version}\",\"description\":\"The title of the produced DMG, which will be shown when mounted (volume name).\\n\\nMacro `${productName}`, `${version}` and `${name}` are supported.\",\"type\":[\"null\",\"string\"]},\"window\":{\"$ref\":\"#/definitions/DmgWindow\",\"description\":\"The DMG windows position and size.\"}},\"title\":\"DmgOptions\",\"type\":\"object\"},\"DmgWindow\":{\"additionalProperties\":false,\"properties\":{\"height\":{\"description\":\"The height. Defaults to background image height or 380.\",\"type\":\"number\"},\"width\":{\"description\":\"The width. Defaults to background image width or 540.\",\"type\":\"number\"},\"x\":{\"default\":400,\"description\":\"The X position relative to left of the screen.\",\"type\":\"number\"},\"y\":{\"default\":100,\"description\":\"The Y position relative to top of the screen.\",\"type\":\"number\"}},\"title\":\"DmgWindow\",\"type\":\"object\"},\"ElectronDownloadOptions\":{\"additionalProperties\":false,\"properties\":{\"arch\":{\"type\":\"string\"},\"cache\":{\"description\":\"The [cache location](https://github.com/electron-userland/electron-download#cache-location).\",\"type\":[\"null\",\"string\"]},\"customDir\":{\"type\":[\"null\",\"string\"]},\"customFilename\":{\"type\":[\"null\",\"string\"]},\"isVerifyChecksum\":{\"type\":\"boolean\"},\"mirror\":{\"description\":\"The mirror.\",\"type\":[\"null\",\"string\"]},\"platform\":{\"enum\":[\"darwin\",\"linux\",\"mas\",\"win32\"],\"type\":\"string\"},\"strictSSL\":{\"type\":\"boolean\"},\"version\":{\"type\":\"string\"}},\"title\":\"ElectronDownloadOptions\",\"type\":\"object\"},\"FileAssociation\":{\"additionalProperties\":false,\"description\":\"File associations.\\n\\nmacOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.\\n\\nOn Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.\",\"properties\":{\"description\":{\"description\":\"*windows-only.* The description.\",\"type\":[\"null\",\"string\"]},\"ext\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The extension (minus the leading period). e.g. `png`.\"},\"icon\":{\"description\":\"The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.\\n\\nNot supported on Linux, file issue if need (default icon will be `x-office-document`).\",\"type\":[\"null\",\"string\"]},\"isPackage\":{\"description\":\"*macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.\",\"type\":\"boolean\"},\"mimeType\":{\"description\":\"*linux-only.* The mime-type.\",\"type\":[\"null\",\"string\"]},\"name\":{\"description\":\"The name. e.g. `PNG`. Defaults to `ext`.\",\"type\":[\"null\",\"string\"]},\"role\":{\"default\":\"Editor\",\"description\":\"*macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.\",\"type\":\"string\"}},\"required\":[\"ext\"],\"title\":\"FileAssociation\",\"type\":\"object\"},\"FileSet\":{\"additionalProperties\":false,\"properties\":{\"filter\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The [glob patterns](/file-patterns).\"},\"from\":{\"description\":\"The source path relative to the project directory.\",\"type\":\"string\"},\"to\":{\"description\":\"The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.\",\"type\":\"string\"}},\"title\":\"FileSet\",\"type\":\"object\"},\"GenericServerOptions\":{\"additionalProperties\":false,\"description\":\"Generic (any HTTP(S) server) options.\\nIn all publish options [File Macros](/file-patterns#file-macros) are supported.\",\"properties\":{\"channel\":{\"default\":\"latest\",\"description\":\"The channel.\",\"type\":[\"null\",\"string\"]},\"provider\":{\"description\":\"The provider. Must be `generic`.\",\"enum\":[\"generic\"],\"type\":\"string\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]},\"url\":{\"description\":\"The base url. e.g. `https://bucket_name.s3.amazonaws.com`.\",\"type\":\"string\"},\"useMultipleRangeRequest\":{\"description\":\"Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.\",\"type\":\"boolean\"}},\"required\":[\"provider\",\"url\"],\"title\":\"GenericServerOptions\",\"type\":\"object\"},\"GithubOptions\":{\"additionalProperties\":false,\"description\":\"[GitHub](https://help.github.com/articles/about-releases/) options.\\n\\nGitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.\\nDefine `GH_TOKEN` environment variable.\",\"properties\":{\"host\":{\"default\":\"github.com\",\"description\":\"The host (including the port if need).\",\"type\":[\"null\",\"string\"]},\"owner\":{\"description\":\"The owner.\",\"type\":[\"null\",\"string\"]},\"private\":{\"description\":\"Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).\",\"type\":[\"null\",\"boolean\"]},\"protocol\":{\"anyOf\":[{\"enum\":[\"http\",\"https\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"https\",\"description\":\"The protocol. GitHub Publisher supports only `https`.\"},\"provider\":{\"description\":\"The provider. Must be `github`.\",\"enum\":[\"github\"],\"type\":\"string\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"releaseType\":{\"anyOf\":[{\"enum\":[\"draft\",\"prerelease\",\"release\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"draft\",\"description\":\"The type of release. By default `draft` release will be created.\\n\\nAlso you can set release type using environment variable. If `EP_DRAFT`is set to `true` \\u2014 `draft`, if `EP_PRE_RELEASE`is set to `true` \\u2014 `prerelease`.\"},\"repo\":{\"description\":\"The repository name. [Detected automatically](#github-repository-and-bintray-package).\",\"type\":[\"null\",\"string\"]},\"token\":{\"description\":\"The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).\",\"type\":[\"null\",\"string\"]},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]},\"vPrefixedTagName\":{\"default\":true,\"description\":\"Whether to use `v`-prefixed tag name.\",\"type\":\"boolean\"}},\"required\":[\"provider\"],\"title\":\"GithubOptions\",\"type\":\"object\"},\"LinuxConfiguration\":{\"additionalProperties\":false,\"properties\":{\"appId\":{\"default\":\"com.electron.${name}\",\"description\":\"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\",\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\",\"type\":[\"null\",\"string\"]},\"asar\":{\"anyOf\":[{\"$ref\":\"#/definitions/AsarOptions\"},{\"type\":[\"null\",\"boolean\"]}],\"default\":true,\"description\":\"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\\n\\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\"},\"asarUnpack\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\"},\"category\":{\"description\":\"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"maximum\",\"normal\",\"store\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"normal\",\"description\":\"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\"},\"cscKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscLink\":{\"type\":[\"null\",\"string\"]},\"depends\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"description\":{\"description\":\"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.\",\"type\":[\"null\",\"string\"]},\"desktop\":{\"description\":\"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).\"},\"detectUpdateChannel\":{\"default\":true,\"description\":\"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\",\"type\":\"boolean\"},\"electronUpdaterCompatibility\":{\"description\":\"The [electron-updater compatibility](/auto-update#compatibility) semver range.\",\"type\":[\"null\",\"string\"]},\"executableName\":{\"description\":\"The executable name. Defaults to `productName`.\\nCannot be specified per target, allowed only in the `linux`.\",\"type\":[\"null\",\"string\"]},\"extraFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"extraResources\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"fileAssociations\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileAssociation\"},{\"items\":{\"$ref\":\"#/definitions/FileAssociation\"},\"type\":\"array\"}],\"description\":\"The file associations.\"},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"forceCodeSigning\":{\"description\":\"Whether to fail if app will be not code signed.\",\"type\":\"boolean\"},\"generateUpdatesFilesForAllChannels\":{\"default\":false,\"description\":\"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\",\"type\":\"boolean\"},\"icon\":{\"description\":\"The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.\\nBy default will be generated automatically based on the macOS icns file.\",\"type\":\"string\"},\"maintainer\":{\"description\":\"The maintainer. Defaults to [author](/configuration/configuration#Metadata-author).\",\"type\":[\"null\",\"string\"]},\"mimeTypes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.\"},\"packageCategory\":{\"description\":\"backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place\",\"type\":[\"null\",\"string\"]},\"protocols\":{\"anyOf\":[{\"$ref\":\"#/definitions/Protocol\"},{\"items\":{\"$ref\":\"#/definitions/Protocol\"},\"type\":\"array\"}],\"description\":\"The URL protocol schemes.\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"releaseInfo\":{\"$ref\":\"#/definitions/ReleaseInfo\",\"description\":\"The release info. Intended for command line usage:\\n\\n```\\n-c.releaseInfo.releaseNotes=\\\"new features\\\"\\n```\"},\"synopsis\":{\"description\":\"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).\",\"type\":[\"null\",\"string\"]},\"target\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"default\":\"AppImage\",\"description\":\"Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\\n\\nelectron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform.\\n\\nPlease [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz.\"},\"vendor\":{\"description\":\"The vendor. Defaults to [author](/configuration/configuration#Metadata-author).\",\"type\":[\"null\",\"string\"]}},\"title\":\"LinuxConfiguration\",\"type\":\"object\"},\"LinuxTargetSpecificOptions\":{\"additionalProperties\":false,\"properties\":{\"afterInstall\":{\"type\":[\"null\",\"string\"]},\"afterRemove\":{\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"category\":{\"description\":\"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"bzip2\",\"gz\",\"xz\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"xz\",\"description\":\"The compression type.\"},\"depends\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"Package dependencies.\"},\"description\":{\"description\":\"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.\",\"type\":[\"null\",\"string\"]},\"desktop\":{\"description\":\"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).\"},\"fpm\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\\n\\nExample: `[\\\"--before-install=build/deb-preinstall.sh\\\", \\\"--after-upgrade=build/deb-postinstall.sh\\\"]`\"},\"icon\":{\"type\":\"string\"},\"maintainer\":{\"type\":[\"null\",\"string\"]},\"mimeTypes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.\"},\"packageCategory\":{\"description\":\"The package category.\",\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"synopsis\":{\"description\":\"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).\",\"type\":[\"null\",\"string\"]},\"vendor\":{\"type\":[\"null\",\"string\"]}},\"title\":\"LinuxTargetSpecificOptions\",\"type\":\"object\"},\"MacConfiguration\":{\"additionalProperties\":false,\"properties\":{\"appId\":{\"default\":\"com.electron.${name}\",\"description\":\"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\",\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\",\"type\":[\"null\",\"string\"]},\"asar\":{\"anyOf\":[{\"$ref\":\"#/definitions/AsarOptions\"},{\"type\":[\"null\",\"boolean\"]}],\"default\":true,\"description\":\"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\\n\\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\"},\"asarUnpack\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\"},\"binaries\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"Paths of any extra binaries that need to be signed.\"},\"bundleShortVersion\":{\"description\":\"The `CFBundleShortVersionString`. Do not use it unless you need to.\",\"type\":[\"null\",\"string\"]},\"bundleVersion\":{\"description\":\"The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).\",\"type\":[\"null\",\"string\"]},\"category\":{\"description\":\"The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\\n\\nFor example, `\\\"category\\\": \\\"public.app-category.developer-tools\\\"` will set the application category to *Developer Tools*.\\n\\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"maximum\",\"normal\",\"store\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"normal\",\"description\":\"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\"},\"cscInstallerKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscInstallerLink\":{\"type\":[\"null\",\"string\"]},\"cscKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscLink\":{\"type\":[\"null\",\"string\"]},\"darkModeSupport\":{\"default\":false,\"description\":\"Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.\",\"type\":\"boolean\"},\"hardenedRuntime\":{\"default\":false,\"description\":\"Whether your app has to be signed with hardened runtime.\",\"type\":\"boolean\"},\"gatekeeperAssess\":{\"default\":false,\"description\":\"Whether to let electron-osx-sign validate the signing or not.\",\"type\":\"boolean\"},\"detectUpdateChannel\":{\"default\":true,\"description\":\"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\",\"type\":\"boolean\"},\"electronLanguages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The electron locales. By default Electron locales used as is.\"},\"electronUpdaterCompatibility\":{\"description\":\"The [electron-updater compatibility](/auto-update#compatibility) semver range.\",\"type\":[\"null\",\"string\"]},\"entitlements\":{\"description\":\"The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).\\nMAS entitlements is specified in the [mas](/configuration/mas).\",\"type\":[\"null\",\"string\"]},\"entitlementsInherit\":{\"description\":\"The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).\\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).\\n\\nThis option only applies when signing with `entitlements` provided.\",\"type\":[\"null\",\"string\"]},\"extendInfo\":{\"description\":\"The extra entries for `Info.plist`.\"},\"extraDistFiles\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"Extra files to put in archive. Not applicable for `tar.*`.\"},\"extraFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"extraResources\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"fileAssociations\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileAssociation\"},{\"items\":{\"$ref\":\"#/definitions/FileAssociation\"},\"type\":\"array\"}],\"description\":\"The file associations.\"},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"forceCodeSigning\":{\"description\":\"Whether to fail if app will be not code signed.\",\"type\":\"boolean\"},\"generateUpdatesFilesForAllChannels\":{\"default\":false,\"description\":\"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\",\"type\":\"boolean\"},\"helperBundleId\":{\"default\":\"${appBundleIdentifier}.helper\",\"description\":\"The bundle identifier to use in the application helper's plist.\",\"type\":[\"null\",\"string\"]},\"icon\":{\"default\":\"build/icon.icns\",\"description\":\"The path to application icon.\",\"type\":[\"null\",\"string\"]},\"identity\":{\"description\":\"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\\nMAS installer identity is specified in the [mas](/configuration/mas).\",\"type\":[\"null\",\"string\"]},\"minimumSystemVersion\":{\"description\":\"The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.\",\"type\":[\"null\",\"string\"]},\"protocols\":{\"anyOf\":[{\"$ref\":\"#/definitions/Protocol\"},{\"items\":{\"$ref\":\"#/definitions/Protocol\"},\"type\":\"array\"}],\"description\":\"The URL protocol schemes.\"},\"provisioningProfile\":{\"description\":\"The path to the provisioning profile to use when signing, absolute or relative to the app root.\",\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"releaseInfo\":{\"$ref\":\"#/definitions/ReleaseInfo\",\"description\":\"The release info. Intended for command line usage:\\n\\n```\\n-c.releaseInfo.releaseNotes=\\\"new features\\\"\\n```\"},\"requirements\":{\"description\":\"Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.\",\"type\":[\"null\",\"string\"]},\"target\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"enum\":[\"7z\",\"default\",\"dir\",\"dmg\",\"mas\",\"mas-dev\",\"pkg\",\"tar.bz2\",\"tar.gz\",\"tar.lz\",\"tar.xz\",\"zip\"],\"type\":\"string\"}]},\"type\":\"array\"},{\"enum\":[\"7z\",\"default\",\"dir\",\"dmg\",\"mas\",\"mas-dev\",\"pkg\",\"tar.bz2\",\"tar.gz\",\"tar.lz\",\"tar.xz\",\"zip\"],\"type\":\"string\"},{\"type\":\"null\"}],\"description\":\"The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).\"},\"type\":{\"anyOf\":[{\"enum\":[\"development\",\"distribution\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"distribution\",\"description\":\"Whether to sign app for development or for distribution.\"}},\"title\":\"MacConfiguration\",\"type\":\"object\"},\"MasConfiguration\":{\"additionalProperties\":false,\"properties\":{\"appId\":{\"default\":\"com.electron.${name}\",\"description\":\"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\",\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\",\"type\":[\"null\",\"string\"]},\"asar\":{\"anyOf\":[{\"$ref\":\"#/definitions/AsarOptions\"},{\"type\":[\"null\",\"boolean\"]}],\"default\":true,\"description\":\"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\\n\\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\"},\"asarUnpack\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\"},\"binaries\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"Paths of any extra binaries that need to be signed.\"},\"bundleShortVersion\":{\"description\":\"The `CFBundleShortVersionString`. Do not use it unless you need to.\",\"type\":[\"null\",\"string\"]},\"bundleVersion\":{\"description\":\"The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).\",\"type\":[\"null\",\"string\"]},\"category\":{\"description\":\"The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\\n\\nFor example, `\\\"category\\\": \\\"public.app-category.developer-tools\\\"` will set the application category to *Developer Tools*.\\n\\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"maximum\",\"normal\",\"store\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"normal\",\"description\":\"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\"},\"cscInstallerKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscInstallerLink\":{\"type\":[\"null\",\"string\"]},\"cscKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscLink\":{\"type\":[\"null\",\"string\"]},\"darkModeSupport\":{\"default\":false,\"description\":\"Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.\",\"type\":\"boolean\"},\"hardenedRuntime\":{\"default\":false,\"description\":\"Whether your app has to be signed with hardened runtime.\",\"type\":\"boolean\"},\"detectUpdateChannel\":{\"default\":true,\"description\":\"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\",\"type\":\"boolean\"},\"electronLanguages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"string\"}],\"description\":\"The electron locales. By default Electron locales used as is.\"},\"electronUpdaterCompatibility\":{\"description\":\"The [electron-updater compatibility](/auto-update#compatibility) semver range.\",\"type\":[\"null\",\"string\"]},\"entitlements\":{\"description\":\"The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).\\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).\",\"type\":[\"null\",\"string\"]},\"entitlementsInherit\":{\"description\":\"The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).\\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).\",\"type\":[\"null\",\"string\"]},\"extendInfo\":{\"description\":\"The extra entries for `Info.plist`.\"},\"extraDistFiles\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"Extra files to put in archive. Not applicable for `tar.*`.\"},\"extraFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"extraResources\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"fileAssociations\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileAssociation\"},{\"items\":{\"$ref\":\"#/definitions/FileAssociation\"},\"type\":\"array\"}],\"description\":\"The file associations.\"},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"forceCodeSigning\":{\"description\":\"Whether to fail if app will be not code signed.\",\"type\":\"boolean\"},\"generateUpdatesFilesForAllChannels\":{\"default\":false,\"description\":\"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\",\"type\":\"boolean\"},\"helperBundleId\":{\"default\":\"${appBundleIdentifier}.helper\",\"description\":\"The bundle identifier to use in the application helper's plist.\",\"type\":[\"null\",\"string\"]},\"icon\":{\"default\":\"build/icon.icns\",\"description\":\"The path to application icon.\",\"type\":[\"null\",\"string\"]},\"identity\":{\"description\":\"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\\nMAS installer identity is specified in the [mas](/configuration/mas).\",\"type\":[\"null\",\"string\"]},\"minimumSystemVersion\":{\"description\":\"The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.\",\"type\":[\"null\",\"string\"]},\"protocols\":{\"anyOf\":[{\"$ref\":\"#/definitions/Protocol\"},{\"items\":{\"$ref\":\"#/definitions/Protocol\"},\"type\":\"array\"}],\"description\":\"The URL protocol schemes.\"},\"provisioningProfile\":{\"description\":\"The path to the provisioning profile to use when signing, absolute or relative to the app root.\",\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"releaseInfo\":{\"$ref\":\"#/definitions/ReleaseInfo\",\"description\":\"The release info. Intended for command line usage:\\n\\n```\\n-c.releaseInfo.releaseNotes=\\\"new features\\\"\\n```\"},\"requirements\":{\"description\":\"Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.\",\"type\":[\"null\",\"string\"]},\"target\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"enum\":[\"7z\",\"default\",\"dir\",\"dmg\",\"mas\",\"mas-dev\",\"pkg\",\"tar.bz2\",\"tar.gz\",\"tar.lz\",\"tar.xz\",\"zip\"],\"type\":\"string\"}]},\"type\":\"array\"},{\"enum\":[\"7z\",\"default\",\"dir\",\"dmg\",\"mas\",\"mas-dev\",\"pkg\",\"tar.bz2\",\"tar.gz\",\"tar.lz\",\"tar.xz\",\"zip\"],\"type\":\"string\"},{\"type\":\"null\"}],\"description\":\"The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).\"},\"type\":{\"anyOf\":[{\"enum\":[\"development\",\"distribution\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"distribution\",\"description\":\"Whether to sign app for development or for distribution.\"}},\"title\":\"MasConfiguration\",\"type\":\"object\"},\"MetadataDirectories\":{\"additionalProperties\":false,\"properties\":{\"app\":{\"description\":\"The application directory (containing the application package.json), defaults to `app`, `www` or working directory.\",\"type\":[\"null\",\"string\"]},\"buildResources\":{\"default\":\"build\",\"description\":\"The path to build resources.\\n\\nPlease note \\u2014 build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `\\\"files\\\": [\\\"**\\\\/*\\\", \\\"build/icon.*\\\"]`\",\"type\":[\"null\",\"string\"]},\"output\":{\"default\":\"dist\",\"description\":\"The output directory. [File macros](/file-patterns#file-macros) are supported.\",\"type\":[\"null\",\"string\"]}},\"title\":\"MetadataDirectories\",\"type\":\"object\"},\"MsiOptions\":{\"additionalProperties\":false,\"properties\":{\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"createDesktopShortcut\":{\"default\":true,\"description\":\"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).\",\"enum\":[\"always\",false,true]},\"createStartMenuShortcut\":{\"default\":true,\"description\":\"Whether to create start menu shortcut.\",\"type\":\"boolean\"},\"menuCategory\":{\"default\":false,\"description\":\"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.\",\"type\":[\"string\",\"boolean\"]},\"oneClick\":{\"default\":true,\"description\":\"One-click installation.\",\"type\":\"boolean\"},\"perMachine\":{\"default\":false,\"description\":\"Whether to install per all users (per-machine).\",\"type\":\"boolean\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"runAfterFinish\":{\"default\":true,\"description\":\"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.\",\"type\":\"boolean\"},\"shortcutName\":{\"description\":\"The name that will be used for all shortcuts. Defaults to the application name.\",\"type\":[\"null\",\"string\"]},\"upgradeCode\":{\"description\":\"The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.\",\"type\":[\"null\",\"string\"]},\"warningsAsErrors\":{\"default\":true,\"description\":\"If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.\",\"type\":\"boolean\"}},\"title\":\"MsiOptions\",\"type\":\"object\"},\"NsisOptions\":{\"additionalProperties\":false,\"properties\":{\"allowElevation\":{\"default\":true,\"description\":\"*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.\",\"type\":\"boolean\"},\"allowToChangeInstallationDirectory\":{\"default\":false,\"description\":\"*assisted installer only.* Whether to allow user to change installation directory.\",\"type\":\"boolean\"},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.\",\"type\":[\"null\",\"string\"]},\"createDesktopShortcut\":{\"default\":true,\"description\":\"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).\",\"enum\":[\"always\",false,true]},\"createStartMenuShortcut\":{\"default\":true,\"description\":\"Whether to create start menu shortcut.\",\"type\":\"boolean\"},\"deleteAppDataOnUninstall\":{\"default\":false,\"description\":\"*one-click installer only.* Whether to delete app data on uninstall.\",\"type\":\"boolean\"},\"differentialPackage\":{\"description\":\"Defaults to `true` for web installer (`nsis-web`)\",\"type\":\"boolean\"},\"displayLanguageSelector\":{\"default\":false,\"description\":\"Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).\",\"type\":\"boolean\"},\"guid\":{\"description\":\"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).\",\"type\":[\"null\",\"string\"]},\"include\":{\"description\":\"The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).\",\"type\":[\"null\",\"string\"]},\"installerHeader\":{\"default\":\"build/installerHeader.bmp\",\"description\":\"*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\",\"type\":[\"null\",\"string\"]},\"installerHeaderIcon\":{\"description\":\"*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerHeaderIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"installerIcon\":{\"description\":\"The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"installerLanguages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what.\"},\"installerSidebar\":{\"description\":\"*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\\\\\Contrib\\\\\\\\Graphics\\\\\\\\Wizard\\\\\\\\nsis3-metro.bmp`. Image size 164 \\u00d7 314 pixels.\",\"type\":[\"null\",\"string\"]},\"language\":{\"description\":\"[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).\",\"type\":[\"null\",\"string\"]},\"license\":{\"description\":\"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\\\"_blank\\\"` for links).\\n\\nMultiple license files in different languages are supported \\u2014 use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\\n\\nAppropriate license file will be selected by user OS language.\",\"type\":[\"null\",\"string\"]},\"menuCategory\":{\"default\":false,\"description\":\"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.\",\"type\":[\"string\",\"boolean\"]},\"multiLanguageInstaller\":{\"description\":\"Whether to create multi-language installer. Defaults to `unicode` option value.\",\"type\":\"boolean\"},\"oneClick\":{\"default\":true,\"description\":\"Whether to create one-click installer or assisted.\",\"type\":\"boolean\"},\"packElevateHelper\":{\"default\":true,\"description\":\"Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.\",\"type\":\"boolean\"},\"perMachine\":{\"default\":false,\"description\":\"Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\\n\\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\\n\\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\\n\\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.\",\"type\":\"boolean\"},\"preCompressedFileExtensions\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"default\":[\".avi\",\".mov\",\".m4v\",\".mp4\",\".m4p\",\".qt\",\".mkv\",\".webm\",\".vmdk\"],\"description\":\"The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files.\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"runAfterFinish\":{\"default\":true,\"description\":\"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.\",\"type\":\"boolean\"},\"script\":{\"description\":\"The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).\",\"type\":[\"null\",\"string\"]},\"shortcutName\":{\"description\":\"The name that will be used for all shortcuts. Defaults to the application name.\",\"type\":[\"null\",\"string\"]},\"unicode\":{\"default\":true,\"description\":\"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).\",\"type\":\"boolean\"},\"uninstallDisplayName\":{\"default\":\"${productName} ${version}\",\"description\":\"The uninstaller display name in the control panel.\",\"type\":\"string\"},\"uninstallerIcon\":{\"description\":\"The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/uninstallerIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"uninstallerSidebar\":{\"description\":\"*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\\\\\Contrib\\\\\\\\Graphics\\\\\\\\Wizard\\\\\\\\nsis3-metro.bmp`\",\"type\":[\"null\",\"string\"]},\"useZip\":{\"default\":false,\"type\":\"boolean\"},\"warningsAsErrors\":{\"default\":true,\"description\":\"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.\",\"type\":\"boolean\"}},\"title\":\"NsisOptions\",\"type\":\"object\"},\"NsisWebOptions\":{\"additionalProperties\":false,\"description\":\"Web Installer options.\",\"properties\":{\"allowElevation\":{\"default\":true,\"description\":\"*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.\",\"type\":\"boolean\"},\"allowToChangeInstallationDirectory\":{\"default\":false,\"description\":\"*assisted installer only.* Whether to allow user to change installation directory.\",\"type\":\"boolean\"},\"appPackageUrl\":{\"description\":\"The application package download URL. Optional \\u2014 by default computed using publish configuration.\\n\\nURL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).\\nPlease note \\u2014 it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).\\n\\nCustom `X-Arch` http header is set to `32` or `64`.\",\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`.\",\"type\":[\"null\",\"string\"]},\"createDesktopShortcut\":{\"default\":true,\"description\":\"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).\",\"enum\":[\"always\",false,true]},\"createStartMenuShortcut\":{\"default\":true,\"description\":\"Whether to create start menu shortcut.\",\"type\":\"boolean\"},\"deleteAppDataOnUninstall\":{\"default\":false,\"description\":\"*one-click installer only.* Whether to delete app data on uninstall.\",\"type\":\"boolean\"},\"differentialPackage\":{\"description\":\"Defaults to `true` for web installer (`nsis-web`)\",\"type\":\"boolean\"},\"displayLanguageSelector\":{\"default\":false,\"description\":\"Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).\",\"type\":\"boolean\"},\"guid\":{\"description\":\"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).\",\"type\":[\"null\",\"string\"]},\"include\":{\"description\":\"The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).\",\"type\":[\"null\",\"string\"]},\"installerHeader\":{\"default\":\"build/installerHeader.bmp\",\"description\":\"*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\",\"type\":[\"null\",\"string\"]},\"installerHeaderIcon\":{\"description\":\"*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerHeaderIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"installerIcon\":{\"description\":\"The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"installerLanguages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what.\"},\"installerSidebar\":{\"description\":\"*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\\\\\Contrib\\\\\\\\Graphics\\\\\\\\Wizard\\\\\\\\nsis3-metro.bmp`. Image size 164 \\u00d7 314 pixels.\",\"type\":[\"null\",\"string\"]},\"language\":{\"description\":\"[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).\",\"type\":[\"null\",\"string\"]},\"license\":{\"description\":\"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\\\"_blank\\\"` for links).\\n\\nMultiple license files in different languages are supported \\u2014 use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\\n\\nAppropriate license file will be selected by user OS language.\",\"type\":[\"null\",\"string\"]},\"menuCategory\":{\"default\":false,\"description\":\"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.\",\"type\":[\"string\",\"boolean\"]},\"multiLanguageInstaller\":{\"description\":\"Whether to create multi-language installer. Defaults to `unicode` option value.\",\"type\":\"boolean\"},\"oneClick\":{\"default\":true,\"description\":\"Whether to create one-click installer or assisted.\",\"type\":\"boolean\"},\"packElevateHelper\":{\"default\":true,\"description\":\"Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.\",\"type\":\"boolean\"},\"perMachine\":{\"default\":false,\"description\":\"Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\\n\\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\\n\\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\\n\\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.\",\"type\":\"boolean\"},\"preCompressedFileExtensions\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"default\":[\".avi\",\".mov\",\".m4v\",\".mp4\",\".m4p\",\".qt\",\".mkv\",\".webm\",\".vmdk\"],\"description\":\"The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files.\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"runAfterFinish\":{\"default\":true,\"description\":\"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.\",\"type\":\"boolean\"},\"script\":{\"description\":\"The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).\",\"type\":[\"null\",\"string\"]},\"shortcutName\":{\"description\":\"The name that will be used for all shortcuts. Defaults to the application name.\",\"type\":[\"null\",\"string\"]},\"unicode\":{\"default\":true,\"description\":\"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).\",\"type\":\"boolean\"},\"uninstallDisplayName\":{\"default\":\"${productName} ${version}\",\"description\":\"The uninstaller display name in the control panel.\",\"type\":\"string\"},\"uninstallerIcon\":{\"description\":\"The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `build/uninstallerIcon.ico` or application icon.\",\"type\":[\"null\",\"string\"]},\"uninstallerSidebar\":{\"description\":\"*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\\\\\Contrib\\\\\\\\Graphics\\\\\\\\Wizard\\\\\\\\nsis3-metro.bmp`\",\"type\":[\"null\",\"string\"]},\"useZip\":{\"default\":false,\"type\":\"boolean\"},\"warningsAsErrors\":{\"default\":true,\"description\":\"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.\",\"type\":\"boolean\"}},\"title\":\"NsisWebOptions\",\"type\":\"object\"},\"PkgBackgroundOptions\":{\"additionalProperties\":false,\"description\":\"Options for the background image in a PKG installer\",\"properties\":{\"alignment\":{\"anyOf\":[{\"enum\":[\"bottom\",\"bottomleft\",\"bottomright\",\"center\",\"left\",\"right\",\"top\",\"topleft\",\"topright\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"center\",\"description\":\"Alignment of the background image.\\nOptions are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright\"},\"file\":{\"description\":\"Path to the image to use as an installer background.\",\"type\":\"string\"},\"scaling\":{\"anyOf\":[{\"enum\":[\"none\",\"proportional\",\"tofit\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"tofit\",\"description\":\"Scaling of the background image.\\nOptions are: tofit, none, proportional\"}},\"title\":\"PkgBackgroundOptions\",\"type\":\"object\"},\"PkgOptions\":{\"additionalProperties\":false,\"description\":\"macOS product archive options.\",\"properties\":{\"allowAnywhere\":{\"default\":true,\"description\":\"Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.\\n\\nCorresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).\",\"type\":[\"null\",\"boolean\"]},\"allowCurrentUserHome\":{\"default\":true,\"description\":\"Whether can be installed into the current user's home directory.\\nA home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.\\nIf the product cannot be installed in the user's home directory and be not completely functional from user's home directory.\\n\\nCorresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).\",\"type\":[\"null\",\"boolean\"]},\"allowRootDirectory\":{\"default\":true,\"description\":\"Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.\\n\\nCorresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).\",\"type\":[\"null\",\"boolean\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"background\":{\"anyOf\":[{\"$ref\":\"#/definitions/PkgBackgroundOptions\"},{\"type\":\"null\"}],\"description\":\"Options for the background image for the installer.\"},\"conclusion\":{\"description\":\"The path to the conclusion file. This may be used to customize the text on the final \\\"Summary\\\" page of the installer.\",\"type\":[\"null\",\"string\"]},\"hasStrictIdentifier\":{\"default\":true,\"description\":\"Require identical bundle identifiers at install path?\",\"type\":[\"null\",\"boolean\"]},\"identity\":{\"description\":\"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\",\"type\":[\"null\",\"string\"]},\"installLocation\":{\"default\":\"/Applications\",\"description\":\"The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.\\nMostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.\",\"type\":[\"null\",\"string\"]},\"isRelocatable\":{\"default\":true,\"description\":\"Install bundle over previous version if moved by user?\",\"type\":[\"null\",\"boolean\"]},\"isVersionChecked\":{\"default\":true,\"description\":\"Don't install bundle if newer version on disk?\",\"type\":[\"null\",\"boolean\"]},\"license\":{\"description\":\"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\\\"_blank\\\"` for links).\",\"type\":[\"null\",\"string\"]},\"overwriteAction\":{\"anyOf\":[{\"enum\":[\"update\",\"upgrade\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"upgrade\",\"description\":\"Specifies how an existing version of the bundle on disk should be handled when the version in\\nthe package is installed.\\n\\nIf you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;\\nthis has the effect of deleting old paths that no longer exist in the new version of\\nthe bundle.\\n\\nIf you specify update, the bundle in the package overwrites the version on disk, and any files\\nnot contained in the package will be left intact; this is appropriate when you are delivering\\nan update-only package.\\n\\nAnother effect of update is that the package bundle will not be installed at all if there is\\nnot already a version on disk; this allows a package to deliver an update for an app that\\nthe user might have deleted.\"},\"productbuild\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"should be not documented, only to experiment\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"scripts\":{\"default\":\"build/pkg-scripts\",\"description\":\"The scripts directory, relative to `build` (build resources directory).\\nThe scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.\\nScripts are required to be executable (`chmod +x file`).\",\"type\":[\"null\",\"string\"]},\"welcome\":{\"description\":\"The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.\",\"type\":[\"null\",\"string\"]}},\"title\":\"PkgOptions\",\"type\":\"object\"},\"PlugDescriptor\":{\"additionalProperties\":{\"anyOf\":[{\"additionalProperties\":{},\"type\":\"object\"},{\"type\":\"null\"}]},\"title\":\"PlugDescriptor\",\"type\":\"object\"},\"PortableOptions\":{\"additionalProperties\":false,\"description\":\"Portable options.\",\"properties\":{\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"guid\":{\"description\":\"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).\",\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"requestExecutionLevel\":{\"default\":\"user\",\"description\":\"The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows.\",\"enum\":[\"admin\",\"highest\",\"user\"],\"type\":\"string\"},\"unicode\":{\"default\":true,\"description\":\"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).\",\"type\":\"boolean\"},\"useZip\":{\"default\":false,\"type\":\"boolean\"},\"warningsAsErrors\":{\"default\":true,\"description\":\"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.\",\"type\":\"boolean\"},\"unpackDirName\":{\"description\":\"The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\\n\\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).\",\"type\":\"string\"}},\"title\":\"PortableOptions\",\"type\":\"object\"},\"Protocol\":{\"additionalProperties\":false,\"description\":\"URL Protocol Schemes. Protocols to associate the app with. macOS only.\\n\\nPlease note \\u2014 on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).\",\"properties\":{\"name\":{\"description\":\"The name. e.g. `IRC server URL`.\",\"type\":\"string\"},\"role\":{\"default\":\"Editor\",\"description\":\"*macOS-only* The app's role with respect to the type.\",\"enum\":[\"Editor\",\"None\",\"Shell\",\"Viewer\"],\"type\":\"string\"},\"schemes\":{\"description\":\"The schemes. e.g. `[\\\"irc\\\", \\\"ircs\\\"]`.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"name\",\"schemes\"],\"title\":\"Protocol\",\"type\":\"object\"},\"PublishProvider\":{\"enum\":[\"bintray\",\"custom\",\"generic\",\"github\",\"s3\",\"spaces\"],\"title\":\"PublishProvider\",\"type\":\"string\"},\"ReleaseInfo\":{\"additionalProperties\":false,\"properties\":{\"releaseDate\":{\"description\":\"The release date.\",\"type\":\"string\"},\"releaseName\":{\"description\":\"The release name.\",\"type\":[\"null\",\"string\"]},\"releaseNotes\":{\"description\":\"The release notes.\",\"type\":[\"null\",\"string\"]},\"releaseNotesFile\":{\"description\":\"The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform \\u2014 `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).\",\"type\":[\"null\",\"string\"]}},\"title\":\"ReleaseInfo\",\"type\":\"object\"},\"S3Options\":{\"additionalProperties\":false,\"properties\":{\"acl\":{\"anyOf\":[{\"enum\":[\"private\",\"public-read\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"public-read\",\"description\":\"The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).\\n\\nPlease see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128).\"},\"bucket\":{\"description\":\"The bucket name.\",\"type\":\"string\"},\"channel\":{\"default\":\"latest\",\"description\":\"The update channel.\",\"type\":[\"null\",\"string\"]},\"encryption\":{\"anyOf\":[{\"enum\":[\"AES256\",\"aws:kms\"],\"type\":\"string\"},{\"type\":\"null\"}],\"description\":\"Server-side encryption algorithm to use for the object.\"},\"endpoint\":{\"description\":\"The endpoint URI to send requests to. The default endpoint is built from the configured region.\\nThe endpoint should be a string like `https://{service}.{region}.amazonaws.com`.\",\"type\":[\"null\",\"string\"]},\"path\":{\"default\":\"/\",\"description\":\"The directory path.\",\"type\":[\"null\",\"string\"]},\"provider\":{\"description\":\"The provider. Must be `s3`.\",\"enum\":[\"s3\"],\"type\":\"string\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"region\":{\"description\":\"The region. Is determined and set automatically when publishing.\",\"type\":[\"null\",\"string\"]},\"storageClass\":{\"anyOf\":[{\"enum\":[\"REDUCED_REDUNDANCY\",\"STANDARD\",\"STANDARD_IA\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"STANDARD\",\"description\":\"The type of storage to use for the object.\"},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]}},\"required\":[\"bucket\",\"provider\"],\"title\":\"S3Options\",\"type\":\"object\"},\"SnapOptions\":{\"additionalProperties\":false,\"properties\":{\"after\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.\\nDefaults to `[\\\"desktop-gtk2\\\"\\\"]`.\\n\\nIf list contains `default`, it will be replaced to default list, so, `[\\\"default\\\", \\\"foo\\\"]` can be used to add custom parts `foo` in addition to defaults.\"},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"assumes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The list of features that must be supported by the core in order for this snap to install.\"},\"buildPackages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The list of debian packages needs to be installed for building this snap.\"},\"category\":{\"description\":\"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).\",\"type\":[\"null\",\"string\"]},\"confinement\":{\"anyOf\":[{\"enum\":[\"classic\",\"devmode\",\"strict\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"strict\",\"description\":\"The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.\"},\"description\":{\"description\":\"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.\",\"type\":[\"null\",\"string\"]},\"desktop\":{\"description\":\"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).\"},\"environment\":{\"anyOf\":[{},{\"type\":\"null\"}],\"description\":\"The custom environment. Defaults to `{\\\"TMPDIR: \\\"$XDG_RUNTIME_DIR\\\"}`. If you set custom, it will be merged with default.\"},\"grade\":{\"anyOf\":[{\"enum\":[\"devel\",\"stable\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"stable\",\"description\":\"The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the \\\"stable\\\" or \\\"candidate\\\" channels) or \\\"stable\\\" (i.e. a stable release or release candidate, which can be released to all channels).\"},\"hooks\":{\"default\":\"build/snap-hooks\",\"description\":\"The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).\",\"type\":[\"null\",\"string\"]},\"mimeTypes\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.\"},\"plugs\":{\"anyOf\":[{\"$ref\":\"#/definitions/PlugDescriptor\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/PlugDescriptor\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The list of [plugs](https://snapcraft.io/docs/reference/interfaces).\\nDefaults to `[\\\"desktop\\\", \\\"desktop-legacy\\\", \\\"home\\\", \\\"x11\\\", \\\"unity7\\\", \\\"browser-support\\\", \\\"network\\\", \\\"gsettings\\\", \\\"pulseaudio\\\", \\\"opengl\\\"]`.\\n\\nIf list contains `default`, it will be replaced to default list, so, `[\\\"default\\\", \\\"foo\\\"]` can be used to add custom plug `foo` in addition to defaults.\\n\\nAdditional attributes can be specified using object instead of just name of plug:\\n```\\n[\\n {\\n \\\"browser-sandbox\\\": {\\n \\\"interface\\\": \\\"browser-support\\\",\\n \\\"allow-sandbox\\\": true\\n },\\n },\\n \\\"another-simple-plug-name\\\"\\n]\\n```\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"stagePackages\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"description\":\"The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.\\nDefaults to `[\\\"libasound2\\\", \\\"libgconf2-4\\\", \\\"libnotify4\\\", \\\"libnspr4\\\", \\\"libnss3\\\", \\\"libpcre3\\\", \\\"libpulse0\\\", \\\"libxss1\\\", \\\"libxtst6\\\"]`.\\n\\nIf list contains `default`, it will be replaced to default list, so, `[\\\"default\\\", \\\"foo\\\"]` can be used to add custom package `foo` in addition to defaults.\"},\"summary\":{\"description\":\"The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).\",\"type\":[\"null\",\"string\"]},\"synopsis\":{\"description\":\"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).\",\"type\":[\"null\",\"string\"]},\"useTemplateApp\":{\"description\":\"Whether to use template snap. Defaults to `true` if `stagePackages` not specified.\",\"type\":\"boolean\"}},\"title\":\"SnapOptions\",\"type\":\"object\"},\"SpacesOptions\":{\"additionalProperties\":false,\"description\":\"[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.\\nAccess key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.\",\"properties\":{\"acl\":{\"anyOf\":[{\"enum\":[\"private\",\"public-read\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"public-read\",\"description\":\"The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).\"},\"channel\":{\"default\":\"latest\",\"description\":\"The update channel.\",\"type\":[\"null\",\"string\"]},\"name\":{\"description\":\"The space name.\",\"type\":\"string\"},\"path\":{\"default\":\"/\",\"description\":\"The directory path.\",\"type\":[\"null\",\"string\"]},\"provider\":{\"description\":\"The provider. Must be `spaces`.\",\"enum\":[\"spaces\"],\"type\":\"string\"},\"publishAutoUpdate\":{\"default\":true,\"description\":\"Whether to publish auto update info files.\\n\\nAuto update relies only on the first provider in the list (you can specify several publishers).\\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.\",\"type\":\"boolean\"},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}]},\"region\":{\"description\":\"The region (e.g. `nyc3`).\",\"type\":\"string\"},\"updaterCacheDirName\":{\"type\":[\"null\",\"string\"]}},\"required\":[\"name\",\"provider\",\"region\"],\"title\":\"SpacesOptions\",\"type\":\"object\"},\"SquirrelWindowsOptions\":{\"additionalProperties\":false,\"properties\":{\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template).\",\"type\":[\"null\",\"string\"]},\"iconUrl\":{\"description\":\"A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.\\n\\nPlease note \\u2014 [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.\\n\\nIf you don't plan to build windows installer, you can omit it.\\nIf your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.\",\"type\":[\"null\",\"string\"]},\"loadingGif\":{\"description\":\"The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)\\n(otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).\",\"type\":[\"null\",\"string\"]},\"msi\":{\"description\":\"Whether to create an MSI installer. Defaults to `false` (MSI is not created).\",\"type\":\"boolean\"},\"name\":{\"description\":\"https://github.com/electron-userland/electron-builder/issues/1743\",\"type\":\"string\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"remoteReleases\":{\"description\":\"A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.\",\"type\":[\"null\",\"string\",\"boolean\"]},\"remoteToken\":{\"description\":\"Authentication token for remote updates\",\"type\":[\"null\",\"string\"]},\"useAppIdAsId\":{\"description\":\"Use `appId` to identify package instead of `name`.\",\"type\":\"boolean\"}},\"title\":\"SquirrelWindowsOptions\",\"type\":\"object\"},\"TargetConfiguration\":{\"additionalProperties\":false,\"properties\":{\"arch\":{\"anyOf\":[{\"items\":{\"enum\":[\"arm64\",\"armv7l\",\"ia32\",\"x64\"],\"type\":\"string\"},\"type\":\"array\"},{\"enum\":[\"arm64\",\"armv7l\",\"ia32\",\"x64\"],\"type\":\"string\"}],\"description\":\"The arch or list of archs.\"},\"target\":{\"description\":\"The target name. e.g. `snap`.\",\"type\":\"string\"}},\"required\":[\"target\"],\"title\":\"TargetConfiguration\",\"type\":\"object\"},\"WindowsConfiguration\":{\"additionalProperties\":false,\"properties\":{\"additionalCertificateFile\":{\"description\":\"The path to an additional certificate file you want to add to the signature block.\",\"type\":[\"null\",\"string\"]},\"appId\":{\"default\":\"com.electron.${name}\",\"description\":\"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\",\"type\":[\"null\",\"string\"]},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\",\"type\":[\"null\",\"string\"]},\"asar\":{\"anyOf\":[{\"$ref\":\"#/definitions/AsarOptions\"},{\"type\":[\"null\",\"boolean\"]}],\"default\":true,\"description\":\"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\\n\\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\"},\"asarUnpack\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\"},\"certificateFile\":{\"description\":\"The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.\\nPlease see [Code Signing](/code-signing).\",\"type\":[\"null\",\"string\"]},\"certificatePassword\":{\"description\":\"The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.\\nPlease see [Code Signing](/code-signing).\",\"type\":[\"null\",\"string\"]},\"certificateSha1\":{\"description\":\"The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).\",\"type\":[\"null\",\"string\"]},\"certificateSubjectName\":{\"description\":\"The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"maximum\",\"normal\",\"store\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"normal\",\"description\":\"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\"},\"cscKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscLink\":{\"type\":[\"null\",\"string\"]},\"detectUpdateChannel\":{\"default\":true,\"description\":\"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\",\"type\":\"boolean\"},\"electronUpdaterCompatibility\":{\"description\":\"The [electron-updater compatibility](/auto-update#compatibility) semver range.\",\"type\":[\"null\",\"string\"]},\"extraFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"extraResources\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"fileAssociations\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileAssociation\"},{\"items\":{\"$ref\":\"#/definitions/FileAssociation\"},\"type\":\"array\"}],\"description\":\"The file associations.\"},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"forceCodeSigning\":{\"description\":\"Whether to fail if app will be not code signed.\",\"type\":\"boolean\"},\"generateUpdatesFilesForAllChannels\":{\"default\":false,\"description\":\"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\",\"type\":\"boolean\"},\"icon\":{\"default\":\"build/icon.ico\",\"description\":\"The path to application icon.\",\"type\":[\"null\",\"string\"]},\"legalTrademarks\":{\"description\":\"The trademarks and registered trademarks.\",\"type\":[\"null\",\"string\"]},\"protocols\":{\"anyOf\":[{\"$ref\":\"#/definitions/Protocol\"},{\"items\":{\"$ref\":\"#/definitions/Protocol\"},\"type\":\"array\"}],\"description\":\"The URL protocol schemes.\"},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"publisherName\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.\\nDefaults to common name from your code signing certificate.\"},\"releaseInfo\":{\"$ref\":\"#/definitions/ReleaseInfo\",\"description\":\"The release info. Intended for command line usage:\\n\\n```\\n-c.releaseInfo.releaseNotes=\\\"new features\\\"\\n```\"},\"requestedExecutionLevel\":{\"anyOf\":[{\"enum\":[\"asInvoker\",\"highestAvailable\",\"requireAdministrator\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"asInvoker\",\"description\":\"The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed.\\nCannot be specified per target, allowed only in the `win`.\"},\"rfc3161TimeStampServer\":{\"default\":\"http://timestamp.comodoca.com/rfc3161\",\"description\":\"The URL of the RFC 3161 time stamp server.\",\"type\":[\"null\",\"string\"]},\"sign\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The custom function (or path to file or module id) to sign Windows executable.\"},\"signAndEditExecutable\":{\"default\":true,\"description\":\"Whether to sign and add metadata to executable. Advanced option.\",\"type\":\"boolean\"},\"signDlls\":{\"default\":false,\"description\":\"Whether to sign DLL files. Advanced option.\",\"type\":\"boolean\"},\"signingHashAlgorithms\":{\"anyOf\":[{\"items\":{\"enum\":[\"sha1\",\"sha256\"],\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":\"['sha1', 'sha256']\",\"description\":\"Array of signing algorithms used. For AppX `sha256` is always used.\"},\"target\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"default\":\"nsis\",\"description\":\"The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\\nAppX package can be built only on Windows 10.\\n\\nTo use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.\"},\"timeStampServer\":{\"default\":\"http://timestamp.verisign.com/scripts/timestamp.dll\",\"description\":\"The URL of the time stamp server.\",\"type\":[\"null\",\"string\"]},\"verifyUpdateCodeSignature\":{\"default\":true,\"description\":\"Whether to verify the signature of an available update before installation.\\nThe [publisher name](#publisherName) will be used for the signature verification.\",\"type\":\"boolean\"}},\"title\":\"WindowsConfiguration\",\"type\":\"object\"}},\"description\":\"Configuration Options\",\"properties\":{\"$schema\":{\"description\":\"JSON Schema for this document.\",\"type\":[\"null\",\"string\"]},\"afterAllArtifactBuild\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).\"},\"afterPack\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).\"},\"afterSign\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).\"},\"apk\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxTargetSpecificOptions\"},{\"type\":\"null\"}]},\"appId\":{\"default\":\"com.electron.${name}\",\"description\":\"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\",\"type\":[\"null\",\"string\"]},\"appImage\":{\"anyOf\":[{\"$ref\":\"#/definitions/AppImageOptions\"},{\"type\":\"null\"}],\"description\":\"AppImage options.\"},\"appx\":{\"anyOf\":[{\"$ref\":\"#/definitions/AppXOptions\"},{\"type\":\"null\"}]},\"artifactBuildCompleted\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be run on artifact build completed.\"},\"artifactBuildStarted\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be run on artifact build start.\"},\"artifactName\":{\"description\":\"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\",\"type\":[\"null\",\"string\"]},\"asar\":{\"anyOf\":[{\"$ref\":\"#/definitions/AsarOptions\"},{\"type\":[\"null\",\"boolean\"]}],\"default\":true,\"description\":\"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\\n\\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\"},\"asarUnpack\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\"},\"beforeBuild\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\\n\\nIf provided and `node_modules` are missing, it will not invoke production dependencies check.\"},\"buildDependenciesFromSource\":{\"default\":false,\"description\":\"Whether to build the application native dependencies from source.\",\"type\":\"boolean\"},\"buildVersion\":{\"description\":\"The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\\nIf `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).\",\"type\":[\"null\",\"string\"]},\"compression\":{\"anyOf\":[{\"enum\":[\"maximum\",\"normal\",\"store\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":\"normal\",\"description\":\"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\"},\"copyright\":{\"default\":\"Copyright \\u00a9 year ${author}\",\"description\":\"The human-readable copyright line for the app.\",\"type\":[\"null\",\"string\"]},\"cscKeyPassword\":{\"type\":[\"null\",\"string\"]},\"cscLink\":{\"type\":[\"null\",\"string\"]},\"deb\":{\"anyOf\":[{\"$ref\":\"#/definitions/DebOptions\"},{\"type\":\"null\"}],\"description\":\"Debian package options.\"},\"detectUpdateChannel\":{\"default\":true,\"description\":\"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\",\"type\":\"boolean\"},\"directories\":{\"anyOf\":[{\"$ref\":\"#/definitions/MetadataDirectories\"},{\"type\":\"null\"}]},\"dmg\":{\"anyOf\":[{\"$ref\":\"#/definitions/DmgOptions\"},{\"type\":\"null\"}],\"description\":\"macOS DMG options.\"},\"electronCompile\":{\"description\":\"Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.\",\"type\":\"boolean\"},\"electronDist\":{\"description\":\"The path to custom Electron build (e.g. `~/electron/out/R`).\",\"type\":\"string\"},\"electronDownload\":{\"$ref\":\"#/definitions/ElectronDownloadOptions\",\"description\":\"The [electron-download](https://github.com/electron-userland/electron-download#usage) options.\"},\"electronUpdaterCompatibility\":{\"description\":\"The [electron-updater compatibility](/auto-update#compatibility) semver range.\",\"type\":[\"null\",\"string\"]},\"electronVersion\":{\"description\":\"The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.\",\"type\":[\"null\",\"string\"]},\"extends\":{\"description\":\"The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported.\\n\\nIf `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.\",\"type\":[\"null\",\"string\"]},\"extraFiles\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"extraMetadata\":{\"description\":\"Inject properties to `package.json`.\"},\"extraResources\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"fileAssociations\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileAssociation\"},{\"items\":{\"$ref\":\"#/definitions/FileAssociation\"},\"type\":\"array\"}],\"description\":\"The file associations.\"},\"files\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/FileSet\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"forceCodeSigning\":{\"description\":\"Whether to fail if app will be not code signed.\",\"type\":\"boolean\"},\"framework\":{\"description\":\"The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.\",\"type\":[\"null\",\"string\"]},\"freebsd\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxTargetSpecificOptions\"},{\"type\":\"null\"}]},\"generateUpdatesFilesForAllChannels\":{\"default\":false,\"description\":\"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\",\"type\":\"boolean\"},\"icon\":{\"type\":[\"null\",\"string\"]},\"includePdb\":{\"default\":false,\"description\":\"Whether to include PDB files.\",\"type\":\"boolean\"},\"launchUiVersion\":{\"description\":\"*libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.\",\"type\":[\"null\",\"string\",\"boolean\"]},\"linux\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxConfiguration\"},{\"type\":\"null\"}],\"description\":\"Options related to how build Linux targets.\"},\"mac\":{\"anyOf\":[{\"$ref\":\"#/definitions/MacConfiguration\"},{\"type\":\"null\"}],\"description\":\"Options related to how build macOS targets.\"},\"mas\":{\"anyOf\":[{\"$ref\":\"#/definitions/MasConfiguration\"},{\"type\":\"null\"}],\"description\":\"MAS (Mac Application Store) options.\"},\"msi\":{\"anyOf\":[{\"$ref\":\"#/definitions/MsiOptions\"},{\"type\":\"null\"}]},\"muonVersion\":{\"description\":\"The version of muon you are packaging for.\",\"type\":[\"null\",\"string\"]},\"nodeGypRebuild\":{\"default\":false,\"description\":\"Whether to execute `node-gyp rebuild` before starting to package the app.\\n\\nDon't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.\",\"type\":\"boolean\"},\"nodeVersion\":{\"description\":\"*libui-based frameworks only* The version of NodeJS you are packaging for.\\nYou can set it to `current` to set the Node.js version that you use to run.\",\"type\":[\"null\",\"string\"]},\"npmArgs\":{\"anyOf\":[{\"items\":{\"type\":\"string\"},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"Additional command line arguments to use when installing app native deps.\"},\"npmRebuild\":{\"default\":true,\"description\":\"Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.\",\"type\":\"boolean\"},\"npmSkipBuildFromSource\":{\"type\":\"boolean\"},\"nsis\":{\"anyOf\":[{\"$ref\":\"#/definitions/NsisOptions\"},{\"type\":\"null\"}]},\"nsisWeb\":{\"anyOf\":[{\"$ref\":\"#/definitions/NsisWebOptions\"},{\"type\":\"null\"}]},\"onNodeModuleFile\":{\"anyOf\":[{\"typeof\":\"function\"},{\"type\":[\"null\",\"string\"]}],\"description\":\"The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file.\"},\"p5p\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxTargetSpecificOptions\"},{\"type\":\"null\"}]},\"pacman\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxTargetSpecificOptions\"},{\"type\":\"null\"}]},\"pkg\":{\"anyOf\":[{\"$ref\":\"#/definitions/PkgOptions\"},{\"type\":\"null\"}],\"description\":\"macOS PKG options.\"},\"portable\":{\"anyOf\":[{\"$ref\":\"#/definitions/PortableOptions\"},{\"type\":\"null\"}]},\"productName\":{\"description\":\"As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).\",\"type\":[\"null\",\"string\"]},\"protocols\":{\"anyOf\":[{\"$ref\":\"#/definitions/Protocol\"},{\"items\":{\"$ref\":\"#/definitions/Protocol\"},\"type\":\"array\"}],\"description\":\"The URL protocol schemes.\"},\"protonNodeVersion\":{\"type\":[\"null\",\"string\"]},\"publish\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/GithubOptions\"},{\"$ref\":\"#/definitions/S3Options\"},{\"$ref\":\"#/definitions/SpacesOptions\"},{\"$ref\":\"#/definitions/GenericServerOptions\"},{\"$ref\":\"#/definitions/BintrayOptions\"},{\"$ref\":\"#/definitions/CustomPublishOptions\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"readonly\":{\"default\":false,\"description\":\"Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).\",\"type\":\"boolean\"},\"releaseInfo\":{\"$ref\":\"#/definitions/ReleaseInfo\",\"description\":\"The release info. Intended for command line usage:\\n\\n```\\n-c.releaseInfo.releaseNotes=\\\"new features\\\"\\n```\"},\"remoteBuild\":{\"default\":true,\"description\":\"Whether to build using Electron Build Service if target not supported on current OS.\",\"type\":\"boolean\"},\"removePackageScripts\":{\"default\":true,\"description\":\"Whether to remove `scripts` field from `package.json` files.\",\"type\":\"boolean\"},\"rpm\":{\"anyOf\":[{\"$ref\":\"#/definitions/LinuxTargetSpecificOptions\"},{\"type\":\"null\"}]},\"snap\":{\"anyOf\":[{\"$ref\":\"#/definitions/SnapOptions\"},{\"type\":\"null\"}],\"description\":\"Snap options.\"},\"squirrelWindows\":{\"anyOf\":[{\"$ref\":\"#/definitions/SquirrelWindowsOptions\"},{\"type\":\"null\"}]},\"target\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/TargetConfiguration\"},{\"type\":\"string\"}]},\"type\":\"array\"},{\"type\":[\"null\",\"string\"]}]},\"win\":{\"anyOf\":[{\"$ref\":\"#/definitions/WindowsConfiguration\"},{\"type\":\"null\"}],\"description\":\"Options related to how build Windows targets.\"}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"electron-builder\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/electron-builder.json","additionalProperties":false,"definitions":{"AppImageOptions":{"additionalProperties":false,"properties":{"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"category":{"description":"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).","type":["null","string"]},"description":{"description":"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.","type":["null","string"]},"desktop":{"description":"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."},"license":{"description":"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). Only plain text is supported.","type":["null","string"]},"mimeTypes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"synopsis":{"description":"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).","type":["null","string"]},"systemIntegration":{"default":"ask","description":"The system integration installation.","enum":["ask","doNotAsk"],"type":"string"}},"title":"AppImageOptions","type":"object"},"AppXOptions":{"additionalProperties":false,"properties":{"addAutoLaunchExtension":{"description":"Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.","type":"boolean"},"applicationId":{"description":"The application id. Defaults to `identityName`. Can't start with numbers.","type":"string"},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"backgroundColor":{"default":"#464646","description":"The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).","type":["null","string"]},"displayName":{"description":"A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).\nDefaults to the application product name.","type":["null","string"]},"electronUpdaterAware":{"default":false,"type":"boolean"},"identityName":{"description":"The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).","type":["null","string"]},"languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.\nThe first entry (index 0) will be the default language.\nDefaults to en-US if omitted."},"makeappxArgs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"publisher":{"description":"The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.","type":["null","string"]},"publisherDisplayName":{"description":"A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).\nDefaults to company name from the application metadata.","type":["null","string"]},"showNameOnTiles":{"description":"Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.","type":"boolean"},"setBuildNumber":{"description":"Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875","type":"boolean"}},"title":"AppXOptions","type":"object"},"AsarOptions":{"additionalProperties":false,"properties":{"externalAllowed":{"default":false,"description":"Allows external asar files.","type":"boolean"},"ordering":{"type":["null","string"]},"smartUnpack":{"default":true,"description":"Whether to automatically unpack executables files.","type":"boolean"}},"title":"AsarOptions","type":"object"},"BintrayOptions":{"additionalProperties":false,"description":"[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page (\"Edit Your Profile\" -> API Key).\nDefine `BT_TOKEN` environment variable.","properties":{"component":{"description":"The Bintray component (Debian only).","type":["null","string"]},"distribution":{"default":"stable","description":"The Bintray distribution (Debian only).","type":["null","string"]},"owner":{"description":"The owner.","type":["null","string"]},"package":{"description":"The Bintray package name.","type":["null","string"]},"provider":{"description":"The provider. Must be `bintray`.","enum":["bintray"],"type":"string"},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"repo":{"default":"generic","description":"The Bintray repository name.","type":["null","string"]},"token":{"type":["null","string"]},"updaterCacheDirName":{"type":["null","string"]},"user":{"description":"The Bintray user account. Used in cases where the owner is an organization.","type":["null","string"]}},"required":["provider"],"title":"BintrayOptions","type":"object"},"CustomPublishOptions":{"additionalProperties":{},"properties":{"provider":{"$ref":"#/definitions/PublishProvider","description":"The provider."},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"updaterCacheDirName":{"type":["null","string"]}},"required":["provider"],"title":"CustomPublishOptions","type":"object"},"DebOptions":{"additionalProperties":false,"properties":{"afterInstall":{"type":["null","string"]},"afterRemove":{"type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"category":{"description":"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).","type":["null","string"]},"compression":{"anyOf":[{"enum":["bzip2","gz","xz"],"type":"string"},{"type":"null"}],"default":"xz","description":"The compression type."},"depends":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Package dependencies. Defaults to `[\"gconf2\", \"gconf-service\", \"libnotify4\", \"libappindicator1\", \"libxtst6\", \"libnss3\"]`."},"description":{"description":"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.","type":["null","string"]},"desktop":{"description":"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."},"fpm":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\n\nExample: `[\"--before-install=build/deb-preinstall.sh\", \"--after-upgrade=build/deb-postinstall.sh\"]`"},"icon":{"type":"string"},"maintainer":{"type":["null","string"]},"mimeTypes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."},"packageCategory":{"description":"The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section).","type":["null","string"]},"priority":{"description":"The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute.","type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"synopsis":{"description":"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).","type":["null","string"]},"vendor":{"type":["null","string"]}},"title":"DebOptions","type":"object"},"DmgContent":{"additionalProperties":false,"properties":{"name":{"description":"The name of the file within the DMG. Defaults to basename of `path`.","type":"string"},"path":{"description":"The path of the file within the DMG.","type":"string"},"type":{"enum":["dir","file","link"],"type":"string"},"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y"],"title":"DmgContent","type":"object"},"DmgOptions":{"additionalProperties":false,"properties":{"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"background":{"description":"The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.\nIf background is not specified, use `window.size`. Default locations expected background size to be 540x380.","type":["null","string"]},"backgroundColor":{"description":"The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.","type":["null","string"]},"contents":{"description":"The content \u2014 to customize icon locations.","items":{"$ref":"#/definitions/DmgContent"},"type":"array"},"format":{"default":"UDZO","description":"The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).","enum":["UDBZ","UDCO","UDRO","UDRW","UDZO","ULFO"],"type":"string"},"icon":{"description":"The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to the application icon (`build/icon.icns`).","type":["null","string"]},"iconSize":{"default":80,"description":"The size of all the icons inside the DMG.","type":["null","number"]},"iconTextSize":{"default":12,"description":"The size of all the icon texts inside the DMG.","type":["null","number"]},"internetEnabled":{"default":false,"description":"Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).","type":"boolean"},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"title":{"default":"${productName} ${version}","description":"The title of the produced DMG, which will be shown when mounted (volume name).\n\nMacro `${productName}`, `${version}` and `${name}` are supported.","type":["null","string"]},"window":{"$ref":"#/definitions/DmgWindow","description":"The DMG windows position and size."}},"title":"DmgOptions","type":"object"},"DmgWindow":{"additionalProperties":false,"properties":{"height":{"description":"The height. Defaults to background image height or 380.","type":"number"},"width":{"description":"The width. Defaults to background image width or 540.","type":"number"},"x":{"default":400,"description":"The X position relative to left of the screen.","type":"number"},"y":{"default":100,"description":"The Y position relative to top of the screen.","type":"number"}},"title":"DmgWindow","type":"object"},"ElectronDownloadOptions":{"additionalProperties":false,"properties":{"arch":{"type":"string"},"cache":{"description":"The [cache location](https://github.com/electron-userland/electron-download#cache-location).","type":["null","string"]},"customDir":{"type":["null","string"]},"customFilename":{"type":["null","string"]},"isVerifyChecksum":{"type":"boolean"},"mirror":{"description":"The mirror.","type":["null","string"]},"platform":{"enum":["darwin","linux","mas","win32"],"type":"string"},"strictSSL":{"type":"boolean"},"version":{"type":"string"}},"title":"ElectronDownloadOptions","type":"object"},"FileAssociation":{"additionalProperties":false,"description":"File associations.\n\nmacOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.\n\nOn Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.","properties":{"description":{"description":"*windows-only.* The description.","type":["null","string"]},"ext":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"The extension (minus the leading period). e.g. `png`."},"icon":{"description":"The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.\n\nNot supported on Linux, file issue if need (default icon will be `x-office-document`).","type":["null","string"]},"isPackage":{"description":"*macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.","type":"boolean"},"mimeType":{"description":"*linux-only.* The mime-type.","type":["null","string"]},"name":{"description":"The name. e.g. `PNG`. Defaults to `ext`.","type":["null","string"]},"role":{"default":"Editor","description":"*macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.","type":"string"}},"required":["ext"],"title":"FileAssociation","type":"object"},"FileSet":{"additionalProperties":false,"properties":{"filter":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"The [glob patterns](/file-patterns)."},"from":{"description":"The source path relative to the project directory.","type":"string"},"to":{"description":"The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.","type":"string"}},"title":"FileSet","type":"object"},"GenericServerOptions":{"additionalProperties":false,"description":"Generic (any HTTP(S) server) options.\nIn all publish options [File Macros](/file-patterns#file-macros) are supported.","properties":{"channel":{"default":"latest","description":"The channel.","type":["null","string"]},"provider":{"description":"The provider. Must be `generic`.","enum":["generic"],"type":"string"},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"updaterCacheDirName":{"type":["null","string"]},"url":{"description":"The base url. e.g. `https://bucket_name.s3.amazonaws.com`.","type":"string"},"useMultipleRangeRequest":{"description":"Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.","type":"boolean"}},"required":["provider","url"],"title":"GenericServerOptions","type":"object"},"GithubOptions":{"additionalProperties":false,"description":"[GitHub](https://help.github.com/articles/about-releases/) options.\n\nGitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.\nDefine `GH_TOKEN` environment variable.","properties":{"host":{"default":"github.com","description":"The host (including the port if need).","type":["null","string"]},"owner":{"description":"The owner.","type":["null","string"]},"private":{"description":"Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).","type":["null","boolean"]},"protocol":{"anyOf":[{"enum":["http","https"],"type":"string"},{"type":"null"}],"default":"https","description":"The protocol. GitHub Publisher supports only `https`."},"provider":{"description":"The provider. Must be `github`.","enum":["github"],"type":"string"},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"releaseType":{"anyOf":[{"enum":["draft","prerelease","release"],"type":"string"},{"type":"null"}],"default":"draft","description":"The type of release. By default `draft` release will be created.\n\nAlso you can set release type using environment variable. If `EP_DRAFT`is set to `true` \u2014 `draft`, if `EP_PRE_RELEASE`is set to `true` \u2014 `prerelease`."},"repo":{"description":"The repository name. [Detected automatically](#github-repository-and-bintray-package).","type":["null","string"]},"token":{"description":"The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).","type":["null","string"]},"updaterCacheDirName":{"type":["null","string"]},"vPrefixedTagName":{"default":true,"description":"Whether to use `v`-prefixed tag name.","type":"boolean"}},"required":["provider"],"title":"GithubOptions","type":"object"},"LinuxConfiguration":{"additionalProperties":false,"properties":{"appId":{"default":"com.electron.${name}","description":"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.","type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).","type":["null","string"]},"asar":{"anyOf":[{"$ref":"#/definitions/AsarOptions"},{"type":["null","boolean"]}],"default":true,"description":"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."},"asarUnpack":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."},"category":{"description":"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).","type":["null","string"]},"compression":{"anyOf":[{"enum":["maximum","normal","store"],"type":"string"},{"type":"null"}],"default":"normal","description":"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."},"cscKeyPassword":{"type":["null","string"]},"cscLink":{"type":["null","string"]},"depends":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"description":{"description":"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.","type":["null","string"]},"desktop":{"description":"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."},"detectUpdateChannel":{"default":true,"description":"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.","type":"boolean"},"electronUpdaterCompatibility":{"description":"The [electron-updater compatibility](/auto-update#compatibility) semver range.","type":["null","string"]},"executableName":{"description":"The executable name. Defaults to `productName`.\nCannot be specified per target, allowed only in the `linux`.","type":["null","string"]},"extraFiles":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"extraResources":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"fileAssociations":{"anyOf":[{"$ref":"#/definitions/FileAssociation"},{"items":{"$ref":"#/definitions/FileAssociation"},"type":"array"}],"description":"The file associations."},"files":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"forceCodeSigning":{"description":"Whether to fail if app will be not code signed.","type":"boolean"},"generateUpdatesFilesForAllChannels":{"default":false,"description":"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).","type":"boolean"},"icon":{"description":"The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.\nBy default will be generated automatically based on the macOS icns file.","type":"string"},"maintainer":{"description":"The maintainer. Defaults to [author](/configuration/configuration#Metadata-author).","type":["null","string"]},"mimeTypes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."},"packageCategory":{"description":"backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place","type":["null","string"]},"protocols":{"anyOf":[{"$ref":"#/definitions/Protocol"},{"items":{"$ref":"#/definitions/Protocol"},"type":"array"}],"description":"The URL protocol schemes."},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"releaseInfo":{"$ref":"#/definitions/ReleaseInfo","description":"The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"},"synopsis":{"description":"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).","type":["null","string"]},"target":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"items":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}],"default":"AppImage","description":"Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\n\nelectron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform.\n\nPlease [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz."},"vendor":{"description":"The vendor. Defaults to [author](/configuration/configuration#Metadata-author).","type":["null","string"]}},"title":"LinuxConfiguration","type":"object"},"LinuxTargetSpecificOptions":{"additionalProperties":false,"properties":{"afterInstall":{"type":["null","string"]},"afterRemove":{"type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"category":{"description":"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).","type":["null","string"]},"compression":{"anyOf":[{"enum":["bzip2","gz","xz"],"type":"string"},{"type":"null"}],"default":"xz","description":"The compression type."},"depends":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Package dependencies."},"description":{"description":"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.","type":["null","string"]},"desktop":{"description":"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."},"fpm":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.\n\nExample: `[\"--before-install=build/deb-preinstall.sh\", \"--after-upgrade=build/deb-postinstall.sh\"]`"},"icon":{"type":"string"},"maintainer":{"type":["null","string"]},"mimeTypes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."},"packageCategory":{"description":"The package category.","type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"synopsis":{"description":"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).","type":["null","string"]},"vendor":{"type":["null","string"]}},"title":"LinuxTargetSpecificOptions","type":"object"},"MacConfiguration":{"additionalProperties":false,"properties":{"appId":{"default":"com.electron.${name}","description":"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.","type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).","type":["null","string"]},"asar":{"anyOf":[{"$ref":"#/definitions/AsarOptions"},{"type":["null","boolean"]}],"default":true,"description":"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."},"asarUnpack":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."},"binaries":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Paths of any extra binaries that need to be signed."},"bundleShortVersion":{"description":"The `CFBundleShortVersionString`. Do not use it unless you need to.","type":["null","string"]},"bundleVersion":{"description":"The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).","type":["null","string"]},"category":{"description":"The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n\nFor example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).","type":["null","string"]},"compression":{"anyOf":[{"enum":["maximum","normal","store"],"type":"string"},{"type":"null"}],"default":"normal","description":"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."},"cscInstallerKeyPassword":{"type":["null","string"]},"cscInstallerLink":{"type":["null","string"]},"cscKeyPassword":{"type":["null","string"]},"cscLink":{"type":["null","string"]},"darkModeSupport":{"default":false,"description":"Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.","type":"boolean"},"hardenedRuntime":{"default":false,"description":"Whether your app has to be signed with hardened runtime.","type":"boolean"},"gatekeeperAssess":{"default":false,"description":"Whether to let electron-osx-sign validate the signing or not.","type":"boolean"},"detectUpdateChannel":{"default":true,"description":"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.","type":"boolean"},"electronLanguages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"The electron locales. By default Electron locales used as is."},"electronUpdaterCompatibility":{"description":"The [electron-updater compatibility](/auto-update#compatibility) semver range.","type":["null","string"]},"entitlements":{"description":"The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).\nMAS entitlements is specified in the [mas](/configuration/mas).","type":["null","string"]},"entitlementsInherit":{"description":"The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).\n\nThis option only applies when signing with `entitlements` provided.","type":["null","string"]},"extendInfo":{"description":"The extra entries for `Info.plist`."},"extraDistFiles":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"Extra files to put in archive. Not applicable for `tar.*`."},"extraFiles":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"extraResources":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"fileAssociations":{"anyOf":[{"$ref":"#/definitions/FileAssociation"},{"items":{"$ref":"#/definitions/FileAssociation"},"type":"array"}],"description":"The file associations."},"files":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"forceCodeSigning":{"description":"Whether to fail if app will be not code signed.","type":"boolean"},"generateUpdatesFilesForAllChannels":{"default":false,"description":"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).","type":"boolean"},"helperBundleId":{"default":"${appBundleIdentifier}.helper","description":"The bundle identifier to use in the application helper's plist.","type":["null","string"]},"icon":{"default":"build/icon.icns","description":"The path to application icon.","type":["null","string"]},"identity":{"description":"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\nMAS installer identity is specified in the [mas](/configuration/mas).","type":["null","string"]},"minimumSystemVersion":{"description":"The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.","type":["null","string"]},"protocols":{"anyOf":[{"$ref":"#/definitions/Protocol"},{"items":{"$ref":"#/definitions/Protocol"},"type":"array"}],"description":"The URL protocol schemes."},"provisioningProfile":{"description":"The path to the provisioning profile to use when signing, absolute or relative to the app root.","type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"releaseInfo":{"$ref":"#/definitions/ReleaseInfo","description":"The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"},"requirements":{"description":"Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.","type":["null","string"]},"target":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"items":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"enum":["7z","default","dir","dmg","mas","mas-dev","pkg","tar.bz2","tar.gz","tar.lz","tar.xz","zip"],"type":"string"}]},"type":"array"},{"enum":["7z","default","dir","dmg","mas","mas-dev","pkg","tar.bz2","tar.gz","tar.lz","tar.xz","zip"],"type":"string"},{"type":"null"}],"description":"The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."},"type":{"anyOf":[{"enum":["development","distribution"],"type":"string"},{"type":"null"}],"default":"distribution","description":"Whether to sign app for development or for distribution."}},"title":"MacConfiguration","type":"object"},"MasConfiguration":{"additionalProperties":false,"properties":{"appId":{"default":"com.electron.${name}","description":"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.","type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).","type":["null","string"]},"asar":{"anyOf":[{"$ref":"#/definitions/AsarOptions"},{"type":["null","boolean"]}],"default":true,"description":"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."},"asarUnpack":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."},"binaries":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Paths of any extra binaries that need to be signed."},"bundleShortVersion":{"description":"The `CFBundleShortVersionString`. Do not use it unless you need to.","type":["null","string"]},"bundleVersion":{"description":"The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).","type":["null","string"]},"category":{"description":"The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n\nFor example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n\nValid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).","type":["null","string"]},"compression":{"anyOf":[{"enum":["maximum","normal","store"],"type":"string"},{"type":"null"}],"default":"normal","description":"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."},"cscInstallerKeyPassword":{"type":["null","string"]},"cscInstallerLink":{"type":["null","string"]},"cscKeyPassword":{"type":["null","string"]},"cscLink":{"type":["null","string"]},"darkModeSupport":{"default":false,"description":"Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.","type":"boolean"},"hardenedRuntime":{"default":false,"description":"Whether your app has to be signed with hardened runtime.","type":"boolean"},"detectUpdateChannel":{"default":true,"description":"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.","type":"boolean"},"electronLanguages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"description":"The electron locales. By default Electron locales used as is."},"electronUpdaterCompatibility":{"description":"The [electron-updater compatibility](/auto-update#compatibility) semver range.","type":["null","string"]},"entitlements":{"description":"The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).","type":["null","string"]},"entitlementsInherit":{"description":"The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).","type":["null","string"]},"extendInfo":{"description":"The extra entries for `Info.plist`."},"extraDistFiles":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"Extra files to put in archive. Not applicable for `tar.*`."},"extraFiles":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"extraResources":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"fileAssociations":{"anyOf":[{"$ref":"#/definitions/FileAssociation"},{"items":{"$ref":"#/definitions/FileAssociation"},"type":"array"}],"description":"The file associations."},"files":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"forceCodeSigning":{"description":"Whether to fail if app will be not code signed.","type":"boolean"},"generateUpdatesFilesForAllChannels":{"default":false,"description":"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).","type":"boolean"},"helperBundleId":{"default":"${appBundleIdentifier}.helper","description":"The bundle identifier to use in the application helper's plist.","type":["null","string"]},"icon":{"default":"build/icon.icns","description":"The path to application icon.","type":["null","string"]},"identity":{"description":"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.\nMAS installer identity is specified in the [mas](/configuration/mas).","type":["null","string"]},"minimumSystemVersion":{"description":"The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.","type":["null","string"]},"protocols":{"anyOf":[{"$ref":"#/definitions/Protocol"},{"items":{"$ref":"#/definitions/Protocol"},"type":"array"}],"description":"The URL protocol schemes."},"provisioningProfile":{"description":"The path to the provisioning profile to use when signing, absolute or relative to the app root.","type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"releaseInfo":{"$ref":"#/definitions/ReleaseInfo","description":"The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"},"requirements":{"description":"Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.","type":["null","string"]},"target":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"items":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"enum":["7z","default","dir","dmg","mas","mas-dev","pkg","tar.bz2","tar.gz","tar.lz","tar.xz","zip"],"type":"string"}]},"type":"array"},{"enum":["7z","default","dir","dmg","mas","mas-dev","pkg","tar.bz2","tar.gz","tar.lz","tar.xz","zip"],"type":"string"},{"type":"null"}],"description":"The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."},"type":{"anyOf":[{"enum":["development","distribution"],"type":"string"},{"type":"null"}],"default":"distribution","description":"Whether to sign app for development or for distribution."}},"title":"MasConfiguration","type":"object"},"MetadataDirectories":{"additionalProperties":false,"properties":{"app":{"description":"The application directory (containing the application package.json), defaults to `app`, `www` or working directory.","type":["null","string"]},"buildResources":{"default":"build","description":"The path to build resources.\n\nPlease note \u2014 build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `\"files\": [\"**\\/*\", \"build/icon.*\"]`","type":["null","string"]},"output":{"default":"dist","description":"The output directory. [File macros](/file-patterns#file-macros) are supported.","type":["null","string"]}},"title":"MetadataDirectories","type":"object"},"MsiOptions":{"additionalProperties":false,"properties":{"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"createDesktopShortcut":{"default":true,"description":"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).","enum":["always",false,true]},"createStartMenuShortcut":{"default":true,"description":"Whether to create start menu shortcut.","type":"boolean"},"menuCategory":{"default":false,"description":"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.","type":["string","boolean"]},"oneClick":{"default":true,"description":"One-click installation.","type":"boolean"},"perMachine":{"default":false,"description":"Whether to install per all users (per-machine).","type":"boolean"},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"runAfterFinish":{"default":true,"description":"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.","type":"boolean"},"shortcutName":{"description":"The name that will be used for all shortcuts. Defaults to the application name.","type":["null","string"]},"upgradeCode":{"description":"The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.","type":["null","string"]},"warningsAsErrors":{"default":true,"description":"If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.","type":"boolean"}},"title":"MsiOptions","type":"object"},"NsisOptions":{"additionalProperties":false,"properties":{"allowElevation":{"default":true,"description":"*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.","type":"boolean"},"allowToChangeInstallationDirectory":{"default":false,"description":"*assisted installer only.* Whether to allow user to change installation directory.","type":"boolean"},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.","type":["null","string"]},"createDesktopShortcut":{"default":true,"description":"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).","enum":["always",false,true]},"createStartMenuShortcut":{"default":true,"description":"Whether to create start menu shortcut.","type":"boolean"},"deleteAppDataOnUninstall":{"default":false,"description":"*one-click installer only.* Whether to delete app data on uninstall.","type":"boolean"},"differentialPackage":{"description":"Defaults to `true` for web installer (`nsis-web`)","type":"boolean"},"displayLanguageSelector":{"default":false,"description":"Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).","type":"boolean"},"guid":{"description":"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).","type":["null","string"]},"include":{"description":"The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).","type":["null","string"]},"installerHeader":{"default":"build/installerHeader.bmp","description":"*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.","type":["null","string"]},"installerHeaderIcon":{"description":"*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerHeaderIcon.ico` or application icon.","type":["null","string"]},"installerIcon":{"description":"The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerIcon.ico` or application icon.","type":["null","string"]},"installerLanguages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what."},"installerSidebar":{"description":"*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`. Image size 164 \u00d7 314 pixels.","type":["null","string"]},"language":{"description":"[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).","type":["null","string"]},"license":{"description":"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).\n\nMultiple license files in different languages are supported \u2014 use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\n\nAppropriate license file will be selected by user OS language.","type":["null","string"]},"menuCategory":{"default":false,"description":"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.","type":["string","boolean"]},"multiLanguageInstaller":{"description":"Whether to create multi-language installer. Defaults to `unicode` option value.","type":"boolean"},"oneClick":{"default":true,"description":"Whether to create one-click installer or assisted.","type":"boolean"},"packElevateHelper":{"default":true,"description":"Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.","type":"boolean"},"perMachine":{"default":false,"description":"Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\n\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\n\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\n\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.","type":"boolean"},"preCompressedFileExtensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"default":[".avi",".mov",".m4v",".mp4",".m4p",".qt",".mkv",".webm",".vmdk"],"description":"The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files."},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"runAfterFinish":{"default":true,"description":"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.","type":"boolean"},"script":{"description":"The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).","type":["null","string"]},"shortcutName":{"description":"The name that will be used for all shortcuts. Defaults to the application name.","type":["null","string"]},"unicode":{"default":true,"description":"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).","type":"boolean"},"uninstallDisplayName":{"default":"${productName} ${version}","description":"The uninstaller display name in the control panel.","type":"string"},"uninstallerIcon":{"description":"The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/uninstallerIcon.ico` or application icon.","type":["null","string"]},"uninstallerSidebar":{"description":"*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`","type":["null","string"]},"useZip":{"default":false,"type":"boolean"},"warningsAsErrors":{"default":true,"description":"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.","type":"boolean"}},"title":"NsisOptions","type":"object"},"NsisWebOptions":{"additionalProperties":false,"description":"Web Installer options.","properties":{"allowElevation":{"default":true,"description":"*assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.","type":"boolean"},"allowToChangeInstallationDirectory":{"default":false,"description":"*assisted installer only.* Whether to allow user to change installation directory.","type":"boolean"},"appPackageUrl":{"description":"The application package download URL. Optional \u2014 by default computed using publish configuration.\n\nURL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).\nPlease note \u2014 it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).\n\nCustom `X-Arch` http header is set to `32` or `64`.","type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`.","type":["null","string"]},"createDesktopShortcut":{"default":true,"description":"Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).","enum":["always",false,true]},"createStartMenuShortcut":{"default":true,"description":"Whether to create start menu shortcut.","type":"boolean"},"deleteAppDataOnUninstall":{"default":false,"description":"*one-click installer only.* Whether to delete app data on uninstall.","type":"boolean"},"differentialPackage":{"description":"Defaults to `true` for web installer (`nsis-web`)","type":"boolean"},"displayLanguageSelector":{"default":false,"description":"Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).","type":"boolean"},"guid":{"description":"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).","type":["null","string"]},"include":{"description":"The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).","type":["null","string"]},"installerHeader":{"default":"build/installerHeader.bmp","description":"*assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.","type":["null","string"]},"installerHeaderIcon":{"description":"*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerHeaderIcon.ico` or application icon.","type":["null","string"]},"installerIcon":{"description":"The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerIcon.ico` or application icon.","type":["null","string"]},"installerLanguages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what."},"installerSidebar":{"description":"*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`. Image size 164 \u00d7 314 pixels.","type":["null","string"]},"language":{"description":"[LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).","type":["null","string"]},"license":{"description":"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).\n\nMultiple license files in different languages are supported \u2014 use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.\nIf OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).\n\nAppropriate license file will be selected by user OS language.","type":["null","string"]},"menuCategory":{"default":false,"description":"Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.","type":["string","boolean"]},"multiLanguageInstaller":{"description":"Whether to create multi-language installer. Defaults to `unicode` option value.","type":"boolean"},"oneClick":{"default":true,"description":"Whether to create one-click installer or assisted.","type":"boolean"},"packElevateHelper":{"default":true,"description":"Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.","type":"boolean"},"perMachine":{"default":false,"description":"Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).\n\nIf `oneClick` is `true` (default): Whether to install per all users (per-machine).\n\nIf `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.\n\nIf `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.","type":"boolean"},"preCompressedFileExtensions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"default":[".avi",".mov",".m4v",".mp4",".m4p",".qt",".mkv",".webm",".vmdk"],"description":"The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files."},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"runAfterFinish":{"default":true,"description":"Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.","type":"boolean"},"script":{"description":"The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).","type":["null","string"]},"shortcutName":{"description":"The name that will be used for all shortcuts. Defaults to the application name.","type":["null","string"]},"unicode":{"default":true,"description":"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).","type":"boolean"},"uninstallDisplayName":{"default":"${productName} ${version}","description":"The uninstaller display name in the control panel.","type":"string"},"uninstallerIcon":{"description":"The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `build/uninstallerIcon.ico` or application icon.","type":["null","string"]},"uninstallerSidebar":{"description":"*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.\nDefaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\\\Contrib\\\\Graphics\\\\Wizard\\\\nsis3-metro.bmp`","type":["null","string"]},"useZip":{"default":false,"type":"boolean"},"warningsAsErrors":{"default":true,"description":"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.","type":"boolean"}},"title":"NsisWebOptions","type":"object"},"PkgBackgroundOptions":{"additionalProperties":false,"description":"Options for the background image in a PKG installer","properties":{"alignment":{"anyOf":[{"enum":["bottom","bottomleft","bottomright","center","left","right","top","topleft","topright"],"type":"string"},{"type":"null"}],"default":"center","description":"Alignment of the background image.\nOptions are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright"},"file":{"description":"Path to the image to use as an installer background.","type":"string"},"scaling":{"anyOf":[{"enum":["none","proportional","tofit"],"type":"string"},{"type":"null"}],"default":"tofit","description":"Scaling of the background image.\nOptions are: tofit, none, proportional"}},"title":"PkgBackgroundOptions","type":"object"},"PkgOptions":{"additionalProperties":false,"description":"macOS product archive options.","properties":{"allowAnywhere":{"default":true,"description":"Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.\n\nCorresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).","type":["null","boolean"]},"allowCurrentUserHome":{"default":true,"description":"Whether can be installed into the current user's home directory.\nA home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.\nIf the product cannot be installed in the user's home directory and be not completely functional from user's home directory.\n\nCorresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).","type":["null","boolean"]},"allowRootDirectory":{"default":true,"description":"Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.\n\nCorresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).","type":["null","boolean"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"background":{"anyOf":[{"$ref":"#/definitions/PkgBackgroundOptions"},{"type":"null"}],"description":"Options for the background image for the installer."},"conclusion":{"description":"The path to the conclusion file. This may be used to customize the text on the final \"Summary\" page of the installer.","type":["null","string"]},"hasStrictIdentifier":{"default":true,"description":"Require identical bundle identifiers at install path?","type":["null","boolean"]},"identity":{"description":"The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.","type":["null","string"]},"installLocation":{"default":"/Applications","description":"The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.\nMostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.","type":["null","string"]},"isRelocatable":{"default":true,"description":"Install bundle over previous version if moved by user?","type":["null","boolean"]},"isVersionChecked":{"default":true,"description":"Don't install bundle if newer version on disk?","type":["null","boolean"]},"license":{"description":"The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target=\"_blank\"` for links).","type":["null","string"]},"overwriteAction":{"anyOf":[{"enum":["update","upgrade"],"type":"string"},{"type":"null"}],"default":"upgrade","description":"Specifies how an existing version of the bundle on disk should be handled when the version in\nthe package is installed.\n\nIf you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;\nthis has the effect of deleting old paths that no longer exist in the new version of\nthe bundle.\n\nIf you specify update, the bundle in the package overwrites the version on disk, and any files\nnot contained in the package will be left intact; this is appropriate when you are delivering\nan update-only package.\n\nAnother effect of update is that the package bundle will not be installed at all if there is\nnot already a version on disk; this allows a package to deliver an update for an app that\nthe user might have deleted."},"productbuild":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"should be not documented, only to experiment"},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"scripts":{"default":"build/pkg-scripts","description":"The scripts directory, relative to `build` (build resources directory).\nThe scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.\nScripts are required to be executable (`chmod +x file`).","type":["null","string"]},"welcome":{"description":"The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.","type":["null","string"]}},"title":"PkgOptions","type":"object"},"PlugDescriptor":{"additionalProperties":{"anyOf":[{"additionalProperties":{},"type":"object"},{"type":"null"}]},"title":"PlugDescriptor","type":"object"},"PortableOptions":{"additionalProperties":false,"description":"Portable options.","properties":{"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"guid":{"description":"See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).","type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"requestExecutionLevel":{"default":"user","description":"The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows.","enum":["admin","highest","user"],"type":"string"},"unicode":{"default":true,"description":"Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).","type":"boolean"},"useZip":{"default":false,"type":"boolean"},"warningsAsErrors":{"default":true,"description":"If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.","type":"boolean"},"unpackDirName":{"description":"The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\n\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).","type":"string"}},"title":"PortableOptions","type":"object"},"Protocol":{"additionalProperties":false,"description":"URL Protocol Schemes. Protocols to associate the app with. macOS only.\n\nPlease note \u2014 on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).","properties":{"name":{"description":"The name. e.g. `IRC server URL`.","type":"string"},"role":{"default":"Editor","description":"*macOS-only* The app's role with respect to the type.","enum":["Editor","None","Shell","Viewer"],"type":"string"},"schemes":{"description":"The schemes. e.g. `[\"irc\", \"ircs\"]`.","items":{"type":"string"},"type":"array"}},"required":["name","schemes"],"title":"Protocol","type":"object"},"PublishProvider":{"enum":["bintray","custom","generic","github","s3","spaces"],"title":"PublishProvider","type":"string"},"ReleaseInfo":{"additionalProperties":false,"properties":{"releaseDate":{"description":"The release date.","type":"string"},"releaseName":{"description":"The release name.","type":["null","string"]},"releaseNotes":{"description":"The release notes.","type":["null","string"]},"releaseNotesFile":{"description":"The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform \u2014 `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).","type":["null","string"]}},"title":"ReleaseInfo","type":"object"},"S3Options":{"additionalProperties":false,"properties":{"acl":{"anyOf":[{"enum":["private","public-read"],"type":"string"},{"type":"null"}],"default":"public-read","description":"The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).\n\nPlease see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128)."},"bucket":{"description":"The bucket name.","type":"string"},"channel":{"default":"latest","description":"The update channel.","type":["null","string"]},"encryption":{"anyOf":[{"enum":["AES256","aws:kms"],"type":"string"},{"type":"null"}],"description":"Server-side encryption algorithm to use for the object."},"endpoint":{"description":"The endpoint URI to send requests to. The default endpoint is built from the configured region.\nThe endpoint should be a string like `https://{service}.{region}.amazonaws.com`.","type":["null","string"]},"path":{"default":"/","description":"The directory path.","type":["null","string"]},"provider":{"description":"The provider. Must be `s3`.","enum":["s3"],"type":"string"},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"region":{"description":"The region. Is determined and set automatically when publishing.","type":["null","string"]},"storageClass":{"anyOf":[{"enum":["REDUCED_REDUNDANCY","STANDARD","STANDARD_IA"],"type":"string"},{"type":"null"}],"default":"STANDARD","description":"The type of storage to use for the object."},"updaterCacheDirName":{"type":["null","string"]}},"required":["bucket","provider"],"title":"S3Options","type":"object"},"SnapOptions":{"additionalProperties":false,"properties":{"after":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.\nDefaults to `[\"desktop-gtk2\"\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom parts `foo` in addition to defaults."},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"assumes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"The list of features that must be supported by the core in order for this snap to install."},"buildPackages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The list of debian packages needs to be installed for building this snap."},"category":{"description":"The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).","type":["null","string"]},"confinement":{"anyOf":[{"enum":["classic","devmode","strict"],"type":"string"},{"type":"null"}],"default":"strict","description":"The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap."},"description":{"description":"As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.","type":["null","string"]},"desktop":{"description":"The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value)."},"environment":{"anyOf":[{},{"type":"null"}],"description":"The custom environment. Defaults to `{\"TMPDIR: \"$XDG_RUNTIME_DIR\"}`. If you set custom, it will be merged with default."},"grade":{"anyOf":[{"enum":["devel","stable"],"type":"string"},{"type":"null"}],"default":"stable","description":"The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the \"stable\" or \"candidate\" channels) or \"stable\" (i.e. a stable release or release candidate, which can be released to all channels)."},"hooks":{"default":"build/snap-hooks","description":"The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).","type":["null","string"]},"mimeTypes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."},"plugs":{"anyOf":[{"$ref":"#/definitions/PlugDescriptor"},{"items":{"anyOf":[{"$ref":"#/definitions/PlugDescriptor"},{"type":"string"}]},"type":"array"},{"type":"null"}],"description":"The list of [plugs](https://snapcraft.io/docs/reference/interfaces).\nDefaults to `[\"desktop\", \"desktop-legacy\", \"home\", \"x11\", \"unity7\", \"browser-support\", \"network\", \"gsettings\", \"pulseaudio\", \"opengl\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom plug `foo` in addition to defaults.\n\nAdditional attributes can be specified using object instead of just name of plug:\n```\n[\n {\n \"browser-sandbox\": {\n \"interface\": \"browser-support\",\n \"allow-sandbox\": true\n },\n },\n \"another-simple-plug-name\"\n]\n```"},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"stagePackages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.\nDefaults to `[\"libasound2\", \"libgconf2-4\", \"libnotify4\", \"libnspr4\", \"libnss3\", \"libpcre3\", \"libpulse0\", \"libxss1\", \"libxtst6\"]`.\n\nIf list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom package `foo` in addition to defaults."},"summary":{"description":"The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).","type":["null","string"]},"synopsis":{"description":"The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).","type":["null","string"]},"useTemplateApp":{"description":"Whether to use template snap. Defaults to `true` if `stagePackages` not specified.","type":"boolean"}},"title":"SnapOptions","type":"object"},"SpacesOptions":{"additionalProperties":false,"description":"[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.\nAccess key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.","properties":{"acl":{"anyOf":[{"enum":["private","public-read"],"type":"string"},{"type":"null"}],"default":"public-read","description":"The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822)."},"channel":{"default":"latest","description":"The update channel.","type":["null","string"]},"name":{"description":"The space name.","type":"string"},"path":{"default":"/","description":"The directory path.","type":["null","string"]},"provider":{"description":"The provider. Must be `spaces`.","enum":["spaces"],"type":"string"},"publishAutoUpdate":{"default":true,"description":"Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.","type":"boolean"},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"region":{"description":"The region (e.g. `nyc3`).","type":"string"},"updaterCacheDirName":{"type":["null","string"]}},"required":["name","provider","region"],"title":"SpacesOptions","type":"object"},"SquirrelWindowsOptions":{"additionalProperties":false,"properties":{"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template).","type":["null","string"]},"iconUrl":{"description":"A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.\n\nPlease note \u2014 [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.\n\nIf you don't plan to build windows installer, you can omit it.\nIf your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.","type":["null","string"]},"loadingGif":{"description":"The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)\n(otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).","type":["null","string"]},"msi":{"description":"Whether to create an MSI installer. Defaults to `false` (MSI is not created).","type":"boolean"},"name":{"description":"https://github.com/electron-userland/electron-builder/issues/1743","type":"string"},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"remoteReleases":{"description":"A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.","type":["null","string","boolean"]},"remoteToken":{"description":"Authentication token for remote updates","type":["null","string"]},"useAppIdAsId":{"description":"Use `appId` to identify package instead of `name`.","type":"boolean"}},"title":"SquirrelWindowsOptions","type":"object"},"TargetConfiguration":{"additionalProperties":false,"properties":{"arch":{"anyOf":[{"items":{"enum":["arm64","armv7l","ia32","x64"],"type":"string"},"type":"array"},{"enum":["arm64","armv7l","ia32","x64"],"type":"string"}],"description":"The arch or list of archs."},"target":{"description":"The target name. e.g. `snap`.","type":"string"}},"required":["target"],"title":"TargetConfiguration","type":"object"},"WindowsConfiguration":{"additionalProperties":false,"properties":{"additionalCertificateFile":{"description":"The path to an additional certificate file you want to add to the signature block.","type":["null","string"]},"appId":{"default":"com.electron.${name}","description":"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.","type":["null","string"]},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).","type":["null","string"]},"asar":{"anyOf":[{"$ref":"#/definitions/AsarOptions"},{"type":["null","boolean"]}],"default":true,"description":"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."},"asarUnpack":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."},"certificateFile":{"description":"The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.\nPlease see [Code Signing](/code-signing).","type":["null","string"]},"certificatePassword":{"description":"The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.\nPlease see [Code Signing](/code-signing).","type":["null","string"]},"certificateSha1":{"description":"The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).","type":["null","string"]},"certificateSubjectName":{"description":"The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).","type":["null","string"]},"compression":{"anyOf":[{"enum":["maximum","normal","store"],"type":"string"},{"type":"null"}],"default":"normal","description":"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."},"cscKeyPassword":{"type":["null","string"]},"cscLink":{"type":["null","string"]},"detectUpdateChannel":{"default":true,"description":"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.","type":"boolean"},"electronUpdaterCompatibility":{"description":"The [electron-updater compatibility](/auto-update#compatibility) semver range.","type":["null","string"]},"extraFiles":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"extraResources":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"fileAssociations":{"anyOf":[{"$ref":"#/definitions/FileAssociation"},{"items":{"$ref":"#/definitions/FileAssociation"},"type":"array"}],"description":"The file associations."},"files":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"forceCodeSigning":{"description":"Whether to fail if app will be not code signed.","type":"boolean"},"generateUpdatesFilesForAllChannels":{"default":false,"description":"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).","type":"boolean"},"icon":{"default":"build/icon.ico","description":"The path to application icon.","type":["null","string"]},"legalTrademarks":{"description":"The trademarks and registered trademarks.","type":["null","string"]},"protocols":{"anyOf":[{"$ref":"#/definitions/Protocol"},{"items":{"$ref":"#/definitions/Protocol"},"type":"array"}],"description":"The URL protocol schemes."},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"publisherName":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.\nDefaults to common name from your code signing certificate."},"releaseInfo":{"$ref":"#/definitions/ReleaseInfo","description":"The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"},"requestedExecutionLevel":{"anyOf":[{"enum":["asInvoker","highestAvailable","requireAdministrator"],"type":"string"},{"type":"null"}],"default":"asInvoker","description":"The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed.\nCannot be specified per target, allowed only in the `win`."},"rfc3161TimeStampServer":{"default":"http://timestamp.comodoca.com/rfc3161","description":"The URL of the RFC 3161 time stamp server.","type":["null","string"]},"sign":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The custom function (or path to file or module id) to sign Windows executable."},"signAndEditExecutable":{"default":true,"description":"Whether to sign and add metadata to executable. Advanced option.","type":"boolean"},"signDlls":{"default":false,"description":"Whether to sign DLL files. Advanced option.","type":"boolean"},"signingHashAlgorithms":{"anyOf":[{"items":{"enum":["sha1","sha256"],"type":"string"},"type":"array"},{"type":"null"}],"default":"['sha1', 'sha256']","description":"Array of signing algorithms used. For AppX `sha256` is always used."},"target":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"items":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}],"default":"nsis","description":"The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\nAppX package can be built only on Windows 10.\n\nTo use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency."},"timeStampServer":{"default":"http://timestamp.verisign.com/scripts/timestamp.dll","description":"The URL of the time stamp server.","type":["null","string"]},"verifyUpdateCodeSignature":{"default":true,"description":"Whether to verify the signature of an available update before installation.\nThe [publisher name](#publisherName) will be used for the signature verification.","type":"boolean"}},"title":"WindowsConfiguration","type":"object"}},"description":"Configuration Options","properties":{"$schema":{"description":"JSON Schema for this document.","type":["null","string"]},"afterAllArtifactBuild":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild)."},"afterPack":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign)."},"afterSign":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format)."},"apk":{"anyOf":[{"$ref":"#/definitions/LinuxTargetSpecificOptions"},{"type":"null"}]},"appId":{"default":"com.electron.${name}","description":"The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.","type":["null","string"]},"appImage":{"anyOf":[{"$ref":"#/definitions/AppImageOptions"},{"type":"null"}],"description":"AppImage options."},"appx":{"anyOf":[{"$ref":"#/definitions/AppXOptions"},{"type":"null"}]},"artifactBuildCompleted":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be run on artifact build completed."},"artifactBuildStarted":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be run on artifact build start."},"artifactName":{"description":"The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).","type":["null","string"]},"asar":{"anyOf":[{"$ref":"#/definitions/AsarOptions"},{"type":["null","boolean"]}],"default":true,"description":"Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n\nNode modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work."},"asarUnpack":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive."},"beforeBuild":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\n\nIf provided and `node_modules` are missing, it will not invoke production dependencies check."},"buildDependenciesFromSource":{"default":false,"description":"Whether to build the application native dependencies from source.","type":"boolean"},"buildVersion":{"description":"The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\nIf `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).","type":["null","string"]},"compression":{"anyOf":[{"enum":["maximum","normal","store"],"type":"string"},{"type":"null"}],"default":"normal","description":"The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time."},"copyright":{"default":"Copyright \u00a9 year ${author}","description":"The human-readable copyright line for the app.","type":["null","string"]},"cscKeyPassword":{"type":["null","string"]},"cscLink":{"type":["null","string"]},"deb":{"anyOf":[{"$ref":"#/definitions/DebOptions"},{"type":"null"}],"description":"Debian package options."},"detectUpdateChannel":{"default":true,"description":"Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.","type":"boolean"},"directories":{"anyOf":[{"$ref":"#/definitions/MetadataDirectories"},{"type":"null"}]},"dmg":{"anyOf":[{"$ref":"#/definitions/DmgOptions"},{"type":"null"}],"description":"macOS DMG options."},"electronCompile":{"description":"Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.","type":"boolean"},"electronDist":{"description":"The path to custom Electron build (e.g. `~/electron/out/R`).","type":"string"},"electronDownload":{"$ref":"#/definitions/ElectronDownloadOptions","description":"The [electron-download](https://github.com/electron-userland/electron-download#usage) options."},"electronUpdaterCompatibility":{"description":"The [electron-updater compatibility](/auto-update#compatibility) semver range.","type":["null","string"]},"electronVersion":{"description":"The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.","type":["null","string"]},"extends":{"description":"The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported.\n\nIf `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.","type":["null","string"]},"extraFiles":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"extraMetadata":{"description":"Inject properties to `package.json`."},"extraResources":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"fileAssociations":{"anyOf":[{"$ref":"#/definitions/FileAssociation"},{"items":{"$ref":"#/definitions/FileAssociation"},"type":"array"}],"description":"The file associations."},"files":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"items":{"anyOf":[{"$ref":"#/definitions/FileSet"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"forceCodeSigning":{"description":"Whether to fail if app will be not code signed.","type":"boolean"},"framework":{"description":"The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.","type":["null","string"]},"freebsd":{"anyOf":[{"$ref":"#/definitions/LinuxTargetSpecificOptions"},{"type":"null"}]},"generateUpdatesFilesForAllChannels":{"default":false,"description":"Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).","type":"boolean"},"icon":{"type":["null","string"]},"includePdb":{"default":false,"description":"Whether to include PDB files.","type":"boolean"},"launchUiVersion":{"description":"*libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.","type":["null","string","boolean"]},"linux":{"anyOf":[{"$ref":"#/definitions/LinuxConfiguration"},{"type":"null"}],"description":"Options related to how build Linux targets."},"mac":{"anyOf":[{"$ref":"#/definitions/MacConfiguration"},{"type":"null"}],"description":"Options related to how build macOS targets."},"mas":{"anyOf":[{"$ref":"#/definitions/MasConfiguration"},{"type":"null"}],"description":"MAS (Mac Application Store) options."},"msi":{"anyOf":[{"$ref":"#/definitions/MsiOptions"},{"type":"null"}]},"muonVersion":{"description":"The version of muon you are packaging for.","type":["null","string"]},"nodeGypRebuild":{"default":false,"description":"Whether to execute `node-gyp rebuild` before starting to package the app.\n\nDon't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.","type":"boolean"},"nodeVersion":{"description":"*libui-based frameworks only* The version of NodeJS you are packaging for.\nYou can set it to `current` to set the Node.js version that you use to run.","type":["null","string"]},"npmArgs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":["null","string"]}],"description":"Additional command line arguments to use when installing app native deps."},"npmRebuild":{"default":true,"description":"Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.","type":"boolean"},"npmSkipBuildFromSource":{"type":"boolean"},"nsis":{"anyOf":[{"$ref":"#/definitions/NsisOptions"},{"type":"null"}]},"nsisWeb":{"anyOf":[{"$ref":"#/definitions/NsisWebOptions"},{"type":"null"}]},"onNodeModuleFile":{"anyOf":[{"typeof":"function"},{"type":["null","string"]}],"description":"The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file."},"p5p":{"anyOf":[{"$ref":"#/definitions/LinuxTargetSpecificOptions"},{"type":"null"}]},"pacman":{"anyOf":[{"$ref":"#/definitions/LinuxTargetSpecificOptions"},{"type":"null"}]},"pkg":{"anyOf":[{"$ref":"#/definitions/PkgOptions"},{"type":"null"}],"description":"macOS PKG options."},"portable":{"anyOf":[{"$ref":"#/definitions/PortableOptions"},{"type":"null"}]},"productName":{"description":"As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).","type":["null","string"]},"protocols":{"anyOf":[{"$ref":"#/definitions/Protocol"},{"items":{"$ref":"#/definitions/Protocol"},"type":"array"}],"description":"The URL protocol schemes."},"protonNodeVersion":{"type":["null","string"]},"publish":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"items":{"anyOf":[{"$ref":"#/definitions/GithubOptions"},{"$ref":"#/definitions/S3Options"},{"$ref":"#/definitions/SpacesOptions"},{"$ref":"#/definitions/GenericServerOptions"},{"$ref":"#/definitions/BintrayOptions"},{"$ref":"#/definitions/CustomPublishOptions"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"readonly":{"default":false,"description":"Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).","type":"boolean"},"releaseInfo":{"$ref":"#/definitions/ReleaseInfo","description":"The release info. Intended for command line usage:\n\n```\n-c.releaseInfo.releaseNotes=\"new features\"\n```"},"remoteBuild":{"default":true,"description":"Whether to build using Electron Build Service if target not supported on current OS.","type":"boolean"},"removePackageScripts":{"default":true,"description":"Whether to remove `scripts` field from `package.json` files.","type":"boolean"},"rpm":{"anyOf":[{"$ref":"#/definitions/LinuxTargetSpecificOptions"},{"type":"null"}]},"snap":{"anyOf":[{"$ref":"#/definitions/SnapOptions"},{"type":"null"}],"description":"Snap options."},"squirrelWindows":{"anyOf":[{"$ref":"#/definitions/SquirrelWindowsOptions"},{"type":"null"}]},"target":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"items":{"anyOf":[{"$ref":"#/definitions/TargetConfiguration"},{"type":"string"}]},"type":"array"},{"type":["null","string"]}]},"win":{"anyOf":[{"$ref":"#/definitions/WindowsConfiguration"},{"type":"null"}],"description":"Options related to how build Windows targets."}},"type":"object"}
|
Provide a JSON object that satisfies the schema "electron-builder". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
electron-builder
|
schema-store
|
schema_store_294
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/elgato-stream-deck-plugin.json\",\"$comment\":\"Used as reference: https://docs.elgato.com/sdk/plugins/manifest\",\"additionalProperties\":true,\"title\":\"Elgato Stream Deck Manifest\",\"description\":\"Manifest files for plugins built for the Elgato Stream Deck SDK\",\"type\":\"object\",\"properties\":{\"Author\":{\"description\":\"The author of the plugin. This string is displayed to the user in the Stream Deck store.\",\"type\":\"string\"},\"CodePath\":{\"type\":\"string\",\"description\":\"The relative path to the HTML/binary file containing the plugin code.\"},\"Description\":{\"type\":\"string\",\"description\":\"Provides a general description of what the plugin does. This string is displayed to the user in the Stream Deck store.\"},\"Icon\":{\"type\":\"string\",\"description\":\"The relative path to an image without the extension. This image is displayed in the Stream Deck marketplace. SVGs are preferred. If not, the PNG image should be 288 x 288 px, and you should provide @1x and @2x (288 x 288 px & 576 x 576 px respectively). The Stream Deck application takes care of loading the appropriate version of the image.\"},\"Name\":{\"type\":\"string\",\"description\":\"The name of the plugin. This string is displayed to the user in the Stream Deck store.\"},\"Version\":{\"type\":\"string\",\"description\":\"Plugin's semantic version (1.0.0).\"},\"SDKVersion\":{\"type\":\"number\",\"minimum\":1,\"description\":\"The current SDK version is 2.\"},\"OS\":{\"type\":\"array\",\"description\":\"The list of operating systems & versions supported by the plugin.\",\"minItems\":1,\"items\":{\"type\":\"object\",\"properties\":{\"Platform\":{\"enum\":[\"mac\",\"windows\"]},\"MinimumVersion\":{\"type\":\"string\",\"description\":\"The minimum version of the operating system that the plugin requires. Example: For Windows 10, you can use `10`. For macOS 10.11, you can use `10.11`.\",\"examples\":[\"10\",\"10.11\"],\"pattern\":\"^\\\\d+(\\\\.\\\\d+)*$\"}},\"required\":[\"Platform\",\"MinimumVersion\"]}},\"Software\":{\"type\":\"object\",\"description\":\"Indicates which version of the Stream Deck application is required to install the plugin.\",\"properties\":{\"MinimumVersion\":{\"type\":\"string\",\"description\":\"The minimum version of the operating system that the plugin requires. For Windows 10, you can use \\u201c10\\u201d. For macOS 10.11, you can use \\u201c10.11\\u201d.\",\"pattern\":\"^\\\\d+(\\\\.\\\\d+)*$\"}}},\"Category\":{\"type\":\"string\",\"description\":\"The name of the custom category in which the actions should be listed. This string is visible to the user in the actions list. If you don't provide a category, the actions will appear inside a \\\"Custom\\\" category.\"},\"CategoryIcon\":{\"type\":\"string\",\"description\":\"The relative path to a PNG image without the .png extension. This image is used in the actions list. The PNG image should be a 28pt x 28pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image.\"},\"CodePathMac\":{\"type\":\"string\",\"description\":\"Override CodePath for macOS.\"},\"CodePathWin\":{\"type\":\"string\",\"description\":\"Override CodePath for Windows.\"},\"Profiles\":{\"type\":\"array\",\"description\":\"Specifies an array of profiles. A plugin can have one or more profiles proposed to the user on installation. This lets you create full screen plugins.\",\"items\":{\"type\":\"object\",\"required\":[\"Name\",\"DeviceType\"],\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"The filename of the profile.\"},\"DeviceType\":{\"description\":\"Type of device.\",\"type\":\"integer\",\"minimum\":0,\"maximum\":7},\"Readonly\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Boolean to mark the profile as read-only.\"},\"DontAutoSwitchWhenInstalled\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Boolean to prevent Stream Deck from automatically switching to this profile when installed.\"}}}},\"PropertyInspectorPath\":{\"type\":\"string\",\"description\":\"The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector. If missing, the plugin will have an empty Property Inspector.\"},\"DefaultWindowSize\":{\"type\":\"array\",\"description\":\"Specify the default window size when a Javascript plugin or Property Inspector opens a window using window.open(). The default value is [500, 650].\",\"items\":{\"type\":\"number\"},\"minItems\":2,\"maxItems\":2},\"URL\":{\"type\":\"string\",\"description\":\"A site to provide more information about the plugin.\"},\"ApplicationsToMonitor\":{\"type\":\"object\",\"description\":\"List of application identifiers to monitor (applications launched or terminated). See the `applicationDidLaunch` and `applicationDidTerminate` events.\",\"properties\":{\"mac\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"windows\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"Actions\":{\"description\":\"Specifies an array of actions. A plugin can indeed have one or multiple actions. For example, the \\u201cGame Capture\\u201d plugin has six actions: Scene, Record, Screenshot, Flashback Recording, Stream, Live Commentary.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"UUID\",\"Name\",\"States\"],\"oneOf\":[{\"required\":[\"Icon\"],\"properties\":{\"Icon\":{\"type\":\"string\",\"description\":\"The relative path to a PNG image without the .png extension. This image is displayed in the actions list. The PNG image should be a 20pt x 20pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image. This icon is not required for actions not visible in the actions list (`VisibleInActionsList` set to false).\"}}},{\"required\":[\"VisibleInActionsList\"],\"properties\":{\"VisibleInActionsList\":{\"const\":false,\"description\":\"Boolean to hide the action in the actions list. This can be used for a plugin that only works with a specific profile.\"}}}],\"properties\":{\"UUID\":{\"type\":\"string\",\"pattern\":\"^[a-z0-9\\\\-.]\",\"description\":\"The unique identifier of the action. It must be a uniform type identifier (UTI) that contains only lowercase alphanumeric characters (a-z, 0-9), hyphen (-), and period (.). The string must be in reverse-DNS format. For example, if your domain is `elgato.com` and you create a plugin named `Hello` with the action `My Action`, you could assign the string `com.elgato.hello.myaction` as your action's Unique Identifier.\"},\"Name\":{\"type\":\"string\",\"description\":\"The name of the action. This string is visible to the user in the actions list.\"},\"Icon\":{\"type\":\"string\",\"description\":\"The relative path to a PNG image without the .png extension. This image is displayed in the actions list. The PNG image should be a 20pt x 20pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image. This icon is not required for actions not visible in the actions list (`VisibleInActionsList` set to false).\"},\"States\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"Image\"],\"properties\":{\"Image\":{\"type\":\"string\",\"description\":\"The default image for the state. When a user sets a custom image on the primary state, Stream Deck will automatically set the secondary state to a darker version of the same icon.\"},\"MultiActionImage\":{\"type\":\"string\",\"description\":\"This can be used if you want to provide a different image for the state when the action is displayed in a Multi-Action.\"},\"Name\":{\"type\":\"string\",\"description\":\"Displayed in the dropdown menu in the Multi-action. For example, the Game Capture Record action has Start and Stop. If the name is not provided, the state will not appear in the Multi-Action.\"},\"Title\":{\"type\":\"string\",\"description\":\"Default title.\"},\"ShowTitle\":{\"type\":\"string\",\"description\":\"Boolean to show or hide the title\"},\"TitleColor\":{\"type\":\"string\",\"description\":\"Default title color.\"},\"FontFamily\":{\"type\":\"string\",\"enum\":[\"Arial\",\"Arial Black\",\"Comic Sans MS\",\"Courier\",\"Courier New\",\"Georgia\",\"Impact\",\"Microsoft Sans Serif\",\"Symbol\",\"Tahoma\",\"Times New Roman\",\"Trebuchet MS\",\"Verdana\",\"Webdings\",\"Wingdings\"],\"description\":\"Default font family for the title.\"},\"TitleAlignment\":{\"type\":\"string\",\"enum\":[\"top\",\"bottom\",\"middle\"],\"description\":\"Default title vertical alignment.\"},\"FontStyle\":{\"type\":\"string\",\"enum\":[\"Regular\",\"Bold\",\"Italic\",\"Bold Italic\"],\"description\":\"Default font style for the title. Note that some fonts might not support all values.\"},\"FontSize\":{\"type\":\"string\",\"description\":\"Default font size for the title.\"},\"FontUnderline\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Boolean to have an underline under the title.\"}}}},\"PropertyInspectorPath\":{\"type\":\"string\",\"description\":\"This can override PropertyInspectorPath member from the plugin if you wish to have a different PropertyInspectorPath based on the action. The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector.\"},\"SupportedInMultiActions\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Boolean to prevent the action from being used in a Multi Action.\"},\"Tooltip\":{\"type\":\"string\",\"description\":\"The string is displayed as a tooltip when the user leaves the mouse over your action in the actions list.\"},\"DisableCaching\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Boolean to disable image caching.\"},\"DisableAutomaticStates\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Determines whether the state of the action should automatically toggle when the user presses the action; only applies to actions that have two states defined.\"},\"VisibleInActionsList\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Boolean to hide the action in the actions list. This can be used for a plugin that only works with a specific profile.\"},\"UserTitleEnabled\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Boolean to disable the title field for users in the property inspector.\"},\"Controllers\":{\"type\":\"array\",\"description\":\"Specifies an array of controllers.\",\"items\":{\"type\":\"string\",\"enum\":[\"Keypad\",\"Encoder\"]},\"default\":[\"Keypad\"]},\"Encoder\":{\"type\":\"object\",\"description\":\"Used to describe and configure the dial and display segment on Stream Deck +.\",\"properties\":{\"background\":{\"type\":\"string\",\"description\":\"The default background image for the encoders touch display slot.\"},\"Icon\":{\"type\":\"string\",\"description\":\"The default icon found in the property inspector, dial stack image, and the layout. If no icon is set Stream Deck will use the action list icon.\"},\"layout\":{\"type\":\"string\",\"description\":\"A string containing the name of a built-in layout or the partial path to a JSON file with a custom layout definition. You can dynamically change the layout with with setFeedbackLayout event. The default layout is the Icon Layout ($X1).\"},\"StackColor\":{\"type\":\"string\",\"description\":\"The color that will be used in the dial stack as background color.\"},\"TriggerDescription\":{\"type\":\"object\",\"description\":\"Used to describe encoder actions in the property inspector.\",\"properties\":{\"Rotate\":{\"description\":\"Describe the rotation.\",\"type\":\"string\"},\"Push\":{\"description\":\"Describe the encoder push.\",\"type\":\"string\"},\"Touch\":{\"description\":\"Describe the touch.\",\"type\":\"string\"},\"LongTouch\":{\"description\":\"Describe the long touch.\",\"type\":\"string\"}}}}}}}}},\"required\":[\"Actions\",\"CodePath\",\"Description\",\"Icon\",\"Name\",\"Version\",\"SDKVersion\",\"OS\",\"Software\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Elgato Stream Deck Manifest\". Here are the required top‑level fields: Actions, CodePath, Description, Icon, Name, Version, SDKVersion, OS, Software. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/elgato-stream-deck-plugin.json","$comment":"Used as reference: https://docs.elgato.com/sdk/plugins/manifest","additionalProperties":true,"title":"Elgato Stream Deck Manifest","description":"Manifest files for plugins built for the Elgato Stream Deck SDK","type":"object","properties":{"Author":{"description":"The author of the plugin. This string is displayed to the user in the Stream Deck store.","type":"string"},"CodePath":{"type":"string","description":"The relative path to the HTML/binary file containing the plugin code."},"Description":{"type":"string","description":"Provides a general description of what the plugin does. This string is displayed to the user in the Stream Deck store."},"Icon":{"type":"string","description":"The relative path to an image without the extension. This image is displayed in the Stream Deck marketplace. SVGs are preferred. If not, the PNG image should be 288 x 288 px, and you should provide @1x and @2x (288 x 288 px & 576 x 576 px respectively). The Stream Deck application takes care of loading the appropriate version of the image."},"Name":{"type":"string","description":"The name of the plugin. This string is displayed to the user in the Stream Deck store."},"Version":{"type":"string","description":"Plugin's semantic version (1.0.0)."},"SDKVersion":{"type":"number","minimum":1,"description":"The current SDK version is 2."},"OS":{"type":"array","description":"The list of operating systems & versions supported by the plugin.","minItems":1,"items":{"type":"object","properties":{"Platform":{"enum":["mac","windows"]},"MinimumVersion":{"type":"string","description":"The minimum version of the operating system that the plugin requires. Example: For Windows 10, you can use `10`. For macOS 10.11, you can use `10.11`.","examples":["10","10.11"],"pattern":"^\\d+(\\.\\d+)*$"}},"required":["Platform","MinimumVersion"]}},"Software":{"type":"object","description":"Indicates which version of the Stream Deck application is required to install the plugin.","properties":{"MinimumVersion":{"type":"string","description":"The minimum version of the operating system that the plugin requires. For Windows 10, you can use \u201c10\u201d. For macOS 10.11, you can use \u201c10.11\u201d.","pattern":"^\\d+(\\.\\d+)*$"}}},"Category":{"type":"string","description":"The name of the custom category in which the actions should be listed. This string is visible to the user in the actions list. If you don't provide a category, the actions will appear inside a \"Custom\" category."},"CategoryIcon":{"type":"string","description":"The relative path to a PNG image without the .png extension. This image is used in the actions list. The PNG image should be a 28pt x 28pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image."},"CodePathMac":{"type":"string","description":"Override CodePath for macOS."},"CodePathWin":{"type":"string","description":"Override CodePath for Windows."},"Profiles":{"type":"array","description":"Specifies an array of profiles. A plugin can have one or more profiles proposed to the user on installation. This lets you create full screen plugins.","items":{"type":"object","required":["Name","DeviceType"],"properties":{"Name":{"type":"string","description":"The filename of the profile."},"DeviceType":{"description":"Type of device.","type":"integer","minimum":0,"maximum":7},"Readonly":{"type":"boolean","default":false,"description":"Boolean to mark the profile as read-only."},"DontAutoSwitchWhenInstalled":{"type":"boolean","default":false,"description":"Boolean to prevent Stream Deck from automatically switching to this profile when installed."}}}},"PropertyInspectorPath":{"type":"string","description":"The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector. If missing, the plugin will have an empty Property Inspector."},"DefaultWindowSize":{"type":"array","description":"Specify the default window size when a Javascript plugin or Property Inspector opens a window using window.open(). The default value is [500, 650].","items":{"type":"number"},"minItems":2,"maxItems":2},"URL":{"type":"string","description":"A site to provide more information about the plugin."},"ApplicationsToMonitor":{"type":"object","description":"List of application identifiers to monitor (applications launched or terminated). See the `applicationDidLaunch` and `applicationDidTerminate` events.","properties":{"mac":{"type":"array","items":{"type":"string"}},"windows":{"type":"array","items":{"type":"string"}}}},"Actions":{"description":"Specifies an array of actions. A plugin can indeed have one or multiple actions. For example, the \u201cGame Capture\u201d plugin has six actions: Scene, Record, Screenshot, Flashback Recording, Stream, Live Commentary.","type":"array","items":{"type":"object","required":["UUID","Name","States"],"oneOf":[{"required":["Icon"],"properties":{"Icon":{"type":"string","description":"The relative path to a PNG image without the .png extension. This image is displayed in the actions list. The PNG image should be a 20pt x 20pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image. This icon is not required for actions not visible in the actions list (`VisibleInActionsList` set to false)."}}},{"required":["VisibleInActionsList"],"properties":{"VisibleInActionsList":{"const":false,"description":"Boolean to hide the action in the actions list. This can be used for a plugin that only works with a specific profile."}}}],"properties":{"UUID":{"type":"string","pattern":"^[a-z0-9\\-.]","description":"The unique identifier of the action. It must be a uniform type identifier (UTI) that contains only lowercase alphanumeric characters (a-z, 0-9), hyphen (-), and period (.). The string must be in reverse-DNS format. For example, if your domain is `elgato.com` and you create a plugin named `Hello` with the action `My Action`, you could assign the string `com.elgato.hello.myaction` as your action's Unique Identifier."},"Name":{"type":"string","description":"The name of the action. This string is visible to the user in the actions list."},"Icon":{"type":"string","description":"The relative path to a PNG image without the .png extension. This image is displayed in the actions list. The PNG image should be a 20pt x 20pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image. This icon is not required for actions not visible in the actions list (`VisibleInActionsList` set to false)."},"States":{"type":"array","items":{"type":"object","required":["Image"],"properties":{"Image":{"type":"string","description":"The default image for the state. When a user sets a custom image on the primary state, Stream Deck will automatically set the secondary state to a darker version of the same icon."},"MultiActionImage":{"type":"string","description":"This can be used if you want to provide a different image for the state when the action is displayed in a Multi-Action."},"Name":{"type":"string","description":"Displayed in the dropdown menu in the Multi-action. For example, the Game Capture Record action has Start and Stop. If the name is not provided, the state will not appear in the Multi-Action."},"Title":{"type":"string","description":"Default title."},"ShowTitle":{"type":"string","description":"Boolean to show or hide the title"},"TitleColor":{"type":"string","description":"Default title color."},"FontFamily":{"type":"string","enum":["Arial","Arial Black","Comic Sans MS","Courier","Courier New","Georgia","Impact","Microsoft Sans Serif","Symbol","Tahoma","Times New Roman","Trebuchet MS","Verdana","Webdings","Wingdings"],"description":"Default font family for the title."},"TitleAlignment":{"type":"string","enum":["top","bottom","middle"],"description":"Default title vertical alignment."},"FontStyle":{"type":"string","enum":["Regular","Bold","Italic","Bold Italic"],"description":"Default font style for the title. Note that some fonts might not support all values."},"FontSize":{"type":"string","description":"Default font size for the title."},"FontUnderline":{"type":"boolean","default":false,"description":"Boolean to have an underline under the title."}}}},"PropertyInspectorPath":{"type":"string","description":"This can override PropertyInspectorPath member from the plugin if you wish to have a different PropertyInspectorPath based on the action. The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector."},"SupportedInMultiActions":{"type":"boolean","default":true,"description":"Boolean to prevent the action from being used in a Multi Action."},"Tooltip":{"type":"string","description":"The string is displayed as a tooltip when the user leaves the mouse over your action in the actions list."},"DisableCaching":{"type":"boolean","default":false,"description":"Boolean to disable image caching."},"DisableAutomaticStates":{"type":"boolean","default":false,"description":"Determines whether the state of the action should automatically toggle when the user presses the action; only applies to actions that have two states defined."},"VisibleInActionsList":{"type":"boolean","default":true,"description":"Boolean to hide the action in the actions list. This can be used for a plugin that only works with a specific profile."},"UserTitleEnabled":{"type":"boolean","default":true,"description":"Boolean to disable the title field for users in the property inspector."},"Controllers":{"type":"array","description":"Specifies an array of controllers.","items":{"type":"string","enum":["Keypad","Encoder"]},"default":["Keypad"]},"Encoder":{"type":"object","description":"Used to describe and configure the dial and display segment on Stream Deck +.","properties":{"background":{"type":"string","description":"The default background image for the encoders touch display slot."},"Icon":{"type":"string","description":"The default icon found in the property inspector, dial stack image, and the layout. If no icon is set Stream Deck will use the action list icon."},"layout":{"type":"string","description":"A string containing the name of a built-in layout or the partial path to a JSON file with a custom layout definition. You can dynamically change the layout with with setFeedbackLayout event. The default layout is the Icon Layout ($X1)."},"StackColor":{"type":"string","description":"The color that will be used in the dial stack as background color."},"TriggerDescription":{"type":"object","description":"Used to describe encoder actions in the property inspector.","properties":{"Rotate":{"description":"Describe the rotation.","type":"string"},"Push":{"description":"Describe the encoder push.","type":"string"},"Touch":{"description":"Describe the touch.","type":"string"},"LongTouch":{"description":"Describe the long touch.","type":"string"}}}}}}}}},"required":["Actions","CodePath","Description","Icon","Name","Version","SDKVersion","OS","Software"]}
|
Provide a JSON object that satisfies the schema "Elgato Stream Deck Manifest". Here are the required top‑level fields: Actions, CodePath, Description, Icon, Name, Version, SDKVersion, OS, Software. Return only the valid JSON object.
|
Elgato Stream Deck Manifest
|
schema-store
|
schema_store_295
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/elm.json\",\"anyOf\":[{\"$ref\":\"#/definitions/Application\"},{\"$ref\":\"#/definitions/Package\"}],\"definitions\":{\"Package\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"package\"},\"name\":{\"type\":\"string\",\"pattern\":\"^[^/]+/[^/]+$\"},\"summary\":{\"type\":\"string\"},\"license\":{\"anyOf\":[{\"type\":\"string\"},{\"enum\":[\"AGPL-3.0-only\",\"Apache-2.0\",\"BSD-2-Clause\",\"BSD-3-Clause\",\"BSL-1.0\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"EPL-1.0\",\"EPL-2.0\",\"GPL-2.0-only\",\"GPL-3.0-only\",\"ISC\",\"LGPL-2.0-only\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"MIT\",\"MPL-2.0\",\"MS-PL\",\"UNLICENSED\"]}]},\"version\":{\"type\":\"string\"},\"exposed-modules\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\".*\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[]}]},\"elm-version\":{\"$ref\":\"#/definitions/Range\"},\"dependencies\":{\"$ref\":\"#/definitions/PackageDependencies\"},\"test-dependencies\":{\"$ref\":\"#/definitions/PackageDependencies\"}},\"required\":[\"dependencies\",\"elm-version\",\"exposed-modules\",\"license\",\"name\",\"summary\",\"test-dependencies\",\"type\",\"version\"]},\"Application\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"const\":\"application\"},\"source-directories\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"elm-version\":{\"$ref\":\"#/definitions/Version\"},\"dependencies\":{\"$ref\":\"#/definitions/ApplicationDependenciesGroup\"},\"test-dependencies\":{\"$ref\":\"#/definitions/ApplicationDependenciesGroup\"}},\"required\":[\"dependencies\",\"elm-version\",\"source-directories\",\"test-dependencies\",\"type\"]},\"ApplicationDependenciesGroup\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"direct\":{\"$ref\":\"#/definitions/ApplicationDependencies\"},\"indirect\":{\"$ref\":\"#/definitions/ApplicationDependencies\"}},\"required\":[\"direct\",\"indirect\"]},\"ApplicationDependencies\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[^/]+/[^/]+$\":{\"$ref\":\"#/definitions/Version\"}},\"required\":[]},\"PackageDependencies\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[^/]+/[^/]+$\":{\"$ref\":\"#/definitions/Range\"}},\"required\":[]},\"Range\":{\"type\":\"string\",\"pattern\":\"^[0-9]+\\\\.[0-9]+\\\\.[0-9]+ <= v < [0-9]+\\\\.[0-9]+\\\\.[0-9]+$\"},\"Version\":{\"type\":\"string\",\"pattern\":\"^[0-9]+\\\\.[0-9]+\\\\.[0-9]+$\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"elm\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/elm.json","anyOf":[{"$ref":"#/definitions/Application"},{"$ref":"#/definitions/Package"}],"definitions":{"Package":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"package"},"name":{"type":"string","pattern":"^[^/]+/[^/]+$"},"summary":{"type":"string"},"license":{"anyOf":[{"type":"string"},{"enum":["AGPL-3.0-only","Apache-2.0","BSD-2-Clause","BSD-3-Clause","BSL-1.0","CC0-1.0","CDDL-1.0","CDDL-1.1","EPL-1.0","EPL-2.0","GPL-2.0-only","GPL-3.0-only","ISC","LGPL-2.0-only","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","MIT","MPL-2.0","MS-PL","UNLICENSED"]}]},"version":{"type":"string"},"exposed-modules":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":false,"patternProperties":{".*":{"type":"array","items":{"type":"string"}}},"required":[]}]},"elm-version":{"$ref":"#/definitions/Range"},"dependencies":{"$ref":"#/definitions/PackageDependencies"},"test-dependencies":{"$ref":"#/definitions/PackageDependencies"}},"required":["dependencies","elm-version","exposed-modules","license","name","summary","test-dependencies","type","version"]},"Application":{"type":"object","additionalProperties":false,"properties":{"type":{"const":"application"},"source-directories":{"type":"array","items":{"type":"string"}},"elm-version":{"$ref":"#/definitions/Version"},"dependencies":{"$ref":"#/definitions/ApplicationDependenciesGroup"},"test-dependencies":{"$ref":"#/definitions/ApplicationDependenciesGroup"}},"required":["dependencies","elm-version","source-directories","test-dependencies","type"]},"ApplicationDependenciesGroup":{"type":"object","additionalProperties":false,"properties":{"direct":{"$ref":"#/definitions/ApplicationDependencies"},"indirect":{"$ref":"#/definitions/ApplicationDependencies"}},"required":["direct","indirect"]},"ApplicationDependencies":{"type":"object","additionalProperties":false,"patternProperties":{"^[^/]+/[^/]+$":{"$ref":"#/definitions/Version"}},"required":[]},"PackageDependencies":{"type":"object","additionalProperties":false,"patternProperties":{"^[^/]+/[^/]+$":{"$ref":"#/definitions/Range"}},"required":[]},"Range":{"type":"string","pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+ <= v < [0-9]+\\.[0-9]+\\.[0-9]+$"},"Version":{"type":"string","pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"}}}
|
Provide a JSON object that satisfies the schema "elm". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
elm
|
schema-store
|
schema_store_296
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"description\":\"JSON Schema definition for the Embrace configuration file.\",\"id\":\"https://json.schemastore.org/embrace-config-schema-1.0.0.json\",\"properties\":{\"app_id\":{\"description\":\"Your 5 character app ID.\",\"type\":\"string\",\"maxLength\":5,\"minLength\":5},\"api_token\":{\"description\":\"Your API 32-hexdigit token.\",\"type\":\"string\",\"maxLength\":32,\"minLength\":32},\"ndk_enabled\":{\"description\":\"Enables NDK crash capture. Defaults to false.\",\"type\":\"boolean\"},\"sdk_config\":{\"type\":\"object\",\"properties\":{\"automatic_data_capture\":{\"type\":\"object\",\"properties\":{\"memory_info\":{\"description\":\"Enables memory warning capture. Defaults to true.\",\"type\":\"boolean\"},\"power_save_mode_info\":{\"description\":\"Enables power save mode capture. Defaults to true.\",\"type\":\"boolean\"},\"network_connectivity_info\":{\"description\":\"Enables network connectivity capture. Defaults to true.\",\"type\":\"boolean\"},\"anr_info\":{\"description\":\"Enables ANR capture. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"taps\":{\"type\":\"object\",\"properties\":{\"capture_coordinates\":{\"description\":\"Set to false to disable capturing tap coordinates. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"view_config\":{\"type\":\"object\",\"properties\":{\"enable_automatic_activity_capture\":{\"description\":\"Enables capturing activity lifecycle changes in breadcrumbs. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"webview\":{\"type\":\"object\",\"properties\":{\"capture_query_params\":{\"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.\",\"type\":\"boolean\"},\"enable\":{\"description\":\"Set to false to disable capturing of web views. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"crash_handler\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"compose\":{\"type\":\"object\",\"properties\":{\"capture_compose_onclick\":{\"description\":\"Enables capture of Jetpack Compose click events. Defaults to false.\",\"type\":\"boolean\"}},\"minProperties\":1},\"capture_fcm_pii_data\":{\"type\":\"boolean\",\"description\":\"Enables PII data within FCM capture. Defaults to false.\"},\"networking\":{\"type\":\"object\",\"properties\":{\"default_capture_limit\":{\"description\":\"Default capture limit for specified domains. Defaults to 1000.\",\"type\":\"integer\"},\"domains\":{\"description\":\"List of domain names and their respective limits.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"domain_name\":{\"description\":\"Domain URL.\",\"type\":\"string\"},\"domain_limit\":{\"description\":\"Limit for the number of requests to be tracked.\",\"type\":\"integer\"}},\"minProperties\":1},\"minItems\":1,\"uniqueItems\":true},\"capture_request_content_length\":{\"description\":\"Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.\",\"type\":\"boolean\"},\"disabled_url_patterns\":{\"description\":\"Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true},\"enable_native_monitoring\":{\"description\":\"Enable capture of network requests made using the native Java network API. Defaults to true.\",\"type\":\"boolean\"},\"enable_network_span_forwarding\":{\"description\":\"Enables network span forwarding. Defaults to false.\",\"type\":\"boolean\"}},\"minProperties\":1},\"capture_public_key\":{\"type\":\"string\",\"description\":\"Declares the key that should be used to capture network request bodies, if any.\"},\"sensitive_keys_denylist\":{\"description\":\"List of sensitive keys whose values should be redacted on capture.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true},\"anr\":{\"type\":\"object\",\"properties\":{\"capture_unity_thread\":{\"description\":\"Enables Unity ANR capture. Defaults to false.\",\"type\":\"boolean\"}},\"minProperties\":1},\"app\":{\"type\":\"object\",\"properties\":{\"report_disk_usage\":{\"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.\",\"type\":\"boolean\"}},\"minProperties\":1},\"background_activity\":{\"type\":\"object\",\"properties\":{\"capture_enabled\":{\"description\":\"Enables background activity capture. Defaults to false.\",\"type\":\"boolean\"}},\"minProperties\":1},\"base_urls\":{\"type\":\"object\",\"properties\":{\"config\":{\"description\":\"Base config URL for the SDK.\",\"type\":\"string\"},\"data\":{\"description\":\"Base data URL for the SDK.\",\"type\":\"integer\"}},\"minProperties\":1},\"session\":{\"type\":\"object\",\"properties\":{\"components\":{\"description\":\"Allowlist of session components that should be included in the session payload. The presence of this property denotes that the gating feature is enabled.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"send_full_for\":{\"description\":\"List of events allowed to send a full session payload if the gating feature is enabled.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true}},\"minProperties\":1},\"sig_handler_detection\":{\"type\":\"boolean\",\"description\":\"Enables 3rd party signal handler detection. Defaults to true.\"},\"app_exit_info\":{\"type\":\"object\",\"properties\":{\"app_exit_info_traces_limit\":{\"description\":\"Defines the max size of bytes to allow capturing AppExitInfo NDK/ANR traces.\",\"type\":\"boolean\"},\"aei_enabled\":{\"description\":\"Enables Application Exit Info capture. Defaults to true.\",\"type\":\"boolean\"}},\"minProperties\":1},\"app_framework\":{\"type\":\"string\",\"description\":\"Project's app framework, one of react_native, unity, flutter or native.\"}},\"minProperties\":1},\"unity\":{\"type\":\"object\",\"properties\":{\"symbols_archive_name\":{\"description\":\"Custom file name for unity symbols\",\"type\":\"string\"}},\"minProperties\":1}},\"title\":\"Embrace Config Schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Embrace Config Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","description":"JSON Schema definition for the Embrace configuration file.","id":"https://json.schemastore.org/embrace-config-schema-1.0.0.json","properties":{"app_id":{"description":"Your 5 character app ID.","type":"string","maxLength":5,"minLength":5},"api_token":{"description":"Your API 32-hexdigit token.","type":"string","maxLength":32,"minLength":32},"ndk_enabled":{"description":"Enables NDK crash capture. Defaults to false.","type":"boolean"},"sdk_config":{"type":"object","properties":{"automatic_data_capture":{"type":"object","properties":{"memory_info":{"description":"Enables memory warning capture. Defaults to true.","type":"boolean"},"power_save_mode_info":{"description":"Enables power save mode capture. Defaults to true.","type":"boolean"},"network_connectivity_info":{"description":"Enables network connectivity capture. Defaults to true.","type":"boolean"},"anr_info":{"description":"Enables ANR capture. Defaults to true.","type":"boolean"}},"minProperties":1},"taps":{"type":"object","properties":{"capture_coordinates":{"description":"Set to false to disable capturing tap coordinates. Defaults to true.","type":"boolean"}},"minProperties":1},"view_config":{"type":"object","properties":{"enable_automatic_activity_capture":{"description":"Enables capturing activity lifecycle changes in breadcrumbs. Defaults to true.","type":"boolean"}},"minProperties":1},"webview":{"type":"object","properties":{"capture_query_params":{"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.","type":"boolean"},"enable":{"description":"Set to false to disable capturing of web views. Defaults to true.","type":"boolean"}},"minProperties":1},"crash_handler":{"type":"object","properties":{"enabled":{"description":"Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.","type":"boolean"}},"minProperties":1},"compose":{"type":"object","properties":{"capture_compose_onclick":{"description":"Enables capture of Jetpack Compose click events. Defaults to false.","type":"boolean"}},"minProperties":1},"capture_fcm_pii_data":{"type":"boolean","description":"Enables PII data within FCM capture. Defaults to false."},"networking":{"type":"object","properties":{"default_capture_limit":{"description":"Default capture limit for specified domains. Defaults to 1000.","type":"integer"},"domains":{"description":"List of domain names and their respective limits.","type":"array","items":{"type":"object","properties":{"domain_name":{"description":"Domain URL.","type":"string"},"domain_limit":{"description":"Limit for the number of requests to be tracked.","type":"integer"}},"minProperties":1},"minItems":1,"uniqueItems":true},"capture_request_content_length":{"description":"Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.","type":"boolean"},"disabled_url_patterns":{"description":"Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.","type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true},"enable_native_monitoring":{"description":"Enable capture of network requests made using the native Java network API. Defaults to true.","type":"boolean"},"enable_network_span_forwarding":{"description":"Enables network span forwarding. Defaults to false.","type":"boolean"}},"minProperties":1},"capture_public_key":{"type":"string","description":"Declares the key that should be used to capture network request bodies, if any."},"sensitive_keys_denylist":{"description":"List of sensitive keys whose values should be redacted on capture.","type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true},"anr":{"type":"object","properties":{"capture_unity_thread":{"description":"Enables Unity ANR capture. Defaults to false.","type":"boolean"}},"minProperties":1},"app":{"type":"object","properties":{"report_disk_usage":{"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.","type":"boolean"}},"minProperties":1},"background_activity":{"type":"object","properties":{"capture_enabled":{"description":"Enables background activity capture. Defaults to false.","type":"boolean"}},"minProperties":1},"base_urls":{"type":"object","properties":{"config":{"description":"Base config URL for the SDK.","type":"string"},"data":{"description":"Base data URL for the SDK.","type":"integer"}},"minProperties":1},"session":{"type":"object","properties":{"components":{"description":"Allowlist of session components that should be included in the session payload. The presence of this property denotes that the gating feature is enabled.","type":"array","items":{"type":"string"},"uniqueItems":true},"send_full_for":{"description":"List of events allowed to send a full session payload if the gating feature is enabled.","type":"array","items":{"type":"string"},"minItems":1,"uniqueItems":true}},"minProperties":1},"sig_handler_detection":{"type":"boolean","description":"Enables 3rd party signal handler detection. Defaults to true."},"app_exit_info":{"type":"object","properties":{"app_exit_info_traces_limit":{"description":"Defines the max size of bytes to allow capturing AppExitInfo NDK/ANR traces.","type":"boolean"},"aei_enabled":{"description":"Enables Application Exit Info capture. Defaults to true.","type":"boolean"}},"minProperties":1},"app_framework":{"type":"string","description":"Project's app framework, one of react_native, unity, flutter or native."}},"minProperties":1},"unity":{"type":"object","properties":{"symbols_archive_name":{"description":"Custom file name for unity symbols","type":"string"}},"minProperties":1}},"title":"Embrace Config Schema","type":"object"}
|
Provide a JSON object that satisfies the schema "Embrace Config Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Embrace Config Schema
|
schema-store
|
schema_store_297
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"historyOptionsBlock\":{\"type\":\"object\",\"properties\":{\"period\":{\"type\":\"number\",\"minimum\":0.0},\"temperature\":{\"type\":\"number\"},\"ozone_concentration\":{\"type\":\"number\"},\"block_repeats\":{\"type\":\"number\",\"minimum\":0.0}},\"additionalProperties\":false},\"historyOptionsStep\":{\"properties\":{\"step_repeats\":{\"type\":\"number\",\"minimum\":0.0},\"period\":{\"type\":\"number\",\"minimum\":0.0},\"temperature\":{\"type\":\"number\"},\"ozone_concentration\":{\"type\":\"number\"},\"block_repeats\":{\"type\":\"number\",\"minimum\":0.0}},\"additionalProperties\":false},\"historyOptions\":{\"properties\":{\"type\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"ne\",\"le\",\"dg\",\"gls\",\"ne_plane_stress\",\"le_plane_stress\",\"gls_plane_stress\",\"dg_ss\",\"ne_eq\",\"ne_pl\",\"ne_si\",\"ne_vol\",\"le_eq\",\"le_pl\",\"le_si\",\"hydrostatic_stress\",\"temperature\"]},\"uniqueItems\":true},\"material\":{\"type\":\"string\"},\"volume\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"preage_time\":{\"type\":\"number\",\"minimum\":0.0},\"preage_temperature\":{\"type\":\"number\"},\"step_repeats\":{\"type\":\"number\",\"minimum\":0.0},\"period\":{\"type\":\"number\",\"minimum\":0.0},\"temperature\":{\"type\":\"number\"},\"ozone_concentration\":{\"type\":\"number\"},\"block_repeats\":{\"type\":\"number\",\"minimum\":0.0}},\"additionalProperties\":false},\"historyOptionsGlobal\":{\"properties\":{\"rolling\":{\"type\":\"object\",\"properties\":{\"sectors\":{\"type\":\"number\",\"multipleOf\":1},\"stride\":{\"type\":\"number\",\"multipleOf\":1}}},\"type\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"ne\",\"le\",\"dg\",\"gls\",\"ne_plane_stress\",\"le_plane_stress\",\"gls_plane_stress\",\"dg_ss\",\"ne_eq\",\"ne_pl\",\"ne_si\",\"ne_vol\",\"le_eq\",\"le_pl\",\"le_si\",\"hydrostatic_stress\",\"temperature\"]},\"uniqueItems\":true},\"material\":{\"type\":\"string\"},\"volume\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"preage_time\":{\"type\":\"number\",\"minimum\":0.0},\"preage_temperature\":{\"type\":\"number\"},\"step_repeats\":{\"type\":\"number\",\"minimum\":0.0},\"period\":{\"type\":\"number\",\"minimum\":0.0},\"temperature\":{\"type\":\"number\"},\"ozone_concentration\":{\"type\":\"number\"},\"block_repeats\":{\"type\":\"number\",\"minimum\":0.0}},\"additionalProperties\":false},\"units\":{\"unitless\":{\"description\":\"Units: unitless\"},\"length\":{\"description\":\"Units: [length] e.g. m, mm, in\"},\"length_over_cycle\":{\"description\":\"Units: [length]/[cycle] e.g. m/cycle, mm/cycle, in/cycle\"},\"length_over_time\":{\"description\":\"Units: [length]/[time] e.g. m/s, mm/s, in/s\"},\"length_over_time_concentration\":{\"description\":\"Units: [length]/([time][concentration]) e.g. m/s/[concentration], mm/s/[concentration], in/s/[concentration]\"},\"pressure\":{\"description\":\"Units: [pressure] e.g. Pa, MPa, lbf/in^2\"},\"1_over_pressure\":{\"description\":\"Units: 1/[pressure] e.g. 1/Pa, 1/MPa, in^2/lbf\"},\"energyReleaseRate\":{\"description\":\"Units: [energy_release_rate] e.g. J/m^2, kJ/m^2, in*lb/in^2\"},\"temperature\":{\"description\":\"Units: [temperature] e.g. C, C, F\"},\"temperatureCoefficient\":{\"description\":\"Units: 1/[temperature] e.g. 1/C, 1/C, 1/F\"},\"hysteresis\":{\"description\":\"Units: [energy]/[volume]/[cycle] e.g. J/m^3/cycle, kJ/mm^3/cycle, in*lb/in^3/cycle\"},\"volumetric_heat_rate\":{\"description\":\"Units: [power]/[volume] e.g. W/m^3, mW/mm^3/cycle, lb/s/in^2\"},\"density\":{\"description\":\"Units: [density] e.g. kg/m^3, tonne/mm^3, slug/in^3\"},\"specific_heat\":{\"description\":\"Units: [specific_heat] e.g. J/kg/C, mJ/tonne/C, in*lb/slug/F\"},\"frequency\":{\"description\":\"Units: [1/time] e.g. 1/s, 1/s, 1/s\"},\"frequencyCoefficient\":{\"description\":\"Units: [time] e.g. s, s, s\"}}},\"type\":\"object\",\"properties\":{\"header\":{\"title\":\"Header\",\"description\":\"Text section used to document the analysis.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"settings\":{\"title\":\"Settings Section\",\"description\":\"Settings that control different aspects of the analysis.\",\"type\":\"object\",\"properties\":{\"history_subset\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"default\"]},\"labels\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"materials\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false},\"ced_integration\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"fixed\"]},\"steps\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1}},\"additionalProperties\":false},\"crack_plane_discretization\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tri3d\"]},\"nmesh\":{\"type\":\"number\",\"minimum\":1,\"maximum\":10,\"multipleOf\":1}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"user\"]},\"planes\":{\"description\":\"List of [x,y,z] unit vectors defining the crack planes to use in the analysis.\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":[{\"type\":\"number\",\"maximum\":1.0},{\"type\":\"number\",\"maximum\":1.0},{\"type\":\"number\",\"maximum\":1.0}],\"minItems\":3,\"maxItems\":3},\"minItems\":1}},\"additionalProperties\":false}]},\"microsphere_discretization\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"tri3d\"]},\"nmesh\":{\"type\":\"number\",\"minimum\":1,\"maximum\":10,\"multipleOf\":1}},\"additionalProperties\":false}},\"additionalProperties\":false},\"material_analysis\":{\"title\":\"Material Analysis Definitions\",\"description\":\"Material analysis definitions that will be performed for each material definition.\",\"type\":\"object\",\"properties\":{\"ageing_crack_growth_rate\":{\"type\":\"object\",\"description\":\"Crack growth rate curves at varying ages.\",\"properties\":{\"n_age\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"n_T\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"age_min\":{\"type\":\"number\",\"minimum\":0},\"age_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"T_min\":{\"type\":\"number\"},\"T_max\":{\"type\":\"number\"}},\"required\":[\"age_max\"],\"additionalProperties\":false},\"ageing_strain_life\":{\"type\":\"object\",\"description\":\"Strain-life curves at varying ages.\",\"properties\":{\"n_age\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"n_strain\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"age_min\":{\"type\":\"number\",\"minimum\":0.0},\"age_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"strain_min\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"strain_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0}},\"required\":[\"age_max\",\"strain_min\",\"strain_max\"],\"additionalProperties\":false},\"crack_growth_rate\":{\"type\":\"object\",\"description\":\"Crack growth rate curves at varying R ratios.\",\"properties\":{\"n_R\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"n_T\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"R_min\":{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0},\"R_max\":{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0},\"T_min\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"T_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0}},\"additionalProperties\":false},\"haigh_diagram\":{\"type\":\"object\",\"description\":\"Haigh diagram output.\",\"properties\":{\"n\":{\"type\":\"number\",\"multipleOf\":1.0,\"minimum\":2},\"strain_mean_max\":{\"type\":\"number\"},\"strain_amplitude_max\":{\"type\":\"number\"}},\"additionalProperties\":false},\"stress_strain\":{\"type\":\"object\",\"description\":\"Stress-Strain curves for different modes of deformation.\",\"properties\":{\"n_points\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"n_unloads\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"strain_min\":{\"type\":\"number\"},\"strain_max\":{\"type\":\"number\"},\"volume_strain_min\":{\"type\":\"number\"},\"volume_strain_max\":{\"type\":\"number\"}},\"additionalProperties\":false},\"hysteresis_frequency_sweep\":{\"type\":\"object\",\"description\":\"Hysteresis frequency sweep.\",\"properties\":{\"n_points\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"frequency_min\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"frequency_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"temperature\":{\"type\":\"number\"},\"deformation_mode\":{\"type\":\"string\",\"enum\":[\"simple_tension\",\"planar_tension\",\"simple_shear\"]},\"strain_amplitude\":{\"type\":\"number\"}},\"additionalProperties\":false},\"hysteresis_strain_sweep\":{\"type\":\"object\",\"description\":\"Hysteresis strain sweep.\",\"properties\":{\"n_points\":{\"type\":\"number\",\"multipleOf\":1,\"minimum\":2},\"strain_amplitude_min\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"strain_amplitude_max\":{\"type\":\"number\",\"exclusiveMinimum\":0.0},\"temperature\":{\"type\":\"number\"},\"deformation_mode\":{\"type\":\"string\",\"enum\":[\"simple_tension\",\"planar_tension\",\"simple_shear\"]},\"frequency\":{\"type\":\"number\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"outputs\":{\"title\":\"Output Requests\",\"description\":\"List of output requests for the analysis.\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"adiabatic_time_limit\",\"age\",\"block_cycle\",\"cauchy_stress\",\"cavitation\",\"ced\",\"ced_cycle_count\",\"ced_sphere\",\"crack_growth\",\"crack_size_calibration\",\"engineering_strain\",\"engineering_stress\",\"factor_of_safety\",\"factor_of_safety_ced\",\"factor_of_safety_sphere\",\"history_compression\",\"hysteresis\",\"life\",\"life_sphere\",\"logarithmic_strain\",\"principal_cauchy_stress\",\"principal_engineering_strain\",\"principal_engineering_stress\",\"principal_logarithmic_strain\",\"residual_strength\",\"sed\",\"stiffness_ratio\",\"stiffness_ratio_ageing\",\"stiffness_ratio_cyclic\",\"thermal_runaway\",\"volume_adjustment\",\"wrinkling\"]},{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"name\":{\"enum\":[\"adiabatic_time_limit\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"age\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"block_cycle\"]},\"n_ced\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1},\"n_r_ratio\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"cauchy_stress\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"cavitation\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"ced\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"ced_cycle_cout\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"ced_sphere\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"crack_growth\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"crack_size_calibration\"]},\"c0_min\":{\"type\":\"number\"},\"n_points\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1},\"target_life\":{\"type\":\"number\"}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"engineering_strain\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"engineering_stress\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"factor_of_safety\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"factor_of_safety_ced\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"factor_of_safety_sphere\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"history_compression\"]},\"keep\":{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0},\"n_ced\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1},\"n_r_ratio\":{\"type\":\"number\",\"minimum\":1,\"multipleOf\":1}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"hysteresis\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"life\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"life_sphere\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"logarithmic_strain\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"principal_cauchy_stress\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"principal_engineering_strain\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"principal_engineering_stress\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"principal_logarithmic_strain\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"residual_strength\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"sed\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"stiffness_ratio\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"stiffness_ratio_ageing\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"stiffness_ratio_cyclic\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"thermal_runaway\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"volume_adjustment\"]}},\"additionalProperties\":false},{\"properties\":{\"name\":{\"enum\":[\"wrinkling\"]}},\"additionalProperties\":false}],\"properties\":{\"name\":{\"type\":\"string\"}}}]},\"uniqueItems\":true},\"materials\":{\"title\":\"Material Section\",\"description\":\"List of material definitions.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"c0\":{\"type\":\"number\",\"exclusiveMinimum\":0.0,\"$ref\":\"#/definitions/units/length\"},\"cf\":{\"type\":\"number\",\"exclusiveMinimum\":0.0,\"$ref\":\"#/definitions/units/length\"},\"elasticity\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"arrudaboyce\"]},\"shear_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"limit_stretch\":{\"$ref\":\"#/definitions/units/unitless\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"bulk_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"hyperfoam\"]},\"mu1\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu2\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu3\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu4\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu5\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu6\":{\"$ref\":\"#/definitions/units/pressure\"},\"alpha1\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha2\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha3\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha4\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha5\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha6\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu1\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu2\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu3\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu4\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu5\":{\"$ref\":\"#/definitions/units/unitless\"},\"nu6\":{\"$ref\":\"#/definitions/units/unitless\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"mooneyrivlin\"]},\"C10\":{\"$ref\":\"#/definitions/units/pressure\"},\"C01\":{\"$ref\":\"#/definitions/units/pressure\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"bulk_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"neohookean\"]},\"C10\":{\"$ref\":\"#/definitions/units/pressure\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"bulk_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"ogden\"]},\"mu1\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu2\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu3\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu4\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu5\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu6\":{\"$ref\":\"#/definitions/units/pressure\"},\"alpha1\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha2\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha3\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha4\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha5\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha6\":{\"$ref\":\"#/definitions/units/unitless\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D2\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D3\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D4\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D5\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D6\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"ogden2\"]},\"mu1\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu2\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu3\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu4\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu5\":{\"$ref\":\"#/definitions/units/pressure\"},\"mu6\":{\"$ref\":\"#/definitions/units/pressure\"},\"alpha1\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha2\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha3\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha4\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha5\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha6\":{\"$ref\":\"#/definitions/units/unitless\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D2\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D3\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D4\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D5\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D6\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"reducedpolynomial\"]},\"C10\":{\"$ref\":\"#/definitions/units/pressure\"},\"C20\":{\"$ref\":\"#/definitions/units/pressure\"},\"C30\":{\"$ref\":\"#/definitions/units/pressure\"},\"C40\":{\"$ref\":\"#/definitions/units/pressure\"},\"C50\":{\"$ref\":\"#/definitions/units/pressure\"},\"C60\":{\"$ref\":\"#/definitions/units/pressure\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D2\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D3\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D4\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D5\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"D6\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"uhyper\"]},\"prop1\":{},\"prop2\":{},\"prop3\":{},\"prop4\":{},\"prop5\":{},\"prop6\":{},\"prop7\":{},\"prop8\":{}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"vanderwaals\"]},\"shear_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"limit_stretch\":{\"$ref\":\"#/definitions/units/unitless\"},\"alpha\":{\"$ref\":\"#/definitions/units/unitless\"},\"beta\":{\"$ref\":\"#/definitions/units/unitless\"},\"D1\":{\"$ref\":\"#/definitions/units/1_over_pressure\"},\"bulk_modulus\":{\"$ref\":\"#/definitions/units/pressure\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"mullins\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"ogdenroxburgh\"]},\"r\":{\"$ref\":\"#/definitions/units/unitless\"},\"m\":{\"$ref\":\"#/definitions/units/pressure\"},\"beta\":{\"$ref\":\"#/definitions/units/unitless\"}},\"additionalProperties\":false}]},\"crack_growth_rate\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"thomas\"]},\"rc\":{\"$ref\":\"#/definitions/units/length_over_cycle\"},\"Tcritical\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"F0\":{\"$ref\":\"#/definitions/units/unitless\"},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"lakelindley\"]},\"rc\":{\"$ref\":\"#/definitions/units/length_over_cycle\"},\"Tcritical\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"F0\":{\"$ref\":\"#/definitions/units/unitless\"},\"threshold\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"transition\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"tabular\"]},\"table\":{\"description\":\"List of [T,dcdn] points. Units: ([energy_release_rate], [length]/[cycle]) e.g. (J/m^2, m/cycle), (kJ/m^2, mm/cycle), (in*lb/in^2, in/cycle)\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":[{\"type\":\"number\",\"minimum\":0.0},{\"type\":\"number\",\"minimum\":0.0}],\"minItems\":2,\"maxItems\":2},\"minItems\":2},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"nonrelaxing\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"paris\"]}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"xR_tabular\"]},\"table\":{\"description\":\"List of [x,R] points\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":[{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0},{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0}],\"minItems\":2,\"maxItems\":2}}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"lindley73\"]}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"marsfatemi\"]},\"F1\":{\"$ref\":\"#/definitions/units/unitless\"},\"F2\":{\"$ref\":\"#/definitions/units/unitless\"},\"F3\":{\"$ref\":\"#/definitions/units/unitless\"},\"Fexp\":{\"$ref\":\"#/definitions/units/unitless\"},\"temperatures\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"ozone_attack\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"williams\"]},\"Tz\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"rz\":{\"$ref\":\"#/definitions/units/length_over_time\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"gentmcgrath\"]},\"Tz\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"Kz\":{\"$ref\":\"#/definitions/units/length_over_time_concentration\"},\"Kv\":{\"$ref\":\"#/definitions/units/length_over_time\"},\"Fv\":{\"$ref\":\"#/definitions/units/unitless\"},\"Gv\":{\"$ref\":\"#/definitions/units/temperature\"},\"Tg\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"hysteresis\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"powerlaw\"]},\"chi\":{\"$ref\":\"#/definitions/units/unitless\"},\"deformation_mode\":{\"type\":\"string\",\"enum\":[\"simple_tension\",\"planar_tension\",\"simple_shear\"]},\"strain_amplitude_ref\":{\"$ref\":\"#/definitions/units/unitless\"},\"hys_ref\":{\"$ref\":\"#/definitions/units/hysteresis\"},\"gamma\":{\"$ref\":\"#/definitions/units/unitless\"},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"},\"frequency_ref\":{\"$ref\":\"#/definitions/units/frequency\"},\"TK_frequency_coef\":{\"$ref\":\"#/definitions/units/frequencyCoefficient\"},\"PL_frequency_coef\":{\"$ref\":\"#/definitions/units/frequencyCoefficient\"},\"WLF_C1\":{\"$ref\":\"#/definitions/units/unitless\"},\"WLF_C2\":{\"$ref\":\"#/definitions/units/temperature\"},\"WLF_frequencies\":{\"$ref\":\"#/definitions/units/frequency\"},\"WLF_Gp\":{\"$ref\":\"#/definitions/units/pressure\"},\"WLF_Gpp\":{\"$ref\":\"#/definitions/units/pressure\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"kraus\"]},\"chi\":{\"$ref\":\"#/definitions/units/unitless\"},\"deformation_mode\":{\"type\":\"string\",\"enum\":[\"simple_tension\",\"planar_tension\",\"simple_shear\"]},\"Gp_inf\":{\"$ref\":\"#/definitions/units/pressure\"},\"Gp_0\":{\"$ref\":\"#/definitions/units/pressure\"},\"Gpp_inf\":{\"$ref\":\"#/definitions/units/pressure\"},\"Gpp_max\":{\"$ref\":\"#/definitions/units/pressure\"},\"strain_amplitude_ref\":{\"$ref\":\"#/definitions/units/unitless\"},\"strain_amplitude_c\":{\"$ref\":\"#/definitions/units/unitless\"},\"delta_Gpp_U\":{\"$ref\":\"#/definitions/units/pressure\"},\"m\":{\"$ref\":\"#/definitions/units/unitless\"},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"},\"frequency_ref\":{\"$ref\":\"#/definitions/units/frequency\"},\"TK_frequency_coef\":{\"$ref\":\"#/definitions/units/frequencyCoefficient\"},\"PL_frequency_coef\":{\"$ref\":\"#/definitions/units/frequencyCoefficient\"},\"WLF_C1\":{\"$ref\":\"#/definitions/units/unitless\"},\"WLF_C2\":{\"$ref\":\"#/definitions/units/temperature\"},\"WLF_frequencies\":{\"$ref\":\"#/definitions/units/frequency\"},\"WLF_Gp\":{\"$ref\":\"#/definitions/units/pressure\"},\"WLF_Gpp\":{\"$ref\":\"#/definitions/units/pressure\"}},\"additionalProperties\":false}]},\"thermal_runaway\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"limit\"]},\"density\":{\"$ref\":\"#/definitions/units/density\"},\"heat_rate\":{\"$ref\":\"#/definitions/units/volumetric_heat_rate\"},\"specific_heat\":{\"$ref\":\"#/definitions/units/specific_heat\"},\"temperature_limit\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"viscoelastic_rupture\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"powerlaw\"]},\"rq\":{\"$ref\":\"#/definitions/units/length_over_time\"},\"Tq\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"F\":{\"$ref\":\"#/definitions/units/unitless\"},\"T0\":{\"$ref\":\"#/definitions/units/energyReleaseRate\"},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"tabular\"]},\"table\":{\"description\":\"List of [T,dcdt] points. Units: ([energy_release_rate], [length]/[time]) e.g. (J/m^2, m/s), (kJ/m^2, mm/s), (in*lb/in^2, in/s)\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":[{\"type\":\"number\",\"minimum\":0.0},{\"type\":\"number\",\"minimum\":0.0}],\"minItems\":2,\"maxItems\":2},\"minItems\":2},\"temp_coef\":{\"$ref\":\"#/definitions/units/temperatureCoefficient\"},\"temp_ref\":{\"$ref\":\"#/definitions/units/temperature\"}},\"additionalProperties\":false}]},\"ageing\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"default\"]}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"arrhenius\"]},\"activation_energy\":{},\"temp_ref\":{},\"gas_constant\":{},\"absolute_zero\":{},\"time\":{\"type\":\"array\",\"items\":{\"type\":\"number\",\"minimum\":0.0}},\"stiffness\":{\"type\":\"array\",\"items\":{\"type\":\"number\",\"minimum\":0.0}}},\"additionalProperties\":false}]},\"cyclic_softening\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"enum\":[\"default\"]}},\"additionalProperties\":false},{\"properties\":{\"type\":{\"enum\":[\"tabular\"]},\"table\":{\"description\":\"List of [crack_ratio, stiffness_ratio] points\",\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":[{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0},{\"type\":\"number\",\"minimum\":0.0,\"maximum\":1.0}],\"minItems\":2,\"maxItems\":2}}},\"additionalProperties\":false}]}},\"required\":[\"name\"],\"additionalProperties\":false},\"uniqueItems\":true},\"history\":{\"title\":\"History Section\",\"description\":\"History definitions.\",\"type\":\"object\",\"properties\":{\"options\":{\"$ref\":\"#/definitions/historyOptionsGlobal\"},\"length\":{\"description\":\"Specify the number of histories in the analysis\",\"type\":\"number\",\"multipleOf\":1},\"histories\":{\"description\":\"An array of histories or a file path to an external input file containing an array of histories\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/definitions/historyOptions\"},\"steps\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/definitions/historyOptionsStep\"},\"blocks\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/definitions/historyOptionsBlock\"},\"data\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"number\"}}}},\"additionalProperties\":false}}},\"additionalProperties\":false}}},\"required\":[\"label\"],\"additionalProperties\":false}}]},\"schedule\":{\"description\":\"A schedule definition of steps and blocks, where a block is defined by an external input file containing an array of histories\",\"type\":\"object\",\"properties\":{\"steps\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/definitions/historyOptionsStep\"},\"blocks\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"options\":{\"$ref\":\"#/definitions/historyOptionsBlock\"},\"file\":{\"type\":\"string\"}},\"required\":[\"file\"],\"additionalProperties\":false}}},\"required\":[\"blocks\"],\"additionalProperties\":false}}},\"required\":[\"steps\"],\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"endurica-cl-schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","definitions":{"historyOptionsBlock":{"type":"object","properties":{"period":{"type":"number","minimum":0.0},"temperature":{"type":"number"},"ozone_concentration":{"type":"number"},"block_repeats":{"type":"number","minimum":0.0}},"additionalProperties":false},"historyOptionsStep":{"properties":{"step_repeats":{"type":"number","minimum":0.0},"period":{"type":"number","minimum":0.0},"temperature":{"type":"number"},"ozone_concentration":{"type":"number"},"block_repeats":{"type":"number","minimum":0.0}},"additionalProperties":false},"historyOptions":{"properties":{"type":{"type":"array","items":{"type":"string","enum":["ne","le","dg","gls","ne_plane_stress","le_plane_stress","gls_plane_stress","dg_ss","ne_eq","ne_pl","ne_si","ne_vol","le_eq","le_pl","le_si","hydrostatic_stress","temperature"]},"uniqueItems":true},"material":{"type":"string"},"volume":{"type":"number","exclusiveMinimum":0.0},"preage_time":{"type":"number","minimum":0.0},"preage_temperature":{"type":"number"},"step_repeats":{"type":"number","minimum":0.0},"period":{"type":"number","minimum":0.0},"temperature":{"type":"number"},"ozone_concentration":{"type":"number"},"block_repeats":{"type":"number","minimum":0.0}},"additionalProperties":false},"historyOptionsGlobal":{"properties":{"rolling":{"type":"object","properties":{"sectors":{"type":"number","multipleOf":1},"stride":{"type":"number","multipleOf":1}}},"type":{"type":"array","items":{"type":"string","enum":["ne","le","dg","gls","ne_plane_stress","le_plane_stress","gls_plane_stress","dg_ss","ne_eq","ne_pl","ne_si","ne_vol","le_eq","le_pl","le_si","hydrostatic_stress","temperature"]},"uniqueItems":true},"material":{"type":"string"},"volume":{"type":"number","exclusiveMinimum":0.0},"preage_time":{"type":"number","minimum":0.0},"preage_temperature":{"type":"number"},"step_repeats":{"type":"number","minimum":0.0},"period":{"type":"number","minimum":0.0},"temperature":{"type":"number"},"ozone_concentration":{"type":"number"},"block_repeats":{"type":"number","minimum":0.0}},"additionalProperties":false},"units":{"unitless":{"description":"Units: unitless"},"length":{"description":"Units: [length] e.g. m, mm, in"},"length_over_cycle":{"description":"Units: [length]/[cycle] e.g. m/cycle, mm/cycle, in/cycle"},"length_over_time":{"description":"Units: [length]/[time] e.g. m/s, mm/s, in/s"},"length_over_time_concentration":{"description":"Units: [length]/([time][concentration]) e.g. m/s/[concentration], mm/s/[concentration], in/s/[concentration]"},"pressure":{"description":"Units: [pressure] e.g. Pa, MPa, lbf/in^2"},"1_over_pressure":{"description":"Units: 1/[pressure] e.g. 1/Pa, 1/MPa, in^2/lbf"},"energyReleaseRate":{"description":"Units: [energy_release_rate] e.g. J/m^2, kJ/m^2, in*lb/in^2"},"temperature":{"description":"Units: [temperature] e.g. C, C, F"},"temperatureCoefficient":{"description":"Units: 1/[temperature] e.g. 1/C, 1/C, 1/F"},"hysteresis":{"description":"Units: [energy]/[volume]/[cycle] e.g. J/m^3/cycle, kJ/mm^3/cycle, in*lb/in^3/cycle"},"volumetric_heat_rate":{"description":"Units: [power]/[volume] e.g. W/m^3, mW/mm^3/cycle, lb/s/in^2"},"density":{"description":"Units: [density] e.g. kg/m^3, tonne/mm^3, slug/in^3"},"specific_heat":{"description":"Units: [specific_heat] e.g. J/kg/C, mJ/tonne/C, in*lb/slug/F"},"frequency":{"description":"Units: [1/time] e.g. 1/s, 1/s, 1/s"},"frequencyCoefficient":{"description":"Units: [time] e.g. s, s, s"}}},"type":"object","properties":{"header":{"title":"Header","description":"Text section used to document the analysis.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"settings":{"title":"Settings Section","description":"Settings that control different aspects of the analysis.","type":"object","properties":{"history_subset":{"type":"object","properties":{"type":{"type":"string","enum":["default"]},"labels":{"type":"array","items":{"type":"string"}},"materials":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"ced_integration":{"type":"object","properties":{"type":{"type":"string","enum":["fixed"]},"steps":{"type":"number","minimum":1,"multipleOf":1}},"additionalProperties":false},"crack_plane_discretization":{"type":"object","oneOf":[{"properties":{"type":{"type":"string","enum":["tri3d"]},"nmesh":{"type":"number","minimum":1,"maximum":10,"multipleOf":1}},"additionalProperties":false},{"properties":{"type":{"type":"string","enum":["user"]},"planes":{"description":"List of [x,y,z] unit vectors defining the crack planes to use in the analysis.","type":"array","items":{"type":"array","items":[{"type":"number","maximum":1.0},{"type":"number","maximum":1.0},{"type":"number","maximum":1.0}],"minItems":3,"maxItems":3},"minItems":1}},"additionalProperties":false}]},"microsphere_discretization":{"type":"object","properties":{"type":{"type":"string","enum":["tri3d"]},"nmesh":{"type":"number","minimum":1,"maximum":10,"multipleOf":1}},"additionalProperties":false}},"additionalProperties":false},"material_analysis":{"title":"Material Analysis Definitions","description":"Material analysis definitions that will be performed for each material definition.","type":"object","properties":{"ageing_crack_growth_rate":{"type":"object","description":"Crack growth rate curves at varying ages.","properties":{"n_age":{"type":"number","multipleOf":1,"minimum":2},"n_T":{"type":"number","multipleOf":1,"minimum":2},"age_min":{"type":"number","minimum":0},"age_max":{"type":"number","exclusiveMinimum":0.0},"T_min":{"type":"number"},"T_max":{"type":"number"}},"required":["age_max"],"additionalProperties":false},"ageing_strain_life":{"type":"object","description":"Strain-life curves at varying ages.","properties":{"n_age":{"type":"number","multipleOf":1,"minimum":2},"n_strain":{"type":"number","multipleOf":1,"minimum":2},"age_min":{"type":"number","minimum":0.0},"age_max":{"type":"number","exclusiveMinimum":0.0},"strain_min":{"type":"number","exclusiveMinimum":0.0},"strain_max":{"type":"number","exclusiveMinimum":0.0}},"required":["age_max","strain_min","strain_max"],"additionalProperties":false},"crack_growth_rate":{"type":"object","description":"Crack growth rate curves at varying R ratios.","properties":{"n_R":{"type":"number","multipleOf":1,"minimum":2},"n_T":{"type":"number","multipleOf":1,"minimum":2},"R_min":{"type":"number","minimum":0.0,"maximum":1.0},"R_max":{"type":"number","minimum":0.0,"maximum":1.0},"T_min":{"type":"number","exclusiveMinimum":0.0},"T_max":{"type":"number","exclusiveMinimum":0.0}},"additionalProperties":false},"haigh_diagram":{"type":"object","description":"Haigh diagram output.","properties":{"n":{"type":"number","multipleOf":1.0,"minimum":2},"strain_mean_max":{"type":"number"},"strain_amplitude_max":{"type":"number"}},"additionalProperties":false},"stress_strain":{"type":"object","description":"Stress-Strain curves for different modes of deformation.","properties":{"n_points":{"type":"number","multipleOf":1,"minimum":2},"n_unloads":{"type":"number","multipleOf":1,"minimum":2},"strain_min":{"type":"number"},"strain_max":{"type":"number"},"volume_strain_min":{"type":"number"},"volume_strain_max":{"type":"number"}},"additionalProperties":false},"hysteresis_frequency_sweep":{"type":"object","description":"Hysteresis frequency sweep.","properties":{"n_points":{"type":"number","multipleOf":1,"minimum":2},"frequency_min":{"type":"number","exclusiveMinimum":0.0},"frequency_max":{"type":"number","exclusiveMinimum":0.0},"temperature":{"type":"number"},"deformation_mode":{"type":"string","enum":["simple_tension","planar_tension","simple_shear"]},"strain_amplitude":{"type":"number"}},"additionalProperties":false},"hysteresis_strain_sweep":{"type":"object","description":"Hysteresis strain sweep.","properties":{"n_points":{"type":"number","multipleOf":1,"minimum":2},"strain_amplitude_min":{"type":"number","exclusiveMinimum":0.0},"strain_amplitude_max":{"type":"number","exclusiveMinimum":0.0},"temperature":{"type":"number"},"deformation_mode":{"type":"string","enum":["simple_tension","planar_tension","simple_shear"]},"frequency":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false},"outputs":{"title":"Output Requests","description":"List of output requests for the analysis.","type":"array","items":{"oneOf":[{"type":"string","enum":["adiabatic_time_limit","age","block_cycle","cauchy_stress","cavitation","ced","ced_cycle_count","ced_sphere","crack_growth","crack_size_calibration","engineering_strain","engineering_stress","factor_of_safety","factor_of_safety_ced","factor_of_safety_sphere","history_compression","hysteresis","life","life_sphere","logarithmic_strain","principal_cauchy_stress","principal_engineering_strain","principal_engineering_stress","principal_logarithmic_strain","residual_strength","sed","stiffness_ratio","stiffness_ratio_ageing","stiffness_ratio_cyclic","thermal_runaway","volume_adjustment","wrinkling"]},{"type":"object","oneOf":[{"properties":{"name":{"enum":["adiabatic_time_limit"]}},"additionalProperties":false},{"properties":{"name":{"enum":["age"]}},"additionalProperties":false},{"properties":{"name":{"enum":["block_cycle"]},"n_ced":{"type":"number","minimum":1,"multipleOf":1},"n_r_ratio":{"type":"number","minimum":1,"multipleOf":1}},"additionalProperties":false},{"properties":{"name":{"enum":["cauchy_stress"]}},"additionalProperties":false},{"properties":{"name":{"enum":["cavitation"]}},"additionalProperties":false},{"properties":{"name":{"enum":["ced"]}},"additionalProperties":false},{"properties":{"name":{"enum":["ced_cycle_cout"]}},"additionalProperties":false},{"properties":{"name":{"enum":["ced_sphere"]}},"additionalProperties":false},{"properties":{"name":{"enum":["crack_growth"]}},"additionalProperties":false},{"properties":{"name":{"enum":["crack_size_calibration"]},"c0_min":{"type":"number"},"n_points":{"type":"number","minimum":1,"multipleOf":1},"target_life":{"type":"number"}},"additionalProperties":false},{"properties":{"name":{"enum":["engineering_strain"]}},"additionalProperties":false},{"properties":{"name":{"enum":["engineering_stress"]}},"additionalProperties":false},{"properties":{"name":{"enum":["factor_of_safety"]}},"additionalProperties":false},{"properties":{"name":{"enum":["factor_of_safety_ced"]}},"additionalProperties":false},{"properties":{"name":{"enum":["factor_of_safety_sphere"]}},"additionalProperties":false},{"properties":{"name":{"enum":["history_compression"]},"keep":{"type":"number","minimum":0.0,"maximum":1.0},"n_ced":{"type":"number","minimum":1,"multipleOf":1},"n_r_ratio":{"type":"number","minimum":1,"multipleOf":1}},"additionalProperties":false},{"properties":{"name":{"enum":["hysteresis"]}},"additionalProperties":false},{"properties":{"name":{"enum":["life"]}},"additionalProperties":false},{"properties":{"name":{"enum":["life_sphere"]}},"additionalProperties":false},{"properties":{"name":{"enum":["logarithmic_strain"]}},"additionalProperties":false},{"properties":{"name":{"enum":["principal_cauchy_stress"]}},"additionalProperties":false},{"properties":{"name":{"enum":["principal_engineering_strain"]}},"additionalProperties":false},{"properties":{"name":{"enum":["principal_engineering_stress"]}},"additionalProperties":false},{"properties":{"name":{"enum":["principal_logarithmic_strain"]}},"additionalProperties":false},{"properties":{"name":{"enum":["residual_strength"]}},"additionalProperties":false},{"properties":{"name":{"enum":["sed"]}},"additionalProperties":false},{"properties":{"name":{"enum":["stiffness_ratio"]}},"additionalProperties":false},{"properties":{"name":{"enum":["stiffness_ratio_ageing"]}},"additionalProperties":false},{"properties":{"name":{"enum":["stiffness_ratio_cyclic"]}},"additionalProperties":false},{"properties":{"name":{"enum":["thermal_runaway"]}},"additionalProperties":false},{"properties":{"name":{"enum":["volume_adjustment"]}},"additionalProperties":false},{"properties":{"name":{"enum":["wrinkling"]}},"additionalProperties":false}],"properties":{"name":{"type":"string"}}}]},"uniqueItems":true},"materials":{"title":"Material Section","description":"List of material definitions.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"c0":{"type":"number","exclusiveMinimum":0.0,"$ref":"#/definitions/units/length"},"cf":{"type":"number","exclusiveMinimum":0.0,"$ref":"#/definitions/units/length"},"elasticity":{"type":"object","oneOf":[{"properties":{"type":{"enum":["arrudaboyce"]},"shear_modulus":{"$ref":"#/definitions/units/pressure"},"limit_stretch":{"$ref":"#/definitions/units/unitless"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"bulk_modulus":{"$ref":"#/definitions/units/pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["hyperfoam"]},"mu1":{"$ref":"#/definitions/units/pressure"},"mu2":{"$ref":"#/definitions/units/pressure"},"mu3":{"$ref":"#/definitions/units/pressure"},"mu4":{"$ref":"#/definitions/units/pressure"},"mu5":{"$ref":"#/definitions/units/pressure"},"mu6":{"$ref":"#/definitions/units/pressure"},"alpha1":{"$ref":"#/definitions/units/unitless"},"alpha2":{"$ref":"#/definitions/units/unitless"},"alpha3":{"$ref":"#/definitions/units/unitless"},"alpha4":{"$ref":"#/definitions/units/unitless"},"alpha5":{"$ref":"#/definitions/units/unitless"},"alpha6":{"$ref":"#/definitions/units/unitless"},"nu1":{"$ref":"#/definitions/units/unitless"},"nu2":{"$ref":"#/definitions/units/unitless"},"nu3":{"$ref":"#/definitions/units/unitless"},"nu4":{"$ref":"#/definitions/units/unitless"},"nu5":{"$ref":"#/definitions/units/unitless"},"nu6":{"$ref":"#/definitions/units/unitless"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["mooneyrivlin"]},"C10":{"$ref":"#/definitions/units/pressure"},"C01":{"$ref":"#/definitions/units/pressure"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"bulk_modulus":{"$ref":"#/definitions/units/pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["neohookean"]},"C10":{"$ref":"#/definitions/units/pressure"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"bulk_modulus":{"$ref":"#/definitions/units/pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["ogden"]},"mu1":{"$ref":"#/definitions/units/pressure"},"mu2":{"$ref":"#/definitions/units/pressure"},"mu3":{"$ref":"#/definitions/units/pressure"},"mu4":{"$ref":"#/definitions/units/pressure"},"mu5":{"$ref":"#/definitions/units/pressure"},"mu6":{"$ref":"#/definitions/units/pressure"},"alpha1":{"$ref":"#/definitions/units/unitless"},"alpha2":{"$ref":"#/definitions/units/unitless"},"alpha3":{"$ref":"#/definitions/units/unitless"},"alpha4":{"$ref":"#/definitions/units/unitless"},"alpha5":{"$ref":"#/definitions/units/unitless"},"alpha6":{"$ref":"#/definitions/units/unitless"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"D2":{"$ref":"#/definitions/units/1_over_pressure"},"D3":{"$ref":"#/definitions/units/1_over_pressure"},"D4":{"$ref":"#/definitions/units/1_over_pressure"},"D5":{"$ref":"#/definitions/units/1_over_pressure"},"D6":{"$ref":"#/definitions/units/1_over_pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["ogden2"]},"mu1":{"$ref":"#/definitions/units/pressure"},"mu2":{"$ref":"#/definitions/units/pressure"},"mu3":{"$ref":"#/definitions/units/pressure"},"mu4":{"$ref":"#/definitions/units/pressure"},"mu5":{"$ref":"#/definitions/units/pressure"},"mu6":{"$ref":"#/definitions/units/pressure"},"alpha1":{"$ref":"#/definitions/units/unitless"},"alpha2":{"$ref":"#/definitions/units/unitless"},"alpha3":{"$ref":"#/definitions/units/unitless"},"alpha4":{"$ref":"#/definitions/units/unitless"},"alpha5":{"$ref":"#/definitions/units/unitless"},"alpha6":{"$ref":"#/definitions/units/unitless"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"D2":{"$ref":"#/definitions/units/1_over_pressure"},"D3":{"$ref":"#/definitions/units/1_over_pressure"},"D4":{"$ref":"#/definitions/units/1_over_pressure"},"D5":{"$ref":"#/definitions/units/1_over_pressure"},"D6":{"$ref":"#/definitions/units/1_over_pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["reducedpolynomial"]},"C10":{"$ref":"#/definitions/units/pressure"},"C20":{"$ref":"#/definitions/units/pressure"},"C30":{"$ref":"#/definitions/units/pressure"},"C40":{"$ref":"#/definitions/units/pressure"},"C50":{"$ref":"#/definitions/units/pressure"},"C60":{"$ref":"#/definitions/units/pressure"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"D2":{"$ref":"#/definitions/units/1_over_pressure"},"D3":{"$ref":"#/definitions/units/1_over_pressure"},"D4":{"$ref":"#/definitions/units/1_over_pressure"},"D5":{"$ref":"#/definitions/units/1_over_pressure"},"D6":{"$ref":"#/definitions/units/1_over_pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["uhyper"]},"prop1":{},"prop2":{},"prop3":{},"prop4":{},"prop5":{},"prop6":{},"prop7":{},"prop8":{}},"additionalProperties":false},{"properties":{"type":{"enum":["vanderwaals"]},"shear_modulus":{"$ref":"#/definitions/units/pressure"},"limit_stretch":{"$ref":"#/definitions/units/unitless"},"alpha":{"$ref":"#/definitions/units/unitless"},"beta":{"$ref":"#/definitions/units/unitless"},"D1":{"$ref":"#/definitions/units/1_over_pressure"},"bulk_modulus":{"$ref":"#/definitions/units/pressure"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"mullins":{"type":"object","oneOf":[{"properties":{"type":{"enum":["ogdenroxburgh"]},"r":{"$ref":"#/definitions/units/unitless"},"m":{"$ref":"#/definitions/units/pressure"},"beta":{"$ref":"#/definitions/units/unitless"}},"additionalProperties":false}]},"crack_growth_rate":{"type":"object","oneOf":[{"properties":{"type":{"enum":["thomas"]},"rc":{"$ref":"#/definitions/units/length_over_cycle"},"Tcritical":{"$ref":"#/definitions/units/energyReleaseRate"},"F0":{"$ref":"#/definitions/units/unitless"},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["lakelindley"]},"rc":{"$ref":"#/definitions/units/length_over_cycle"},"Tcritical":{"$ref":"#/definitions/units/energyReleaseRate"},"F0":{"$ref":"#/definitions/units/unitless"},"threshold":{"$ref":"#/definitions/units/energyReleaseRate"},"transition":{"$ref":"#/definitions/units/energyReleaseRate"},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["tabular"]},"table":{"description":"List of [T,dcdn] points. Units: ([energy_release_rate], [length]/[cycle]) e.g. (J/m^2, m/cycle), (kJ/m^2, mm/cycle), (in*lb/in^2, in/cycle)","type":"array","items":{"type":"array","items":[{"type":"number","minimum":0.0},{"type":"number","minimum":0.0}],"minItems":2,"maxItems":2},"minItems":2},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"nonrelaxing":{"type":"object","oneOf":[{"properties":{"type":{"enum":["paris"]}},"additionalProperties":false},{"properties":{"type":{"enum":["xR_tabular"]},"table":{"description":"List of [x,R] points","type":"array","items":{"type":"array","items":[{"type":"number","minimum":0.0,"maximum":1.0},{"type":"number","minimum":0.0,"maximum":1.0}],"minItems":2,"maxItems":2}}},"additionalProperties":false},{"properties":{"type":{"enum":["lindley73"]}},"additionalProperties":false},{"properties":{"type":{"enum":["marsfatemi"]},"F1":{"$ref":"#/definitions/units/unitless"},"F2":{"$ref":"#/definitions/units/unitless"},"F3":{"$ref":"#/definitions/units/unitless"},"Fexp":{"$ref":"#/definitions/units/unitless"},"temperatures":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"ozone_attack":{"type":"object","oneOf":[{"properties":{"type":{"enum":["williams"]},"Tz":{"$ref":"#/definitions/units/energyReleaseRate"},"rz":{"$ref":"#/definitions/units/length_over_time"}},"additionalProperties":false},{"properties":{"type":{"enum":["gentmcgrath"]},"Tz":{"$ref":"#/definitions/units/energyReleaseRate"},"Kz":{"$ref":"#/definitions/units/length_over_time_concentration"},"Kv":{"$ref":"#/definitions/units/length_over_time"},"Fv":{"$ref":"#/definitions/units/unitless"},"Gv":{"$ref":"#/definitions/units/temperature"},"Tg":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"hysteresis":{"type":"object","oneOf":[{"properties":{"type":{"enum":["powerlaw"]},"chi":{"$ref":"#/definitions/units/unitless"},"deformation_mode":{"type":"string","enum":["simple_tension","planar_tension","simple_shear"]},"strain_amplitude_ref":{"$ref":"#/definitions/units/unitless"},"hys_ref":{"$ref":"#/definitions/units/hysteresis"},"gamma":{"$ref":"#/definitions/units/unitless"},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"},"frequency_ref":{"$ref":"#/definitions/units/frequency"},"TK_frequency_coef":{"$ref":"#/definitions/units/frequencyCoefficient"},"PL_frequency_coef":{"$ref":"#/definitions/units/frequencyCoefficient"},"WLF_C1":{"$ref":"#/definitions/units/unitless"},"WLF_C2":{"$ref":"#/definitions/units/temperature"},"WLF_frequencies":{"$ref":"#/definitions/units/frequency"},"WLF_Gp":{"$ref":"#/definitions/units/pressure"},"WLF_Gpp":{"$ref":"#/definitions/units/pressure"}},"additionalProperties":false},{"properties":{"type":{"enum":["kraus"]},"chi":{"$ref":"#/definitions/units/unitless"},"deformation_mode":{"type":"string","enum":["simple_tension","planar_tension","simple_shear"]},"Gp_inf":{"$ref":"#/definitions/units/pressure"},"Gp_0":{"$ref":"#/definitions/units/pressure"},"Gpp_inf":{"$ref":"#/definitions/units/pressure"},"Gpp_max":{"$ref":"#/definitions/units/pressure"},"strain_amplitude_ref":{"$ref":"#/definitions/units/unitless"},"strain_amplitude_c":{"$ref":"#/definitions/units/unitless"},"delta_Gpp_U":{"$ref":"#/definitions/units/pressure"},"m":{"$ref":"#/definitions/units/unitless"},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"},"frequency_ref":{"$ref":"#/definitions/units/frequency"},"TK_frequency_coef":{"$ref":"#/definitions/units/frequencyCoefficient"},"PL_frequency_coef":{"$ref":"#/definitions/units/frequencyCoefficient"},"WLF_C1":{"$ref":"#/definitions/units/unitless"},"WLF_C2":{"$ref":"#/definitions/units/temperature"},"WLF_frequencies":{"$ref":"#/definitions/units/frequency"},"WLF_Gp":{"$ref":"#/definitions/units/pressure"},"WLF_Gpp":{"$ref":"#/definitions/units/pressure"}},"additionalProperties":false}]},"thermal_runaway":{"type":"object","oneOf":[{"properties":{"type":{"enum":["limit"]},"density":{"$ref":"#/definitions/units/density"},"heat_rate":{"$ref":"#/definitions/units/volumetric_heat_rate"},"specific_heat":{"$ref":"#/definitions/units/specific_heat"},"temperature_limit":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"viscoelastic_rupture":{"type":"object","oneOf":[{"properties":{"type":{"enum":["powerlaw"]},"rq":{"$ref":"#/definitions/units/length_over_time"},"Tq":{"$ref":"#/definitions/units/energyReleaseRate"},"F":{"$ref":"#/definitions/units/unitless"},"T0":{"$ref":"#/definitions/units/energyReleaseRate"},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false},{"properties":{"type":{"enum":["tabular"]},"table":{"description":"List of [T,dcdt] points. Units: ([energy_release_rate], [length]/[time]) e.g. (J/m^2, m/s), (kJ/m^2, mm/s), (in*lb/in^2, in/s)","type":"array","items":{"type":"array","items":[{"type":"number","minimum":0.0},{"type":"number","minimum":0.0}],"minItems":2,"maxItems":2},"minItems":2},"temp_coef":{"$ref":"#/definitions/units/temperatureCoefficient"},"temp_ref":{"$ref":"#/definitions/units/temperature"}},"additionalProperties":false}]},"ageing":{"type":"object","oneOf":[{"properties":{"type":{"enum":["default"]}},"additionalProperties":false},{"properties":{"type":{"enum":["arrhenius"]},"activation_energy":{},"temp_ref":{},"gas_constant":{},"absolute_zero":{},"time":{"type":"array","items":{"type":"number","minimum":0.0}},"stiffness":{"type":"array","items":{"type":"number","minimum":0.0}}},"additionalProperties":false}]},"cyclic_softening":{"type":"object","oneOf":[{"properties":{"type":{"enum":["default"]}},"additionalProperties":false},{"properties":{"type":{"enum":["tabular"]},"table":{"description":"List of [crack_ratio, stiffness_ratio] points","type":"array","items":{"type":"array","items":[{"type":"number","minimum":0.0,"maximum":1.0},{"type":"number","minimum":0.0,"maximum":1.0}],"minItems":2,"maxItems":2}}},"additionalProperties":false}]}},"required":["name"],"additionalProperties":false},"uniqueItems":true},"history":{"title":"History Section","description":"History definitions.","type":"object","properties":{"options":{"$ref":"#/definitions/historyOptionsGlobal"},"length":{"description":"Specify the number of histories in the analysis","type":"number","multipleOf":1},"histories":{"description":"An array of histories or a file path to an external input file containing an array of histories","oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"options":{"$ref":"#/definitions/historyOptions"},"steps":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"options":{"$ref":"#/definitions/historyOptionsStep"},"blocks":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"options":{"$ref":"#/definitions/historyOptionsBlock"},"data":{"type":"array","items":{"type":"array","items":{"type":"number"}}}},"additionalProperties":false}}},"additionalProperties":false}}},"required":["label"],"additionalProperties":false}}]},"schedule":{"description":"A schedule definition of steps and blocks, where a block is defined by an external input file containing an array of histories","type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"options":{"$ref":"#/definitions/historyOptionsStep"},"blocks":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"options":{"$ref":"#/definitions/historyOptionsBlock"},"file":{"type":"string"}},"required":["file"],"additionalProperties":false}}},"required":["blocks"],"additionalProperties":false}}},"required":["steps"],"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "endurica-cl-schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
endurica-cl-schema
|
schema-store
|
schema_store_298
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).\",\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"definitions\":{\"CodeGeneration\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (entity-driven)\",\"description\":\"The `CodeGeneration` object defines global properties that are used to drive the underlying entity-driven code generation.\",\"properties\":{\"withResult\":{\"type\":\"boolean\",\"title\":\"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).\",\"description\":\"Defaults to `true`. This can be overridden within the `Entity`(s) and/or `Operation`(s).\"},\"preprocessorDirectives\":{\"type\":\"boolean\",\"title\":\"Indicates whether to use preprocessor directives in the generated output.\"},\"refDataNamespace\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data entities (adds as a c# `using` statement).\",\"description\":\"Defaults to `Company` + `.` (literal) + AppName + `.Business.Entities` (literal).\"},\"refDataCommonNamespace\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data common entities (adds as a c# `using` statement).\",\"description\":\"Defaults to `Company` + `.` (literal) + AppName + `.Common.Entities` (literal).\"},\"refDataText\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding `Text` property is added when generating a Reference Data `Property` for an `Entity`.\",\"description\":\"This is used where serializing within the Web API `Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`). This can be further configured on the `Entity` and for each `Property`.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The Reference Data identifier Type option.\",\"description\":\"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier. Results in all underlying entities becoming Reference Data.\",\"enum\":[\"int\",\"long\",\"Guid\",\"string\"]},\"refDataWebApiRoute\":{\"type\":\"string\",\"title\":\"The `RouteAtttribute` for the Reference Data Web API controller required for named pre-fetching. The `WebApiRoutePrefix` will be prepended where specified.\"},\"refDataDataCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `ReferenceDataData` constructor.\",\"description\":\"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"jsonSerializer\":{\"type\":\"string\",\"title\":\"The JSON Serializer to use for JSON property attribution.\",\"description\":\"Defaults to `SystemText`. This can be overridden within the `Entity`(s).\",\"enum\":[\"SystemText\",\"Newtonsoft\"]},\"etagJsonName\":{\"type\":\"string\",\"title\":\"The default JSON name for the `ETag` property.\",\"description\":\"Defaults to `etag`. Note that the `JsonName` can be set individually per property where required.\",\"enum\":[\"etag\",\"eTag\",\"_etag\",\"_eTag\",\"ETag\",\"ETAG\"]},\"usingNamespace1\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated `Entity` code.\",\"description\":\"Typically used where referening a `Type` from a Namespace that is not generated by default.\"},\"usingNamespace2\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated `Entity` code.\",\"description\":\"Typically used where referening a `Type` from a Namespace that is not generated by default.\"},\"usingNamespace3\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated `Entity` code.\",\"description\":\"Typically used where referening a `Type` from a Namespace that is not generated by default.\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.\",\"description\":\"This can be overridden within the `Entity`(s) and/or their corresponding `Operation`(s).\"},\"webApiAutoLocation\":{\"type\":\"boolean\",\"title\":\"Indicates whether the HTTP Response Location Header route (`Operation.WebApiLocation`) is automatically inferred.\",\"description\":\"This will automatically set the `Operation.WebApiLocation` for an `Operation` named `Create` where there is a corresponding named `Get`. This can be overridden within the `Entity`(s).\"},\"webApiRoutePrefix\":{\"type\":\"string\",\"title\":\"The base (prefix) `URI` prepended to all `Operation.WebApiRoute` values.\"},\"webApiTags\":{\"type\":\"array\",\"title\":\"The list of tags to add for the generated `WebApi`.\",\"description\":\"This can be overridden within the `Entity`(s) and/or their corresponding `Operation`(s).\",\"items\":{\"type\":\"string\"}},\"managerCleanUp\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.\",\"description\":\"This can be overridden within the `Entity`(s) and `Operation`(s).\"},\"validationFramework\":{\"type\":\"string\",\"title\":\"The `Validation` framework to use for the entity-based validation.\",\"description\":\"Defaults to `CoreEx` (literal). This can be overridden within the `Entity`(s), `Operation`(s) and `Parameter`(s).\",\"enum\":[\"CoreEx\",\"FluentValidation\"]},\"autoImplement\":{\"type\":\"string\",\"title\":\"The data source auto-implementation option.\",\"description\":\"Defaults to `None`. Indicates that the implementation for the underlying `Operations` will be auto-implemented using the selected data source (unless explicitly overridden). When selected some of the related attributes will also be required (as documented). Additionally, the `AutoImplement` can be further specified/overridden per `Operation`.\",\"enum\":[\"Database\",\"EntityFramework\",\"Cosmos\",\"OData\",\"HttpAgent\",\"None\"]},\"databaseType\":{\"type\":\"string\",\"title\":\"The .NET database type and optional name (used where `Operation.AutoImplement` is `Database`).\",\"description\":\"Defaults to `IDatabase`. Should be formatted as `Type` + `^` + `Name`; e.g. `IDatabase^Db`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s).\"},\"databaseSchema\":{\"type\":\"string\",\"title\":\"The default database schema name.\",\"description\":\"Defaults to `dbo`.\"},\"databaseProvider\":{\"type\":\"string\",\"title\":\"The default database schema name.\",\"description\":\"Defaults to `SqlServer`. Enables specific database provider functionality/formatting/etc. where applicable.\",\"enum\":[\"SqlServer\",\"MySQL\",\"Postgres\"]},\"databaseMapperEx\":{\"type\":\"boolean\",\"title\":\"Indicates that a `DatabaseMapperEx` will be used; versus, `DatabaseMapper` (which uses Reflection internally).\",\"description\":\"Defaults to `true`. The `DatabaseMapperEx` essentially replaces the `DatabaseMapper` as it is more performant (extended/explicit); this option can be used where leagcy/existing behavior is required.\"},\"entityFrameworkType\":{\"type\":\"string\",\"title\":\"The .NET Entity Framework type and optional name (used where `Operation.AutoImplement` is `EntityFramework`).\",\"description\":\"Defaults to `IEfDb`. Should be formatted as `Type` + `^` + `Name`; e.g. `IEfDb^Ef`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s).\"},\"cosmosType\":{\"type\":\"string\",\"title\":\"The .NET Cosmos DB type and name (used where `Operation.AutoImplement` is `Cosmos`).\",\"description\":\"Defaults to `ICosmosDb`. Should be formatted as `Type` + `^` + `Name`; e.g. `ICosmosDb^Cosmos`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s).\"},\"odataType\":{\"type\":\"string\",\"title\":\"The .NET OData interface name used where `Operation.AutoImplement` is `OData`.\",\"description\":\"Defaults to `IOData`. Should be formatted as `Type` + `^` + `Name`; e.g. `IOData^OData`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s).\"},\"httpAgentType\":{\"type\":\"string\",\"title\":\"The default .NET HTTP Agent interface name used where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"Defaults to `IHttpAgent`. Should be formatted as `Type` + `^` + `Name`; e.g. `IHttpAgent^HttpAgent`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s).\"},\"etagDefaultMapperConverter\":{\"type\":\"string\",\"title\":\"The default ETag to/from RowVersion column Mapping Converter used where `Operation.AutoImplement` is `Database` or `EntityFramework`.\",\"description\":\"Defaults to `StringToBase64Converter`.\"},\"refDataDefaultMapperConverter\":{\"type\":\"string\",\"title\":\"The default Reference Data property `Converter` used by the generated `Mapper`(s) where not specifically defined.\",\"description\":\"Defaults to `ReferenceDataCodeConverter<T>`. Where this value is suffixed by `<T>` or `{T}` this will automatically be set to the `Type`.\",\"enum\":[\"ReferenceDataCodeConverter\",\"ReferenceDataCodeConverter{T}\",\"ReferenceDataCodeConverter<T>\",\"ReferenceDataIdConverter{T, int}\",\"ReferenceDataIdConverter<T, int>\",\"ReferenceDataIdConverter{T, int?}\",\"ReferenceDataIdConverter<T, int?>\",\"ReferenceDataIdConverter{T, long}\",\"ReferenceDataIdConverter<T, long>\",\"ReferenceDataIdConverter{T, long?}\",\"ReferenceDataIdConverter<T, long?>\",\"ReferenceDataIdConverter{T, Guid}\",\"ReferenceDataIdConverter<T, Guid>\",\"ReferenceDataIdConverter{T, Guid?}\",\"ReferenceDataIdConverter<T, Guid?>\",\"ReferenceDataInt32IdConverter\",\"ReferenceDataInt32IdConverter{T}\",\"ReferenceDataInt32IdConverter<T>\",\"ReferenceDataNullableInt32IdConverter\",\"ReferenceDataNullableInt32IdConverter{T}\",\"ReferenceDataNullableInt32IdConverter<T>\",\"ReferenceDataInt64IdConverter\",\"ReferenceDataInt64IdConverter{T}\",\"ReferenceDataInt64IdConverter<T>\",\"ReferenceDataNullableInt64IdConverter\",\"ReferenceDataNullableInt64IdConverter{T}\",\"ReferenceDataNullableInt64IdConverter<T>\",\"ReferenceDataGuidIdConverter\",\"ReferenceDataGuidIdConverter{T}\",\"ReferenceDataGuidIdConverter<T>\",\"ReferenceDataNullableGuidIdConverter\",\"ReferenceDataNullableGuidIdConverter{T}\",\"ReferenceDataNullableGuidIdConverter<T>\"]},\"refDataCodeDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `Code` data name.\",\"description\":\"Defaults to `Code` (literal).\"},\"refDataTextDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `Text` data name.\",\"description\":\"Defaults to `Text` (literal).\"},\"refDataIsActiveDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `IsActive` data name.\",\"description\":\"Defaults to `IsActive` (literal).\"},\"refDataSortOrderDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `SortOrder` data name.\",\"description\":\"Defaults to `SortOrder` (literal).\"},\"refDataETagDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `ETag` data name.\",\"description\":\"Defaults to `RowVersion` (literal).\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.\",\"description\":\"Defaults to `DataSvc`. Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the `Entity`(s).\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventSourceRoot\":{\"type\":\"string\",\"title\":\"The URI root for the event source by prepending to all event source URIs.\",\"description\":\"The event source is only updated where an `EventSourceKind` is not `None`. This can be extended within the `Entity`(s).\"},\"eventSourceKind\":{\"type\":\"string\",\"title\":\"The URI kind for the event source URIs.\",\"description\":\"Defaults to `None` (being the event source is not updated).\",\"enum\":[\"None\",\"Absolute\",\"Relative\",\"RelativeOrAbsolute\"]},\"eventSubjectRoot\":{\"type\":\"string\",\"title\":\"The root for the event Subject name by prepending to all event subject names.\",\"description\":\"Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the `Entity`(s).\"},\"eventSubjectSeparator\":{\"type\":\"string\",\"title\":\"The subject path separator.\",\"description\":\"Defaults to `.`. Used only where the subject is automatically inferred.\"},\"eventActionFormat\":{\"type\":\"string\",\"title\":\"The formatting for the Action when an Event is published.\",\"description\":\"Defaults to `None` (no formatting required, i.e. as-is)`.\",\"enum\":[\"None\",\"PastTense\"]},\"eventTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `DataSvc`-layer whereever generating event publishing logic.\",\"description\":\"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an `EventPublish` error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to `false`. This essentially defaults the `Entity.EventTransaction` where not otherwise specified. This should only be used where `EventPublish` is `DataSvc` and a transactionally-aware data source is being used.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required.\",\"description\":\"gRPC support is an explicit opt-in model. Must be set to `true` for any of the subordinate gRPC capabilities to be code-generated. Will require each `Entity`, and corresponding `Property` and `Operation` to be opted-in specifically.\"},\"pathBase\":{\"type\":\"string\",\"title\":\"The base path (directory) prefix for the artefacts; other `Path*` properties append to this value when they are not specifically overridden.\",\"description\":\"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`.\"},\"pathCommon\":{\"type\":\"string\",\"title\":\"The path (directory) for the Database-related artefacts.\",\"description\":\"Defaults to `PathBase` + `.Common` (literal). For example `Beef.Demo.Common`.\"},\"pathBusiness\":{\"type\":\"string\",\"title\":\"The path (directory) for the Business-related (.NET) artefacts.\",\"description\":\"Defaults to `PathBase` + `.Business` (literal). For example `Beef.Demo.Business`.\"},\"pathApi\":{\"type\":\"string\",\"title\":\"The path (directory) for the API-related (.NET) artefacts.\",\"description\":\"Defaults to `PathBase` + `.` + `ApiName` (runtime parameter). For example `Beef.Demo.Api`.\"},\"namespaceBase\":{\"type\":\"string\",\"title\":\"The base Namespace (root) for the .NET artefacts.\",\"description\":\"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`.\"},\"namespaceCommon\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Common-related .NET artefacts.\",\"description\":\"Defaults to `NamespaceBase` + `.Common` (literal). For example `Beef.Demo.Common`.\"},\"namespaceBusiness\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Business-related .NET artefacts.\",\"description\":\"Defaults to `NamespaceBase` + `.Business` (literal). For example `Beef.Demo.Business`.\"},\"namespaceApi\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Api-related .NET artefacts.\",\"description\":\"Defaults to `NamespaceBase` + `.` + `ApiName` (runtime parameter). For example `Beef.Demo.Api`.\"},\"authActionCreate\":{\"type\":\"string\",\"title\":\"The default `Operation.AuthAction` for an `Operation.Type` of `Create`.\",\"description\":\"Defaults to `Create`.\"},\"authActionRead\":{\"type\":\"string\",\"title\":\"The default `Operation.AuthAction` for an `Operation.Type` of `Get` or `GetColl`.\",\"description\":\"Defaults to `Read`.\"},\"authActionUpdate\":{\"type\":\"string\",\"title\":\"The default `Operation.AuthAction` for an `Operation.Type` of `Update`.\",\"description\":\"Defaults to `Update`.\"},\"authActionDelete\":{\"type\":\"string\",\"title\":\"The default `Operation.AuthAction` for an `Operation.Type` of `Delete`.\",\"description\":\"Defaults to `Delete`.\"},\"entities\":{\"type\":\"array\",\"title\":\"The corresponding `Entity` collection.\",\"items\":{\"$ref\":\"#/definitions/Entity\"}}}},\"Entity\":{\"type\":\"object\",\"title\":\"'Entity' object (entity-driven)\",\"description\":\"The `Entity` is used as the primary configuration for driving the entity-driven code generation.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique entity name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"Overrides the Name (as sentence text) for the summary comments. It will be formatted as: `Represents the {Text} entity.`. To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character.\"},\"fileName\":{\"type\":\"string\",\"title\":\"The overriding file name.\",\"description\":\"Overrides the Name as the code-generated file name.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`.\"},\"constType\":{\"type\":\"string\",\"title\":\"The Const .NET Type option.\",\"description\":\"The .NET Type to be used for the `const` values. Defaults to `string`.\",\"enum\":[\"int\",\"long\",\"Guid\",\"string\"]},\"isInitialOverride\":{\"type\":\"boolean\",\"title\":\"Indicates whether to override the `IInitial.IsInitial` property.\",\"description\":\"Set to either `true` or `false` to override as specified; otherwise, `null` to check each property. Defaults to `null`.\"},\"withResult\":{\"type\":\"boolean\",\"title\":\"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).\",\"description\":\"Defaults to `CodeGeneration.WithResult`. This can be overridden within the Operation`(s).\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The Reference Data identifier Type option.\",\"description\":\"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.\",\"enum\":[\"int\",\"long\",\"Guid\",\"string\"]},\"refDataText\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding `Text` property is added when generating a Reference Data `Property` overriding the `CodeGeneration.RefDataText` selection.\",\"description\":\"This is used where serializing within the Web API`Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`). Defaults from `CodeGeneration.RefDataText`.\"},\"refDataSortOrder\":{\"type\":\"string\",\"title\":\"The Reference Data sort order option.\",\"description\":\"Specifies the default sort order for the underlying Reference Data collection. Defaults to `SortOrder`.\",\"enum\":[\"SortOrder\",\"Id\",\"Code\",\"Text\"]},\"inherits\":{\"type\":\"string\",\"title\":\"The base class that the entity inherits from.\",\"description\":\"Defaults to `EntityBase` for a standard entity. For Reference Data it will default to `ReferenceDataBaseEx<xxx>` depending on the corresponding `RefDataType` value. See `OmitEntityBase` if the desired outcome is to not inherit from any of the aforementioned base classes.\"},\"implements\":{\"type\":\"string\",\"title\":\"The list of comma separated interfaces that are to be declared for the entity class.\"},\"implementsAutoInfer\":{\"type\":\"boolean\",\"title\":\"Indicates whether to automatically infer the interface implements for the entity from the properties declared.\",\"description\":\"Will attempt to infer the following: `IIdentifier<Guid>`, `IIdentifier<int>`, `IIdentifier<long>`, `IIdentifier<string>`, `IETag` and `IChangeLog`. Defaults to `true`.\"},\"abstract\":{\"type\":\"boolean\",\"title\":\"Indicates whether the class should be defined as abstract.\"},\"genericWithT\":{\"type\":\"boolean\",\"title\":\"Indicates whether the class should be defined as a generic with a single parameter `T`.\"},\"namespace\":{\"type\":\"string\",\"title\":\"The entity namespace to be appended.\",\"description\":\"Appended to the end of the standard structure as follows: `{Company}.{AppName}.Business.Entities.{Namespace}`.\"},\"omitEntityBase\":{\"type\":\"boolean\",\"title\":\"Indicates that the entity should not inherit from `EntityBase`.\",\"description\":\"As such any of the `EntityBase` related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities.\"},\"jsonSerializer\":{\"type\":\"string\",\"title\":\"The JSON Serializer to use for JSON property attribution.\",\"description\":\"Defaults to the `CodeGeneration.JsonSerializer` configuration property where specified; otherwise, `SystemText`.\",\"enum\":[\"SystemText\",\"Newtonsoft\"]},\"internalOnly\":{\"type\":\"boolean\",\"title\":\"Indicates whether the entity is for internal use only; declared in Business entities only.\"},\"collection\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding entity collection class should be created.\"},\"collectionResult\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding entity collection result class should be created\",\"description\":\"Enables the likes of additional paging state to be stored with the underlying collection.\"},\"collectionType\":{\"type\":\"string\",\"title\":\"The entity collection type used where `CollectionInherits` is not specified.\",\"enum\":[\"Standard\",\"Keyed\",\"Dictionary\"]},\"collectionInherits\":{\"type\":\"string\",\"title\":\"The base class that a `Collection` inherits from.\",\"description\":\"Defaults to `EntityBaseCollection` or `EntityBaseKeyedCollection` depending on `CollectionKeyed`. For Reference Data it will default to `ReferenceDataCollectionBase`.\"},\"collectionResultInherits\":{\"type\":\"string\",\"title\":\"The base class that a `CollectionResult` inherits from.\",\"description\":\"Defaults to `EntityCollectionResult`.\"},\"behavior\":{\"type\":\"string\",\"title\":\"Defines the key CRUD-style behavior (operation types), being 'C'reate, 'G'et (or 'R'ead), 'U'pdate, 'P'atch, 'D'elete and `Q`uery). Additionally, `GetByArgs` ('B'), `GetAll` ('A') and `GetByQuery` ('Q') operations configuration will be automatically inferred where not otherwise explicitly specified.\",\"description\":\"Value may only specifiy one or more of the `CGRUDBAQ` characters (in any order) to define the automatically generated behavior (operations); for example: `CRUPD` or `CRUP` or `rba` (case insensitive). This is shorthand for setting one or more of the following properties: `Get`, `GetByArgs`, `GetAll`, 'Create', `Update`, `Patch` and `Delete`. Where one of these properties is set to either `true` or `false` this will take precedence over the value set for `Behavior`.\"},\"get\":{\"type\":\"boolean\",\"title\":\"Indicates that a `Get` operation will be automatically generated where not otherwise explicitly specified.\"},\"getByArgs\":{\"type\":\"boolean\",\"title\":\"Indicates that a `GetByArgs` operation will be automatically generated where not otherwise explicitly specified.\"},\"getAll\":{\"type\":\"boolean\",\"title\":\"Indicates that a `GetAll` operation will be automatically generated where not otherwise explicitly specified.\"},\"getByQuery\":{\"type\":\"boolean\",\"title\":\"Indicates that a `GetByQuery` operation will be automatically generated where not otherwise explicitly specified.\"},\"create\":{\"type\":\"boolean\",\"title\":\"Indicates that a `Create` operation will be automatically generated where not otherwise explicitly specified.\"},\"update\":{\"type\":\"boolean\",\"title\":\"Indicates that a `Update` operation will be automatically generated where not otherwise explicitly specified.\"},\"patch\":{\"type\":\"boolean\",\"title\":\"Indicates that a `Patch` operation will be automatically generated where not otherwise explicitly specified.\"},\"delete\":{\"type\":\"boolean\",\"title\":\"Indicates that a `Delete` operation will be automatically generated where not otherwise explicitly specified.\"},\"autoImplement\":{\"type\":\"string\",\"title\":\"The data source auto-implementation option.\",\"description\":\"Defaults to `CodeGeneration.AutoImplement` (where `RefDataType` or `EntityFrameworkModel` or `CosmosModel` or `HttpAgent` is not null; otherwise, `None`. Indicates that the implementation for the underlying `Operations` will be auto-implemented using the selected data source (unless explicitly overridden). When selected some of the related attributes will also be required (as documented). Additionally, the `AutoImplement` can be further specified/overridden per `Operation`.\",\"enum\":[\"Database\",\"EntityFramework\",\"Cosmos\",\"OData\",\"HttpAgent\",\"None\"]},\"dataCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated `Data` constructor.\",\"description\":\"Defaults to `Public`.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"dataCtorCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Data` constructor will be implemented as custom; i.e. not generated.\"},\"dataCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `Data` constructor.\",\"description\":\"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"dataExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Data` extensions logic should be generated.\",\"description\":\"This can be overridden using `Operation.DataExtensions`.\"},\"refDataIdDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `Id` data name.\",\"description\":\"Defaults to `Name` + `Id` (literal).\"},\"refDataCodeDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `Code` data name.\",\"description\":\"Defaults to `Code` (literal).\"},\"refDataTextDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `Text` data name.\",\"description\":\"Defaults to `Text` (literal).\"},\"refDataIsActiveDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `IsActive` data name.\",\"description\":\"Defaults to `IsActive` (literal).\"},\"refDataSortOrderDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `SortOrder` data name.\",\"description\":\"Defaults to `SortOrder` (literal).\"},\"refDataETagDataName\":{\"type\":\"string\",\"title\":\"The Reference Data `ETag` data name.\",\"description\":\"Defaults to `RowVersion` (literal).\"},\"refDataStoredProcedureName\":{\"type\":\"string\",\"title\":\"The Reference Data database stored procedure name.\",\"description\":\"Defaults to `sp` (literal) + `Name` + `GetAll` (literal).\"},\"databaseType\":{\"type\":\"string\",\"title\":\"The .NET database type and optional name (used where `AutoImplement` is `Database`).\",\"description\":\"Defaults to the `CodeGeneration.DatabaseName` configuration property (its default value is `IDatabase`). Should be formatted as `Type` + `^` + `Name`.\"},\"databaseSchema\":{\"type\":\"string\",\"title\":\"The database schema name (used where `AutoImplement` is `Database`).\",\"description\":\"Defaults to `dbo`.\"},\"databaseMapperInheritsFrom\":{\"type\":\"string\",\"title\":\"The name of the `Mapper` that the generated Database `Mapper` inherits from.\"},\"databaseCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Database `Mapper` will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a `Mapper` will be generated.\"},\"databaseMapperEx\":{\"type\":\"boolean\",\"title\":\"Indicates that a `DatabaseMapperEx` (extended/explicit) will be used; versus, `DatabaseMapper` (which uses Reflection internally).\",\"description\":\"Defaults to `CodeGeneration.DatabaseMapperEx` (its default value is `true`). The `DatabaseMapperEx` essentially replaces the `DatabaseMapper` as it is more performant; this option can be used where leagcy/existing behavior is required.\"},\"entityFrameworkType\":{\"type\":\"string\",\"title\":\"The .NET Entity Framework type and optyional name used where `AutoImplement` is `EntityFramework`.\",\"description\":\"Defaults to `CodeGeneration.EntityFrameworkName`. Should be formatted as `Type` + `^` + `Name`.\"},\"entityFrameworkModel\":{\"type\":\"string\",\"title\":\"The corresponding Entity Framework model name (required where `AutoImplement` is `EntityFramework`).\"},\"entityFrameworkCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Entity Framework `Mapper` will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a `Mapper` will be generated.\"},\"entityFrameworkMapperBase\":{\"type\":\"string\",\"title\":\"The EntityFramework data-layer name that should be used for base mappings.\"},\"cosmosType\":{\"type\":\"string\",\"title\":\"The .NET Cosmos DB type and optional name used where `AutoImplement` is `Cosmos`.\",\"description\":\"Defaults to the `CodeGeneration.CosmosName` configuration property (its default value is `ICosmosDb`). Should be formatted as `Type` + `^` + `Name`.\"},\"cosmosModel\":{\"type\":\"string\",\"title\":\"The corresponding Cosmos model name (required where `AutoImplement` is `Cosmos`).\"},\"cosmosContainerId\":{\"type\":\"string\",\"title\":\"The Cosmos `ContainerId` required where `AutoImplement` is `Cosmos`.\"},\"cosmosPartitionKey\":{\"type\":\"string\",\"title\":\"The C# code to be used for setting the optional Cosmos `PartitionKey` where `AutoImplement` is `Cosmos`.\",\"description\":\"The value `PartitionKey.None` can be specified. Literals will need to be quoted.\"},\"cosmosValueContainer\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `CosmosDbValueContainer` is to be used; otherwise, `CosmosDbContainer`.\"},\"cosmosCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Cosmos `Mapper` will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a `Mapper` will be generated.\"},\"cosmosMapperBase\":{\"type\":\"string\",\"title\":\"The Cosmos data-layer name that should be used for base mappings.\"},\"odataType\":{\"type\":\"string\",\"title\":\"The .NET OData type and optional name used where `AutoImplement` is `OData`.\",\"description\":\"Defaults to the `CodeGeneration.ODataName` configuration property (its default value is `IOData`). Should be formatted as `Type` + `^` + `Name`.\"},\"odataModel\":{\"type\":\"string\",\"title\":\"The corresponding OData model name (required where `AutoImplement` is `OData`).\"},\"odataCollectionName\":{\"type\":\"string\",\"title\":\"The name of the underlying OData collection where `AutoImplement` is `OData`.\",\"description\":\"The underlying `Simple.OData.Client` will attempt to infer.\"},\"odataCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom OData `Mapper` will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a `Mapper` will be generated.\"},\"httpAgentType\":{\"type\":\"string\",\"title\":\"The .NET HTTP Agent type and optional name used where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"Defaults to `CodeGeneration.HttpAgentName` configuration property (its default value is `IHttpAgent`). Should be formatted as `Type` + `^` + `Name`.\"},\"httpAgentRoutePrefix\":{\"type\":\"string\",\"title\":\"The base HTTP Agent API route where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"This is the base (prefix) `URI` for the HTTP Agent endpoint and can be further extended when defining the underlying `Operation`(s).\"},\"httpAgentModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).\",\"description\":\"This can be overridden within the `Operation`(s).\"},\"httpAgentReturnModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).\",\"description\":\"This can be overridden within the `Operation`(s).\"},\"httpAgentCode\":{\"type\":\"string\",\"title\":\"The fluent-style method-chaining C# HTTP Agent API code to include where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"Prepended to `Operation.HttpAgentCode` where specified to enable standardized functionality.\"},\"httpAgentCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom HTTP Agent `Mapper` will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a `Mapper` will be generated.\"},\"httpAgentMapperBase\":{\"type\":\"string\",\"title\":\"The HTTP Agent data-layer name that should be used for base mappings.\"},\"dataSvcCaching\":{\"type\":\"boolean\",\"title\":\"Indicates whether request-based `IRequestCache` caching is to be performed at the `DataSvc` layer to improve performance (i.e. reduce chattiness).\",\"description\":\"Defaults to `true`.\"},\"dataSvcCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated `DataSvc` constructor.\",\"description\":\"Defaults to `Public`.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"dataSvcCustom\":{\"type\":\"string\",\"title\":\"The option that indicates the level of `DataSvc` customization (invokes `*OnImplementationAsync` method) vs code-generation (automatically invokes data-layer).\",\"description\":\"`Full` indicates the logic is fully customized (only invocation is code-generated). `Partial` indicates combination of surrounding code-generation with final custom invocation versus data-layer. `None` indicates data-layer invocation with _no_ custom invocation (default).\",\"enum\":[\"Full\",\"Partial\",\"None\"]},\"dataSvcCtorCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `DataSvc` constructor will be implemented as custom; i.e. not generated.\"},\"dataSvcCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `DataSvc` constructor.\",\"description\":\"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"dataSvcExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `DataSvc` extensions logic should be generated.\",\"description\":\"This can be overridden using `Operation.DataSvcExtensions`.\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.\",\"description\":\"Defaults to the `CodeGeneration.EventPublish` configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the `Operation`(s).\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventSource\":{\"type\":\"string\",\"title\":\"The Event Source.\",\"description\":\"Defaults to `Name` (as lowercase) appended with the `/{$key}` placeholder. Note: when used in code-generation the `CodeGeneration.EventSourceRoot` will be prepended where specified. To include the entity id/key include a `{$key}` placeholder (`Create`, `Update` or `Delete` operation only); for example: `person/{$key}`. This can be overridden for the `Operation`.\"},\"eventTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `System.TransactionScope` should be created and orchestrated whereever generating event publishing logic.\",\"description\":\"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an `EventPublish` error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to `CodeGeneration.EventTransaction`. This essentially defaults the `Operation.DataSvcTransaction` where not otherwise specified. This should only be used where a transactionally-aware data source is being used.\"},\"managerCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Manager` logic is a custom implementation; i.e. no auto-`DataSvc` invocation logic is to be generated.\"},\"managerCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated `Manager` constructor.\",\"description\":\"Defaults to `Public`.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"managerCtorCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Manager` constructor will be implemented as custom; i.e. not generated.\"},\"managerCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `Manager` constructor.\",\"description\":\"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"managerExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Manager` extensions logic should be generated.\",\"description\":\"This can be overridden using `Operation.ManagerExtensions`.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET implementing `Type` or interface `Type` that will perform the validation.\",\"description\":\"Only used for defaulting the `Create` and `Update` operation types (`Operation.Type`) where not specified explicitly.\"},\"identifierGenerator\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `IIdentifierGenerator` should be used to generate the `Id` property where the operation types (`Operation.Type`) is `Create`.\"},\"managerCleanUp\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.\",\"description\":\"This can be overridden within the `CodeGeneration` and `Operation`(s).\"},\"validationFramework\":{\"type\":\"string\",\"title\":\"The `Validation` framework to use for the entity-based validation.\",\"description\":\"Defaults to `CodeGeneration.ValidationFramework`. This can be overridden within the `Operation`(s) and `Parameter`(s).\",\"enum\":[\"CoreEx\",\"FluentValidation\"]},\"webApiRoutePrefix\":{\"type\":\"string\",\"title\":\"The `RoutePrefixAtttribute` for the corresponding entity Web API controller.\",\"description\":\"This is the base (prefix) `URI` for the entity and can be further extended when defining the underlying `Operation`(s). The `CodeGeneration.WebApiRoutePrefix` will be prepended where specified. Where not specified will automatically default to the pluralized `Name` (as lowercase).\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.\",\"description\":\"Defaults to the `CodeGeneration.WebApiAuthorize` configuration property (inherits) where not specified; can be overridden at the `Operation` level also.\"},\"webApiCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated Web API `Controller` constructor.\",\"description\":\"Defaults to `Public`.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"webApiCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `WebApi` constructor.\",\"description\":\"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"webApiAutoLocation\":{\"type\":\"boolean\",\"title\":\"Indicates whether the HTTP Response Location Header route (`Operation.WebApiLocation`) is automatically inferred.\",\"description\":\"This will automatically set the `Operation.WebApiLocation` for an `Operation` named `Create` where there is a corresponding named `Get`. This is defaulted from the `CodeGen.WebApiAutoLocation`.\"},\"webApiConcurrency\":{\"type\":\"boolean\",\"title\":\"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.\",\"description\":\"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the `Operation.Type` is `Update` or `Patch`, the request ETag will be matched against the response for a corresponding `Get` operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the `Get` must be the same as that returned from the corresponding `Create`, `Update` and `Patch` (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the `Operation.WebApiConcurrency`.\"},\"webApiGetOperation\":{\"type\":\"string\",\"title\":\"The corresponding `Get` method name (in the `XxxManager`) where the `Operation.Type` is `Update` and `SimulateConcurrency` is `true`.\",\"description\":\"Defaults to `Get`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`.\"},\"webApiTags\":{\"type\":\"array\",\"title\":\"The list of tags to add for the generated `WebApi` controller.\",\"items\":{\"type\":\"string\"}},\"dataModel\":{\"type\":\"boolean\",\"title\":\"Indicates whether a data `model` version of the entity should also be generated (output to `.\\\\Business\\\\Data\\\\Model`).\",\"description\":\"The model will be generated with `OmitEntityBase = true`. Any reference data properties will be defined using their `RefDataType` intrinsic `Type` versus their corresponding (actual) reference data `Type`.\"},\"dataModelInherits\":{\"type\":\"string\",\"title\":\"Overrides the default data `model` inherits value.\"},\"excludeEntity\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `Entity` class (`Xxx.cs`).\"},\"excludeAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of all `Operation` related artefacts; excluding the `Entity` class.\",\"description\":\"Is a shorthand means for setting all of the other `Exclude*` properties (with the exception of `ExcludeEntity`) to exclude.\"},\"excludeIData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `Data` interface (`IXxxData.cs`).\"},\"excludeData\":{\"type\":\"string\",\"title\":\"The option to exclude the generation of the `Data` class (`XxxData.cs`).\",\"description\":\"Defaults to `Include` indicating _not_ to exclude. A value of `Exclude` indicates to exclude all output; alternatively, `RequiresMapper` indicates to at least output the corresponding `Mapper` class.\",\"enum\":[\"Include\",\"Exclude\",\"RequiresMapper\"]},\"excludeIDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `DataSvc` interface (`IXxxDataSvc.cs`).\"},\"excludeDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `DataSvc` class (`XxxDataSvc.cs`).\"},\"excludeIManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `Manager` interface (`IXxxManager.cs`).\"},\"excludeManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the `Manager` class (`XxxManager.cs`).\"},\"excludeWebApi\":{\"type\":\"boolean\",\"title\":\"The option to exclude the generation of the WebAPI `Controller` class (`XxxController.cs`).\"},\"excludeWebApiAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the WebAPI consuming `Agent` class (`XxxAgent.cs`).\"},\"excludeGrpcAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the gRPC consuming `Agent` class (`XxxAgent.cs`).\"},\"authPermission\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsAuthorized(AuthPermission)` to determine whether the user is authorized.\"},\"authEntity\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized.\"},\"authRole\":{\"type\":\"string\",\"title\":\"The role (permission) used by the `ExecutionContext.UserIsInRole(role)` for each `Operation`.\",\"description\":\"Used where not overridden specifically for an `Operation`; i.e. acts as the default.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required for the Entity.\",\"description\":\"gRPC support is an explicit opt-in model (see `CodeGeneration.Grpc` configuration); therefore, each corresponding `Property` and `Operation` will also need to be opted-in specifically.\"},\"properties\":{\"type\":\"array\",\"title\":\"The corresponding `Property` collection.\",\"items\":{\"$ref\":\"#/definitions/Property\"}},\"operations\":{\"type\":\"array\",\"title\":\"The corresponding `Operation` collection.\",\"items\":{\"$ref\":\"#/definitions/Operation\"}},\"consts\":{\"type\":\"array\",\"title\":\"The corresponding `Consts` collection.\",\"items\":{\"$ref\":\"#/definitions/Const\"}}},\"required\":[\"name\"]},\"Property\":{\"type\":\"object\",\"title\":\"'Property' object (entity-driven)\",\"description\":\"The `Property` object defines an `Entity` property and its charateristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique property name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the `Text` will be the `Name` reformatted as sentence casing. Depending on whether the `Type` is `bool`, will appear in one of the two generated sentences. Where not `bool` it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character.\"},\"modelText\":{\"type\":\"string\",\"title\":\"The overriding model text for use in comments.\",\"description\":\"By default the `ModelText` will be the `Name` reformatted as sentence casing. Depending on whether the `Type` is `bool`, will appear in one of the two generated sentences. Where not `bool` it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character.\"},\"type\":{\"type\":\"string\",\"title\":\"The .NET `Type`.\",\"description\":\"Defaults to `string`. To reference a Reference Data `Type` always prefix with `RefDataNamespace` (e.g. `RefDataNamespace.Gender`) or shortcut `^` (e.g. `^Gender`). This will ensure that the appropriate Reference Data `using` statement is used. _Shortcut:_ Where the `Type` starts with (prefix) `RefDataNamespace.` or `^`, and the correspondong `RefDataType` attribute is not specified it will automatically default the `RefDataType` to `string.`\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the .NET `Type` should be declared as nullable; e.g. `string?`. Will be inferred where the `Type` is denoted as nullable; i.e. suffixed by a `?`.\"},\"inherited\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is inherited and therefore should not be output within the generated Entity class.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`.\"},\"primaryKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is considered part of the primary (unique) key.\",\"description\":\"This is also used to simplify the parameter specification for an Entity Operation by inferrence.\"},\"isEntity\":{\"type\":\"boolean\",\"title\":\"Indicates that the property `Type` is another generated entity / collection and therefore specific capabilities can be assumed (e.g. `CopyFrom` and `Clone`).\",\"description\":\"Will be inferred (default to `true`) where the `Type` is `ChangeLog` or the `Type` is found as another `Entity` within the code-generation configuration file.\"},\"immutable\":{\"type\":\"boolean\",\"title\":\"Indicates that the value is immutable and therefore cannot be changed once set.\"},\"dateTimeTransform\":{\"type\":\"string\",\"title\":\"The `DateTime` transformation to be performed on `Set` and `CleanUp`.\",\"description\":\"Defaults to `UseDefault`. This is only applied where the `Type` is `DateTime`.\",\"enum\":[\"UseDefault\",\"None\",\"DateOnly\",\"DateTimeLocal\",\"DateTimeUtc\",\"DateTimeUnspecified\"]},\"stringTrim\":{\"type\":\"string\",\"title\":\"The `string` trimming of white space characters to be performed on `Set` and `CleanUp`.\",\"description\":\"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.\",\"enum\":[\"UseDefault\",\"None\",\"Start\",\"End\",\"Both\"]},\"stringTransform\":{\"type\":\"string\",\"title\":\"The `string` transformation to be performed on `Set` and `CleanUp`.\",\"description\":\"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.\",\"enum\":[\"UseDefault\",\"None\",\"NullToEmpty\",\"EmptyToNull\"]},\"stringCasing\":{\"type\":\"string\",\"title\":\"The `string` casing to be performed on `Set` and `CleanUp`.\",\"description\":\"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.\",\"enum\":[\"UseDefault\",\"None\",\"Lower\",\"Upper\",\"Title\"]},\"autoCreate\":{\"type\":\"boolean\",\"title\":\"Indicates whether an instance of the `Type` is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation).\"},\"default\":{\"type\":\"string\",\"title\":\"The C# code to default the value.\",\"description\":\"Where the `Type` is `string` then the specified default value will need to be delimited. Any valid value assignment C# code can be used.\"},\"partitionKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is considered part of the Partition Key.\",\"description\":\"This will implement `IPartitionKey` for the generated entity.\"},\"cacheKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is considered part of the Cache Key.\",\"description\":\"This will implement `ICacheKey` for the generated entity.\"},\"internalOnly\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is for internal use only; declared in Business entities only.\",\"description\":\"In this instance the `Property` will be excluded from the `Common` entity declaration and `Business` JSON serialization.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).\",\"description\":\"Defaults to `string` (being the `ReferenceDataBase.Code`) where not specified and the corresponding `Type` starts with (prefix) `RefDataNamespace.` or `^`. Note: an `Id` of type `string` is currently not supported; the use of the `Code` is the recommended approach.\",\"enum\":[\"string\",\"int\",\"Guid\"]},\"refDataList\":{\"type\":\"boolean\",\"title\":\"Indicates that the Reference Data property is to be a serializable list (`ReferenceDataSidList`).\",\"description\":\"This is required to enable a list of Reference Data values (as per `RefDataType`) to be passed as an argument for example.\"},\"refDataText\":{\"type\":\"string\",\"title\":\"Indicates whether a corresponding `Text` property is added when generating a Reference Data property, overriding the `Entity.RefDataText` selection.\",\"description\":\"This is used where serializing within the Web API `Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`).`Optional` indicates when `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` then a value is output, `Always` indicates that the value is _always_ output, and `Never` indicates that feature is turned off.\",\"enum\":[\"Optional\",\"Always\",\"Never\"]},\"refDataTextName\":{\"type\":\"string\",\"title\":\"The corresponding reference data `Text` property name; defaults to `Name` + 'Text'.\"},\"refDataMapping\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should use the underlying Reference Data mapping capabilities.\",\"description\":\"Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable.\"},\"jsonName\":{\"type\":\"string\",\"title\":\"The JSON property name.\",\"description\":\"Defaults to `ArgumentName` where not specified (i.e. camelCase); however, where the property is `ETag` it will default to the `Config.ETagJsonName`.\"},\"jsonDataModelName\":{\"type\":\"string\",\"title\":\"The JSON property name for the corresponding data model (see `Entity.DataModel`).\",\"description\":\"Defaults to `JsonName` where not specified.\"},\"serializationIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is not to be serialized.\",\"description\":\"All properties are serialized by default.\"},\"serializationAlwaysInclude\":{\"type\":\"boolean\",\"title\":\"Indicates whether to include the value (default or otherwise) when serializing.\"},\"dataModelIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is to be included within the data model.\",\"description\":\"All properties are included in the data model by default.\"},\"dataModelSerializationIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is not to be serialized where outputting as a data model.\",\"description\":\"All properties are included in the data model by default.\"},\"dataName\":{\"type\":\"string\",\"title\":\"The data name where Entity.AutoImplement is selected.\",\"description\":\"Defaults to the property `Name`. Represents the column name for a `Database`, or the correspinding property name for the other options.\"},\"dataConverter\":{\"type\":\"string\",\"title\":\"The data `Converter` class name where `Entity.AutoImplement` is selected.\",\"description\":\"A `Converter` is used to convert a data source value to/from a .NET `Type` where no standard data conversion can be applied. Where this value is suffixed by `<T>` or `{T}` this will automatically set `Type`.\"},\"dataMapperIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should be ignored (excluded) from the `Data`-layer / data `Mapper` generated output.\",\"description\":\"All properties are included by default.\"},\"dataAutoGenerated\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `PrimaryKey` property value is automatically generated by the data source on `Create`.\"},\"dataOperationTypes\":{\"type\":\"string\",\"title\":\"The operations types (`ExecutionContext.OperationType`) selection to enable inclusion and exclusion of property mapping.\",\"description\":\"Defaults to `Any`.\",\"enum\":[\"Any\",\"AnyExceptCreate\",\"AnyExceptUpdate\",\"AnyExceptGet\",\"Get\",\"Create\",\"Update\",\"Delete\"]},\"databaseMapper\":{\"type\":\"string\",\"title\":\"The database property `Mapper` class name where `Entity.AutoImplement` is selected.\",\"description\":\"A `Mapper` is used to map a data source value to/from a .NET complex `Type` (i.e. class with one or more properties).\"},\"databaseIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should be ignored (excluded) from the database `Mapper` generated output.\"},\"databaseDbType\":{\"type\":\"string\",\"title\":\"The database `DbType` override (versus inferring from the corresponding .NET Type).\",\"description\":\"Overrides the inferred database type; i.e. can specify `Date` or `DateTime2`, for .NET Type `System.DateTime`.\"},\"entityFrameworkMapper\":{\"type\":\"string\",\"title\":\"The Entity Framework `Mapper` approach for the property.\",\"description\":\"Defaults to `Set`.\",\"enum\":[\"Set\",\"Ignore\",\"Map\",\"Flatten\"]},\"cosmosMapper\":{\"type\":\"string\",\"title\":\"The Cosmos `Mapper` approach for the property.\",\"description\":\"Defaults to `Set`.\",\"enum\":[\"Set\",\"Ignore\",\"Map\",\"Flatten\"]},\"odataMapper\":{\"type\":\"string\",\"title\":\"The OData `Mapper` approach for the property.\",\"description\":\"Defaults to `Map` which indicates the property will be explicitly mapped. A value of `Ignore` will explicitly `Ignore`, whilst a value of `Skip` will skip code-generated mapping altogether.\",\"enum\":[\"Map\",\"Ignore\",\"Skip\"]},\"httpAgentMapper\":{\"type\":\"string\",\"title\":\"The HttpAgent `Mapper` approach for the property.\",\"description\":\"Defaults to `Set`.\",\"enum\":[\"Set\",\"Ignore\",\"Map\",\"Flatten\"]},\"displayName\":{\"type\":\"string\",\"title\":\"The display name used in the likes of error messages for the property.\",\"description\":\"Defaults to the `Name` as sentence case.\"},\"annotation1\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"annotation2\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"annotation3\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"grpcFieldNo\":{\"type\":\"integer\",\"title\":\"The unique (immutable) field number required to enable gRPC support.\"},\"grpcType\":{\"type\":\"string\",\"title\":\"The underlying gRPC data type; will be inferred where not specified.\"}},\"required\":[\"name\"]},\"Operation\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (entity-driven)\",\"description\":\"The code generation for an `Operation` is primarily driven by the `Type` property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique operation name.\"},\"type\":{\"type\":\"string\",\"title\":\"The type of operation that is to be code-generated.\",\"description\":\"Defaults to `Custom`.\",\"enum\":[\"Get\",\"GetColl\",\"Create\",\"Update\",\"Patch\",\"Delete\",\"Custom\",\"CustomManagerOnly\"]},\"text\":{\"type\":\"string\",\"title\":\"The text for use in comments.\",\"description\":\"The `Text` will be defaulted for all the `Operation.Type` options with the exception of `Custom`. To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character.\"},\"primaryKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the properties marked as a primary key (`Property.PrimaryKey`) are to be used as the parameters.\",\"description\":\"This simplifies the specification of these properties as parameters versus having to declare each specifically. Each of the parameters will also be set to be mandatory.\"},\"paging\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `PagingArgs` argument is to be added to the operation to enable (standardized) paging related logic.\"},\"query\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `QueryArgs` argument is to be added to the operation to enable OData-like $filter and $orderby related logic.\"},\"valueType\":{\"type\":\"string\",\"title\":\"The .NET value parameter `Type` for the operation.\",\"description\":\"Defaults to the parent `Entity.Name` where the `Operation.Type` options are `Create` or `Update`.\"},\"returnType\":{\"type\":\"string\",\"title\":\"The .NET return `Type` for the operation.\",\"description\":\"Defaults to the parent `Entity.Name` where the `Operation.Type` options are `Get`, `GetColl`, `Create` or `Update`; otherwise, defaults to `void`.\"},\"returnTypeNullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `ReturnType` is nullable for the operation.\",\"description\":\"Will be inferred where the `ReturnType` is denoted as nullable; i.e. suffixed by a `?`. Additionally a `Type` of `Get` will default to `true` where not specified.\"},\"returnText\":{\"type\":\"string\",\"title\":\"The text for use in comments to describe the `ReturnType`.\",\"description\":\"A default will be created where not specified. To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the `Name` to be used for private usage. By default reformatted from `Name`; e.g. `GetByArgs` as `_getByArgs`.\"},\"withResult\":{\"type\":\"boolean\",\"title\":\"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).\",\"description\":\"Defaults to `Entity.WilhResult`.\"},\"autoImplement\":{\"type\":\"string\",\"title\":\"The operation override for the `Entity.AutoImplement`.\",\"description\":\"Defaults to `Entity.AutoImplement`. The corresponding `Entity.AutoImplement` must be defined for this to be enacted. Auto-implementation is applicable for all `Operation.Type` options with the exception of `Custom`.\",\"enum\":[\"Database\",\"EntityFramework\",\"Cosmos\",\"OData\",\"HttpAgent\",\"None\"]},\"dataEntityMapper\":{\"type\":\"string\",\"title\":\"The override for the data entity `Mapper`.\",\"description\":\"Used where the default generated `Mapper` is not applicable.\"},\"dataExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Data` extensions logic should be generated.\",\"description\":\"Defaults to `Entity.DataExtensions`.\"},\"dataInvoker\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `DataInvoker` should orchestrate the `Data`-layer.\",\"description\":\"Where `Dataransaction` or `EventPublish` is `Data` then orchestration will default to `true`.\"},\"dataTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `Data`-layer.\",\"description\":\"Where using an `EventOutbox` this is ignored as it is implied through its usage.\"},\"databaseStoredProc\":{\"type\":\"string\",\"title\":\"The database stored procedure name used where `Operation.AutoImplement` is `Database`.\",\"description\":\"Defaults to `sp` + `Entity.Name` + `Operation.Name`; e.g. `spPersonCreate`.\"},\"entityFrameworkModel\":{\"type\":\"string\",\"title\":\"The corresponding Entity Framework model name (required where `AutoImplement` is `EntityFramework`).\",\"description\":\"Overrides the `Entity.EntityFrameworkModel`.\"},\"cosmosModel\":{\"type\":\"string\",\"title\":\"The corresponding Cosmos model name (required where `AutoImplement` is `Cosmos`).\",\"description\":\"Overrides the `Entity.CosmosModel`.\"},\"cosmosContainerId\":{\"type\":\"string\",\"title\":\"The Cosmos `ContainerId` override used where `Operation.AutoImplement` is `Cosmos`.\",\"description\":\"Overrides the `Entity.CosmosContainerId`.\"},\"cosmosPartitionKey\":{\"type\":\"string\",\"title\":\"The C# code override to be used for setting the optional Cosmos `PartitionKey` used where `Operation.AutoImplement` is `Cosmos`.\",\"description\":\"Overrides the `Entity.CosmosPartitionKey`.\"},\"odataCollectionName\":{\"type\":\"string\",\"title\":\"The override name of the underlying OData collection where `Operation.AutoImplement` is `OData`.\",\"description\":\"Overriddes the `Entity.ODataCollectionName`; otherwise, the underlying `Simple.OData.Client` will attempt to infer.\"},\"httpAgentRoute\":{\"type\":\"string\",\"title\":\"The HTTP Agent API route where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"This is appended to the `Entity.HttpAgentRoutePrefix`.\"},\"httpAgentMethod\":{\"type\":\"string\",\"title\":\"The HTTP Agent Method for the operation.\",\"description\":\"Defaults to `Operation.WebApiMethod`.\",\"enum\":[\"HttpGet\",\"HttpPost\",\"HttpPut\",\"HttpDelete\",\"HttpPatch\"]},\"httpAgentModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).\",\"description\":\"This can be overridden within the `Operation`(s).\"},\"httpAgentReturnModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).\",\"description\":\"Defaults to `Operation.HttpAgentModel` where the `Operation.ReturnType` is equal to `Entity.Name` (same type). This can be overridden within the `Operation`(s).\"},\"httpAgentCode\":{\"type\":\"string\",\"title\":\"The fluent-style method-chaining C# HTTP Agent API code to include where `Operation.AutoImplement` is `HttpAgent`.\",\"description\":\"Appended to `Entity.HttpAgentCode` where specified to extend.\"},\"managerCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Manager` logic is a custom implementation; i.e. no auto-`DataSvc` invocation logic is to be generated.\"},\"managerTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `Manager`-layer.\"},\"managerExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `Manager` extensions logic should be generated.\",\"description\":\"Defaults to `Entity.ManagerExtensions`.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET implementing `Type` or interface `Type` that will perform the validation.\",\"description\":\"Defaults to the `Entity.Validator` where not specified explicitly (where `Operation.Type` options `Create` or `Update`).\"},\"validationFramework\":{\"type\":\"string\",\"title\":\"The `Validation` framework to use for the entity-based validation.\",\"description\":\"Defaults to `Entity.ValidationFramework`. This can be overridden within the `Parameter`(s).\",\"enum\":[\"CoreEx\",\"FluentValidation\"]},\"managerOperationType\":{\"type\":\"string\",\"title\":\"The `ExecutionContext.OperationType` (CRUD denotation) defined at the `Manager`-layer.\",\"description\":\"The default will be inferred from the `Operation.Type`; however, where the `Operation.Type` is `Custom` it will default to `Unspecified`.\",\"enum\":[\"Create\",\"Read\",\"Update\",\"Delete\",\"Unspecified\"]},\"managerCleanUp\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.\",\"description\":\"This can be overridden within the `CodeGeneration` and `Entity`.\"},\"dataSvcCustom\":{\"type\":\"string\",\"title\":\"The option that indicates the level of `DataSvc` customization (invokes `*OnImplementationAsync` method) vs code-generation (automatically invokes data-layer).\",\"description\":\"`Full` indicates the logic is fully customized (only invocation is code-generated). `Partial` indicates combination of surrounding code-generation with final custom invocation versus data-layer. `None` indicates data-layer invocation with _no_ custom invocation (default).\",\"enum\":[\"Full\",\"Partial\",\"None\"]},\"dataSvcTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `DataSvc`-layer.\"},\"dataSvcInvoker\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `DataSvcInvoker` should orchestrate the `DataSvc`-layer.\",\"description\":\"Where `DataSvcTransaction` or `EventPublish` is `DataSvc` then the orchestration will default to `true`.\"},\"dataSvcExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the `DataSvc` extensions logic should be generated.\",\"description\":\"Defaults to `Entity.ManagerExtensions`.\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.\",\"description\":\"Defaults to the `Entity.EventPublish` configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventValue\":{\"type\":\"string\",\"title\":\"The event value override as C# code (is used as-is).\",\"description\":\"The event value is automatically inferred where the `Operation.Type` is `Create`, `Update` or `Delete`.\"},\"eventSource\":{\"type\":\"string\",\"title\":\"The Event Source.\",\"description\":\"Defaults to `Entity.EventSource`. Note: when used in code-generation the `CodeGeneration.EventSourceRoot` will be prepended where specified. To include the entity id/key include a `{$key}` placeholder (`Create`, `Update` or `Delete` operation only); for example: `person/{$key}`. Otherwise, specify the C# string interpolation expression; for example: `person/{r.Id}`.\"},\"eventSubject\":{\"type\":\"string\",\"title\":\"The event subject template and corresponding event action pair (separated by a colon).\",\"description\":\"The event subject template defaults to `{AppName}.{Entity.Name}`, plus each of the unique key placeholders comma separated; e.g. `Domain.Entity.{id1},{id2}` (depending on whether `Entity.EventSubjectFormat` is `NameAndKey` or `NameOnly`). The event action defaults to `WebApiOperationType` or `Operation.Type` where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. `Demo.Person.{id}:Create;Demo.Other.{id}:Update`.\"},\"webApiRoute\":{\"type\":\"string\",\"title\":\"The Web API `RouteAtttribute` to be appended to the `Entity.WebApiRoutePrefix`.\",\"description\":\"Where the value is specified with a leading `!` character this indicates that the `Entity.WebApiRoutePrefix` should not be used, and the value should be used as-is (with the `!` removed).\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.\",\"description\":\"Where not specified no attribute output will occur; it will then inherit as supported by .NET.\"},\"webApiMethod\":{\"type\":\"string\",\"title\":\"The HTTP Method for the operation.\",\"description\":\"The value defaults as follows: `HttpGet` for `Operation.Type` value `Get` or `GetColl`, `HttpPost` for `Operation.Type` value `Create` or `Custom`, `HttpPut` for `Operation.Type` value `Update`, and `HttpDelete` for `Operation.Type` value `Delete`. An `Operation.Type` value `Patch` can not be specified and will always default to `HttpPatch`.\",\"enum\":[\"HttpGet\",\"HttpPost\",\"HttpPut\",\"HttpDelete\"]},\"webApiStatus\":{\"type\":\"string\",\"title\":\"The primary HTTP Status Code that will be returned for the operation where there is a non-`null` return value.\",\"description\":\"The value defaults as follows: `OK` for `Operation.Type` value `Get`, `GetColl`, `Update`, `Delete` or `Custom`, `Created` for `Operation.Type` value `Create`.\",\"enum\":[\"OK\",\"Accepted\",\"Created\",\"NoContent\",\"NotFound\"]},\"webApiAlternateStatus\":{\"type\":\"string\",\"title\":\"The primary HTTP Status Code that will be returned for the operation where there is a `null` return value.\",\"description\":\"The value defaults as follows: `NotFound` for `Operation.Type` of `Get`, `Update`, `Patch`; `NoContent` for `Operation.Type` of `GetColl`; otherwise, `none`. A value of `none` indicates that there is _no_ alternate status.\",\"enum\":[\"OK\",\"Accepted\",\"Created\",\"NoContent\",\"NotFound\",\"none\"]},\"webApiLocation\":{\"type\":\"string\",\"title\":\"The HTTP Response Location Header route.\",\"description\":\"This uses similar formatting to the `WebApiRoute`. The response value is accessed using `r.` notation to access underlying properties; for example `{r.Id}` or `person/{r.Id}`. The `Entity.WebApiRoutePrefix` will be prepended automatically; however, to disable set the first character to `!`, e.g. `!person/{r.Id}`. The URI can be inferred from another `Operation` by using a lookup `^`; for example `^Get` indicates to infer from the named `Get` operation (where only `^` is specified this is shorthand for `^Get` as this is the most common value). The Location URI will ensure the first character is a `/` so it acts a 'relative URL absolute path'.\"},\"webApiConcurrency\":{\"type\":\"boolean\",\"title\":\"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.\",\"description\":\"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the `Operation.Type` is `Update` or `Patch`, the request ETag will be matched against the response for a corresponding `Get` operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the `Get` must be the same as that returned from the corresponding `Create`, `Update` and `Patch` (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to `Entity.WebApiConcurrency`.\"},\"webApiGetOperation\":{\"type\":\"string\",\"title\":\"The corresponding `Get` method name (in the `XxxManager`) where the `Operation.Type` is `Update` and `SimulateConcurrency` is `true`.\",\"description\":\"Defaults to `Get`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`.\"},\"webApiUpdateOperation\":{\"type\":\"string\",\"title\":\"The corresponding `Update` method name (in the `XxxManager`) where the `Operation.Type` is `Patch`.\",\"description\":\"Defaults to `Update`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`.\"},\"webApiProduces\":{\"type\":\"array\",\"title\":\"The value(s) for the optional `[Produces()]` attribute for the operation within the Web Api Controller for the Swagger/OpenAPI documentation.\",\"items\":{\"type\":\"string\"}},\"webApiProducesResponseType\":{\"type\":\"string\",\"title\":\"The `[ProducesResponseType()]` attribute `typeof` for the operation within the Web Api Controller for the Swagger/OpenAPI documentation.\",\"description\":\"Defaults to the _Common_ type. A value of `None`, `none` or `` will ensure no type is emitted.\"},\"webApiTags\":{\"type\":\"array\",\"title\":\"The list of tags to add for the generated `WebApi` operation.\",\"description\":\"Overrides the `Entity.WebApiTags`; unless, if the first tag value is a `^` then this indicates that the `Entity.WebApiTags` are to be included (inherited) as a replacement. Otherwise, defaults to `Entity.WebApiTags`.\",\"items\":{\"type\":\"string\"}},\"authPermission\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsAuthorized(AuthPermission)` to determine whether the user is authorized.\"},\"authEntity\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized. Defaults to `Entity.AuthEntity`. Both the `AuthEntity` and `AuthAction` are required for code-generation.\"},\"authAction\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized. Both the `AuthEntity` and `AuthAction` are required for code-generation.\"},\"authRole\":{\"type\":\"string\",\"title\":\"The permission used by the `ExecutionContext.UserIsInRole(AuthRole)` to determine whether the user is authorized.\"},\"excludeAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of all `Operation` related output.\",\"description\":\"Is a shorthand means for setting all of the other `Exclude*` properties to `true`.\"},\"excludeIData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `Data` interface (`IXxxData.cs`) output.\"},\"excludeData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `Data` class (`XxxData.cs`) output.\"},\"excludeIDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `DataSvc` interface (`IXxxDataSvc.cs`) output.\"},\"excludeDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `DataSvc` class (`XxxDataSvc.cs`) output.\"},\"excludeIManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `Manager` interface (`IXxxManager.cs`) output.\"},\"excludeManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the `Manager` class (`XxxManager.cs`) output.\"},\"excludeWebApi\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the WebAPI `Controller` class (`XxxController.cs`) output.\"},\"excludeWebApiAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the WebAPI consuming `Agent` class (`XxxAgent.cs`) output.\"},\"excludeGrpcAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the gRPC consuming `Agent` class (`XxxAgent.cs`) output.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required for the Operation.\",\"description\":\"gRPC support is an explicit opt-in model (see `CodeGeneration.Grpc` configuration); therefore, each corresponding `Entity`, `Property` and `Operation` will also need to be opted-in specifically.\"},\"parameters\":{\"type\":\"array\",\"title\":\"The corresponding `Parameter` collection.\",\"items\":{\"$ref\":\"#/definitions/Parameter\"}}},\"required\":[\"name\"]},\"Parameter\":{\"type\":\"object\",\"title\":\"'Parameter' object (entity-driven)\",\"description\":\"The `Parameter` object defines an `Operation` parameter and its charateristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique parameter name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the `Text` will be the `Name` reformatted as sentence casing. To have the text used as-is prefix with a `+` plus-sign character.\"},\"type\":{\"type\":\"string\",\"title\":\"The .NET `Type`.\",\"description\":\"Defaults to `string`. To reference a Reference Data `Type` always prefix with `RefDataNamespace` (e.g. `RefDataNamespace.Gender`) or shortcut `^` (e.g. `^Gender`). This will ensure that the appropriate Reference Data `using` statement is used. _Shortcut:_ Where the `Type` starts with (prefix) `RefDataNamespace.` or `^`, and the correspondong `RefDataType` attribute is not specified it will automatically default the `RefDataType` to `string.`\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the .NET Type should be declared as nullable; e.g. `int?`. Will be inferred where the `Type` is denoted as nullable; i.e. suffixed by a `?`. Where the .NET Type is not considered as an intrinsic type then will default to `true`.\"},\"default\":{\"type\":\"string\",\"title\":\"The C# code to default the value.\",\"description\":\"Where the `Type` is `string` then the specified default value will need to be delimited. Any valid value assignment C# code can be used.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`.\"},\"property\":{\"type\":\"string\",\"title\":\"The `Property.Name` within the parent `Entity` to copy (set) the configuration/characteristics from where not already defined.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).\",\"description\":\"Defaults to `string` where not specified and the corresponding `Type` starts with (prefix) `RefDataNamespace.`.\",\"enum\":[\"string\",\"int\",\"Guid\"]},\"refDataList\":{\"type\":\"boolean\",\"title\":\"Indicates that the Reference Data property is to be a serializable list (`ReferenceDataSidList`).\",\"description\":\"This is required to enable a list of Reference Data values (as per `RefDataType`) to be passed as an argument for example.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET `Type` that will perform the validation.\"},\"validatorCode\":{\"type\":\"string\",\"title\":\"The fluent-style method-chaining C# validator code to append to `IsMandatory` and `Validator` (where specified).\"},\"validationFramework\":{\"type\":\"string\",\"title\":\"The `Validation` framework to use for the entity-based validation.\",\"description\":\"Defaults to `Operation.ValidationFramework`.\",\"enum\":[\"CoreEx\",\"FluentValidation\"]},\"isMandatory\":{\"type\":\"boolean\",\"title\":\"Indicates whether a `ValidationException` should be thrown when the parameter value has its default value (null, zero, etc).\"},\"layerPassing\":{\"type\":\"string\",\"title\":\"The option that determines the layers in which the parameter is passed.\",\"description\":\"Defaults to `All`. To further describe, `All` passes the parameter through all layeys, `ToManagerSet` only passes the parameter to the `Manager` layer and overrides the same named property within the corresponding `value` parameter, `ToManagerCollSet` only passes the parameter to the `Manager` layer and overrides the same named property within the corresponding `value` collection parameter. Where using the `PrimaryKey` option to automatically set `Parameters`, and the `Operation.Type` is `Create` or `Update` it will default to `ToManagerSet`.\",\"enum\":[\"All\",\"ToManagerSet\",\"ToManagerCollSet\"]},\"dataConverter\":{\"type\":\"string\",\"title\":\"The data `Converter` class name where specific data conversion is required.\",\"description\":\"A `Converter` is used to convert a data source value to/from a .NET `Type` where no standard data conversion can be applied. Where this value is suffixed by `<T>` or `{T}` this will automatically set `Type`.\"},\"webApiFrom\":{\"type\":\"string\",\"title\":\"The option for how the parameter will be delcared within the Web API Controller.\",\"description\":\"Defaults to `FromQuery`; unless the parameter `Type` has also been defined as an `Entity` within the code-gen config file then it will default to `FromEntityProperties`. Specifies that the parameter will be declared with corresponding `FromQueryAttribute`, `FromBodyAttribute` or `FromRouteAttribute` for the Web API method. The `FromEntityProperties` will declare all properties of the `Entity` as query parameters.An `AcceptsBody` indicates that the _value_ will be passed in the HTTP Request Body and be handled (JSON deserialized) as a `CoreEx.AspNetCore.WebApis.WebWebApiParam` (default behavior for a `Create` or `Update` operation type).\",\"enum\":[\"FromQuery\",\"FromBody\",\"FromRoute\",\"FromEntityProperties\",\"AcceptsBody\"]},\"webApiText\":{\"type\":\"string\",\"title\":\"The overriding text for use in the Web API comments.\",\"description\":\"By default the `WbeApiText` will be the `Name` reformatted as sentence casing. To have the text used as-is prefix with a `+` plus-sign character.\"},\"grpcType\":{\"type\":\"string\",\"title\":\"The underlying gRPC data type; will be inferred where not specified.\"}},\"required\":[\"name\"]},\"Const\":{\"type\":\"object\",\"title\":\"'Const' object (entity-driven)\",\"description\":\"The `Const` object is used to define a .NET (C#) constant value for an `Entity`.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique constant name.\"},\"value\":{\"type\":\"string\",\"title\":\"The .NET (C#) code for the constant value.\",\"description\":\"The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the `Text` will be the `Name` reformatted as sentence casing. It will be formatted as: `Represents a {text} constant value.` To create a `<see cref=\\\"XXX\\\"/>` within use moustache shorthand (e.g. `{{Xxx}}`). To have the text used as-is prefix with a `+` plus-sign character.\"}},\"required\":[\"name\",\"value\"]}},\"allOf\":[{\"$ref\":\"#/definitions/CodeGeneration\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).","$schema":"https://json-schema.org/draft-04/schema#","definitions":{"CodeGeneration":{"type":"object","title":"'CodeGeneration' object (entity-driven)","description":"The `CodeGeneration` object defines global properties that are used to drive the underlying entity-driven code generation.","properties":{"withResult":{"type":"boolean","title":"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).","description":"Defaults to `true`. This can be overridden within the `Entity`(s) and/or `Operation`(s)."},"preprocessorDirectives":{"type":"boolean","title":"Indicates whether to use preprocessor directives in the generated output."},"refDataNamespace":{"type":"string","title":"The namespace for the Reference Data entities (adds as a c# `using` statement).","description":"Defaults to `Company` + `.` (literal) + AppName + `.Business.Entities` (literal)."},"refDataCommonNamespace":{"type":"string","title":"The namespace for the Reference Data common entities (adds as a c# `using` statement).","description":"Defaults to `Company` + `.` (literal) + AppName + `.Common.Entities` (literal)."},"refDataText":{"type":"boolean","title":"Indicates whether a corresponding `Text` property is added when generating a Reference Data `Property` for an `Entity`.","description":"This is used where serializing within the Web API `Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`). This can be further configured on the `Entity` and for each `Property`."},"refDataType":{"type":"string","title":"The Reference Data identifier Type option.","description":"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier. Results in all underlying entities becoming Reference Data.","enum":["int","long","Guid","string"]},"refDataWebApiRoute":{"type":"string","title":"The `RouteAtttribute` for the Reference Data Web API controller required for named pre-fetching. The `WebApiRoutePrefix` will be prepended where specified."},"refDataDataCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `ReferenceDataData` constructor.","description":"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.","items":{"type":"string"}},"jsonSerializer":{"type":"string","title":"The JSON Serializer to use for JSON property attribution.","description":"Defaults to `SystemText`. This can be overridden within the `Entity`(s).","enum":["SystemText","Newtonsoft"]},"etagJsonName":{"type":"string","title":"The default JSON name for the `ETag` property.","description":"Defaults to `etag`. Note that the `JsonName` can be set individually per property where required.","enum":["etag","eTag","_etag","_eTag","ETag","ETAG"]},"usingNamespace1":{"type":"string","title":"The additional Namespace using statement to be added to the generated `Entity` code.","description":"Typically used where referening a `Type` from a Namespace that is not generated by default."},"usingNamespace2":{"type":"string","title":"The additional Namespace using statement to be added to the generated `Entity` code.","description":"Typically used where referening a `Type` from a Namespace that is not generated by default."},"usingNamespace3":{"type":"string","title":"The additional Namespace using statement to be added to the generated `Entity` code.","description":"Typically used where referening a `Type` from a Namespace that is not generated by default."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.","description":"This can be overridden within the `Entity`(s) and/or their corresponding `Operation`(s)."},"webApiAutoLocation":{"type":"boolean","title":"Indicates whether the HTTP Response Location Header route (`Operation.WebApiLocation`) is automatically inferred.","description":"This will automatically set the `Operation.WebApiLocation` for an `Operation` named `Create` where there is a corresponding named `Get`. This can be overridden within the `Entity`(s)."},"webApiRoutePrefix":{"type":"string","title":"The base (prefix) `URI` prepended to all `Operation.WebApiRoute` values."},"webApiTags":{"type":"array","title":"The list of tags to add for the generated `WebApi`.","description":"This can be overridden within the `Entity`(s) and/or their corresponding `Operation`(s).","items":{"type":"string"}},"managerCleanUp":{"type":"boolean","title":"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.","description":"This can be overridden within the `Entity`(s) and `Operation`(s)."},"validationFramework":{"type":"string","title":"The `Validation` framework to use for the entity-based validation.","description":"Defaults to `CoreEx` (literal). This can be overridden within the `Entity`(s), `Operation`(s) and `Parameter`(s).","enum":["CoreEx","FluentValidation"]},"autoImplement":{"type":"string","title":"The data source auto-implementation option.","description":"Defaults to `None`. Indicates that the implementation for the underlying `Operations` will be auto-implemented using the selected data source (unless explicitly overridden). When selected some of the related attributes will also be required (as documented). Additionally, the `AutoImplement` can be further specified/overridden per `Operation`.","enum":["Database","EntityFramework","Cosmos","OData","HttpAgent","None"]},"databaseType":{"type":"string","title":"The .NET database type and optional name (used where `Operation.AutoImplement` is `Database`).","description":"Defaults to `IDatabase`. Should be formatted as `Type` + `^` + `Name`; e.g. `IDatabase^Db`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s)."},"databaseSchema":{"type":"string","title":"The default database schema name.","description":"Defaults to `dbo`."},"databaseProvider":{"type":"string","title":"The default database schema name.","description":"Defaults to `SqlServer`. Enables specific database provider functionality/formatting/etc. where applicable.","enum":["SqlServer","MySQL","Postgres"]},"databaseMapperEx":{"type":"boolean","title":"Indicates that a `DatabaseMapperEx` will be used; versus, `DatabaseMapper` (which uses Reflection internally).","description":"Defaults to `true`. The `DatabaseMapperEx` essentially replaces the `DatabaseMapper` as it is more performant (extended/explicit); this option can be used where leagcy/existing behavior is required."},"entityFrameworkType":{"type":"string","title":"The .NET Entity Framework type and optional name (used where `Operation.AutoImplement` is `EntityFramework`).","description":"Defaults to `IEfDb`. Should be formatted as `Type` + `^` + `Name`; e.g. `IEfDb^Ef`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s)."},"cosmosType":{"type":"string","title":"The .NET Cosmos DB type and name (used where `Operation.AutoImplement` is `Cosmos`).","description":"Defaults to `ICosmosDb`. Should be formatted as `Type` + `^` + `Name`; e.g. `ICosmosDb^Cosmos`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s)."},"odataType":{"type":"string","title":"The .NET OData interface name used where `Operation.AutoImplement` is `OData`.","description":"Defaults to `IOData`. Should be formatted as `Type` + `^` + `Name`; e.g. `IOData^OData`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s)."},"httpAgentType":{"type":"string","title":"The default .NET HTTP Agent interface name used where `Operation.AutoImplement` is `HttpAgent`.","description":"Defaults to `IHttpAgent`. Should be formatted as `Type` + `^` + `Name`; e.g. `IHttpAgent^HttpAgent`. Where the `Name` portion is not specified it will be inferred. This can be overridden within the `Entity`(s)."},"etagDefaultMapperConverter":{"type":"string","title":"The default ETag to/from RowVersion column Mapping Converter used where `Operation.AutoImplement` is `Database` or `EntityFramework`.","description":"Defaults to `StringToBase64Converter`."},"refDataDefaultMapperConverter":{"type":"string","title":"The default Reference Data property `Converter` used by the generated `Mapper`(s) where not specifically defined.","description":"Defaults to `ReferenceDataCodeConverter<T>`. Where this value is suffixed by `<T>` or `{T}` this will automatically be set to the `Type`.","enum":["ReferenceDataCodeConverter","ReferenceDataCodeConverter{T}","ReferenceDataCodeConverter<T>","ReferenceDataIdConverter{T, int}","ReferenceDataIdConverter<T, int>","ReferenceDataIdConverter{T, int?}","ReferenceDataIdConverter<T, int?>","ReferenceDataIdConverter{T, long}","ReferenceDataIdConverter<T, long>","ReferenceDataIdConverter{T, long?}","ReferenceDataIdConverter<T, long?>","ReferenceDataIdConverter{T, Guid}","ReferenceDataIdConverter<T, Guid>","ReferenceDataIdConverter{T, Guid?}","ReferenceDataIdConverter<T, Guid?>","ReferenceDataInt32IdConverter","ReferenceDataInt32IdConverter{T}","ReferenceDataInt32IdConverter<T>","ReferenceDataNullableInt32IdConverter","ReferenceDataNullableInt32IdConverter{T}","ReferenceDataNullableInt32IdConverter<T>","ReferenceDataInt64IdConverter","ReferenceDataInt64IdConverter{T}","ReferenceDataInt64IdConverter<T>","ReferenceDataNullableInt64IdConverter","ReferenceDataNullableInt64IdConverter{T}","ReferenceDataNullableInt64IdConverter<T>","ReferenceDataGuidIdConverter","ReferenceDataGuidIdConverter{T}","ReferenceDataGuidIdConverter<T>","ReferenceDataNullableGuidIdConverter","ReferenceDataNullableGuidIdConverter{T}","ReferenceDataNullableGuidIdConverter<T>"]},"refDataCodeDataName":{"type":"string","title":"The Reference Data `Code` data name.","description":"Defaults to `Code` (literal)."},"refDataTextDataName":{"type":"string","title":"The Reference Data `Text` data name.","description":"Defaults to `Text` (literal)."},"refDataIsActiveDataName":{"type":"string","title":"The Reference Data `IsActive` data name.","description":"Defaults to `IsActive` (literal)."},"refDataSortOrderDataName":{"type":"string","title":"The Reference Data `SortOrder` data name.","description":"Defaults to `SortOrder` (literal)."},"refDataETagDataName":{"type":"string","title":"The Reference Data `ETag` data name.","description":"Defaults to `RowVersion` (literal)."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.","description":"Defaults to `DataSvc`. Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the `Entity`(s).","enum":["None","DataSvc","Data"]},"eventSourceRoot":{"type":"string","title":"The URI root for the event source by prepending to all event source URIs.","description":"The event source is only updated where an `EventSourceKind` is not `None`. This can be extended within the `Entity`(s)."},"eventSourceKind":{"type":"string","title":"The URI kind for the event source URIs.","description":"Defaults to `None` (being the event source is not updated).","enum":["None","Absolute","Relative","RelativeOrAbsolute"]},"eventSubjectRoot":{"type":"string","title":"The root for the event Subject name by prepending to all event subject names.","description":"Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the `Entity`(s)."},"eventSubjectSeparator":{"type":"string","title":"The subject path separator.","description":"Defaults to `.`. Used only where the subject is automatically inferred."},"eventActionFormat":{"type":"string","title":"The formatting for the Action when an Event is published.","description":"Defaults to `None` (no formatting required, i.e. as-is)`.","enum":["None","PastTense"]},"eventTransaction":{"type":"boolean","title":"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `DataSvc`-layer whereever generating event publishing logic.","description":"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an `EventPublish` error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to `false`. This essentially defaults the `Entity.EventTransaction` where not otherwise specified. This should only be used where `EventPublish` is `DataSvc` and a transactionally-aware data source is being used."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required.","description":"gRPC support is an explicit opt-in model. Must be set to `true` for any of the subordinate gRPC capabilities to be code-generated. Will require each `Entity`, and corresponding `Property` and `Operation` to be opted-in specifically."},"pathBase":{"type":"string","title":"The base path (directory) prefix for the artefacts; other `Path*` properties append to this value when they are not specifically overridden.","description":"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`."},"pathCommon":{"type":"string","title":"The path (directory) for the Database-related artefacts.","description":"Defaults to `PathBase` + `.Common` (literal). For example `Beef.Demo.Common`."},"pathBusiness":{"type":"string","title":"The path (directory) for the Business-related (.NET) artefacts.","description":"Defaults to `PathBase` + `.Business` (literal). For example `Beef.Demo.Business`."},"pathApi":{"type":"string","title":"The path (directory) for the API-related (.NET) artefacts.","description":"Defaults to `PathBase` + `.` + `ApiName` (runtime parameter). For example `Beef.Demo.Api`."},"namespaceBase":{"type":"string","title":"The base Namespace (root) for the .NET artefacts.","description":"Defaults to `Company` (runtime parameter) + `.` + `AppName` (runtime parameter). For example `Beef.Demo`."},"namespaceCommon":{"type":"string","title":"The Namespace (root) for the Common-related .NET artefacts.","description":"Defaults to `NamespaceBase` + `.Common` (literal). For example `Beef.Demo.Common`."},"namespaceBusiness":{"type":"string","title":"The Namespace (root) for the Business-related .NET artefacts.","description":"Defaults to `NamespaceBase` + `.Business` (literal). For example `Beef.Demo.Business`."},"namespaceApi":{"type":"string","title":"The Namespace (root) for the Api-related .NET artefacts.","description":"Defaults to `NamespaceBase` + `.` + `ApiName` (runtime parameter). For example `Beef.Demo.Api`."},"authActionCreate":{"type":"string","title":"The default `Operation.AuthAction` for an `Operation.Type` of `Create`.","description":"Defaults to `Create`."},"authActionRead":{"type":"string","title":"The default `Operation.AuthAction` for an `Operation.Type` of `Get` or `GetColl`.","description":"Defaults to `Read`."},"authActionUpdate":{"type":"string","title":"The default `Operation.AuthAction` for an `Operation.Type` of `Update`.","description":"Defaults to `Update`."},"authActionDelete":{"type":"string","title":"The default `Operation.AuthAction` for an `Operation.Type` of `Delete`.","description":"Defaults to `Delete`."},"entities":{"type":"array","title":"The corresponding `Entity` collection.","items":{"$ref":"#/definitions/Entity"}}}},"Entity":{"type":"object","title":"'Entity' object (entity-driven)","description":"The `Entity` is used as the primary configuration for driving the entity-driven code generation.","properties":{"name":{"type":"string","title":"The unique entity name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"Overrides the Name (as sentence text) for the summary comments. It will be formatted as: `Represents the {Text} entity.`. To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character."},"fileName":{"type":"string","title":"The overriding file name.","description":"Overrides the Name as the code-generated file name."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`."},"constType":{"type":"string","title":"The Const .NET Type option.","description":"The .NET Type to be used for the `const` values. Defaults to `string`.","enum":["int","long","Guid","string"]},"isInitialOverride":{"type":"boolean","title":"Indicates whether to override the `IInitial.IsInitial` property.","description":"Set to either `true` or `false` to override as specified; otherwise, `null` to check each property. Defaults to `null`."},"withResult":{"type":"boolean","title":"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).","description":"Defaults to `CodeGeneration.WithResult`. This can be overridden within the Operation`(s)."},"refDataType":{"type":"string","title":"The Reference Data identifier Type option.","description":"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.","enum":["int","long","Guid","string"]},"refDataText":{"type":"boolean","title":"Indicates whether a corresponding `Text` property is added when generating a Reference Data `Property` overriding the `CodeGeneration.RefDataText` selection.","description":"This is used where serializing within the Web API`Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`). Defaults from `CodeGeneration.RefDataText`."},"refDataSortOrder":{"type":"string","title":"The Reference Data sort order option.","description":"Specifies the default sort order for the underlying Reference Data collection. Defaults to `SortOrder`.","enum":["SortOrder","Id","Code","Text"]},"inherits":{"type":"string","title":"The base class that the entity inherits from.","description":"Defaults to `EntityBase` for a standard entity. For Reference Data it will default to `ReferenceDataBaseEx<xxx>` depending on the corresponding `RefDataType` value. See `OmitEntityBase` if the desired outcome is to not inherit from any of the aforementioned base classes."},"implements":{"type":"string","title":"The list of comma separated interfaces that are to be declared for the entity class."},"implementsAutoInfer":{"type":"boolean","title":"Indicates whether to automatically infer the interface implements for the entity from the properties declared.","description":"Will attempt to infer the following: `IIdentifier<Guid>`, `IIdentifier<int>`, `IIdentifier<long>`, `IIdentifier<string>`, `IETag` and `IChangeLog`. Defaults to `true`."},"abstract":{"type":"boolean","title":"Indicates whether the class should be defined as abstract."},"genericWithT":{"type":"boolean","title":"Indicates whether the class should be defined as a generic with a single parameter `T`."},"namespace":{"type":"string","title":"The entity namespace to be appended.","description":"Appended to the end of the standard structure as follows: `{Company}.{AppName}.Business.Entities.{Namespace}`."},"omitEntityBase":{"type":"boolean","title":"Indicates that the entity should not inherit from `EntityBase`.","description":"As such any of the `EntityBase` related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities."},"jsonSerializer":{"type":"string","title":"The JSON Serializer to use for JSON property attribution.","description":"Defaults to the `CodeGeneration.JsonSerializer` configuration property where specified; otherwise, `SystemText`.","enum":["SystemText","Newtonsoft"]},"internalOnly":{"type":"boolean","title":"Indicates whether the entity is for internal use only; declared in Business entities only."},"collection":{"type":"boolean","title":"Indicates whether a corresponding entity collection class should be created."},"collectionResult":{"type":"boolean","title":"Indicates whether a corresponding entity collection result class should be created","description":"Enables the likes of additional paging state to be stored with the underlying collection."},"collectionType":{"type":"string","title":"The entity collection type used where `CollectionInherits` is not specified.","enum":["Standard","Keyed","Dictionary"]},"collectionInherits":{"type":"string","title":"The base class that a `Collection` inherits from.","description":"Defaults to `EntityBaseCollection` or `EntityBaseKeyedCollection` depending on `CollectionKeyed`. For Reference Data it will default to `ReferenceDataCollectionBase`."},"collectionResultInherits":{"type":"string","title":"The base class that a `CollectionResult` inherits from.","description":"Defaults to `EntityCollectionResult`."},"behavior":{"type":"string","title":"Defines the key CRUD-style behavior (operation types), being 'C'reate, 'G'et (or 'R'ead), 'U'pdate, 'P'atch, 'D'elete and `Q`uery). Additionally, `GetByArgs` ('B'), `GetAll` ('A') and `GetByQuery` ('Q') operations configuration will be automatically inferred where not otherwise explicitly specified.","description":"Value may only specifiy one or more of the `CGRUDBAQ` characters (in any order) to define the automatically generated behavior (operations); for example: `CRUPD` or `CRUP` or `rba` (case insensitive). This is shorthand for setting one or more of the following properties: `Get`, `GetByArgs`, `GetAll`, 'Create', `Update`, `Patch` and `Delete`. Where one of these properties is set to either `true` or `false` this will take precedence over the value set for `Behavior`."},"get":{"type":"boolean","title":"Indicates that a `Get` operation will be automatically generated where not otherwise explicitly specified."},"getByArgs":{"type":"boolean","title":"Indicates that a `GetByArgs` operation will be automatically generated where not otherwise explicitly specified."},"getAll":{"type":"boolean","title":"Indicates that a `GetAll` operation will be automatically generated where not otherwise explicitly specified."},"getByQuery":{"type":"boolean","title":"Indicates that a `GetByQuery` operation will be automatically generated where not otherwise explicitly specified."},"create":{"type":"boolean","title":"Indicates that a `Create` operation will be automatically generated where not otherwise explicitly specified."},"update":{"type":"boolean","title":"Indicates that a `Update` operation will be automatically generated where not otherwise explicitly specified."},"patch":{"type":"boolean","title":"Indicates that a `Patch` operation will be automatically generated where not otherwise explicitly specified."},"delete":{"type":"boolean","title":"Indicates that a `Delete` operation will be automatically generated where not otherwise explicitly specified."},"autoImplement":{"type":"string","title":"The data source auto-implementation option.","description":"Defaults to `CodeGeneration.AutoImplement` (where `RefDataType` or `EntityFrameworkModel` or `CosmosModel` or `HttpAgent` is not null; otherwise, `None`. Indicates that the implementation for the underlying `Operations` will be auto-implemented using the selected data source (unless explicitly overridden). When selected some of the related attributes will also be required (as documented). Additionally, the `AutoImplement` can be further specified/overridden per `Operation`.","enum":["Database","EntityFramework","Cosmos","OData","HttpAgent","None"]},"dataCtor":{"type":"string","title":"The access modifier for the generated `Data` constructor.","description":"Defaults to `Public`.","enum":["Public","Private","Protected"]},"dataCtorCustom":{"type":"boolean","title":"Indicates whether the `Data` constructor will be implemented as custom; i.e. not generated."},"dataCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `Data` constructor.","description":"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.","items":{"type":"string"}},"dataExtensions":{"type":"boolean","title":"Indicates whether the `Data` extensions logic should be generated.","description":"This can be overridden using `Operation.DataExtensions`."},"refDataIdDataName":{"type":"string","title":"The Reference Data `Id` data name.","description":"Defaults to `Name` + `Id` (literal)."},"refDataCodeDataName":{"type":"string","title":"The Reference Data `Code` data name.","description":"Defaults to `Code` (literal)."},"refDataTextDataName":{"type":"string","title":"The Reference Data `Text` data name.","description":"Defaults to `Text` (literal)."},"refDataIsActiveDataName":{"type":"string","title":"The Reference Data `IsActive` data name.","description":"Defaults to `IsActive` (literal)."},"refDataSortOrderDataName":{"type":"string","title":"The Reference Data `SortOrder` data name.","description":"Defaults to `SortOrder` (literal)."},"refDataETagDataName":{"type":"string","title":"The Reference Data `ETag` data name.","description":"Defaults to `RowVersion` (literal)."},"refDataStoredProcedureName":{"type":"string","title":"The Reference Data database stored procedure name.","description":"Defaults to `sp` (literal) + `Name` + `GetAll` (literal)."},"databaseType":{"type":"string","title":"The .NET database type and optional name (used where `AutoImplement` is `Database`).","description":"Defaults to the `CodeGeneration.DatabaseName` configuration property (its default value is `IDatabase`). Should be formatted as `Type` + `^` + `Name`."},"databaseSchema":{"type":"string","title":"The database schema name (used where `AutoImplement` is `Database`).","description":"Defaults to `dbo`."},"databaseMapperInheritsFrom":{"type":"string","title":"The name of the `Mapper` that the generated Database `Mapper` inherits from."},"databaseCustomMapper":{"type":"boolean","title":"Indicates that a custom Database `Mapper` will be used; i.e. not generated.","description":"Otherwise, by default, a `Mapper` will be generated."},"databaseMapperEx":{"type":"boolean","title":"Indicates that a `DatabaseMapperEx` (extended/explicit) will be used; versus, `DatabaseMapper` (which uses Reflection internally).","description":"Defaults to `CodeGeneration.DatabaseMapperEx` (its default value is `true`). The `DatabaseMapperEx` essentially replaces the `DatabaseMapper` as it is more performant; this option can be used where leagcy/existing behavior is required."},"entityFrameworkType":{"type":"string","title":"The .NET Entity Framework type and optyional name used where `AutoImplement` is `EntityFramework`.","description":"Defaults to `CodeGeneration.EntityFrameworkName`. Should be formatted as `Type` + `^` + `Name`."},"entityFrameworkModel":{"type":"string","title":"The corresponding Entity Framework model name (required where `AutoImplement` is `EntityFramework`)."},"entityFrameworkCustomMapper":{"type":"boolean","title":"Indicates that a custom Entity Framework `Mapper` will be used; i.e. not generated.","description":"Otherwise, by default, a `Mapper` will be generated."},"entityFrameworkMapperBase":{"type":"string","title":"The EntityFramework data-layer name that should be used for base mappings."},"cosmosType":{"type":"string","title":"The .NET Cosmos DB type and optional name used where `AutoImplement` is `Cosmos`.","description":"Defaults to the `CodeGeneration.CosmosName` configuration property (its default value is `ICosmosDb`). Should be formatted as `Type` + `^` + `Name`."},"cosmosModel":{"type":"string","title":"The corresponding Cosmos model name (required where `AutoImplement` is `Cosmos`)."},"cosmosContainerId":{"type":"string","title":"The Cosmos `ContainerId` required where `AutoImplement` is `Cosmos`."},"cosmosPartitionKey":{"type":"string","title":"The C# code to be used for setting the optional Cosmos `PartitionKey` where `AutoImplement` is `Cosmos`.","description":"The value `PartitionKey.None` can be specified. Literals will need to be quoted."},"cosmosValueContainer":{"type":"boolean","title":"Indicates whether the `CosmosDbValueContainer` is to be used; otherwise, `CosmosDbContainer`."},"cosmosCustomMapper":{"type":"boolean","title":"Indicates that a custom Cosmos `Mapper` will be used; i.e. not generated.","description":"Otherwise, by default, a `Mapper` will be generated."},"cosmosMapperBase":{"type":"string","title":"The Cosmos data-layer name that should be used for base mappings."},"odataType":{"type":"string","title":"The .NET OData type and optional name used where `AutoImplement` is `OData`.","description":"Defaults to the `CodeGeneration.ODataName` configuration property (its default value is `IOData`). Should be formatted as `Type` + `^` + `Name`."},"odataModel":{"type":"string","title":"The corresponding OData model name (required where `AutoImplement` is `OData`)."},"odataCollectionName":{"type":"string","title":"The name of the underlying OData collection where `AutoImplement` is `OData`.","description":"The underlying `Simple.OData.Client` will attempt to infer."},"odataCustomMapper":{"type":"boolean","title":"Indicates that a custom OData `Mapper` will be used; i.e. not generated.","description":"Otherwise, by default, a `Mapper` will be generated."},"httpAgentType":{"type":"string","title":"The .NET HTTP Agent type and optional name used where `Operation.AutoImplement` is `HttpAgent`.","description":"Defaults to `CodeGeneration.HttpAgentName` configuration property (its default value is `IHttpAgent`). Should be formatted as `Type` + `^` + `Name`."},"httpAgentRoutePrefix":{"type":"string","title":"The base HTTP Agent API route where `Operation.AutoImplement` is `HttpAgent`.","description":"This is the base (prefix) `URI` for the HTTP Agent endpoint and can be further extended when defining the underlying `Operation`(s)."},"httpAgentModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).","description":"This can be overridden within the `Operation`(s)."},"httpAgentReturnModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).","description":"This can be overridden within the `Operation`(s)."},"httpAgentCode":{"type":"string","title":"The fluent-style method-chaining C# HTTP Agent API code to include where `Operation.AutoImplement` is `HttpAgent`.","description":"Prepended to `Operation.HttpAgentCode` where specified to enable standardized functionality."},"httpAgentCustomMapper":{"type":"boolean","title":"Indicates that a custom HTTP Agent `Mapper` will be used; i.e. not generated.","description":"Otherwise, by default, a `Mapper` will be generated."},"httpAgentMapperBase":{"type":"string","title":"The HTTP Agent data-layer name that should be used for base mappings."},"dataSvcCaching":{"type":"boolean","title":"Indicates whether request-based `IRequestCache` caching is to be performed at the `DataSvc` layer to improve performance (i.e. reduce chattiness).","description":"Defaults to `true`."},"dataSvcCtor":{"type":"string","title":"The access modifier for the generated `DataSvc` constructor.","description":"Defaults to `Public`.","enum":["Public","Private","Protected"]},"dataSvcCustom":{"type":"string","title":"The option that indicates the level of `DataSvc` customization (invokes `*OnImplementationAsync` method) vs code-generation (automatically invokes data-layer).","description":"`Full` indicates the logic is fully customized (only invocation is code-generated). `Partial` indicates combination of surrounding code-generation with final custom invocation versus data-layer. `None` indicates data-layer invocation with _no_ custom invocation (default).","enum":["Full","Partial","None"]},"dataSvcCtorCustom":{"type":"boolean","title":"Indicates whether the `DataSvc` constructor will be implemented as custom; i.e. not generated."},"dataSvcCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `DataSvc` constructor.","description":"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.","items":{"type":"string"}},"dataSvcExtensions":{"type":"boolean","title":"Indicates whether the `DataSvc` extensions logic should be generated.","description":"This can be overridden using `Operation.DataSvcExtensions`."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.","description":"Defaults to the `CodeGeneration.EventPublish` configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the `Operation`(s).","enum":["None","DataSvc","Data"]},"eventSource":{"type":"string","title":"The Event Source.","description":"Defaults to `Name` (as lowercase) appended with the `/{$key}` placeholder. Note: when used in code-generation the `CodeGeneration.EventSourceRoot` will be prepended where specified. To include the entity id/key include a `{$key}` placeholder (`Create`, `Update` or `Delete` operation only); for example: `person/{$key}`. This can be overridden for the `Operation`."},"eventTransaction":{"type":"boolean","title":"Indicates whether a `System.TransactionScope` should be created and orchestrated whereever generating event publishing logic.","description":"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an `EventPublish` error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to `CodeGeneration.EventTransaction`. This essentially defaults the `Operation.DataSvcTransaction` where not otherwise specified. This should only be used where a transactionally-aware data source is being used."},"managerCustom":{"type":"boolean","title":"Indicates whether the `Manager` logic is a custom implementation; i.e. no auto-`DataSvc` invocation logic is to be generated."},"managerCtor":{"type":"string","title":"The access modifier for the generated `Manager` constructor.","description":"Defaults to `Public`.","enum":["Public","Private","Protected"]},"managerCtorCustom":{"type":"boolean","title":"Indicates whether the `Manager` constructor will be implemented as custom; i.e. not generated."},"managerCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `Manager` constructor.","description":"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.","items":{"type":"string"}},"managerExtensions":{"type":"boolean","title":"Indicates whether the `Manager` extensions logic should be generated.","description":"This can be overridden using `Operation.ManagerExtensions`."},"validator":{"type":"string","title":"The name of the .NET implementing `Type` or interface `Type` that will perform the validation.","description":"Only used for defaulting the `Create` and `Update` operation types (`Operation.Type`) where not specified explicitly."},"identifierGenerator":{"type":"boolean","title":"Indicates whether the `IIdentifierGenerator` should be used to generate the `Id` property where the operation types (`Operation.Type`) is `Create`."},"managerCleanUp":{"type":"boolean","title":"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.","description":"This can be overridden within the `CodeGeneration` and `Operation`(s)."},"validationFramework":{"type":"string","title":"The `Validation` framework to use for the entity-based validation.","description":"Defaults to `CodeGeneration.ValidationFramework`. This can be overridden within the `Operation`(s) and `Parameter`(s).","enum":["CoreEx","FluentValidation"]},"webApiRoutePrefix":{"type":"string","title":"The `RoutePrefixAtttribute` for the corresponding entity Web API controller.","description":"This is the base (prefix) `URI` for the entity and can be further extended when defining the underlying `Operation`(s). The `CodeGeneration.WebApiRoutePrefix` will be prepended where specified. Where not specified will automatically default to the pluralized `Name` (as lowercase)."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.","description":"Defaults to the `CodeGeneration.WebApiAuthorize` configuration property (inherits) where not specified; can be overridden at the `Operation` level also."},"webApiCtor":{"type":"string","title":"The access modifier for the generated Web API `Controller` constructor.","description":"Defaults to `Public`.","enum":["Public","Private","Protected"]},"webApiCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated `WebApi` constructor.","description":"Each constructor parameter should be formatted as `Type` + `^` + `Name`; e.g. `IConfiguration^Config`. Where the `Name` portion is not specified it will be inferred. Where the `Type` matches an already inferred value it will be ignored.","items":{"type":"string"}},"webApiAutoLocation":{"type":"boolean","title":"Indicates whether the HTTP Response Location Header route (`Operation.WebApiLocation`) is automatically inferred.","description":"This will automatically set the `Operation.WebApiLocation` for an `Operation` named `Create` where there is a corresponding named `Get`. This is defaulted from the `CodeGen.WebApiAutoLocation`."},"webApiConcurrency":{"type":"boolean","title":"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.","description":"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the `Operation.Type` is `Update` or `Patch`, the request ETag will be matched against the response for a corresponding `Get` operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the `Get` must be the same as that returned from the corresponding `Create`, `Update` and `Patch` (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the `Operation.WebApiConcurrency`."},"webApiGetOperation":{"type":"string","title":"The corresponding `Get` method name (in the `XxxManager`) where the `Operation.Type` is `Update` and `SimulateConcurrency` is `true`.","description":"Defaults to `Get`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`."},"webApiTags":{"type":"array","title":"The list of tags to add for the generated `WebApi` controller.","items":{"type":"string"}},"dataModel":{"type":"boolean","title":"Indicates whether a data `model` version of the entity should also be generated (output to `.\\Business\\Data\\Model`).","description":"The model will be generated with `OmitEntityBase = true`. Any reference data properties will be defined using their `RefDataType` intrinsic `Type` versus their corresponding (actual) reference data `Type`."},"dataModelInherits":{"type":"string","title":"Overrides the default data `model` inherits value."},"excludeEntity":{"type":"boolean","title":"Indicates whether to exclude the generation of the `Entity` class (`Xxx.cs`)."},"excludeAll":{"type":"boolean","title":"Indicates whether to exclude the generation of all `Operation` related artefacts; excluding the `Entity` class.","description":"Is a shorthand means for setting all of the other `Exclude*` properties (with the exception of `ExcludeEntity`) to exclude."},"excludeIData":{"type":"boolean","title":"Indicates whether to exclude the generation of the `Data` interface (`IXxxData.cs`)."},"excludeData":{"type":"string","title":"The option to exclude the generation of the `Data` class (`XxxData.cs`).","description":"Defaults to `Include` indicating _not_ to exclude. A value of `Exclude` indicates to exclude all output; alternatively, `RequiresMapper` indicates to at least output the corresponding `Mapper` class.","enum":["Include","Exclude","RequiresMapper"]},"excludeIDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the `DataSvc` interface (`IXxxDataSvc.cs`)."},"excludeDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the `DataSvc` class (`XxxDataSvc.cs`)."},"excludeIManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the `Manager` interface (`IXxxManager.cs`)."},"excludeManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the `Manager` class (`XxxManager.cs`)."},"excludeWebApi":{"type":"boolean","title":"The option to exclude the generation of the WebAPI `Controller` class (`XxxController.cs`)."},"excludeWebApiAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the WebAPI consuming `Agent` class (`XxxAgent.cs`)."},"excludeGrpcAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the gRPC consuming `Agent` class (`XxxAgent.cs`)."},"authPermission":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsAuthorized(AuthPermission)` to determine whether the user is authorized."},"authEntity":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized."},"authRole":{"type":"string","title":"The role (permission) used by the `ExecutionContext.UserIsInRole(role)` for each `Operation`.","description":"Used where not overridden specifically for an `Operation`; i.e. acts as the default."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required for the Entity.","description":"gRPC support is an explicit opt-in model (see `CodeGeneration.Grpc` configuration); therefore, each corresponding `Property` and `Operation` will also need to be opted-in specifically."},"properties":{"type":"array","title":"The corresponding `Property` collection.","items":{"$ref":"#/definitions/Property"}},"operations":{"type":"array","title":"The corresponding `Operation` collection.","items":{"$ref":"#/definitions/Operation"}},"consts":{"type":"array","title":"The corresponding `Consts` collection.","items":{"$ref":"#/definitions/Const"}}},"required":["name"]},"Property":{"type":"object","title":"'Property' object (entity-driven)","description":"The `Property` object defines an `Entity` property and its charateristics.","properties":{"name":{"type":"string","title":"The unique property name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the `Text` will be the `Name` reformatted as sentence casing. Depending on whether the `Type` is `bool`, will appear in one of the two generated sentences. Where not `bool` it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character."},"modelText":{"type":"string","title":"The overriding model text for use in comments.","description":"By default the `ModelText` will be the `Name` reformatted as sentence casing. Depending on whether the `Type` is `bool`, will appear in one of the two generated sentences. Where not `bool` it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character."},"type":{"type":"string","title":"The .NET `Type`.","description":"Defaults to `string`. To reference a Reference Data `Type` always prefix with `RefDataNamespace` (e.g. `RefDataNamespace.Gender`) or shortcut `^` (e.g. `^Gender`). This will ensure that the appropriate Reference Data `using` statement is used. _Shortcut:_ Where the `Type` starts with (prefix) `RefDataNamespace.` or `^`, and the correspondong `RefDataType` attribute is not specified it will automatically default the `RefDataType` to `string.`"},"nullable":{"type":"boolean","title":"Indicates whether the .NET `Type` should be declared as nullable; e.g. `string?`. Will be inferred where the `Type` is denoted as nullable; i.e. suffixed by a `?`."},"inherited":{"type":"boolean","title":"Indicates whether the property is inherited and therefore should not be output within the generated Entity class."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`."},"primaryKey":{"type":"boolean","title":"Indicates whether the property is considered part of the primary (unique) key.","description":"This is also used to simplify the parameter specification for an Entity Operation by inferrence."},"isEntity":{"type":"boolean","title":"Indicates that the property `Type` is another generated entity / collection and therefore specific capabilities can be assumed (e.g. `CopyFrom` and `Clone`).","description":"Will be inferred (default to `true`) where the `Type` is `ChangeLog` or the `Type` is found as another `Entity` within the code-generation configuration file."},"immutable":{"type":"boolean","title":"Indicates that the value is immutable and therefore cannot be changed once set."},"dateTimeTransform":{"type":"string","title":"The `DateTime` transformation to be performed on `Set` and `CleanUp`.","description":"Defaults to `UseDefault`. This is only applied where the `Type` is `DateTime`.","enum":["UseDefault","None","DateOnly","DateTimeLocal","DateTimeUtc","DateTimeUnspecified"]},"stringTrim":{"type":"string","title":"The `string` trimming of white space characters to be performed on `Set` and `CleanUp`.","description":"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.","enum":["UseDefault","None","Start","End","Both"]},"stringTransform":{"type":"string","title":"The `string` transformation to be performed on `Set` and `CleanUp`.","description":"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.","enum":["UseDefault","None","NullToEmpty","EmptyToNull"]},"stringCasing":{"type":"string","title":"The `string` casing to be performed on `Set` and `CleanUp`.","description":"Defaults to `UseDefault`. This is only applied where the `Type` is `string`.","enum":["UseDefault","None","Lower","Upper","Title"]},"autoCreate":{"type":"boolean","title":"Indicates whether an instance of the `Type` is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation)."},"default":{"type":"string","title":"The C# code to default the value.","description":"Where the `Type` is `string` then the specified default value will need to be delimited. Any valid value assignment C# code can be used."},"partitionKey":{"type":"boolean","title":"Indicates whether the property is considered part of the Partition Key.","description":"This will implement `IPartitionKey` for the generated entity."},"cacheKey":{"type":"boolean","title":"Indicates whether the property is considered part of the Cache Key.","description":"This will implement `ICacheKey` for the generated entity."},"internalOnly":{"type":"boolean","title":"Indicates whether the property is for internal use only; declared in Business entities only.","description":"In this instance the `Property` will be excluded from the `Common` entity declaration and `Business` JSON serialization."},"refDataType":{"type":"string","title":"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).","description":"Defaults to `string` (being the `ReferenceDataBase.Code`) where not specified and the corresponding `Type` starts with (prefix) `RefDataNamespace.` or `^`. Note: an `Id` of type `string` is currently not supported; the use of the `Code` is the recommended approach.","enum":["string","int","Guid"]},"refDataList":{"type":"boolean","title":"Indicates that the Reference Data property is to be a serializable list (`ReferenceDataSidList`).","description":"This is required to enable a list of Reference Data values (as per `RefDataType`) to be passed as an argument for example."},"refDataText":{"type":"string","title":"Indicates whether a corresponding `Text` property is added when generating a Reference Data property, overriding the `Entity.RefDataText` selection.","description":"This is used where serializing within the Web API `Controller` and the `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` (which is automatically set where the url contains `$text=true`).`Optional` indicates when `ExecutionContext.IsRefDataTextSerializationEnabled` is set to `true` then a value is output, `Always` indicates that the value is _always_ output, and `Never` indicates that feature is turned off.","enum":["Optional","Always","Never"]},"refDataTextName":{"type":"string","title":"The corresponding reference data `Text` property name; defaults to `Name` + 'Text'."},"refDataMapping":{"type":"boolean","title":"Indicates whether the property should use the underlying Reference Data mapping capabilities.","description":"Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable."},"jsonName":{"type":"string","title":"The JSON property name.","description":"Defaults to `ArgumentName` where not specified (i.e. camelCase); however, where the property is `ETag` it will default to the `Config.ETagJsonName`."},"jsonDataModelName":{"type":"string","title":"The JSON property name for the corresponding data model (see `Entity.DataModel`).","description":"Defaults to `JsonName` where not specified."},"serializationIgnore":{"type":"boolean","title":"Indicates whether the property is not to be serialized.","description":"All properties are serialized by default."},"serializationAlwaysInclude":{"type":"boolean","title":"Indicates whether to include the value (default or otherwise) when serializing."},"dataModelIgnore":{"type":"boolean","title":"Indicates whether the property is to be included within the data model.","description":"All properties are included in the data model by default."},"dataModelSerializationIgnore":{"type":"boolean","title":"Indicates whether the property is not to be serialized where outputting as a data model.","description":"All properties are included in the data model by default."},"dataName":{"type":"string","title":"The data name where Entity.AutoImplement is selected.","description":"Defaults to the property `Name`. Represents the column name for a `Database`, or the correspinding property name for the other options."},"dataConverter":{"type":"string","title":"The data `Converter` class name where `Entity.AutoImplement` is selected.","description":"A `Converter` is used to convert a data source value to/from a .NET `Type` where no standard data conversion can be applied. Where this value is suffixed by `<T>` or `{T}` this will automatically set `Type`."},"dataMapperIgnore":{"type":"boolean","title":"Indicates whether the property should be ignored (excluded) from the `Data`-layer / data `Mapper` generated output.","description":"All properties are included by default."},"dataAutoGenerated":{"type":"boolean","title":"Indicates whether the `PrimaryKey` property value is automatically generated by the data source on `Create`."},"dataOperationTypes":{"type":"string","title":"The operations types (`ExecutionContext.OperationType`) selection to enable inclusion and exclusion of property mapping.","description":"Defaults to `Any`.","enum":["Any","AnyExceptCreate","AnyExceptUpdate","AnyExceptGet","Get","Create","Update","Delete"]},"databaseMapper":{"type":"string","title":"The database property `Mapper` class name where `Entity.AutoImplement` is selected.","description":"A `Mapper` is used to map a data source value to/from a .NET complex `Type` (i.e. class with one or more properties)."},"databaseIgnore":{"type":"boolean","title":"Indicates whether the property should be ignored (excluded) from the database `Mapper` generated output."},"databaseDbType":{"type":"string","title":"The database `DbType` override (versus inferring from the corresponding .NET Type).","description":"Overrides the inferred database type; i.e. can specify `Date` or `DateTime2`, for .NET Type `System.DateTime`."},"entityFrameworkMapper":{"type":"string","title":"The Entity Framework `Mapper` approach for the property.","description":"Defaults to `Set`.","enum":["Set","Ignore","Map","Flatten"]},"cosmosMapper":{"type":"string","title":"The Cosmos `Mapper` approach for the property.","description":"Defaults to `Set`.","enum":["Set","Ignore","Map","Flatten"]},"odataMapper":{"type":"string","title":"The OData `Mapper` approach for the property.","description":"Defaults to `Map` which indicates the property will be explicitly mapped. A value of `Ignore` will explicitly `Ignore`, whilst a value of `Skip` will skip code-generated mapping altogether.","enum":["Map","Ignore","Skip"]},"httpAgentMapper":{"type":"string","title":"The HttpAgent `Mapper` approach for the property.","description":"Defaults to `Set`.","enum":["Set","Ignore","Map","Flatten"]},"displayName":{"type":"string","title":"The display name used in the likes of error messages for the property.","description":"Defaults to the `Name` as sentence case."},"annotation1":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"annotation2":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"annotation3":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"grpcFieldNo":{"type":"integer","title":"The unique (immutable) field number required to enable gRPC support."},"grpcType":{"type":"string","title":"The underlying gRPC data type; will be inferred where not specified."}},"required":["name"]},"Operation":{"type":"object","title":"'CodeGeneration' object (entity-driven)","description":"The code generation for an `Operation` is primarily driven by the `Type` property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.","properties":{"name":{"type":"string","title":"The unique operation name."},"type":{"type":"string","title":"The type of operation that is to be code-generated.","description":"Defaults to `Custom`.","enum":["Get","GetColl","Create","Update","Patch","Delete","Custom","CustomManagerOnly"]},"text":{"type":"string","title":"The text for use in comments.","description":"The `Text` will be defaulted for all the `Operation.Type` options with the exception of `Custom`. To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character."},"primaryKey":{"type":"boolean","title":"Indicates whether the properties marked as a primary key (`Property.PrimaryKey`) are to be used as the parameters.","description":"This simplifies the specification of these properties as parameters versus having to declare each specifically. Each of the parameters will also be set to be mandatory."},"paging":{"type":"boolean","title":"Indicates whether a `PagingArgs` argument is to be added to the operation to enable (standardized) paging related logic."},"query":{"type":"boolean","title":"Indicates whether a `QueryArgs` argument is to be added to the operation to enable OData-like $filter and $orderby related logic."},"valueType":{"type":"string","title":"The .NET value parameter `Type` for the operation.","description":"Defaults to the parent `Entity.Name` where the `Operation.Type` options are `Create` or `Update`."},"returnType":{"type":"string","title":"The .NET return `Type` for the operation.","description":"Defaults to the parent `Entity.Name` where the `Operation.Type` options are `Get`, `GetColl`, `Create` or `Update`; otherwise, defaults to `void`."},"returnTypeNullable":{"type":"boolean","title":"Indicates whether the `ReturnType` is nullable for the operation.","description":"Will be inferred where the `ReturnType` is denoted as nullable; i.e. suffixed by a `?`. Additionally a `Type` of `Get` will default to `true` where not specified."},"returnText":{"type":"string","title":"The text for use in comments to describe the `ReturnType`.","description":"A default will be created where not specified. To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. {{Xxx}}). To have the text used as-is prefix with a `+` plus-sign character."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the `Name` to be used for private usage. By default reformatted from `Name`; e.g. `GetByArgs` as `_getByArgs`."},"withResult":{"type":"boolean","title":"Indicates whether to use `CoreEx.Results` (aka Railway-oriented programming).","description":"Defaults to `Entity.WilhResult`."},"autoImplement":{"type":"string","title":"The operation override for the `Entity.AutoImplement`.","description":"Defaults to `Entity.AutoImplement`. The corresponding `Entity.AutoImplement` must be defined for this to be enacted. Auto-implementation is applicable for all `Operation.Type` options with the exception of `Custom`.","enum":["Database","EntityFramework","Cosmos","OData","HttpAgent","None"]},"dataEntityMapper":{"type":"string","title":"The override for the data entity `Mapper`.","description":"Used where the default generated `Mapper` is not applicable."},"dataExtensions":{"type":"boolean","title":"Indicates whether the `Data` extensions logic should be generated.","description":"Defaults to `Entity.DataExtensions`."},"dataInvoker":{"type":"boolean","title":"Indicates whether a `DataInvoker` should orchestrate the `Data`-layer.","description":"Where `Dataransaction` or `EventPublish` is `Data` then orchestration will default to `true`."},"dataTransaction":{"type":"boolean","title":"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `Data`-layer.","description":"Where using an `EventOutbox` this is ignored as it is implied through its usage."},"databaseStoredProc":{"type":"string","title":"The database stored procedure name used where `Operation.AutoImplement` is `Database`.","description":"Defaults to `sp` + `Entity.Name` + `Operation.Name`; e.g. `spPersonCreate`."},"entityFrameworkModel":{"type":"string","title":"The corresponding Entity Framework model name (required where `AutoImplement` is `EntityFramework`).","description":"Overrides the `Entity.EntityFrameworkModel`."},"cosmosModel":{"type":"string","title":"The corresponding Cosmos model name (required where `AutoImplement` is `Cosmos`).","description":"Overrides the `Entity.CosmosModel`."},"cosmosContainerId":{"type":"string","title":"The Cosmos `ContainerId` override used where `Operation.AutoImplement` is `Cosmos`.","description":"Overrides the `Entity.CosmosContainerId`."},"cosmosPartitionKey":{"type":"string","title":"The C# code override to be used for setting the optional Cosmos `PartitionKey` used where `Operation.AutoImplement` is `Cosmos`.","description":"Overrides the `Entity.CosmosPartitionKey`."},"odataCollectionName":{"type":"string","title":"The override name of the underlying OData collection where `Operation.AutoImplement` is `OData`.","description":"Overriddes the `Entity.ODataCollectionName`; otherwise, the underlying `Simple.OData.Client` will attempt to infer."},"httpAgentRoute":{"type":"string","title":"The HTTP Agent API route where `Operation.AutoImplement` is `HttpAgent`.","description":"This is appended to the `Entity.HttpAgentRoutePrefix`."},"httpAgentMethod":{"type":"string","title":"The HTTP Agent Method for the operation.","description":"Defaults to `Operation.WebApiMethod`.","enum":["HttpGet","HttpPost","HttpPut","HttpDelete","HttpPatch"]},"httpAgentModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).","description":"This can be overridden within the `Operation`(s)."},"httpAgentReturnModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where `AutoImplement` is `HttpAgent`).","description":"Defaults to `Operation.HttpAgentModel` where the `Operation.ReturnType` is equal to `Entity.Name` (same type). This can be overridden within the `Operation`(s)."},"httpAgentCode":{"type":"string","title":"The fluent-style method-chaining C# HTTP Agent API code to include where `Operation.AutoImplement` is `HttpAgent`.","description":"Appended to `Entity.HttpAgentCode` where specified to extend."},"managerCustom":{"type":"boolean","title":"Indicates whether the `Manager` logic is a custom implementation; i.e. no auto-`DataSvc` invocation logic is to be generated."},"managerTransaction":{"type":"boolean","title":"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `Manager`-layer."},"managerExtensions":{"type":"boolean","title":"Indicates whether the `Manager` extensions logic should be generated.","description":"Defaults to `Entity.ManagerExtensions`."},"validator":{"type":"string","title":"The name of the .NET implementing `Type` or interface `Type` that will perform the validation.","description":"Defaults to the `Entity.Validator` where not specified explicitly (where `Operation.Type` options `Create` or `Update`)."},"validationFramework":{"type":"string","title":"The `Validation` framework to use for the entity-based validation.","description":"Defaults to `Entity.ValidationFramework`. This can be overridden within the `Parameter`(s).","enum":["CoreEx","FluentValidation"]},"managerOperationType":{"type":"string","title":"The `ExecutionContext.OperationType` (CRUD denotation) defined at the `Manager`-layer.","description":"The default will be inferred from the `Operation.Type`; however, where the `Operation.Type` is `Custom` it will default to `Unspecified`.","enum":["Create","Read","Update","Delete","Unspecified"]},"managerCleanUp":{"type":"boolean","title":"Indicates whether a `Cleaner.Cleanup` is performed for the operation parameters within the Manager-layer.","description":"This can be overridden within the `CodeGeneration` and `Entity`."},"dataSvcCustom":{"type":"string","title":"The option that indicates the level of `DataSvc` customization (invokes `*OnImplementationAsync` method) vs code-generation (automatically invokes data-layer).","description":"`Full` indicates the logic is fully customized (only invocation is code-generated). `Partial` indicates combination of surrounding code-generation with final custom invocation versus data-layer. `None` indicates data-layer invocation with _no_ custom invocation (default).","enum":["Full","Partial","None"]},"dataSvcTransaction":{"type":"boolean","title":"Indicates whether a `System.TransactionScope` should be created and orchestrated at the `DataSvc`-layer."},"dataSvcInvoker":{"type":"boolean","title":"Indicates whether a `DataSvcInvoker` should orchestrate the `DataSvc`-layer.","description":"Where `DataSvcTransaction` or `EventPublish` is `DataSvc` then the orchestration will default to `true`."},"dataSvcExtensions":{"type":"boolean","title":"Indicates whether the `DataSvc` extensions logic should be generated.","description":"Defaults to `Entity.ManagerExtensions`."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a `Create`, `Update` or `Delete` operation.","description":"Defaults to the `Entity.EventPublish` configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.","enum":["None","DataSvc","Data"]},"eventValue":{"type":"string","title":"The event value override as C# code (is used as-is).","description":"The event value is automatically inferred where the `Operation.Type` is `Create`, `Update` or `Delete`."},"eventSource":{"type":"string","title":"The Event Source.","description":"Defaults to `Entity.EventSource`. Note: when used in code-generation the `CodeGeneration.EventSourceRoot` will be prepended where specified. To include the entity id/key include a `{$key}` placeholder (`Create`, `Update` or `Delete` operation only); for example: `person/{$key}`. Otherwise, specify the C# string interpolation expression; for example: `person/{r.Id}`."},"eventSubject":{"type":"string","title":"The event subject template and corresponding event action pair (separated by a colon).","description":"The event subject template defaults to `{AppName}.{Entity.Name}`, plus each of the unique key placeholders comma separated; e.g. `Domain.Entity.{id1},{id2}` (depending on whether `Entity.EventSubjectFormat` is `NameAndKey` or `NameOnly`). The event action defaults to `WebApiOperationType` or `Operation.Type` where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. `Demo.Person.{id}:Create;Demo.Other.{id}:Update`."},"webApiRoute":{"type":"string","title":"The Web API `RouteAtttribute` to be appended to the `Entity.WebApiRoutePrefix`.","description":"Where the value is specified with a leading `!` character this indicates that the `Entity.WebApiRoutePrefix` should not be used, and the value should be used as-is (with the `!` removed)."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either `Authorize` or `AllowAnonymous`.","description":"Where not specified no attribute output will occur; it will then inherit as supported by .NET."},"webApiMethod":{"type":"string","title":"The HTTP Method for the operation.","description":"The value defaults as follows: `HttpGet` for `Operation.Type` value `Get` or `GetColl`, `HttpPost` for `Operation.Type` value `Create` or `Custom`, `HttpPut` for `Operation.Type` value `Update`, and `HttpDelete` for `Operation.Type` value `Delete`. An `Operation.Type` value `Patch` can not be specified and will always default to `HttpPatch`.","enum":["HttpGet","HttpPost","HttpPut","HttpDelete"]},"webApiStatus":{"type":"string","title":"The primary HTTP Status Code that will be returned for the operation where there is a non-`null` return value.","description":"The value defaults as follows: `OK` for `Operation.Type` value `Get`, `GetColl`, `Update`, `Delete` or `Custom`, `Created` for `Operation.Type` value `Create`.","enum":["OK","Accepted","Created","NoContent","NotFound"]},"webApiAlternateStatus":{"type":"string","title":"The primary HTTP Status Code that will be returned for the operation where there is a `null` return value.","description":"The value defaults as follows: `NotFound` for `Operation.Type` of `Get`, `Update`, `Patch`; `NoContent` for `Operation.Type` of `GetColl`; otherwise, `none`. A value of `none` indicates that there is _no_ alternate status.","enum":["OK","Accepted","Created","NoContent","NotFound","none"]},"webApiLocation":{"type":"string","title":"The HTTP Response Location Header route.","description":"This uses similar formatting to the `WebApiRoute`. The response value is accessed using `r.` notation to access underlying properties; for example `{r.Id}` or `person/{r.Id}`. The `Entity.WebApiRoutePrefix` will be prepended automatically; however, to disable set the first character to `!`, e.g. `!person/{r.Id}`. The URI can be inferred from another `Operation` by using a lookup `^`; for example `^Get` indicates to infer from the named `Get` operation (where only `^` is specified this is shorthand for `^Get` as this is the most common value). The Location URI will ensure the first character is a `/` so it acts a 'relative URL absolute path'."},"webApiConcurrency":{"type":"boolean","title":"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.","description":"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the `Operation.Type` is `Update` or `Patch`, the request ETag will be matched against the response for a corresponding `Get` operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the `Get` must be the same as that returned from the corresponding `Create`, `Update` and `Patch` (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to `Entity.WebApiConcurrency`."},"webApiGetOperation":{"type":"string","title":"The corresponding `Get` method name (in the `XxxManager`) where the `Operation.Type` is `Update` and `SimulateConcurrency` is `true`.","description":"Defaults to `Get`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`."},"webApiUpdateOperation":{"type":"string","title":"The corresponding `Update` method name (in the `XxxManager`) where the `Operation.Type` is `Patch`.","description":"Defaults to `Update`. Specify either just the method name (e.g. `OperationName`) or, interface and method name (e.g. `IXxxManager.OperationName`) to be invoked where in a different `YyyManager.OperationName`."},"webApiProduces":{"type":"array","title":"The value(s) for the optional `[Produces()]` attribute for the operation within the Web Api Controller for the Swagger/OpenAPI documentation.","items":{"type":"string"}},"webApiProducesResponseType":{"type":"string","title":"The `[ProducesResponseType()]` attribute `typeof` for the operation within the Web Api Controller for the Swagger/OpenAPI documentation.","description":"Defaults to the _Common_ type. A value of `None`, `none` or `` will ensure no type is emitted."},"webApiTags":{"type":"array","title":"The list of tags to add for the generated `WebApi` operation.","description":"Overrides the `Entity.WebApiTags`; unless, if the first tag value is a `^` then this indicates that the `Entity.WebApiTags` are to be included (inherited) as a replacement. Otherwise, defaults to `Entity.WebApiTags`.","items":{"type":"string"}},"authPermission":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsAuthorized(AuthPermission)` to determine whether the user is authorized."},"authEntity":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized. Defaults to `Entity.AuthEntity`. Both the `AuthEntity` and `AuthAction` are required for code-generation."},"authAction":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsAuthorized(AuthEntity, AuthAction)` to determine whether the user is authorized. Both the `AuthEntity` and `AuthAction` are required for code-generation."},"authRole":{"type":"string","title":"The permission used by the `ExecutionContext.UserIsInRole(AuthRole)` to determine whether the user is authorized."},"excludeAll":{"type":"boolean","title":"Indicates whether to exclude the generation of all `Operation` related output.","description":"Is a shorthand means for setting all of the other `Exclude*` properties to `true`."},"excludeIData":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `Data` interface (`IXxxData.cs`) output."},"excludeData":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `Data` class (`XxxData.cs`) output."},"excludeIDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `DataSvc` interface (`IXxxDataSvc.cs`) output."},"excludeDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `DataSvc` class (`XxxDataSvc.cs`) output."},"excludeIManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `Manager` interface (`IXxxManager.cs`) output."},"excludeManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the `Manager` class (`XxxManager.cs`) output."},"excludeWebApi":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the WebAPI `Controller` class (`XxxController.cs`) output."},"excludeWebApiAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the WebAPI consuming `Agent` class (`XxxAgent.cs`) output."},"excludeGrpcAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the gRPC consuming `Agent` class (`XxxAgent.cs`) output."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required for the Operation.","description":"gRPC support is an explicit opt-in model (see `CodeGeneration.Grpc` configuration); therefore, each corresponding `Entity`, `Property` and `Operation` will also need to be opted-in specifically."},"parameters":{"type":"array","title":"The corresponding `Parameter` collection.","items":{"$ref":"#/definitions/Parameter"}}},"required":["name"]},"Parameter":{"type":"object","title":"'Parameter' object (entity-driven)","description":"The `Parameter` object defines an `Operation` parameter and its charateristics.","properties":{"name":{"type":"string","title":"The unique parameter name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the `Text` will be the `Name` reformatted as sentence casing. To have the text used as-is prefix with a `+` plus-sign character."},"type":{"type":"string","title":"The .NET `Type`.","description":"Defaults to `string`. To reference a Reference Data `Type` always prefix with `RefDataNamespace` (e.g. `RefDataNamespace.Gender`) or shortcut `^` (e.g. `^Gender`). This will ensure that the appropriate Reference Data `using` statement is used. _Shortcut:_ Where the `Type` starts with (prefix) `RefDataNamespace.` or `^`, and the correspondong `RefDataType` attribute is not specified it will automatically default the `RefDataType` to `string.`"},"nullable":{"type":"boolean","title":"Indicates whether the .NET Type should be declared as nullable; e.g. `int?`. Will be inferred where the `Type` is denoted as nullable; i.e. suffixed by a `?`. Where the .NET Type is not considered as an intrinsic type then will default to `true`."},"default":{"type":"string","title":"The C# code to default the value.","description":"Where the `Type` is `string` then the specified default value will need to be delimited. Any valid value assignment C# code can be used."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the `Name` to be used for private fields. By default reformatted from `Name`; e.g. `FirstName` as `_firstName`."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the `Name` to be used for argument parameters. By default reformatted from `Name`; e.g. `FirstName` as `firstName`."},"property":{"type":"string","title":"The `Property.Name` within the parent `Entity` to copy (set) the configuration/characteristics from where not already defined."},"refDataType":{"type":"string","title":"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).","description":"Defaults to `string` where not specified and the corresponding `Type` starts with (prefix) `RefDataNamespace.`.","enum":["string","int","Guid"]},"refDataList":{"type":"boolean","title":"Indicates that the Reference Data property is to be a serializable list (`ReferenceDataSidList`).","description":"This is required to enable a list of Reference Data values (as per `RefDataType`) to be passed as an argument for example."},"validator":{"type":"string","title":"The name of the .NET `Type` that will perform the validation."},"validatorCode":{"type":"string","title":"The fluent-style method-chaining C# validator code to append to `IsMandatory` and `Validator` (where specified)."},"validationFramework":{"type":"string","title":"The `Validation` framework to use for the entity-based validation.","description":"Defaults to `Operation.ValidationFramework`.","enum":["CoreEx","FluentValidation"]},"isMandatory":{"type":"boolean","title":"Indicates whether a `ValidationException` should be thrown when the parameter value has its default value (null, zero, etc)."},"layerPassing":{"type":"string","title":"The option that determines the layers in which the parameter is passed.","description":"Defaults to `All`. To further describe, `All` passes the parameter through all layeys, `ToManagerSet` only passes the parameter to the `Manager` layer and overrides the same named property within the corresponding `value` parameter, `ToManagerCollSet` only passes the parameter to the `Manager` layer and overrides the same named property within the corresponding `value` collection parameter. Where using the `PrimaryKey` option to automatically set `Parameters`, and the `Operation.Type` is `Create` or `Update` it will default to `ToManagerSet`.","enum":["All","ToManagerSet","ToManagerCollSet"]},"dataConverter":{"type":"string","title":"The data `Converter` class name where specific data conversion is required.","description":"A `Converter` is used to convert a data source value to/from a .NET `Type` where no standard data conversion can be applied. Where this value is suffixed by `<T>` or `{T}` this will automatically set `Type`."},"webApiFrom":{"type":"string","title":"The option for how the parameter will be delcared within the Web API Controller.","description":"Defaults to `FromQuery`; unless the parameter `Type` has also been defined as an `Entity` within the code-gen config file then it will default to `FromEntityProperties`. Specifies that the parameter will be declared with corresponding `FromQueryAttribute`, `FromBodyAttribute` or `FromRouteAttribute` for the Web API method. The `FromEntityProperties` will declare all properties of the `Entity` as query parameters.An `AcceptsBody` indicates that the _value_ will be passed in the HTTP Request Body and be handled (JSON deserialized) as a `CoreEx.AspNetCore.WebApis.WebWebApiParam` (default behavior for a `Create` or `Update` operation type).","enum":["FromQuery","FromBody","FromRoute","FromEntityProperties","AcceptsBody"]},"webApiText":{"type":"string","title":"The overriding text for use in the Web API comments.","description":"By default the `WbeApiText` will be the `Name` reformatted as sentence casing. To have the text used as-is prefix with a `+` plus-sign character."},"grpcType":{"type":"string","title":"The underlying gRPC data type; will be inferred where not specified."}},"required":["name"]},"Const":{"type":"object","title":"'Const' object (entity-driven)","description":"The `Const` object is used to define a .NET (C#) constant value for an `Entity`.","properties":{"name":{"type":"string","title":"The unique constant name."},"value":{"type":"string","title":"The .NET (C#) code for the constant value.","description":"The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the `Text` will be the `Name` reformatted as sentence casing. It will be formatted as: `Represents a {text} constant value.` To create a `<see cref=\"XXX\"/>` within use moustache shorthand (e.g. `{{Xxx}}`). To have the text used as-is prefix with a `+` plus-sign character."}},"required":["name","value"]}},"allOf":[{"$ref":"#/definitions/CodeGeneration"}]}
|
Provide a JSON object that satisfies the schema "JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).
|
schema-store
|
schema_store_299
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).\",\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"definitions\":{\"CodeGeneration\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (entity-driven)\",\"description\":\"The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.\",\"properties\":{\"refDataNamespace\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data entities (adds as a c# 'using' statement).\",\"description\":\"Defaults to 'Company' + '.' (literal) + AppName + '.' (literal) + 'EntityUsing' + '.Entities' (literal).\"},\"refDataCommonNamespace\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data common entities (adds as a c# 'using' statement).\",\"description\":\"Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal).\"},\"refDataText\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' for an 'Entity'.\",\"description\":\"This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').\"},\"refDataWebApiRoute\":{\"type\":\"string\",\"title\":\"The 'RouteAtttribute' for the Reference Data Web API controller required for named pre-fetching. The 'WebApiRoutePrefix' will be prepended where specified.\"},\"refDataCache\":{\"type\":\"string\",\"title\":\"The cache used for the ReferenceData providers.\",\"description\":\"Defaults to 'ReferenceDataCache'. A value of 'ReferenceDataCache' specifies a single-tenant cache; otherwise, 'ReferenceDataMultiTenantCache' for a multi-tenant cache leverageing the 'ExecutionContext.TenantId'.\",\"enum\":[\"ReferenceDataCache\",\"ReferenceDataMultiTenantCache\"]},\"refDataAppendToNamespace\":{\"type\":\"string\",\"title\":\"The Reference Data entity namespace appended to end of the standard 'company.appname.Common.Entities.{AppendToNamespace}'.\",\"description\":\"Defaults to 'null'; being nothing to append.\"},\"refDataBusNamespace\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data entities (adds as a c# 'using' statement) for additional business-layer inclusion where requried.\"},\"entityScope\":{\"type\":\"string\",\"title\":\"The entity scope option.\",\"description\":\"Defaults to 'Common' for backwards compatibility; 'Autonomous' is **recommended**. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is the special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).\",\"enum\":[\"Common\",\"Business\",\"Autonomous\"]},\"entityUsing\":{\"type\":\"string\",\"title\":\"The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).\",\"description\":\"Defaults to 'Common' (unless 'EntityScope' is 'Autonomous' and then it will default to 'Business') which will add '.Common.Entities'. Additionally, 'Business' to add '.Business.Entities', 'All' to add both, and 'None' to exclude any. This can be overridden for each 'Entity'.\",\"enum\":[\"Common\",\"Business\",\"All\",\"None\"]},\"jsonSerializer\":{\"type\":\"string\",\"title\":\"The JSON Serializer to use for JSON property attribution.\",\"description\":\"Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).\",\"enum\":[\"None\",\"Newtonsoft\"]},\"etagJsonName\":{\"type\":\"string\",\"title\":\"The default JSON name for the 'ETag' property.\",\"description\":\"Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required.\",\"enum\":[\"etag\",\"eTag\",\"_etag\",\"_eTag\",\"ETag\",\"ETAG\"]},\"usingNamespace1\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Entity' code.\",\"description\":\"Typically used where referening a 'Type' from a Namespace that is not generated by default.\"},\"usingNamespace2\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Entity' code.\",\"description\":\"Typically used where referening a 'Type' from a Namespace that is not generated by default.\"},\"usingNamespace3\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Entity' code.\",\"description\":\"Typically used where referening a 'Type' from a Namespace that is not generated by default.\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.\",\"description\":\"This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s).\"},\"appBasedAgentArgs\":{\"type\":\"boolean\",\"title\":\"Indicates whether to create and use a domain-specific 'WebApi.WebApiAgentArgs' to simplify dependency injection usage.\"},\"webApiAutoLocation\":{\"type\":\"boolean\",\"title\":\"Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.\",\"description\":\"This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This can be overridden within the 'Entity'(s).\"},\"webApiRoutePrefix\":{\"type\":\"string\",\"title\":\"The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.\",\"description\":\"This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s).\"},\"validatorLayer\":{\"type\":\"string\",\"title\":\"The namespace for the Reference Data entities (adds as a c# 'using' statement).\",\"description\":\"Defaults to 'Business'. A value of 'Business' indicates that the Validators will be defined within the 'Business' namespace/assembly; otherwise, defined within the 'Common' namespace/assembly.\",\"enum\":[\"Business\",\"Common\"]},\"databaseName\":{\"type\":\"string\",\"title\":\"The .NET database interface name (used where 'Operation.AutoImplement' is 'Database').\",\"description\":\"Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s).\"},\"databaseSchema\":{\"type\":\"string\",\"title\":\"The default database schema name.\",\"description\":\"Defaults to 'dbo'.\"},\"entityFrameworkName\":{\"type\":\"string\",\"title\":\"The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'EntityFramework'.\",\"description\":\"Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s).\"},\"cosmosName\":{\"type\":\"string\",\"title\":\"The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'Cosmos'.\",\"description\":\"Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s).\"},\"odataName\":{\"type\":\"string\",\"title\":\"The .NET OData interface name used where 'Operation.AutoImplement' is 'OData'.\",\"description\":\"Defaults to 'IOData'. This can be overridden within the 'Entity'(s).\"},\"httpAgentName\":{\"type\":\"string\",\"title\":\"The default .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.\",\"description\":\"Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s).\"},\"refDataDefaultMapperConverter\":{\"type\":\"string\",\"title\":\"The default Reference Data property 'Converter' used by the generated 'Mapper'(s) where not specifically defined.\",\"description\":\"Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Property.DataConverterIsGeneric' to 'true'.\",\"enum\":[\"ReferenceDataCodeConverter\",\"ReferenceDataCodeConverter{T}\",\"ReferenceDataCodeConverter<T>\",\"ReferenceDataInt32IdConverter\",\"ReferenceDataInt32IdConverter{T}\",\"ReferenceDataInt32IdConverter<T>\",\"ReferenceDataNullableInt32IdConverter\",\"ReferenceDataNullableInt32IdConverter{T}\",\"ReferenceDataNullableInt32IdConverter<T>\",\"ReferenceDataInt64IdConverter\",\"ReferenceDataInt64IdConverter{T}\",\"ReferenceDataInt64IdConverter<T>\",\"ReferenceDataNullableInt64IdConverter\",\"ReferenceDataNullableInt64IdConverter{T}\",\"ReferenceDataNullableInt64IdConverter<T>\",\"ReferenceDataGuidIdConverter\",\"ReferenceDataGuidIdConverter{T}\",\"ReferenceDataGuidIdConverter<T>\",\"ReferenceDataNullableGuidIdConverter\",\"ReferenceDataNullableGuidIdConverter{T}\",\"ReferenceDataNullableGuidIdConverter<T>\"]},\"dataUsingNamespace\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Data' code.\"},\"databaseUsingNamespace\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Database'.\"},\"entityFrameworkUsingNamespace\":{\"type\":\"string\",\"title\":\"The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'EntityFramework'.\"},\"cosmosUsingNamespace\":{\"type\":\"string\",\"title\":\"additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Cosmos'.\"},\"odataUsingNamespace\":{\"type\":\"string\",\"title\":\"additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'OData'.\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.\",\"description\":\"Defaults to 'DataSvc'; unless the 'EventOutbox' is not 'None' where it will default to 'Data'. Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventOutbox\":{\"type\":\"string\",\"title\":\"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).\",\"description\":\"Defaults to 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.\",\"enum\":[\"None\",\"Database\"]},\"eventSourceRoot\":{\"type\":\"string\",\"title\":\"The URI root for the event source by prepending to all event source URIs.\",\"description\":\"The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s).\"},\"eventSourceKind\":{\"type\":\"string\",\"title\":\"The URI kind for the event source URIs.\",\"description\":\"Defaults to 'None' (being the event source is not updated).\",\"enum\":[\"None\",\"Absolute\",\"Relative\",\"RelativeOrAbsolute\"]},\"eventSubjectRoot\":{\"type\":\"string\",\"title\":\"The root for the event Subject name by prepending to all event subject names.\",\"description\":\"Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).\"},\"eventSubjectFormat\":{\"type\":\"string\",\"title\":\"The default formatting for the Subject when an Event is published.\",\"description\":\"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.\",\"enum\":[\"NameOnly\",\"NameAndKey\"]},\"eventSubjectSeparator\":{\"type\":\"string\",\"title\":\"The subject path separator.\",\"description\":\"Defaults to '.'. Used only where the subject is automatically inferred.\"},\"eventActionFormat\":{\"type\":\"string\",\"title\":\"The formatting for the Action when an Event is published.\",\"description\":\"Defaults to 'None' (no formatting required, i.e. as-is)'.\",\"enum\":[\"None\",\"PastTense\"]},\"eventCasing\":{\"type\":\"string\",\"title\":\"The casing for the Subject and Action (with the exception of the key)\",\"description\":\"Defaults to 'None' (no casing required, i.e. as-is)'.\",\"enum\":[\"None\",\"Lower\",\"Upper\"]},\"eventTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.\",\"description\":\"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'false'. This essentially defaults the 'Entity.EventTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required.\",\"description\":\"gRPC support is an explicit opt-in model. Must be set to 'true' for any of the subordinate gRPC capabilities to be code-generated. Will require each 'Entity', and corresponding 'Property' and 'Operation' to be opted-in specifically.\"},\"pathBase\":{\"type\":\"string\",\"title\":\"The base path (directory) prefix for the artefacts; other 'Path*' properties append to this value when they are not specifically overridden.\",\"description\":\"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.\"},\"pathCommon\":{\"type\":\"string\",\"title\":\"The path (directory) for the Database-related artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'.\"},\"pathBusiness\":{\"type\":\"string\",\"title\":\"The path (directory) for the Business-related (.NET) artefacts.\",\"description\":\"Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.\"},\"pathApi\":{\"type\":\"string\",\"title\":\"The path (directory) for the API-related (.NET) artefacts.\",\"description\":\"Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.\"},\"namespaceBase\":{\"type\":\"string\",\"title\":\"The base Namespace (root) for the .NET artefacts.\",\"description\":\"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.\"},\"namespaceCommon\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Common-related .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.\"},\"namespaceBusiness\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Business-related .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.\"},\"namespaceApi\":{\"type\":\"string\",\"title\":\"The Namespace (root) for the Api-related .NET artefacts.\",\"description\":\"Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.\"},\"entities\":{\"type\":\"array\",\"title\":\"The corresponding 'Entity' collection.\",\"items\":{\"$ref\":\"#/definitions/Entity\"}}}},\"Entity\":{\"type\":\"object\",\"title\":\"'Entity' object (entity-driven)\",\"description\":\"The 'Entity' is used as the primary configuration for driving the entity-driven code generation.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique entity name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"Overrides the Name (as sentence text) for the summary comments. It will be formatted as: 'Represents the {Text} entity.'. To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. {{Xxx}}).\"},\"fileName\":{\"type\":\"string\",\"title\":\"The overriding file name.\",\"description\":\"Overrides the Name as the code-generated file name.\"},\"entityScope\":{\"type\":\"string\",\"title\":\"The entity scope option.\",\"description\":\"Defaults to the 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is a special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).\",\"enum\":[\"Common\",\"Business\",\"Autonomous\"]},\"entityUsing\":{\"type\":\"string\",\"title\":\"The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).\",\"description\":\"Defaults to 'EntityScope' ('Autonomous' will result in 'Business'). A value of 'Common' will add '.Common.Entities', 'Business' will add '.Business.Entities', 'All' to add both, and 'None' to exclude any.\",\"enum\":[\"Common\",\"Business\",\"All\",\"None\"]},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.\"},\"constType\":{\"type\":\"string\",\"title\":\"The Const .NET Type option.\",\"description\":\"The .NET Type to be used for the 'const' values. Defaults to 'string'.\",\"enum\":[\"int\",\"long\",\"Guid\",\"string\"]},\"isInitialOverride\":{\"type\":\"boolean\",\"title\":\"Indicates whether to override the 'ICleanup.IsInitial' property.\",\"description\":\"Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The Reference Data identifier Type option.\",\"description\":\"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.\",\"enum\":[\"int\",\"long\",\"Guid\",\"string\"]},\"refDataText\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' overriding the 'CodeGeneration.RefDataText' selection.\",\"description\":\"This is used where serializing within the Web API'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').\"},\"refDataSortOrder\":{\"type\":\"string\",\"title\":\"The Reference Data sort order option.\",\"description\":\"Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.\",\"enum\":[\"SortOrder\",\"Id\",\"Code\",\"Text\"]},\"refDataStringFormat\":{\"type\":\"string\",\"title\":\"The Reference Data 'ToString' composite format.\",\"description\":\"The string format supports the standard composite formatting; where the following indexes are used: '{0}' for 'Id', '{1}' for 'Code' and '{2}' for 'Text'. Defaults to '{2}'.\"},\"inherits\":{\"type\":\"string\",\"title\":\"The base class that the entity inherits from.\",\"description\":\"Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseXxx' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes.\"},\"implements\":{\"type\":\"string\",\"title\":\"The list of comma separated interfaces that are to be declared for the entity class.\"},\"implementsAutoInfer\":{\"type\":\"boolean\",\"title\":\"Indicates whether to automatically infer the interface implements for the entity from the properties declared.\",\"description\":\"Will attempt to infer the following: 'IGuidIdentifier', 'IInt32Identifier', 'IInt64Identifier', 'IStringIdentifier', 'IETag' and 'IChangeLog'. Defaults to 'true'.\"},\"abstract\":{\"type\":\"boolean\",\"title\":\"Indicates whether the class should be defined as abstract.\"},\"genericWithT\":{\"type\":\"boolean\",\"title\":\"Indicates whether the class should be defined as a generic with a single parameter 'T'.\"},\"namespace\":{\"type\":\"string\",\"title\":\"The entity namespace to be appended.\",\"description\":\"Appended to the end of the standard structure as follows: '{Company}.{AppName}.Common.Entities.{Namespace}'.\"},\"omitEntityBase\":{\"type\":\"boolean\",\"title\":\"Indicates that the entity should not inherit from 'EntityBase'.\",\"description\":\"As such any of the 'EntityBase' related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities.\"},\"jsonSerializer\":{\"type\":\"string\",\"title\":\"The JSON Serializer to use for JSON property attribution.\",\"description\":\"Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'Newtonsoft'.\",\"enum\":[\"None\",\"Newtonsoft\"]},\"collection\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding entity collection class should be created.\"},\"collectionResult\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding entity collection result class should be created\",\"description\":\"Enables the likes of additional paging state to be stored with the underlying collection.\"},\"collectionKeyed\":{\"type\":\"boolean\",\"title\":\"Indicates whether the entity collection is keyed using the properties defined as forming part of the unique key.\"},\"collectionInherits\":{\"type\":\"string\",\"title\":\"The base class that a 'Collection' inherits from.\",\"description\":\"Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'.\"},\"collectionResultInherits\":{\"type\":\"string\",\"title\":\"The base class that a 'CollectionResult' inherits from.\",\"description\":\"Defaults to 'EntityCollectionResult'.\"},\"get\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'Get' operation will be automatically generated where not otherwise explicitly specified.\"},\"getAll\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'GetAll' operation will be automatically generated where not otherwise explicitly specified.\"},\"create\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'Create' operation will be automatically generated where not otherwise explicitly specified.\"},\"update\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'Update' operation will be automatically generated where not otherwise explicitly specified.\"},\"patch\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'Patch' operation will be automatically generated where not otherwise explicitly specified.\"},\"delete\":{\"type\":\"boolean\",\"title\":\"Indicates that a 'Delete' operation will be automatically generated where not otherwise explicitly specified.\"},\"autoImplement\":{\"type\":\"string\",\"title\":\"The data source auto-implementation option.\",\"description\":\"Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented.\",\"enum\":[\"Database\",\"EntityFramework\",\"Cosmos\",\"OData\",\"HttpAgent\",\"None\"]},\"dataCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated 'Data' constructor.\",\"description\":\"Defaults to 'Public'.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"dataCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Data' constructor.\",\"description\":\"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"dataExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'Data' extensions logic should be generated.\",\"description\":\"This can be overridden using 'Operation.DataExtensions'.\"},\"databaseName\":{\"type\":\"string\",\"title\":\"The .NET database interface name (used where 'AutoImplement' is 'Database').\",\"description\":\"Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase').\"},\"databaseSchema\":{\"type\":\"string\",\"title\":\"The database schema name (used where 'AutoImplement' is 'Database').\",\"description\":\"Defaults to 'dbo'.\"},\"databaseMapperInheritsFrom\":{\"type\":\"string\",\"title\":\"The name of the 'Mapper' that the generated Database 'Mapper' inherits from.\"},\"databaseCustomerMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Database 'Mapper' will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a 'Mapper' will be generated.\"},\"entityFrameworkName\":{\"type\":\"string\",\"title\":\"The .NET Entity Framework interface name used where 'AutoImplement' is 'EntityFramework'.\",\"description\":\"Defaults to the 'CodeGeneration.EntityFrameworkName' configuration property (its default value is 'IEfDb').\"},\"entityFrameworkModel\":{\"type\":\"string\",\"title\":\"The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework').\"},\"entityFrameworkMapperInheritsFrom\":{\"type\":\"string\",\"title\":\"The name of the 'Mapper that the generated Entity Framework 'Mapper' inherits from.\",\"description\":\"Defaults to 'Model.{Name}'; i.e. an entity with the same name in the 'Model' namespace.\"},\"entityFrameworkCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Entity Framework 'Mapper' will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a 'Mapper' will be generated.\"},\"cosmosName\":{\"type\":\"string\",\"title\":\"The .NET Cosmos interface name used where 'AutoImplement' is 'Cosmos'.\",\"description\":\"Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb').\"},\"cosmosModel\":{\"type\":\"string\",\"title\":\"The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos').\"},\"cosmosContainerId\":{\"type\":\"string\",\"title\":\"The Cosmos 'ContainerId' required where 'AutoImplement' is 'Cosmos'.\"},\"cosmosPartitionKey\":{\"type\":\"string\",\"title\":\"The C# code to be used for setting the optional Cosmos 'PartitionKey' where 'AutoImplement' is 'Cosmos'.\",\"description\":\"Defaults to 'PartitionKey.None'.\"},\"cosmosValueContainer\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'CosmosDbValueContainer' is to be used; otherwise, 'CosmosDbContainer'.\"},\"cosmosMapperInheritsFrom\":{\"type\":\"string\",\"title\":\"The name of the 'Mapper' that the generated Cosmos 'Mapper' inherits from.\"},\"cosmosCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom Cosmos 'Mapper' will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a 'Mapper' will be generated.\"},\"odataName\":{\"type\":\"string\",\"title\":\"The .NET OData interface name used where 'AutoImplement' is 'OData'.\",\"description\":\"Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData').\"},\"odataModel\":{\"type\":\"string\",\"title\":\"The corresponding OData model name (required where 'AutoImplement' is 'OData').\"},\"odataCollectionName\":{\"type\":\"string\",\"title\":\"The name of the underlying OData collection where 'AutoImplement' is 'OData'.\",\"description\":\"The underlying 'Simple.OData.Client' will attempt to infer.\"},\"odataMapperInheritsFrom\":{\"type\":\"string\",\"title\":\"The name of the 'Mapper' that the generated OData 'Mapper' inherits from.\"},\"odataCustomMapper\":{\"type\":\"boolean\",\"title\":\"Indicates that a custom OData 'Mapper' will be used; i.e. not generated.\",\"description\":\"Otherwise, by default, a 'Mapper' will be generated.\"},\"httpAgentName\":{\"type\":\"string\",\"title\":\"The .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.\",\"description\":\"Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent').\"},\"httpAgentRoutePrefix\":{\"type\":\"string\",\"title\":\"The base HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.\",\"description\":\"This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s).\"},\"httpAgentModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').\",\"description\":\"This can be overridden within the 'Operation'(s).\"},\"httpAgentReturnModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').\",\"description\":\"This can be overridden within the 'Operation'(s).\"},\"dataSvcCaching\":{\"type\":\"boolean\",\"title\":\"Indicates whether request-based 'IRequestCache' caching is to be performed at the 'DataSvc' layer to improve performance (i.e. reduce chattiness).\",\"description\":\"Defaults to 'true'.\"},\"dataSvcCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated 'DataSvc' constructor.\",\"description\":\"Defaults to 'Public'.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"dataSvcCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'DataSvc' constructor.\",\"description\":\"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"dataSvcExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'DataSvc' extensions logic should be generated.\",\"description\":\"This can be overridden using 'Operation.DataSvcExtensions'.\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.\",\"description\":\"Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventOutbox\":{\"type\":\"string\",\"title\":\"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).\",\"description\":\"Defaults to 'CodeGeneration.EventOutbox' configuration property (inherits) where not specified. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.\",\"enum\":[\"None\",\"Database\"]},\"eventSource\":{\"type\":\"string\",\"title\":\"The Event Source.\",\"description\":\"Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'.\"},\"eventSubjectFormat\":{\"type\":\"string\",\"title\":\"The default formatting for the Subject when an Event is published.\",\"description\":\"Defaults to 'CodeGeneration.EventSubjectFormat'.\",\"enum\":[\"NameOnly\",\"NameAndKey\"]},\"eventCasing\":{\"type\":\"string\",\"title\":\"The casing for the Subject and Action (with the exception of the key)\",\"description\":\"Defaults to 'CodeGeneration.EventCasing'.\",\"enum\":[\"None\",\"Lower\",\"Upper\"]},\"eventTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.\",\"description\":\"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used.\"},\"managerCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated 'Manager' constructor.\",\"description\":\"Defaults to 'Public'.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"managerCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Manager' constructor.\",\"description\":\"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"managerExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'Manager' extensions logic should be generated.\",\"description\":\"This can be overridden using 'Operation.ManagerExtensions'.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET 'Type' that will perform the validation.\",\"description\":\"Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly.\"},\"iValidator\":{\"type\":\"string\",\"title\":\"The name of the .NET Interface that the 'Validator' implements/inherits.\",\"description\":\"Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly.\"},\"webApiRoutePrefix\":{\"type\":\"string\",\"title\":\"The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.\",\"description\":\"This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified.\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.\",\"description\":\"Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also.\"},\"webApiCtor\":{\"type\":\"string\",\"title\":\"The access modifier for the generated Web API 'Controller' constructor.\",\"description\":\"Defaults to 'Public'.\",\"enum\":[\"Public\",\"Private\",\"Protected\"]},\"webApiCtorParams\":{\"type\":\"array\",\"title\":\"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'WebApi' constructor.\",\"description\":\"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.\",\"items\":{\"type\":\"string\"}},\"webApiAutoLocation\":{\"type\":\"boolean\",\"title\":\"Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.\",\"description\":\"This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'.\"},\"webApiConcurrency\":{\"type\":\"boolean\",\"title\":\"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.\",\"description\":\"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'.\"},\"webApiGetOperation\":{\"type\":\"string\",\"title\":\"The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.\",\"description\":\"Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.\"},\"dataModel\":{\"type\":\"boolean\",\"title\":\"Indicates whether a data 'model' version of the entity should also be generated (output to '.\\\\Business\\\\Data\\\\Model').\",\"description\":\"The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'.\"},\"excludeEntity\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'Entity' class ('Xxx.cs').\"},\"excludeAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of all 'Operation' related artefacts; excluding the 'Entity' class.\",\"description\":\"Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude.\"},\"excludeIData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'Data' interface ('IXxxData.cs').\"},\"excludeData\":{\"type\":\"string\",\"title\":\"The option to exclude the generation of the 'Data' class ('XxxData.cs').\",\"description\":\"Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.\",\"enum\":[\"Include\",\"Exclude\",\"RequiresMapper\"]},\"excludeIDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'DataSvc' interface ('IXxxDataSvc.cs').\"},\"excludeDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'DataSvc' class ('XxxDataSvc.cs').\"},\"excludeIManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'Manager' interface ('IXxxManager.cs').\"},\"excludeManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the 'Manager' class ('XxxManager.cs').\"},\"excludeWebApi\":{\"type\":\"boolean\",\"title\":\"The option to exclude the generation of the WebAPI 'Controller' class ('XxxController.cs').\"},\"excludeWebApiAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the WebAPI consuming 'Agent' class ('XxxAgent.cs').\"},\"excludeGrpcAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the gRPC consuming 'Agent' class ('XxxAgent.cs').\"},\"authRole\":{\"type\":\"string\",\"title\":\"The role (permission) used by the 'ExecutionContext.IsInRole(role)' for each 'Operation'.\",\"description\":\"Used where not overridden specifically for an 'Operation'; i.e. acts as the default.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required for the Entity.\",\"description\":\"gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically.\"},\"properties\":{\"type\":\"array\",\"title\":\"The corresponding 'Property' collection.\",\"items\":{\"$ref\":\"#/definitions/Property\"}},\"operations\":{\"type\":\"array\",\"title\":\"The corresponding 'Operation' collection.\",\"items\":{\"$ref\":\"#/definitions/Operation\"}},\"consts\":{\"type\":\"array\",\"title\":\"The corresponding 'Consts' collection.\",\"items\":{\"$ref\":\"#/definitions/Const\"}}},\"required\":[\"name\"]},\"Property\":{\"type\":\"object\",\"title\":\"'Property' object (entity-driven)\",\"description\":\"The 'Property' object defines an 'Entity' property and its charateristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique property name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. {{Xxx}}).\"},\"modelText\":{\"type\":\"string\",\"title\":\"The overriding model text for use in comments.\",\"description\":\"By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. {{Xxx}}).\"},\"type\":{\"type\":\"string\",\"title\":\"The .NET 'Type'.\",\"description\":\"Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.\"},\"inherited\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is inherited and therefore should not be output within the generated Entity class.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.\"},\"uniqueKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is considered part of the unique (primary) key.\",\"description\":\"This is also used to simplify the parameter specification for an Entity Operation by inferrence.\"},\"isEntity\":{\"type\":\"boolean\",\"title\":\"Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').\",\"description\":\"Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file.\"},\"immutable\":{\"type\":\"boolean\",\"title\":\"Indicates that the value is immutable and therefore cannot be changed once set.\"},\"dateTimeTransform\":{\"type\":\"string\",\"title\":\"The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.\",\"description\":\"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.\",\"enum\":[\"UseDefault\",\"None\",\"DateOnly\",\"DateTimeLocal\",\"DateTimeUtc\",\"DateTimeUnspecified\"]},\"stringTrim\":{\"type\":\"string\",\"title\":\"The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.\",\"description\":\"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.\",\"enum\":[\"UseDefault\",\"None\",\"Start\",\"End\",\"Both\"]},\"stringTransform\":{\"type\":\"string\",\"title\":\"The 'string' transformation to be performed on 'Set' and 'CleanUp'.\",\"description\":\"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.\",\"enum\":[\"UseDefault\",\"None\",\"NullToEmpty\",\"EmptyToNull\"]},\"autoCreate\":{\"type\":\"boolean\",\"title\":\"Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation).\"},\"default\":{\"type\":\"string\",\"title\":\"The C# code to default the value.\",\"description\":\"Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.\"},\"partitionKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is considered part of the Partition Key.\",\"description\":\"This will implement 'IPartitionKey' for the generated entity.\"},\"secondaryPropertyChanged\":{\"type\":\"string\",\"title\":\"The names of the secondary property(s), comma delimited, that are to be notified on a property change.\"},\"bubblePropertyChanges\":{\"type\":\"boolean\",\"title\":\"Indicates whether the value should bubble up property changes versus only recording within the sub-entity itself.\",\"description\":\"Note that the 'IsEntity' property is also required to enable.\"},\"excludeCleanup\":{\"type\":\"boolean\",\"title\":\"Indicates that 'CleanUp' is not to be performed for the property within the 'Entity.CleanUp' method.\"},\"internalOnly\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is for internal use only; declared in Business entities only.\",\"description\":\"This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).\",\"description\":\"Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.\",\"enum\":[\"string\",\"int\",\"Guid\"]},\"refDataList\":{\"type\":\"boolean\",\"title\":\"Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').\",\"description\":\"This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.\"},\"refDataText\":{\"type\":\"boolean\",\"title\":\"Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.\",\"description\":\"This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').\"},\"refDataMapping\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should use the underlying Reference Data mapping capabilities.\",\"description\":\"Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable.\"},\"jsonName\":{\"type\":\"string\",\"title\":\"The JSON property name.\",\"description\":\"Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'.\"},\"jsonDataModelName\":{\"type\":\"string\",\"title\":\"The JSON property name for the corresponding data model (see 'Entity.DataModel').\",\"description\":\"Defaults to 'JsonName' where not specified.\"},\"serializationIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property is not to be serialized.\",\"description\":\"All properties are serialized by default.\"},\"serializationEmitDefault\":{\"type\":\"boolean\",\"title\":\"Indicates whether to emit the default value when serializing.\"},\"dataModelJsonName\":{\"type\":\"string\",\"title\":\"The override JSON property name where outputting as a data model.\",\"description\":\"Defaults to 'JsonName' where not specified.\"},\"identifierGenerator\":{\"type\":\"string\",\"title\":\"The Identifier Generator Type to generate the identifier on create via Dependency Injection.\",\"description\":\"Should be formatted as 'Type' + '^' + 'Name'; e.g. 'IGuidIdentifierGenerator^GuidIdGen'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored. See 'Beef.Entities.IInt32IdentifierGenerator', 'Beef.Entities.IInt64IdentifierGenerator', 'Beef.Entities.IGuidIdentifierGenerator' or 'Beef.Entities.IStringIdentifierGenerator' for underlying implementation requirements.\"},\"dataName\":{\"type\":\"string\",\"title\":\"The data name where Entity.AutoImplement is selected.\",\"description\":\"Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options.\"},\"dataConverter\":{\"type\":\"string\",\"title\":\"The data 'Converter' class name where 'Entity.AutoImplement' is selected.\",\"description\":\"A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'DataConverterIsGeneric' to 'true'.\"},\"dataConverterIsGeneric\":{\"type\":\"boolean\",\"title\":\"Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'.\"},\"dataMapperIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.\",\"description\":\"All properties are included by default.\"},\"dataAutoGenerated\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'UniqueKey' property value is automatically generated by the data source on 'Create'.\"},\"dataOperationTypes\":{\"type\":\"string\",\"title\":\"The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.\",\"description\":\"Defaults to 'Any'.\",\"enum\":[\"Any\",\"AnyExceptCreate\",\"AnyExceptUpdate\",\"AnyExceptGet\",\"Get\",\"Create\",\"Update\",\"Delete\"]},\"databaseMapper\":{\"type\":\"string\",\"title\":\"The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.\",\"description\":\"A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties).\"},\"databaseIgnore\":{\"type\":\"boolean\",\"title\":\"Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output.\"},\"databaseDbType\":{\"type\":\"string\",\"title\":\"The database 'DbType' override (versus inferring from the corresponding .NET Type).\",\"description\":\"Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'.\"},\"entityFrameworkMapper\":{\"type\":\"string\",\"title\":\"The Entity Framework 'Mapper' approach for the property.\",\"description\":\"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.\",\"enum\":[\"Map\",\"Ignore\",\"Skip\"]},\"cosmosMapper\":{\"type\":\"string\",\"title\":\"The Cosmos 'Mapper' approach for the property.\",\"description\":\"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.\",\"enum\":[\"Map\",\"Ignore\",\"Skip\"]},\"odataMapper\":{\"type\":\"string\",\"title\":\"The OData 'Mapper' approach for the property.\",\"description\":\"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.\",\"enum\":[\"Map\",\"Ignore\",\"Skip\"]},\"httpAgentMapper\":{\"type\":\"string\",\"title\":\"The HttpAgent 'Mapper' approach for the property.\",\"description\":\"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.\",\"enum\":[\"Map\",\"Ignore\",\"Skip\"]},\"displayName\":{\"type\":\"string\",\"title\":\"The display name used in the likes of error messages for the property.\",\"description\":\"Defaults to the 'Name' as sentence case.\"},\"annotation1\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"annotation2\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"annotation3\":{\"type\":\"string\",\"title\":\"The property annotation (e.g. attribute) declaration code.\"},\"webApiQueryStringConverter\":{\"type\":\"string\",\"title\":\"The 'IPropertyMapperConverter' to perform 'Type' to 'string' conversion for writing to and parsing from the query string.\"},\"grpcFieldNo\":{\"type\":\"integer\",\"title\":\"The unique (immutable) field number required to enable gRPC support.\"},\"grpcType\":{\"type\":\"string\",\"title\":\"The underlying gRPC data type; will be inferred where not specified.\"}},\"required\":[\"name\"]},\"Operation\":{\"type\":\"object\",\"title\":\"'CodeGeneration' object (entity-driven)\",\"description\":\"The code generation for an 'Operation' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique operation name.\"},\"type\":{\"type\":\"string\",\"title\":\"The type of operation that is to be code-generated.\",\"enum\":[\"Get\",\"GetColl\",\"Create\",\"Update\",\"Patch\",\"Delete\",\"Custom\"]},\"text\":{\"type\":\"string\",\"title\":\"The text for use in comments.\",\"description\":\"The 'Text' will be defaulted for all the 'Operation.Type' options with the exception of 'Custom'. To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. {{Xxx}}).\"},\"uniqueKey\":{\"type\":\"boolean\",\"title\":\"Indicates whether the properties marked as a unique key ('Property.UniqueKey') are to be used as the parameters.\",\"description\":\"This simplifies the specification of these properties versus having to declare each specifically.\"},\"paging\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'PagingArgs' argument is to be added to the operation to enable (standardized) paging related logic.\"},\"valueType\":{\"type\":\"string\",\"title\":\"The .NET value parameter 'Type' for the operation.\",\"description\":\"Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'.\"},\"returnType\":{\"type\":\"string\",\"title\":\"The .NET return 'Type' for the operation.\",\"description\":\"Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'.\"},\"returnTypeNullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'ReturnType' is nullable for the operation.\",\"description\":\"This is only applicable for an 'Operation.Type' of 'Custom'. Will be inferred where the 'ReturnType' is denoted as nullable; i.e. suffixed by a '?'.\"},\"returnText\":{\"type\":\"string\",\"title\":\"The text for use in comments to describe the 'ReturnType'.\",\"description\":\"A default will be created where not specified. To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. {{Xxx}}).\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'.\"},\"autoImplement\":{\"type\":\"string\",\"title\":\"The operation override for the 'Entity.AutoImplement'.\",\"description\":\"Defaults to 'Entity.AutoImplement'. The corresponding 'Entity.AutoImplement' must be defined for this to be enacted. Auto-implementation is applicable for all 'Operation.Type' options with the exception of 'Custom'.\",\"enum\":[\"Database\",\"EntityFramework\",\"Cosmos\",\"OData\",\"HttpAgent\",\"None\"]},\"dataEntityMapper\":{\"type\":\"string\",\"title\":\"The override for the data entity 'Mapper'.\",\"description\":\"Used where the default generated 'Mapper' is not applicable.\"},\"dataExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'Data' extensions logic should be generated.\",\"description\":\"Defaults to 'Entity.DataExtensions'.\"},\"dataTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Data'-layer.\",\"description\":\"Where using an 'EventOutbox' this is ignored as it is implied through its usage.\"},\"databaseStoredProc\":{\"type\":\"string\",\"title\":\"The database stored procedure name used where 'Operation.AutoImplement' is 'Database'.\",\"description\":\"Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'.\"},\"cosmosContainerId\":{\"type\":\"string\",\"title\":\"The Cosmos 'ContainerId' override used where 'Operation.AutoImplement' is 'Cosmos'.\",\"description\":\"Overrides the 'Entity.CosmosContainerId'.\"},\"cosmosPartitionKey\":{\"type\":\"string\",\"title\":\"The C# code override to be used for setting the optional Cosmos 'PartitionKey' used where 'Operation.AutoImplement' is 'Cosmos'.\",\"description\":\"Overrides the 'Entity.CosmosPartitionKey'.\"},\"odataCollectionName\":{\"type\":\"string\",\"title\":\"The override name of the underlying OData collection where 'Operation.AutoImplement' is 'OData'.\",\"description\":\"Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer.\"},\"httpAgentRoute\":{\"type\":\"string\",\"title\":\"The HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.\",\"description\":\"This is appended to the 'Entity.HttpAgentRoutePrefix'.\"},\"httpAgentMethod\":{\"type\":\"string\",\"title\":\"The HTTP Agent Method for the operation.\",\"description\":\"Defaults to 'Operation.WebApiMethod'.\",\"enum\":[\"HttpGet\",\"HttpPost\",\"HttpPut\",\"HttpDelete\",\"HttpPatch\"]},\"httpAgentModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').\",\"description\":\"This can be overridden within the 'Operation'(s).\"},\"httpAgentReturnModel\":{\"type\":\"string\",\"title\":\"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').\",\"description\":\"Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s).\"},\"managerCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'Manager' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated.\"},\"managerTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Manager'-layer.\"},\"managerExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'Manager' extensions logic should be generated.\",\"description\":\"Defaults to 'Entity.ManagerExtensions'.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET Type that will perform the validation.\",\"description\":\"Defaults to the 'Entity.Validator' where not specified explicitly. Only used for 'Operation.Type' options 'Create' or 'Update'.\"},\"iValidator\":{\"type\":\"string\",\"title\":\"The name of the .NET Interface that the 'Validator' implements/inherits.\",\"description\":\"Defaults to the 'Entity.IValidator' where specified; otherwise, defaults to 'IValidator<{Type}>' where the '{Type}' is 'ValueType'. Only used 'Operation.Type' options 'Create' or 'Update'.\"},\"managerOperationType\":{\"type\":\"string\",\"title\":\"The 'ExecutionContext.OperationType' (CRUD denotation) defined at the 'Manager'-layer.\",\"description\":\"The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.\",\"enum\":[\"Create\",\"Read\",\"Update\",\"Delete\",\"Unspecified\"]},\"dataSvcCustom\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'DataSvc' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated.\"},\"dataSvcTransaction\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer.\"},\"dataSvcExtensions\":{\"type\":\"boolean\",\"title\":\"Indicates whether the 'DataSvc' extensions logic should be generated.\",\"description\":\"Defaults to 'Entity.ManagerExtensions'.\"},\"eventPublish\":{\"type\":\"string\",\"title\":\"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.\",\"description\":\"Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.\",\"enum\":[\"None\",\"DataSvc\",\"Data\"]},\"eventOutbox\":{\"type\":\"string\",\"title\":\"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).\",\"description\":\"Defaults to 'Entity.EventOutbox' configuration property (inherits) where not specified and 'EventPublish' is 'Data'; otherwise, 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.\",\"enum\":[\"None\",\"Database\"]},\"eventSource\":{\"type\":\"string\",\"title\":\"The Event Source.\",\"description\":\"Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'.\"},\"eventSubject\":{\"type\":\"string\",\"title\":\"The event subject template and corresponding event action pair (separated by a colon).\",\"description\":\"The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'.\"},\"webApiRoute\":{\"type\":\"string\",\"title\":\"The Web API 'RouteAtttribute' to be appended to the 'Entity.WebApiRoutePrefix'.\"},\"webApiAuthorize\":{\"type\":\"string\",\"title\":\"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.\",\"description\":\"Where not specified no attribute output will occur; it will then inherit as supported by .NET.\"},\"webApiMethod\":{\"type\":\"string\",\"title\":\"The HTTP Method for the operation.\",\"description\":\"The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.\",\"enum\":[\"HttpGet\",\"HttpPost\",\"HttpPut\",\"HttpDelete\"]},\"webApiStatus\":{\"type\":\"string\",\"title\":\"The primary HTTP Status Code that will be returned for the operation where there is a non-'null' return value.\",\"description\":\"The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.\",\"enum\":[\"OK\",\"Accepted\",\"Created\",\"NoContent\",\"NotFound\"]},\"webApiAlternateStatus\":{\"type\":\"string\",\"title\":\"The primary HTTP Status Code that will be returned for the operation where there is a 'null' return value.\",\"description\":\"The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.\",\"enum\":[\"OK\",\"Accepted\",\"Created\",\"NoContent\",\"NotFound\",\"ThrowException\"]},\"webApiLocation\":{\"type\":\"string\",\"title\":\"The HTTP Response Location Header route.\",\"description\":\"This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'.\"},\"webApiConcurrency\":{\"type\":\"boolean\",\"title\":\"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.\",\"description\":\"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to 'Entity.WebApiConcurrency'.\"},\"webApiGetOperation\":{\"type\":\"string\",\"title\":\"The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.\",\"description\":\"Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.\"},\"webApiUpdateOperation\":{\"type\":\"string\",\"title\":\"The corresponding 'Update' method name (in the 'XxxManager') where the 'Operation.Type' is 'Patch'.\",\"description\":\"Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.\"},\"authPermission\":{\"type\":\"string\",\"title\":\"The permission used by the 'ExecutionContext.IsAuthorized(AuthPermission)' to determine whether the user is authorized.\"},\"authRole\":{\"type\":\"string\",\"title\":\"The permission used by the 'ExecutionContext.IsInRole(AuthRole)' to determine whether the user is authorized.\"},\"excludeAll\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of all 'Operation' related output.\",\"description\":\"Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'.\"},\"excludeIData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'Data' interface ('IXxxData.cs') output.\"},\"excludeData\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'Data' class ('XxxData.cs') output.\"},\"excludeIDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'DataSvc' interface ('IXxxDataSvc.cs') output.\"},\"excludeDataSvc\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'DataSvc' class ('XxxDataSvc.cs') output.\"},\"excludeIManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'Manager' interface ('IXxxManager.cs') output.\"},\"excludeManager\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the 'Manager' class ('XxxManager.cs') output.\"},\"excludeWebApi\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the WebAPI 'Controller' class ('XxxController.cs') output.\"},\"excludeWebApiAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the WebAPI consuming 'Agent' class ('XxxAgent.cs') output.\"},\"excludeGrpcAgent\":{\"type\":\"boolean\",\"title\":\"Indicates whether to exclude the generation of the operation within the gRPC consuming 'Agent' class ('XxxAgent.cs') output.\"},\"grpc\":{\"type\":\"boolean\",\"title\":\"Indicates whether gRPC support (more specifically service-side) is required for the Operation.\",\"description\":\"gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically.\"},\"parameters\":{\"type\":\"array\",\"title\":\"The corresponding 'Parameter' collection.\",\"items\":{\"$ref\":\"#/definitions/Parameter\"}}},\"required\":[\"name\"]},\"Parameter\":{\"type\":\"object\",\"title\":\"'Parameter' object (entity-driven)\",\"description\":\"The 'Parameter' object defines an 'Operation' parameter and its charateristics.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique parameter name.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the 'Text' will be the 'Name' reformatted as sentence casing.\"},\"type\":{\"type\":\"string\",\"title\":\"The .NET 'Type'.\",\"description\":\"Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'\"},\"nullable\":{\"type\":\"boolean\",\"title\":\"Indicates whether the .NET 'Type should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.\"},\"default\":{\"type\":\"string\",\"title\":\"The C# code to default the value.\",\"description\":\"Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.\"},\"privateName\":{\"type\":\"string\",\"title\":\"The overriding private name.\",\"description\":\"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.\"},\"argumentName\":{\"type\":\"string\",\"title\":\"The overriding argument name.\",\"description\":\"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.\"},\"property\":{\"type\":\"string\",\"title\":\"The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined.\"},\"refDataType\":{\"type\":\"string\",\"title\":\"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).\",\"description\":\"Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.\",\"enum\":[\"string\",\"int\",\"Guid\"]},\"refDataList\":{\"type\":\"boolean\",\"title\":\"Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').\",\"description\":\"This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.\"},\"validator\":{\"type\":\"string\",\"title\":\"The name of the .NET 'Type' that will perform the validation.\"},\"iValidator\":{\"type\":\"string\",\"title\":\"The name of the .NET Interface that the 'Validator' implements/inherits.\",\"description\":\"Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'.\"},\"validatorCode\":{\"type\":\"string\",\"title\":\"The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified).\"},\"isMandatory\":{\"type\":\"boolean\",\"title\":\"Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc).\"},\"layerPassing\":{\"type\":\"string\",\"title\":\"The option that determines the layers in which the parameter is passed.\",\"description\":\"Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.\",\"enum\":[\"All\",\"ToManagerSet\",\"ToManagerCollSet\"]},\"dataConverter\":{\"type\":\"string\",\"title\":\"The data 'Converter' class name where specific data conversion is required.\",\"description\":\"A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable.\"},\"dataConverterIsGeneric\":{\"type\":\"boolean\",\"title\":\"Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'.\"},\"webApiFrom\":{\"type\":\"string\",\"title\":\"The option for how the parameter will be delcared within the Web API Controller.\",\"description\":\"Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.\",\"enum\":[\"FromQuery\",\"FromBody\",\"FromRoute\",\"FromEntityProperties\"]},\"grpcType\":{\"type\":\"string\",\"title\":\"The underlying gRPC data type; will be inferred where not specified.\"}},\"required\":[\"name\"]},\"Const\":{\"type\":\"object\",\"title\":\"'Const' object (entity-driven)\",\"description\":\"The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"The unique constant name.\"},\"value\":{\"type\":\"string\",\"title\":\"The .NET (C#) code for the constant value.\",\"description\":\"The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.\"},\"text\":{\"type\":\"string\",\"title\":\"The overriding text for use in comments.\",\"description\":\"By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref=\\\"XXX\\\"/>' within use moustache shorthand (e.g. '{{Xxx}}').\"}},\"required\":[\"name\",\"value\"]}},\"allOf\":[{\"$ref\":\"#/definitions/CodeGeneration\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).","$schema":"https://json-schema.org/draft-04/schema#","definitions":{"CodeGeneration":{"type":"object","title":"'CodeGeneration' object (entity-driven)","description":"The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.","properties":{"refDataNamespace":{"type":"string","title":"The namespace for the Reference Data entities (adds as a c# 'using' statement).","description":"Defaults to 'Company' + '.' (literal) + AppName + '.' (literal) + 'EntityUsing' + '.Entities' (literal)."},"refDataCommonNamespace":{"type":"string","title":"The namespace for the Reference Data common entities (adds as a c# 'using' statement).","description":"Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal)."},"refDataText":{"type":"boolean","title":"Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' for an 'Entity'.","description":"This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')."},"refDataWebApiRoute":{"type":"string","title":"The 'RouteAtttribute' for the Reference Data Web API controller required for named pre-fetching. The 'WebApiRoutePrefix' will be prepended where specified."},"refDataCache":{"type":"string","title":"The cache used for the ReferenceData providers.","description":"Defaults to 'ReferenceDataCache'. A value of 'ReferenceDataCache' specifies a single-tenant cache; otherwise, 'ReferenceDataMultiTenantCache' for a multi-tenant cache leverageing the 'ExecutionContext.TenantId'.","enum":["ReferenceDataCache","ReferenceDataMultiTenantCache"]},"refDataAppendToNamespace":{"type":"string","title":"The Reference Data entity namespace appended to end of the standard 'company.appname.Common.Entities.{AppendToNamespace}'.","description":"Defaults to 'null'; being nothing to append."},"refDataBusNamespace":{"type":"string","title":"The namespace for the Reference Data entities (adds as a c# 'using' statement) for additional business-layer inclusion where requried."},"entityScope":{"type":"string","title":"The entity scope option.","description":"Defaults to 'Common' for backwards compatibility; 'Autonomous' is **recommended**. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is the special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).","enum":["Common","Business","Autonomous"]},"entityUsing":{"type":"string","title":"The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).","description":"Defaults to 'Common' (unless 'EntityScope' is 'Autonomous' and then it will default to 'Business') which will add '.Common.Entities'. Additionally, 'Business' to add '.Business.Entities', 'All' to add both, and 'None' to exclude any. This can be overridden for each 'Entity'.","enum":["Common","Business","All","None"]},"jsonSerializer":{"type":"string","title":"The JSON Serializer to use for JSON property attribution.","description":"Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).","enum":["None","Newtonsoft"]},"etagJsonName":{"type":"string","title":"The default JSON name for the 'ETag' property.","description":"Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required.","enum":["etag","eTag","_etag","_eTag","ETag","ETAG"]},"usingNamespace1":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Entity' code.","description":"Typically used where referening a 'Type' from a Namespace that is not generated by default."},"usingNamespace2":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Entity' code.","description":"Typically used where referening a 'Type' from a Namespace that is not generated by default."},"usingNamespace3":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Entity' code.","description":"Typically used where referening a 'Type' from a Namespace that is not generated by default."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.","description":"This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s)."},"appBasedAgentArgs":{"type":"boolean","title":"Indicates whether to create and use a domain-specific 'WebApi.WebApiAgentArgs' to simplify dependency injection usage."},"webApiAutoLocation":{"type":"boolean","title":"Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.","description":"This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This can be overridden within the 'Entity'(s)."},"webApiRoutePrefix":{"type":"string","title":"The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.","description":"This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s)."},"validatorLayer":{"type":"string","title":"The namespace for the Reference Data entities (adds as a c# 'using' statement).","description":"Defaults to 'Business'. A value of 'Business' indicates that the Validators will be defined within the 'Business' namespace/assembly; otherwise, defined within the 'Common' namespace/assembly.","enum":["Business","Common"]},"databaseName":{"type":"string","title":"The .NET database interface name (used where 'Operation.AutoImplement' is 'Database').","description":"Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s)."},"databaseSchema":{"type":"string","title":"The default database schema name.","description":"Defaults to 'dbo'."},"entityFrameworkName":{"type":"string","title":"The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'EntityFramework'.","description":"Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s)."},"cosmosName":{"type":"string","title":"The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'Cosmos'.","description":"Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s)."},"odataName":{"type":"string","title":"The .NET OData interface name used where 'Operation.AutoImplement' is 'OData'.","description":"Defaults to 'IOData'. This can be overridden within the 'Entity'(s)."},"httpAgentName":{"type":"string","title":"The default .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.","description":"Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s)."},"refDataDefaultMapperConverter":{"type":"string","title":"The default Reference Data property 'Converter' used by the generated 'Mapper'(s) where not specifically defined.","description":"Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Property.DataConverterIsGeneric' to 'true'.","enum":["ReferenceDataCodeConverter","ReferenceDataCodeConverter{T}","ReferenceDataCodeConverter<T>","ReferenceDataInt32IdConverter","ReferenceDataInt32IdConverter{T}","ReferenceDataInt32IdConverter<T>","ReferenceDataNullableInt32IdConverter","ReferenceDataNullableInt32IdConverter{T}","ReferenceDataNullableInt32IdConverter<T>","ReferenceDataInt64IdConverter","ReferenceDataInt64IdConverter{T}","ReferenceDataInt64IdConverter<T>","ReferenceDataNullableInt64IdConverter","ReferenceDataNullableInt64IdConverter{T}","ReferenceDataNullableInt64IdConverter<T>","ReferenceDataGuidIdConverter","ReferenceDataGuidIdConverter{T}","ReferenceDataGuidIdConverter<T>","ReferenceDataNullableGuidIdConverter","ReferenceDataNullableGuidIdConverter{T}","ReferenceDataNullableGuidIdConverter<T>"]},"dataUsingNamespace":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Data' code."},"databaseUsingNamespace":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Database'."},"entityFrameworkUsingNamespace":{"type":"string","title":"The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'EntityFramework'."},"cosmosUsingNamespace":{"type":"string","title":"additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Cosmos'."},"odataUsingNamespace":{"type":"string","title":"additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'OData'."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.","description":"Defaults to 'DataSvc'; unless the 'EventOutbox' is not 'None' where it will default to 'Data'. Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).","enum":["None","DataSvc","Data"]},"eventOutbox":{"type":"string","title":"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).","description":"Defaults to 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.","enum":["None","Database"]},"eventSourceRoot":{"type":"string","title":"The URI root for the event source by prepending to all event source URIs.","description":"The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s)."},"eventSourceKind":{"type":"string","title":"The URI kind for the event source URIs.","description":"Defaults to 'None' (being the event source is not updated).","enum":["None","Absolute","Relative","RelativeOrAbsolute"]},"eventSubjectRoot":{"type":"string","title":"The root for the event Subject name by prepending to all event subject names.","description":"Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s)."},"eventSubjectFormat":{"type":"string","title":"The default formatting for the Subject when an Event is published.","description":"Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.","enum":["NameOnly","NameAndKey"]},"eventSubjectSeparator":{"type":"string","title":"The subject path separator.","description":"Defaults to '.'. Used only where the subject is automatically inferred."},"eventActionFormat":{"type":"string","title":"The formatting for the Action when an Event is published.","description":"Defaults to 'None' (no formatting required, i.e. as-is)'.","enum":["None","PastTense"]},"eventCasing":{"type":"string","title":"The casing for the Subject and Action (with the exception of the key)","description":"Defaults to 'None' (no casing required, i.e. as-is)'.","enum":["None","Lower","Upper"]},"eventTransaction":{"type":"boolean","title":"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.","description":"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'false'. This essentially defaults the 'Entity.EventTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required.","description":"gRPC support is an explicit opt-in model. Must be set to 'true' for any of the subordinate gRPC capabilities to be code-generated. Will require each 'Entity', and corresponding 'Property' and 'Operation' to be opted-in specifically."},"pathBase":{"type":"string","title":"The base path (directory) prefix for the artefacts; other 'Path*' properties append to this value when they are not specifically overridden.","description":"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'."},"pathCommon":{"type":"string","title":"The path (directory) for the Database-related artefacts.","description":"Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'."},"pathBusiness":{"type":"string","title":"The path (directory) for the Business-related (.NET) artefacts.","description":"Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'."},"pathApi":{"type":"string","title":"The path (directory) for the API-related (.NET) artefacts.","description":"Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'."},"namespaceBase":{"type":"string","title":"The base Namespace (root) for the .NET artefacts.","description":"Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'."},"namespaceCommon":{"type":"string","title":"The Namespace (root) for the Common-related .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'."},"namespaceBusiness":{"type":"string","title":"The Namespace (root) for the Business-related .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'."},"namespaceApi":{"type":"string","title":"The Namespace (root) for the Api-related .NET artefacts.","description":"Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'."},"entities":{"type":"array","title":"The corresponding 'Entity' collection.","items":{"$ref":"#/definitions/Entity"}}}},"Entity":{"type":"object","title":"'Entity' object (entity-driven)","description":"The 'Entity' is used as the primary configuration for driving the entity-driven code generation.","properties":{"name":{"type":"string","title":"The unique entity name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"Overrides the Name (as sentence text) for the summary comments. It will be formatted as: 'Represents the {Text} entity.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})."},"fileName":{"type":"string","title":"The overriding file name.","description":"Overrides the Name as the code-generated file name."},"entityScope":{"type":"string","title":"The entity scope option.","description":"Defaults to the 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is a special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).","enum":["Common","Business","Autonomous"]},"entityUsing":{"type":"string","title":"The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).","description":"Defaults to 'EntityScope' ('Autonomous' will result in 'Business'). A value of 'Common' will add '.Common.Entities', 'Business' will add '.Business.Entities', 'All' to add both, and 'None' to exclude any.","enum":["Common","Business","All","None"]},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'."},"constType":{"type":"string","title":"The Const .NET Type option.","description":"The .NET Type to be used for the 'const' values. Defaults to 'string'.","enum":["int","long","Guid","string"]},"isInitialOverride":{"type":"boolean","title":"Indicates whether to override the 'ICleanup.IsInitial' property.","description":"Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'."},"refDataType":{"type":"string","title":"The Reference Data identifier Type option.","description":"Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.","enum":["int","long","Guid","string"]},"refDataText":{"type":"boolean","title":"Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' overriding the 'CodeGeneration.RefDataText' selection.","description":"This is used where serializing within the Web API'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')."},"refDataSortOrder":{"type":"string","title":"The Reference Data sort order option.","description":"Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.","enum":["SortOrder","Id","Code","Text"]},"refDataStringFormat":{"type":"string","title":"The Reference Data 'ToString' composite format.","description":"The string format supports the standard composite formatting; where the following indexes are used: '{0}' for 'Id', '{1}' for 'Code' and '{2}' for 'Text'. Defaults to '{2}'."},"inherits":{"type":"string","title":"The base class that the entity inherits from.","description":"Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseXxx' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes."},"implements":{"type":"string","title":"The list of comma separated interfaces that are to be declared for the entity class."},"implementsAutoInfer":{"type":"boolean","title":"Indicates whether to automatically infer the interface implements for the entity from the properties declared.","description":"Will attempt to infer the following: 'IGuidIdentifier', 'IInt32Identifier', 'IInt64Identifier', 'IStringIdentifier', 'IETag' and 'IChangeLog'. Defaults to 'true'."},"abstract":{"type":"boolean","title":"Indicates whether the class should be defined as abstract."},"genericWithT":{"type":"boolean","title":"Indicates whether the class should be defined as a generic with a single parameter 'T'."},"namespace":{"type":"string","title":"The entity namespace to be appended.","description":"Appended to the end of the standard structure as follows: '{Company}.{AppName}.Common.Entities.{Namespace}'."},"omitEntityBase":{"type":"boolean","title":"Indicates that the entity should not inherit from 'EntityBase'.","description":"As such any of the 'EntityBase' related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities."},"jsonSerializer":{"type":"string","title":"The JSON Serializer to use for JSON property attribution.","description":"Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'Newtonsoft'.","enum":["None","Newtonsoft"]},"collection":{"type":"boolean","title":"Indicates whether a corresponding entity collection class should be created."},"collectionResult":{"type":"boolean","title":"Indicates whether a corresponding entity collection result class should be created","description":"Enables the likes of additional paging state to be stored with the underlying collection."},"collectionKeyed":{"type":"boolean","title":"Indicates whether the entity collection is keyed using the properties defined as forming part of the unique key."},"collectionInherits":{"type":"string","title":"The base class that a 'Collection' inherits from.","description":"Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'."},"collectionResultInherits":{"type":"string","title":"The base class that a 'CollectionResult' inherits from.","description":"Defaults to 'EntityCollectionResult'."},"get":{"type":"boolean","title":"Indicates that a 'Get' operation will be automatically generated where not otherwise explicitly specified."},"getAll":{"type":"boolean","title":"Indicates that a 'GetAll' operation will be automatically generated where not otherwise explicitly specified."},"create":{"type":"boolean","title":"Indicates that a 'Create' operation will be automatically generated where not otherwise explicitly specified."},"update":{"type":"boolean","title":"Indicates that a 'Update' operation will be automatically generated where not otherwise explicitly specified."},"patch":{"type":"boolean","title":"Indicates that a 'Patch' operation will be automatically generated where not otherwise explicitly specified."},"delete":{"type":"boolean","title":"Indicates that a 'Delete' operation will be automatically generated where not otherwise explicitly specified."},"autoImplement":{"type":"string","title":"The data source auto-implementation option.","description":"Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented.","enum":["Database","EntityFramework","Cosmos","OData","HttpAgent","None"]},"dataCtor":{"type":"string","title":"The access modifier for the generated 'Data' constructor.","description":"Defaults to 'Public'.","enum":["Public","Private","Protected"]},"dataCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Data' constructor.","description":"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.","items":{"type":"string"}},"dataExtensions":{"type":"boolean","title":"Indicates whether the 'Data' extensions logic should be generated.","description":"This can be overridden using 'Operation.DataExtensions'."},"databaseName":{"type":"string","title":"The .NET database interface name (used where 'AutoImplement' is 'Database').","description":"Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase')."},"databaseSchema":{"type":"string","title":"The database schema name (used where 'AutoImplement' is 'Database').","description":"Defaults to 'dbo'."},"databaseMapperInheritsFrom":{"type":"string","title":"The name of the 'Mapper' that the generated Database 'Mapper' inherits from."},"databaseCustomerMapper":{"type":"boolean","title":"Indicates that a custom Database 'Mapper' will be used; i.e. not generated.","description":"Otherwise, by default, a 'Mapper' will be generated."},"entityFrameworkName":{"type":"string","title":"The .NET Entity Framework interface name used where 'AutoImplement' is 'EntityFramework'.","description":"Defaults to the 'CodeGeneration.EntityFrameworkName' configuration property (its default value is 'IEfDb')."},"entityFrameworkModel":{"type":"string","title":"The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework')."},"entityFrameworkMapperInheritsFrom":{"type":"string","title":"The name of the 'Mapper that the generated Entity Framework 'Mapper' inherits from.","description":"Defaults to 'Model.{Name}'; i.e. an entity with the same name in the 'Model' namespace."},"entityFrameworkCustomMapper":{"type":"boolean","title":"Indicates that a custom Entity Framework 'Mapper' will be used; i.e. not generated.","description":"Otherwise, by default, a 'Mapper' will be generated."},"cosmosName":{"type":"string","title":"The .NET Cosmos interface name used where 'AutoImplement' is 'Cosmos'.","description":"Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb')."},"cosmosModel":{"type":"string","title":"The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos')."},"cosmosContainerId":{"type":"string","title":"The Cosmos 'ContainerId' required where 'AutoImplement' is 'Cosmos'."},"cosmosPartitionKey":{"type":"string","title":"The C# code to be used for setting the optional Cosmos 'PartitionKey' where 'AutoImplement' is 'Cosmos'.","description":"Defaults to 'PartitionKey.None'."},"cosmosValueContainer":{"type":"boolean","title":"Indicates whether the 'CosmosDbValueContainer' is to be used; otherwise, 'CosmosDbContainer'."},"cosmosMapperInheritsFrom":{"type":"string","title":"The name of the 'Mapper' that the generated Cosmos 'Mapper' inherits from."},"cosmosCustomMapper":{"type":"boolean","title":"Indicates that a custom Cosmos 'Mapper' will be used; i.e. not generated.","description":"Otherwise, by default, a 'Mapper' will be generated."},"odataName":{"type":"string","title":"The .NET OData interface name used where 'AutoImplement' is 'OData'.","description":"Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData')."},"odataModel":{"type":"string","title":"The corresponding OData model name (required where 'AutoImplement' is 'OData')."},"odataCollectionName":{"type":"string","title":"The name of the underlying OData collection where 'AutoImplement' is 'OData'.","description":"The underlying 'Simple.OData.Client' will attempt to infer."},"odataMapperInheritsFrom":{"type":"string","title":"The name of the 'Mapper' that the generated OData 'Mapper' inherits from."},"odataCustomMapper":{"type":"boolean","title":"Indicates that a custom OData 'Mapper' will be used; i.e. not generated.","description":"Otherwise, by default, a 'Mapper' will be generated."},"httpAgentName":{"type":"string","title":"The .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.","description":"Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent')."},"httpAgentRoutePrefix":{"type":"string","title":"The base HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.","description":"This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s)."},"httpAgentModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').","description":"This can be overridden within the 'Operation'(s)."},"httpAgentReturnModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').","description":"This can be overridden within the 'Operation'(s)."},"dataSvcCaching":{"type":"boolean","title":"Indicates whether request-based 'IRequestCache' caching is to be performed at the 'DataSvc' layer to improve performance (i.e. reduce chattiness).","description":"Defaults to 'true'."},"dataSvcCtor":{"type":"string","title":"The access modifier for the generated 'DataSvc' constructor.","description":"Defaults to 'Public'.","enum":["Public","Private","Protected"]},"dataSvcCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'DataSvc' constructor.","description":"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.","items":{"type":"string"}},"dataSvcExtensions":{"type":"boolean","title":"Indicates whether the 'DataSvc' extensions logic should be generated.","description":"This can be overridden using 'Operation.DataSvcExtensions'."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.","description":"Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).","enum":["None","DataSvc","Data"]},"eventOutbox":{"type":"string","title":"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).","description":"Defaults to 'CodeGeneration.EventOutbox' configuration property (inherits) where not specified. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.","enum":["None","Database"]},"eventSource":{"type":"string","title":"The Event Source.","description":"Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'."},"eventSubjectFormat":{"type":"string","title":"The default formatting for the Subject when an Event is published.","description":"Defaults to 'CodeGeneration.EventSubjectFormat'.","enum":["NameOnly","NameAndKey"]},"eventCasing":{"type":"string","title":"The casing for the Subject and Action (with the exception of the key)","description":"Defaults to 'CodeGeneration.EventCasing'.","enum":["None","Lower","Upper"]},"eventTransaction":{"type":"boolean","title":"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.","description":"Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used."},"managerCtor":{"type":"string","title":"The access modifier for the generated 'Manager' constructor.","description":"Defaults to 'Public'.","enum":["Public","Private","Protected"]},"managerCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Manager' constructor.","description":"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.","items":{"type":"string"}},"managerExtensions":{"type":"boolean","title":"Indicates whether the 'Manager' extensions logic should be generated.","description":"This can be overridden using 'Operation.ManagerExtensions'."},"validator":{"type":"string","title":"The name of the .NET 'Type' that will perform the validation.","description":"Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly."},"iValidator":{"type":"string","title":"The name of the .NET Interface that the 'Validator' implements/inherits.","description":"Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly."},"webApiRoutePrefix":{"type":"string","title":"The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.","description":"This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.","description":"Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also."},"webApiCtor":{"type":"string","title":"The access modifier for the generated Web API 'Controller' constructor.","description":"Defaults to 'Public'.","enum":["Public","Private","Protected"]},"webApiCtorParams":{"type":"array","title":"The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'WebApi' constructor.","description":"Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.","items":{"type":"string"}},"webApiAutoLocation":{"type":"boolean","title":"Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.","description":"This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'."},"webApiConcurrency":{"type":"boolean","title":"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.","description":"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'."},"webApiGetOperation":{"type":"string","title":"The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.","description":"Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'."},"dataModel":{"type":"boolean","title":"Indicates whether a data 'model' version of the entity should also be generated (output to '.\\Business\\Data\\Model').","description":"The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'."},"excludeEntity":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'Entity' class ('Xxx.cs')."},"excludeAll":{"type":"boolean","title":"Indicates whether to exclude the generation of all 'Operation' related artefacts; excluding the 'Entity' class.","description":"Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude."},"excludeIData":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'Data' interface ('IXxxData.cs')."},"excludeData":{"type":"string","title":"The option to exclude the generation of the 'Data' class ('XxxData.cs').","description":"Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.","enum":["Include","Exclude","RequiresMapper"]},"excludeIDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'DataSvc' interface ('IXxxDataSvc.cs')."},"excludeDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'DataSvc' class ('XxxDataSvc.cs')."},"excludeIManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'Manager' interface ('IXxxManager.cs')."},"excludeManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the 'Manager' class ('XxxManager.cs')."},"excludeWebApi":{"type":"boolean","title":"The option to exclude the generation of the WebAPI 'Controller' class ('XxxController.cs')."},"excludeWebApiAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the WebAPI consuming 'Agent' class ('XxxAgent.cs')."},"excludeGrpcAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the gRPC consuming 'Agent' class ('XxxAgent.cs')."},"authRole":{"type":"string","title":"The role (permission) used by the 'ExecutionContext.IsInRole(role)' for each 'Operation'.","description":"Used where not overridden specifically for an 'Operation'; i.e. acts as the default."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required for the Entity.","description":"gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically."},"properties":{"type":"array","title":"The corresponding 'Property' collection.","items":{"$ref":"#/definitions/Property"}},"operations":{"type":"array","title":"The corresponding 'Operation' collection.","items":{"$ref":"#/definitions/Operation"}},"consts":{"type":"array","title":"The corresponding 'Consts' collection.","items":{"$ref":"#/definitions/Const"}}},"required":["name"]},"Property":{"type":"object","title":"'Property' object (entity-driven)","description":"The 'Property' object defines an 'Entity' property and its charateristics.","properties":{"name":{"type":"string","title":"The unique property name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})."},"modelText":{"type":"string","title":"The overriding model text for use in comments.","description":"By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})."},"type":{"type":"string","title":"The .NET 'Type'.","description":"Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'"},"nullable":{"type":"boolean","title":"Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'."},"inherited":{"type":"boolean","title":"Indicates whether the property is inherited and therefore should not be output within the generated Entity class."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'."},"uniqueKey":{"type":"boolean","title":"Indicates whether the property is considered part of the unique (primary) key.","description":"This is also used to simplify the parameter specification for an Entity Operation by inferrence."},"isEntity":{"type":"boolean","title":"Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').","description":"Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file."},"immutable":{"type":"boolean","title":"Indicates that the value is immutable and therefore cannot be changed once set."},"dateTimeTransform":{"type":"string","title":"The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.","description":"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.","enum":["UseDefault","None","DateOnly","DateTimeLocal","DateTimeUtc","DateTimeUnspecified"]},"stringTrim":{"type":"string","title":"The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.","description":"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.","enum":["UseDefault","None","Start","End","Both"]},"stringTransform":{"type":"string","title":"The 'string' transformation to be performed on 'Set' and 'CleanUp'.","description":"Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.","enum":["UseDefault","None","NullToEmpty","EmptyToNull"]},"autoCreate":{"type":"boolean","title":"Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation)."},"default":{"type":"string","title":"The C# code to default the value.","description":"Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used."},"partitionKey":{"type":"boolean","title":"Indicates whether the property is considered part of the Partition Key.","description":"This will implement 'IPartitionKey' for the generated entity."},"secondaryPropertyChanged":{"type":"string","title":"The names of the secondary property(s), comma delimited, that are to be notified on a property change."},"bubblePropertyChanges":{"type":"boolean","title":"Indicates whether the value should bubble up property changes versus only recording within the sub-entity itself.","description":"Note that the 'IsEntity' property is also required to enable."},"excludeCleanup":{"type":"boolean","title":"Indicates that 'CleanUp' is not to be performed for the property within the 'Entity.CleanUp' method."},"internalOnly":{"type":"boolean","title":"Indicates whether the property is for internal use only; declared in Business entities only.","description":"This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration."},"refDataType":{"type":"string","title":"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).","description":"Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.","enum":["string","int","Guid"]},"refDataList":{"type":"boolean","title":"Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').","description":"This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example."},"refDataText":{"type":"boolean","title":"Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.","description":"This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')."},"refDataMapping":{"type":"boolean","title":"Indicates whether the property should use the underlying Reference Data mapping capabilities.","description":"Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable."},"jsonName":{"type":"string","title":"The JSON property name.","description":"Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'."},"jsonDataModelName":{"type":"string","title":"The JSON property name for the corresponding data model (see 'Entity.DataModel').","description":"Defaults to 'JsonName' where not specified."},"serializationIgnore":{"type":"boolean","title":"Indicates whether the property is not to be serialized.","description":"All properties are serialized by default."},"serializationEmitDefault":{"type":"boolean","title":"Indicates whether to emit the default value when serializing."},"dataModelJsonName":{"type":"string","title":"The override JSON property name where outputting as a data model.","description":"Defaults to 'JsonName' where not specified."},"identifierGenerator":{"type":"string","title":"The Identifier Generator Type to generate the identifier on create via Dependency Injection.","description":"Should be formatted as 'Type' + '^' + 'Name'; e.g. 'IGuidIdentifierGenerator^GuidIdGen'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored. See 'Beef.Entities.IInt32IdentifierGenerator', 'Beef.Entities.IInt64IdentifierGenerator', 'Beef.Entities.IGuidIdentifierGenerator' or 'Beef.Entities.IStringIdentifierGenerator' for underlying implementation requirements."},"dataName":{"type":"string","title":"The data name where Entity.AutoImplement is selected.","description":"Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options."},"dataConverter":{"type":"string","title":"The data 'Converter' class name where 'Entity.AutoImplement' is selected.","description":"A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'DataConverterIsGeneric' to 'true'."},"dataConverterIsGeneric":{"type":"boolean","title":"Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'."},"dataMapperIgnore":{"type":"boolean","title":"Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.","description":"All properties are included by default."},"dataAutoGenerated":{"type":"boolean","title":"Indicates whether the 'UniqueKey' property value is automatically generated by the data source on 'Create'."},"dataOperationTypes":{"type":"string","title":"The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.","description":"Defaults to 'Any'.","enum":["Any","AnyExceptCreate","AnyExceptUpdate","AnyExceptGet","Get","Create","Update","Delete"]},"databaseMapper":{"type":"string","title":"The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.","description":"A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties)."},"databaseIgnore":{"type":"boolean","title":"Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output."},"databaseDbType":{"type":"string","title":"The database 'DbType' override (versus inferring from the corresponding .NET Type).","description":"Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'."},"entityFrameworkMapper":{"type":"string","title":"The Entity Framework 'Mapper' approach for the property.","description":"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.","enum":["Map","Ignore","Skip"]},"cosmosMapper":{"type":"string","title":"The Cosmos 'Mapper' approach for the property.","description":"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.","enum":["Map","Ignore","Skip"]},"odataMapper":{"type":"string","title":"The OData 'Mapper' approach for the property.","description":"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.","enum":["Map","Ignore","Skip"]},"httpAgentMapper":{"type":"string","title":"The HttpAgent 'Mapper' approach for the property.","description":"Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.","enum":["Map","Ignore","Skip"]},"displayName":{"type":"string","title":"The display name used in the likes of error messages for the property.","description":"Defaults to the 'Name' as sentence case."},"annotation1":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"annotation2":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"annotation3":{"type":"string","title":"The property annotation (e.g. attribute) declaration code."},"webApiQueryStringConverter":{"type":"string","title":"The 'IPropertyMapperConverter' to perform 'Type' to 'string' conversion for writing to and parsing from the query string."},"grpcFieldNo":{"type":"integer","title":"The unique (immutable) field number required to enable gRPC support."},"grpcType":{"type":"string","title":"The underlying gRPC data type; will be inferred where not specified."}},"required":["name"]},"Operation":{"type":"object","title":"'CodeGeneration' object (entity-driven)","description":"The code generation for an 'Operation' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.","properties":{"name":{"type":"string","title":"The unique operation name."},"type":{"type":"string","title":"The type of operation that is to be code-generated.","enum":["Get","GetColl","Create","Update","Patch","Delete","Custom"]},"text":{"type":"string","title":"The text for use in comments.","description":"The 'Text' will be defaulted for all the 'Operation.Type' options with the exception of 'Custom'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})."},"uniqueKey":{"type":"boolean","title":"Indicates whether the properties marked as a unique key ('Property.UniqueKey') are to be used as the parameters.","description":"This simplifies the specification of these properties versus having to declare each specifically."},"paging":{"type":"boolean","title":"Indicates whether a 'PagingArgs' argument is to be added to the operation to enable (standardized) paging related logic."},"valueType":{"type":"string","title":"The .NET value parameter 'Type' for the operation.","description":"Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'."},"returnType":{"type":"string","title":"The .NET return 'Type' for the operation.","description":"Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'."},"returnTypeNullable":{"type":"boolean","title":"Indicates whether the 'ReturnType' is nullable for the operation.","description":"This is only applicable for an 'Operation.Type' of 'Custom'. Will be inferred where the 'ReturnType' is denoted as nullable; i.e. suffixed by a '?'."},"returnText":{"type":"string","title":"The text for use in comments to describe the 'ReturnType'.","description":"A default will be created where not specified. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'."},"autoImplement":{"type":"string","title":"The operation override for the 'Entity.AutoImplement'.","description":"Defaults to 'Entity.AutoImplement'. The corresponding 'Entity.AutoImplement' must be defined for this to be enacted. Auto-implementation is applicable for all 'Operation.Type' options with the exception of 'Custom'.","enum":["Database","EntityFramework","Cosmos","OData","HttpAgent","None"]},"dataEntityMapper":{"type":"string","title":"The override for the data entity 'Mapper'.","description":"Used where the default generated 'Mapper' is not applicable."},"dataExtensions":{"type":"boolean","title":"Indicates whether the 'Data' extensions logic should be generated.","description":"Defaults to 'Entity.DataExtensions'."},"dataTransaction":{"type":"boolean","title":"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Data'-layer.","description":"Where using an 'EventOutbox' this is ignored as it is implied through its usage."},"databaseStoredProc":{"type":"string","title":"The database stored procedure name used where 'Operation.AutoImplement' is 'Database'.","description":"Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'."},"cosmosContainerId":{"type":"string","title":"The Cosmos 'ContainerId' override used where 'Operation.AutoImplement' is 'Cosmos'.","description":"Overrides the 'Entity.CosmosContainerId'."},"cosmosPartitionKey":{"type":"string","title":"The C# code override to be used for setting the optional Cosmos 'PartitionKey' used where 'Operation.AutoImplement' is 'Cosmos'.","description":"Overrides the 'Entity.CosmosPartitionKey'."},"odataCollectionName":{"type":"string","title":"The override name of the underlying OData collection where 'Operation.AutoImplement' is 'OData'.","description":"Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer."},"httpAgentRoute":{"type":"string","title":"The HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.","description":"This is appended to the 'Entity.HttpAgentRoutePrefix'."},"httpAgentMethod":{"type":"string","title":"The HTTP Agent Method for the operation.","description":"Defaults to 'Operation.WebApiMethod'.","enum":["HttpGet","HttpPost","HttpPut","HttpDelete","HttpPatch"]},"httpAgentModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').","description":"This can be overridden within the 'Operation'(s)."},"httpAgentReturnModel":{"type":"string","title":"The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').","description":"Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s)."},"managerCustom":{"type":"boolean","title":"Indicates whether the 'Manager' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated."},"managerTransaction":{"type":"boolean","title":"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Manager'-layer."},"managerExtensions":{"type":"boolean","title":"Indicates whether the 'Manager' extensions logic should be generated.","description":"Defaults to 'Entity.ManagerExtensions'."},"validator":{"type":"string","title":"The name of the .NET Type that will perform the validation.","description":"Defaults to the 'Entity.Validator' where not specified explicitly. Only used for 'Operation.Type' options 'Create' or 'Update'."},"iValidator":{"type":"string","title":"The name of the .NET Interface that the 'Validator' implements/inherits.","description":"Defaults to the 'Entity.IValidator' where specified; otherwise, defaults to 'IValidator<{Type}>' where the '{Type}' is 'ValueType'. Only used 'Operation.Type' options 'Create' or 'Update'."},"managerOperationType":{"type":"string","title":"The 'ExecutionContext.OperationType' (CRUD denotation) defined at the 'Manager'-layer.","description":"The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.","enum":["Create","Read","Update","Delete","Unspecified"]},"dataSvcCustom":{"type":"boolean","title":"Indicates whether the 'DataSvc' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated."},"dataSvcTransaction":{"type":"boolean","title":"Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer."},"dataSvcExtensions":{"type":"boolean","title":"Indicates whether the 'DataSvc' extensions logic should be generated.","description":"Defaults to 'Entity.ManagerExtensions'."},"eventPublish":{"type":"string","title":"The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.","description":"Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.","enum":["None","DataSvc","Data"]},"eventOutbox":{"type":"string","title":"The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).","description":"Defaults to 'Entity.EventOutbox' configuration property (inherits) where not specified and 'EventPublish' is 'Data'; otherwise, 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.","enum":["None","Database"]},"eventSource":{"type":"string","title":"The Event Source.","description":"Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'."},"eventSubject":{"type":"string","title":"The event subject template and corresponding event action pair (separated by a colon).","description":"The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'."},"webApiRoute":{"type":"string","title":"The Web API 'RouteAtttribute' to be appended to the 'Entity.WebApiRoutePrefix'."},"webApiAuthorize":{"type":"string","title":"The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.","description":"Where not specified no attribute output will occur; it will then inherit as supported by .NET."},"webApiMethod":{"type":"string","title":"The HTTP Method for the operation.","description":"The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.","enum":["HttpGet","HttpPost","HttpPut","HttpDelete"]},"webApiStatus":{"type":"string","title":"The primary HTTP Status Code that will be returned for the operation where there is a non-'null' return value.","description":"The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.","enum":["OK","Accepted","Created","NoContent","NotFound"]},"webApiAlternateStatus":{"type":"string","title":"The primary HTTP Status Code that will be returned for the operation where there is a 'null' return value.","description":"The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.","enum":["OK","Accepted","Created","NoContent","NotFound","ThrowException"]},"webApiLocation":{"type":"string","title":"The HTTP Response Location Header route.","description":"This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'."},"webApiConcurrency":{"type":"boolean","title":"Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.","description":"This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to 'Entity.WebApiConcurrency'."},"webApiGetOperation":{"type":"string","title":"The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.","description":"Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'."},"webApiUpdateOperation":{"type":"string","title":"The corresponding 'Update' method name (in the 'XxxManager') where the 'Operation.Type' is 'Patch'.","description":"Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'."},"authPermission":{"type":"string","title":"The permission used by the 'ExecutionContext.IsAuthorized(AuthPermission)' to determine whether the user is authorized."},"authRole":{"type":"string","title":"The permission used by the 'ExecutionContext.IsInRole(AuthRole)' to determine whether the user is authorized."},"excludeAll":{"type":"boolean","title":"Indicates whether to exclude the generation of all 'Operation' related output.","description":"Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'."},"excludeIData":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'Data' interface ('IXxxData.cs') output."},"excludeData":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'Data' class ('XxxData.cs') output."},"excludeIDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'DataSvc' interface ('IXxxDataSvc.cs') output."},"excludeDataSvc":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'DataSvc' class ('XxxDataSvc.cs') output."},"excludeIManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'Manager' interface ('IXxxManager.cs') output."},"excludeManager":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the 'Manager' class ('XxxManager.cs') output."},"excludeWebApi":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the WebAPI 'Controller' class ('XxxController.cs') output."},"excludeWebApiAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the WebAPI consuming 'Agent' class ('XxxAgent.cs') output."},"excludeGrpcAgent":{"type":"boolean","title":"Indicates whether to exclude the generation of the operation within the gRPC consuming 'Agent' class ('XxxAgent.cs') output."},"grpc":{"type":"boolean","title":"Indicates whether gRPC support (more specifically service-side) is required for the Operation.","description":"gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically."},"parameters":{"type":"array","title":"The corresponding 'Parameter' collection.","items":{"$ref":"#/definitions/Parameter"}}},"required":["name"]},"Parameter":{"type":"object","title":"'Parameter' object (entity-driven)","description":"The 'Parameter' object defines an 'Operation' parameter and its charateristics.","properties":{"name":{"type":"string","title":"The unique parameter name."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the 'Text' will be the 'Name' reformatted as sentence casing."},"type":{"type":"string","title":"The .NET 'Type'.","description":"Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'"},"nullable":{"type":"boolean","title":"Indicates whether the .NET 'Type should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'."},"default":{"type":"string","title":"The C# code to default the value.","description":"Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used."},"privateName":{"type":"string","title":"The overriding private name.","description":"Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'."},"argumentName":{"type":"string","title":"The overriding argument name.","description":"Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'."},"property":{"type":"string","title":"The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined."},"refDataType":{"type":"string","title":"The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).","description":"Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.","enum":["string","int","Guid"]},"refDataList":{"type":"boolean","title":"Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').","description":"This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example."},"validator":{"type":"string","title":"The name of the .NET 'Type' that will perform the validation."},"iValidator":{"type":"string","title":"The name of the .NET Interface that the 'Validator' implements/inherits.","description":"Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'."},"validatorCode":{"type":"string","title":"The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified)."},"isMandatory":{"type":"boolean","title":"Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc)."},"layerPassing":{"type":"string","title":"The option that determines the layers in which the parameter is passed.","description":"Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.","enum":["All","ToManagerSet","ToManagerCollSet"]},"dataConverter":{"type":"string","title":"The data 'Converter' class name where specific data conversion is required.","description":"A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable."},"dataConverterIsGeneric":{"type":"boolean","title":"Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'."},"webApiFrom":{"type":"string","title":"The option for how the parameter will be delcared within the Web API Controller.","description":"Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.","enum":["FromQuery","FromBody","FromRoute","FromEntityProperties"]},"grpcType":{"type":"string","title":"The underlying gRPC data type; will be inferred where not specified."}},"required":["name"]},"Const":{"type":"object","title":"'Const' object (entity-driven)","description":"The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.","properties":{"name":{"type":"string","title":"The unique constant name."},"value":{"type":"string","title":"The .NET (C#) code for the constant value.","description":"The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code."},"text":{"type":"string","title":"The overriding text for use in comments.","description":"By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. '{{Xxx}}')."}},"required":["name","value"]}},"allOf":[{"$ref":"#/definitions/CodeGeneration"}]}
|
Provide a JSON object that satisfies the schema "JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).
|
schema-store
|
schema_store_300
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/entity.schema.json\",\"title\":\"Software Catalog Definition Versions [v2, v2.1, v2.2, v3]\",\"oneOf\":[{\"allOf\":[{\"properties\":{\"schema-version\":{\"const\":\"v2\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2/schema.json\"}]},{\"allOf\":[{\"properties\":{\"schema-version\":{\"const\":\"v2.1\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2.1/schema.json\"}]},{\"allOf\":[{\"properties\":{\"schema-version\":{\"const\":\"v2.2\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2.2/schema.json\"}]},{\"allOf\":[{\"properties\":{\"apiVersion\":{\"const\":\"v3\"},\"kind\":{\"const\":\"service\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/service.schema.json\"}]},{\"allOf\":[{\"properties\":{\"apiVersion\":{\"const\":\"v3\"},\"kind\":{\"const\":\"queue\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/queue.schema.json\"}]},{\"allOf\":[{\"properties\":{\"apiVersion\":{\"const\":\"v3\"},\"kind\":{\"const\":\"datastore\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/datastore.schema.json\"}]},{\"allOf\":[{\"properties\":{\"apiVersion\":{\"const\":\"v3\"},\"kind\":{\"const\":\"api\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/api.schema.json\"}]},{\"allOf\":[{\"properties\":{\"apiVersion\":{\"const\":\"v3\"},\"kind\":{\"const\":\"system\"}}},{\"$ref\":\"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/system.schema.json\"}]}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Software Catalog Definition Versions [v2, v2.1, v2.2, v3]\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/entity.schema.json","title":"Software Catalog Definition Versions [v2, v2.1, v2.2, v3]","oneOf":[{"allOf":[{"properties":{"schema-version":{"const":"v2"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2/schema.json"}]},{"allOf":[{"properties":{"schema-version":{"const":"v2.1"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2.1/schema.json"}]},{"allOf":[{"properties":{"schema-version":{"const":"v2.2"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v2.2/schema.json"}]},{"allOf":[{"properties":{"apiVersion":{"const":"v3"},"kind":{"const":"service"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/service.schema.json"}]},{"allOf":[{"properties":{"apiVersion":{"const":"v3"},"kind":{"const":"queue"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/queue.schema.json"}]},{"allOf":[{"properties":{"apiVersion":{"const":"v3"},"kind":{"const":"datastore"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/datastore.schema.json"}]},{"allOf":[{"properties":{"apiVersion":{"const":"v3"},"kind":{"const":"api"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/api.schema.json"}]},{"allOf":[{"properties":{"apiVersion":{"const":"v3"},"kind":{"const":"system"}}},{"$ref":"https://raw.githubusercontent.com/DataDog/schema/main/service-catalog/v3/system.schema.json"}]}]}
|
Provide a JSON object that satisfies the schema "Software Catalog Definition Versions [v2, v2.1, v2.2, v3]". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Software Catalog Definition Versions [v2, v2.1, v2.2, v3]
|
schema-store
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.