diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index 1cec48c3f50..ec258fef9f0 100644 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -7,6 +7,7 @@ ### CLI ### Bundles +* Add documentation for the common bundle resource fields `permissions`, `lifecycle`, and `grants` in the JSON schema, so they surface in editor completions and the docs. * `bundle run` now prints the modern job run URL (`/jobs//runs/`) so that non-admin users permitted to view the run are taken to the run instead of the workspace homepage. * Fix missing field descriptions in the bundle JSON schema for fields whose upstream API docs arrived after the field was first annotated (e.g. `vector_search_endpoints.*.target_qps`); stale placeholder markers no longer hide them ([#5588](https://github.com/databricks/cli/pull/5588)). diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 3adb9e9e740..2791e91f463 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -282,10 +282,24 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "schedule": "description": |- PLACEHOLDER @@ -349,20 +363,34 @@ resources: PLACEHOLDER "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "resources": "$fields": "app": @@ -476,10 +504,22 @@ resources: "$fields": "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "managed_encryption_settings": "$fields": "azure_encryption_settings": @@ -540,20 +580,34 @@ resources: Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses in direct deployment mode. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "dashboards": "description": |- The dashboard definitions for the bundle, where each key is the name of the dashboard. @@ -621,7 +675,21 @@ resources: This field is excluded in List Dashboards responses. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- @@ -672,7 +740,21 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "experiments": "description": |- The experiment definitions for the bundle, where each key is the name of the experiment. @@ -700,20 +782,34 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "external_locations": "description": |- PLACEHOLDER @@ -753,10 +849,22 @@ resources: AWS_SSE_S3 "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "genie_spaces": "description": |- PLACEHOLDER @@ -772,13 +880,27 @@ resources: Local path to a `.geniespace.json` file holding the serialized Genie space definition. The contents are inlined into `serialized_space` at deploy time. Mutually exclusive with an inline `serialized_space`. "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "parent_path": "description": |- Workspace folder under which to create the Genie space. Immutable: changing this field recreates the resource. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "serialized_space": "description": |- Serialized Genie space body. May be provided inline as a JSON string (or YAML that will be marshalled to JSON) or referenced via `file_path`. To round-trip an existing space into a bundle, use `databricks bundle generate genie-space`. @@ -857,20 +979,34 @@ resources: Lifecycle setting to prevent the resource from being destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "run_as": "$fields": "service_principal_name": @@ -987,20 +1123,34 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "models": "description": |- The model definitions for the bundle, where each key is the name of the model. @@ -1015,20 +1165,34 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "pipelines": "description": |- The pipeline definitions for the bundle, where each key is the name of the pipeline. @@ -1119,20 +1283,34 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "trigger": "deprecation_message": |- Use continuous instead @@ -1165,7 +1343,7 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "no_expiry": "description": |- PLACEHOLDER @@ -1202,7 +1380,7 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "postgres_database": "description": |- PLACEHOLDER @@ -1215,7 +1393,7 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "parent": "description": |- PLACEHOLDER @@ -1249,7 +1427,7 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "no_suspension": "description": |- PLACEHOLDER @@ -1292,10 +1470,24 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "pg_version": "description": |- PLACEHOLDER @@ -1330,7 +1522,7 @@ resources: The type of the Databricks managed identity that this Role represents. Leave empty to create a regular Postgres role not associated with a Databricks identity. "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "membership_roles": "description": |- Standard roles that this role is a member of. @@ -1361,7 +1553,7 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "new_pipeline_spec": "description": |- PLACEHOLDER @@ -1461,7 +1653,19 @@ resources: "$fields": "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. @@ -1519,7 +1723,19 @@ resources: "$fields": "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. @@ -1589,20 +1805,34 @@ resources: Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "$fields": "group_name": "description": |- - PLACEHOLDER + The name of the group that has the permission set in level. "level": "description": |- - PLACEHOLDER + The allowed permission for user, group, service principal defined for this permission. "service_principal_name": "description": |- - PLACEHOLDER + The name of the service principal that has the permission set in level. "user_name": "description": |- - PLACEHOLDER + The name of the user that has the permission set in level. "tags": "$fields": "custom_tags": @@ -1628,27 +1858,53 @@ resources: PLACEHOLDER "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "vector_search_endpoints": "description": |- PLACEHOLDER "$fields": "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "permissions": "description": |- - PLACEHOLDER + The permissions to apply to this resource. + "markdown_description": |- + A Sequence that defines the permissions to apply to this resource, where each item in the sequence is a permission for a specific entity. + + See [\_](/dev-tools/bundles/settings.md#permissions) and [\_](/dev-tools/bundles/permissions.md). + "markdown_examples": |- + ```yaml + permissions: + - level: CAN_VIEW + group_name: test-group + - level: CAN_MANAGE + user_name: someone@example.com + - level: CAN_RUN + service_principal_name: 123456-abcdef + ``` "vector_search_indexes": "description": |- PLACEHOLDER "$fields": "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- - PLACEHOLDER + Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. "volumes": "description": |- The volume definitions for the bundle, where each key is the name of the volume. @@ -1677,7 +1933,19 @@ resources: "$fields": "grants": "description": |- - PLACEHOLDER + The Unity Catalog privileges to grant to principals on this securable. + "markdown_description": |- + A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal. + "markdown_examples": |- + ```yaml + grants: + - principal: account users + privileges: + - SELECT + - principal: data-engineers + privileges: + - ALL_PRIVILEGES + ``` "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 1afe4321798..a9f72589fb5 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -99,6 +99,7 @@ "$ref": "#/$defs/string" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent_path": { @@ -106,7 +107,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "query_text": { "description": "[Public Preview] Text of the query to be run.", @@ -194,7 +197,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.AppPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.AppPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "resources": { "description": "Resources for the app.", @@ -285,15 +290,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -326,9 +335,12 @@ "$ref": "#/$defs/int64" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "managed_encryption_settings": { @@ -470,7 +482,9 @@ "$ref": "#/$defs/int" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ClusterPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ClusterPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "policy_id": { "description": "The ID of the cluster policy used to create the cluster if applicable.", @@ -536,15 +550,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -611,7 +629,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "serialized_dashboard": { "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.", @@ -713,7 +733,9 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "retention_window_in_days": { "description": "[Public Preview] The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", @@ -769,9 +791,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.FileEventQueue" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { @@ -821,6 +846,7 @@ "$ref": "#/$defs/string" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent_path": { @@ -828,7 +854,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "serialized_space": { "description": "Serialized Genie space body. May be provided inline as a JSON string (or YAML that will be marshalled to JSON) or referenced via `file_path`. To round-trip an existing space into a bundle, use `databricks bundle generate genie-space`.", @@ -913,7 +941,9 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.JobPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.JobPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "queue": { "description": "The queue settings of the job.", @@ -969,15 +999,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -1050,7 +1084,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowExperimentPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowExperimentPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "tags": { "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", @@ -1075,15 +1111,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -1116,7 +1156,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowModelPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowModelPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "tags": { "description": "Additional metadata for registered model.", @@ -1141,15 +1183,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.RegisteredModelPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -1197,7 +1243,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ModelServingEndpointPermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ModelServingEndpointPermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "rate_limits": { "description": "Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.", @@ -1232,15 +1280,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -1376,7 +1428,9 @@ "$ref": "#/$defs/map/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "photon": { "description": "Whether Photon is enabled for this pipeline.", @@ -1452,15 +1506,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinePermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -1490,6 +1548,7 @@ "$ref": "#/$defs/bool" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "no_expiry": { @@ -1541,6 +1600,7 @@ "$ref": "#/$defs/bool" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "postgres_database": { @@ -1568,6 +1628,7 @@ "$ref": "#/$defs/string" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent": { @@ -1616,6 +1677,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "no_suspension": { @@ -1674,10 +1736,13 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "pg_version": { "$ref": "#/$defs/int" @@ -1718,6 +1783,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleIdentityType" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "membership_roles": { @@ -1767,6 +1833,7 @@ "$ref": "#/$defs/string" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "new_pipeline_spec": { @@ -1923,7 +1990,9 @@ "$ref": "#/$defs/string" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "lifecycle": { "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", @@ -1985,7 +2054,9 @@ "$ref": "#/$defs/int64" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "lifecycle": { "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", @@ -2156,7 +2227,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "spot_instance_policy": { "description": "Configurations whether the endpoint should use spot instances.", @@ -2185,15 +2258,19 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group that has the permission set in level.", "$ref": "#/$defs/string" }, "level": { + "description": "The allowed permission for user, group, service principal defined for this permission.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.WarehousePermissionLevel" }, "service_principal_name": { + "description": "The name of the service principal that has the permission set in level.", "$ref": "#/$defs/string" }, "user_name": { + "description": "The name of the user that has the permission set in level.", "$ref": "#/$defs/string" } }, @@ -2218,6 +2295,7 @@ "$ref": "#/$defs/string" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "logical_database_name": { @@ -2258,6 +2336,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { @@ -2265,7 +2344,9 @@ "$ref": "#/$defs/string" }, "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence that defines the permissions to apply to this resource, 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)." }, "target_qps": { "description": "[Public Preview] Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", @@ -2308,7 +2389,9 @@ "$ref": "#/$defs/string" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "index_subtype": { "description": "[Beta] The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", @@ -2319,6 +2402,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType" }, "lifecycle": { + "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { @@ -2358,7 +2442,9 @@ "$ref": "#/$defs/string" }, "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" + "description": "The Unity Catalog privileges to grant to principals on this securable.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence that defines the Unity Catalog privilege grants for this securable, where each item grants a set of privileges to a principal." }, "lifecycle": { "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.",