steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: More descriptions

This commit is contained in:
Ilya Kuznetsov 2025-01-10 16:37:22 +01:00
parent 954ef76fe9
commit d5d433e9d7
No known key found for this signature in database
GPG Key ID: 91F3DDCF5D21CDDF
3 changed files with 78 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bundle/internal/schema/annotations.go
View File

@ -102,7 +102,7 @@ func (d *annotationHandler) syncWithMissingAnnotations(outputPath string) error
return err return err
} }
var outputTyped annotationFile var outputTyped annotation.File
err = convert.ToTyped(&outputTyped, output) err = convert.ToTyped(&outputTyped, output)
if err != nil { if err != nil {
return err return err
@ -132,7 +132,7 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) {
s.Enum = a.Enum s.Enum = a.Enum
} }
func saveYamlWithStyle(outputPath string, annotations annotationFile) error { func saveYamlWithStyle(outputPath string, annotations annotation.File) error {
annotationOrder := yamlsaver.NewOrder([]string{"description", "markdown_description", "title", "default", "enum"}) annotationOrder := yamlsaver.NewOrder([]string{"description", "markdown_description", "title", "default", "enum"})
style := map[string]yaml3.Style{} style := map[string]yaml3.Style{}

32
bundle/internal/schema/annotations.yml
View File

@ -196,6 +196,7 @@ github.com/databricks/cli/bundle/config.Resources:
The volume definitions for the bundle, where each key is the name of the volume. The volume definitions for the bundle, where each key is the name of the volume.
"markdown_description": |- "markdown_description": |-
The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volume) The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volume)
github.com/databricks/cli/bundle/config.Root:
"artifacts": "artifacts":
"description": |- "description": |-
Defines the attributes to build an artifact Defines the attributes to build an artifact
@ -213,9 +214,9 @@ github.com/databricks/cli/bundle/config.Resources:
``` ```
"bundle": "bundle":
"description": |- "description": |-
The attributes of the bundle. The bundle attributes when deploying to this target.
"markdown_description": |- "markdown_description": |-
The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle). The bundle attributes when deploying to this target,
"experimental": "experimental":
"description": |- "description": |-
Defines attributes for experimental features. Defines attributes for experimental features.
@ -267,16 +268,20 @@ github.com/databricks/cli/bundle/config.Resources:
"description": |- "description": |-
The files and file paths to include or exclude in the bundle. The files and file paths to include or exclude in the bundle.
"markdown_description": |- "markdown_description": |-
The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/) The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/settings.md#sync).
"targets": "targets":
"description": |- "description": |-
Defines deployment targets for the bundle. Defines deployment targets for the bundle.
"markdown_description": |-
Defines deployment targets for the bundle. See [_](/dev-tools/bundles/settings.md#targets)
"variables": "variables":
"description": |- "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. 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": "workspace":
"description": |- "description": |-
Defines the Databricks workspace for the bundle. Defines the Databricks workspace for the bundle.
"markdown_description": |-
Defines the Databricks workspace for the bundle. See [_](/dev-tools/bundles/settings.md#workspace).
github.com/databricks/cli/bundle/config.Sync: github.com/databricks/cli/bundle/config.Sync:
"exclude": "exclude":
"description": |- "description": |-
@ -295,7 +300,7 @@ github.com/databricks/cli/bundle/config.Target:
The artifacts to include in the target deployment. See [_](#artifact) The artifacts to include in the target deployment. See [_](#artifact)
"bundle": "bundle":
"description": |- "description": |-
The name of the bundle when deploying to this target. The bundle attributes when deploying to this target.
"cluster_id": "cluster_id":
"description": |- "description": |-
The ID of the cluster to use for this target. The ID of the cluster to use for this target.
@ -308,8 +313,6 @@ github.com/databricks/cli/bundle/config.Target:
"git": "git":
"description": |- "description": |-
The Git version control settings for the target. The Git version control settings for the target.
"markdown_description": |-
The Git version control settings for the target. See [_](#git).
"mode": "mode":
"description": |- "description": |-
The deployment mode for the target. The deployment mode for the target.
@ -318,23 +321,17 @@ github.com/databricks/cli/bundle/config.Target:
"permissions": "permissions":
"description": |- "description": |-
The permissions for deploying and running the bundle in the target. The permissions for deploying and running the bundle in the target.
"markdown_description": |-
The permissions for deploying and running the bundle in the target. See [_](#permission).
"presets": "presets":
"description": |- "description": |-
The deployment presets for the target. The deployment presets for the target.
"markdown_description": |-
The deployment presets for the target. See [_](#preset).
"resources": "resources":
"description": |- "description": |-
The resource definitions for the target. The resource definitions for the target.
"markdown_description": |-
The resource definitions for the target. See [_](#resources).
"run_as": "run_as":
"description": |- "description": |-
The identity to use to run the bundle. The identity to use to run the bundle.
"markdown_description": |- "markdown_description": |-
The identity to use to run the bundle. See [_](#job_run_as) and [_](/dev-tools/bundles/run_as.md). The identity to use to run the bundle, see [_](/dev-tools/bundles/run-as.md).
"sync": "sync":
"description": |- "description": |-
The local paths to sync to the target workspace when a bundle is run or deployed. The local paths to sync to the target workspace when a bundle is run or deployed.
@ -344,7 +341,7 @@ github.com/databricks/cli/bundle/config.Target:
"description": |- "description": |-
The custom variable definitions for the target. The custom variable definitions for the target.
"markdown_description": |- "markdown_description": |-
The custom variable definitions for the target. See [_](/dev-tools/bundles/settings.md#variables) and [_](/dev-tools/bundles/variables.md). The custom variable definitions for the target. See [_](/dev-tools/bundles/variables.md).
"workspace": "workspace":
"description": |- "description": |-
The Databricks workspace for the target. The Databricks workspace for the target.
@ -492,3 +489,10 @@ github.com/databricks/cli/bundle/config/variable.Variable:
"type": "type":
"description": |- "description": |-
The type of the variable. The type of the variable.
github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs:
"service_principal_name":
"description": |-
The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.
"user_name":
"description": |-
The email of an active workspace user. Non-admin users can only set this field to their own email.

114
bundle/schema/jsonschema.json generated
View File

@ -845,7 +845,8 @@
"catalog_name", "catalog_name",
"name", "name",
"schema_name" "schema_name"
] ],
"markdownDescription": "The volume resource type allows you to define and create Unity Catalog [volumes](https://docs.databricks.com/api/workspace/volumes/create) as part of a bundle. When deploying a bundle with a volume defined, note that:\n\n* A volume cannot be referenced in the `artifact_path` for the bundle until it exists in the workspace. Hence, if you want to use Databricks Asset Bundles to create the volume, you must first define the volume in the bundle, deploy it to create the volume, then reference it in the `artifact_path`` in subsequent deployments.\n\n* Volumes in the bundle are not prepended with the `dev_${workspace.current_user.short_name}` prefix when the deployment target has `mode: development`` configured. However, you can manually configure this prefix. See [custom-presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#custom-presets)"
}, },
{ {
"type": "string", "type": "string",
@ -961,26 +962,25 @@
"type": "object", "type": "object",
"properties": { "properties": {
"build": { "build": {
"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 (\u0026\u0026) characters.", "description": "An optional set of non-default build commands to run locally before deployment.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"executable": { "executable": {
"description": "The executable type.", "description": "The executable type. Valid values are `bash`, `sh`, and `cmd`.",
"$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType" "$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType"
}, },
"files": { "files": {
"description": "The source files for the artifact.", "description": "The source files for the artifact.",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile"
"markdownDescription": "The source files for the artifact, defined as an [artifact_file](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact_file)."
}, },
"path": { "path": {
"description": "The location where the built artifact will be saved.", "description": "The location where the built artifact will be saved.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"type": { "type": {
"description": "The type of the artifact.", "description": "Required. The type of the artifact.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType",
"markdownDescription": "The type of the artifact. Valid values are `wheel` or `jar`" "markdownDescription": "Required. The type of the artifact. Valid values are `whl`."
} }
}, },
"additionalProperties": false, "additionalProperties": false,
@ -1000,7 +1000,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"source": { "source": {
"description": "The path of the files used to build the artifact.", "description": "Required. The path of the files used to build the artifact.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -1105,15 +1105,15 @@
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Python" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Python"
}, },
"python_wheel_wrapper": { "python_wheel_wrapper": {
"description": "Whether to use a Python wheel wrapper", "description": "Whether to use a Python wheel wrapper.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"scripts": { "scripts": {
"description": "The commands to run", "description": "The commands to run.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Command" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Command"
}, },
"use_legacy_run_as": { "use_legacy_run_as": {
"description": "Whether to use the legacy run_as behavior", "description": "Whether to use the legacy run_as behavior.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
} }
}, },
@ -1274,57 +1274,59 @@
"type": "object", "type": "object",
"properties": { "properties": {
"clusters": { "clusters": {
"description": "The cluster definitions for the bundle.", "description": "The cluster definitions for the bundle, where each key is the name of a cluster.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster",
"markdownDescription": "The cluster definitions for the bundle. See [cluster](https://docs.databricks.com/dev-tools/bundles/resources.html#cluster)" "markdownDescription": "The cluster definitions for the bundle, where each key is the name of a cluster. See [cluster](https://docs.databricks.com/dev-tools/bundles/resources.html#cluster)"
}, },
"dashboards": { "dashboards": {
"description": "The dashboard definitions for the bundle.", "description": "The dashboard definitions for the bundle, where each key is the name of the dashboard.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard",
"markdownDescription": "The dashboard definitions for the bundle. See [dashboard](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboard)" "markdownDescription": "The dashboard definitions for the bundle, where each key is the name of the dashboard. See [dashboard](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboard)"
}, },
"experiments": { "experiments": {
"description": "The experiment definitions for the bundle.", "description": "The experiment definitions for the bundle, where each key is the name of the experiment.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment",
"markdownDescription": "The experiment definitions for the bundle. See [experiment](https://docs.databricks.com/dev-tools/bundles/resources.html#experiment)" "markdownDescription": "The experiment definitions for the bundle, where each key is the name of the experiment. See [experiment](https://docs.databricks.com/dev-tools/bundles/resources.html#experiment)"
}, },
"jobs": { "jobs": {
"description": "The job definitions for the bundle.", "description": "The job definitions for the bundle, where each key is the name of the job.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job",
"markdownDescription": "The job definitions for the bundle. See [job](https://docs.databricks.com/dev-tools/bundles/resources.html#job)" "markdownDescription": "The job definitions for the bundle, where each key is the name of the job. See [job](https://docs.databricks.com/dev-tools/bundles/resources.html#job)"
}, },
"model_serving_endpoints": { "model_serving_endpoints": {
"description": "The model serving endpoint definitions for the bundle.", "description": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint",
"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)" "markdownDescription": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [model_serving_endpoint](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoint)"
}, },
"models": { "models": {
"description": "The model definitions for the bundle.", "description": "The model definitions for the bundle, where each key is the name of the model.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel",
"markdownDescription": "The model definitions for the bundle. See [model](https://docs.databricks.com/dev-tools/bundles/resources.html#model)" "markdownDescription": "The model definitions for the bundle, where each key is the name of the model. See [model-legacy](https://docs.databricks.com/dev-tools/bundles/resources.html#model-legacy)"
}, },
"pipelines": { "pipelines": {
"description": "The pipeline definitions for the bundle.", "description": "The pipeline definitions for the bundle, where each key is the name of the pipeline.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline",
"markdownDescription": "The pipeline definitions for the bundle. See [pipeline](https://docs.databricks.com/dev-tools/bundles/resources.html#pipeline)" "markdownDescription": "The pipeline definitions for the bundle, where each key is the name of the pipeline. See [pipeline](https://docs.databricks.com/dev-tools/bundles/resources.html#pipeline)"
}, },
"quality_monitors": { "quality_monitors": {
"description": "The quality monitor definitions for the bundle.", "description": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor",
"markdownDescription": "The quality monitor definitions for the bundle. See [quality_monitor](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitor)" "markdownDescription": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [quality-monitor](https://docs.databricks.com/dev-tools/bundles/resources.html#quality-monitor)"
}, },
"registered_models": { "registered_models": {
"description": "The registered model definitions for the bundle.", "description": "The registered model definitions for the bundle, where each key is the name of the \u003cUC\u003e registered model.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel",
"markdownDescription": "The registered model definitions for the bundle. See [registered_model](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_model)" "markdownDescription": "The registered model definitions for the bundle, where each key is the name of the \u003cUC\u003e registered model. See [registered-model](https://docs.databricks.com/dev-tools/bundles/resources.html#registered-model)"
}, },
"schemas": { "schemas": {
"description": "The schema definitions for the bundle.", "description": "The schema definitions for the bundle, where each key is the name of the schema.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema",
"markdownDescription": "The schema definitions for the bundle. See [schema](https://docs.databricks.com/dev-tools/bundles/resources.html#schema)" "markdownDescription": "The schema definitions for the bundle, where each key is the name of the schema. See [schema](https://docs.databricks.com/dev-tools/bundles/resources.html#schema)"
}, },
"volumes": { "volumes": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume" "description": "The volume definitions for the bundle, where each key is the name of the volume.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume",
"markdownDescription": "The volume definitions for the bundle, where each key is the name of the volume. See [volume](https://docs.databricks.com/dev-tools/bundles/resources.html#volume)"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -1372,7 +1374,7 @@
"markdownDescription": "The artifacts to include in the target deployment. See [artifact](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact)" "markdownDescription": "The artifacts to include in the target deployment. See [artifact](https://docs.databricks.com/dev-tools/bundles/reference.html#artifact)"
}, },
"bundle": { "bundle": {
"description": "The name of the bundle when deploying to this target.", "description": "The bundle attributes when deploying to this target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle"
}, },
"cluster_id": { "cluster_id": {
@ -1389,8 +1391,7 @@
}, },
"git": { "git": {
"description": "The Git version control settings for the target.", "description": "The Git version control settings for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git"
"markdownDescription": "The Git version control settings for the target. See [git](https://docs.databricks.com/dev-tools/bundles/reference.html#git)."
}, },
"mode": { "mode": {
"description": "The deployment mode for the target.", "description": "The deployment mode for the target.",
@ -1399,23 +1400,20 @@
}, },
"permissions": { "permissions": {
"description": "The permissions for deploying and running the bundle in the target.", "description": "The permissions for deploying and running the bundle in the target.",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission"
"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": { "presets": {
"description": "The deployment presets for the target.", "description": "The deployment presets for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets"
"markdownDescription": "The deployment presets for the target. See [preset](https://docs.databricks.com/dev-tools/bundles/reference.html#preset)."
}, },
"resources": { "resources": {
"description": "The resource definitions for the target.", "description": "The resource definitions for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources"
"markdownDescription": "The resource definitions for the target. See [resources](https://docs.databricks.com/dev-tools/bundles/reference.html#resources)."
}, },
"run_as": { "run_as": {
"description": "The identity to use to run the bundle.", "description": "The identity to use to run the bundle.",
"$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs",
"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)." "markdownDescription": "The identity to use to run the bundle, see [link](https://docs.databricks.com/dev-tools/bundles/run-as.html)."
}, },
"sync": { "sync": {
"description": "The local paths to sync to the target workspace when a bundle is run or deployed.", "description": "The local paths to sync to the target workspace when a bundle is run or deployed.",
@ -1425,7 +1423,7 @@
"variables": { "variables": {
"description": "The custom variable definitions for the target.", "description": "The custom variable definitions for the target.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable",
"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)." "markdownDescription": "The custom variable definitions for the target. See [link](https://docs.databricks.com/dev-tools/bundles/variables.html)."
}, },
"workspace": { "workspace": {
"description": "The Databricks workspace for the target.", "description": "The Databricks workspace for the target.",
@ -3102,7 +3100,7 @@
"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.", "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": { "properties": {
"service_principal_name": { "service_principal_name": {
"description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"user_name": { "user_name": {
@ -6406,12 +6404,13 @@
"properties": { "properties": {
"artifacts": { "artifacts": {
"description": "Defines the attributes to build an artifact", "description": "Defines the attributes to build an artifact",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact",
"markdownDescription": "Defines the attributes to build artifacts, where each key is the name of the artifact, and the value is a Map that defines the artifact build settings. For information about the `artifacts` mapping, see [artifacts](https://docs.databricks.com/dev-tools/bundles/settings.html#artifacts).\n\nArtifact settings defined in the top level of the bundle configuration can be overridden in the `targets` mapping. See [link](https://docs.databricks.com/dev-tools/bundles/artifact-overrides.html)."
}, },
"bundle": { "bundle": {
"description": "The attributes of the bundle.", "description": "The bundle attributes when deploying to this target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle",
"markdownDescription": "The attributes of the bundle. See [bundle](https://docs.databricks.com/dev-tools/bundles/settings.html#bundle)" "markdownDescription": "The bundle attributes when deploying to this target,"
}, },
"experimental": { "experimental": {
"description": "Defines attributes for experimental features.", "description": "Defines attributes for experimental features.",
@ -6423,9 +6422,9 @@
"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)" "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": { "permissions": {
"description": "Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle", "description": "Defines a permission for a specific entity.",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission",
"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)." "markdownDescription": "A Sequence that defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle, where each item in the sequence is a permission for a specific entity.\n\nSee [permissions](https://docs.databricks.com/dev-tools/bundles/settings.html#permissions) and [link](https://docs.databricks.com/dev-tools/bundles/permissions.html)."
}, },
"presets": { "presets": {
"description": "Defines bundle deployment presets.", "description": "Defines bundle deployment presets.",
@ -6433,22 +6432,24 @@
"markdownDescription": "Defines bundle deployment presets. See [presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#presets)." "markdownDescription": "Defines bundle deployment presets. See [presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#presets)."
}, },
"resources": { "resources": {
"description": "Specifies information about the Databricks resources used by the bundle", "description": "A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources",
"markdownDescription": "Specifies information about the Databricks resources used by the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/resources.html)." "markdownDescription": "A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about \u003cDABS\u003e supported resources, and resource definition reference, see [link](https://docs.databricks.com/dev-tools/bundles/resources.html).\n\n```yaml\nresources:\n \u003cresource-type\u003es:\n \u003cresource-name\u003e:\n \u003cresource-field-name\u003e: \u003cresource-field-value\u003e\n```"
}, },
"run_as": { "run_as": {
"description": "The identity to use to run the bundle.", "description": "The identity to use when running \u003cDABS\u003e workflows.",
"$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs" "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs",
"markdownDescription": "The identity to use when running \u003cDABS\u003e workflows. See [link](https://docs.databricks.com/dev-tools/bundles/run-as.html)."
}, },
"sync": { "sync": {
"description": "The files and file paths to include or exclude in the bundle.", "description": "The files and file paths to include or exclude in the bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync",
"markdownDescription": "The files and file paths to include or exclude in the bundle. See [link](https://docs.databricks.com/dev-tools/bundles/)" "markdownDescription": "The files and file paths to include or exclude in the bundle. See [sync](https://docs.databricks.com/dev-tools/bundles/settings.html#sync)."
}, },
"targets": { "targets": {
"description": "Defines deployment targets for the bundle.", "description": "Defines deployment targets for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target",
"markdownDescription": "Defines deployment targets for the bundle. See [targets](https://docs.databricks.com/dev-tools/bundles/settings.html#targets)"
}, },
"variables": { "variables": {
"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.", "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.",
@ -6456,7 +6457,8 @@
}, },
"workspace": { "workspace": {
"description": "Defines the Databricks workspace for the bundle.", "description": "Defines the Databricks workspace for the bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace",
"markdownDescription": "Defines the Databricks workspace for the bundle. See [workspace](https://docs.databricks.com/dev-tools/bundles/settings.html#workspace)."
} }
}, },
"additionalProperties": false "additionalProperties": false