diff --git a/.codegen/service.go.tmpl b/.codegen/service.go.tmpl index 16c7dc97..cdabd196 100644 --- a/.codegen/service.go.tmpl +++ b/.codegen/service.go.tmpl @@ -24,6 +24,9 @@ var Cmd = &cobra.Command{ Short: `{{.Summary | without "`"}}`, Long: `{{.Comment " " 80 | without "`"}}`, {{- end}} + Annotations: map[string]string{ + "package": "{{ .Package.Name }}", + }, } {{- $serviceName := .KebabName -}} diff --git a/cmd/account/access-control/access-control.go b/cmd/account/access-control/access-control.go index ce695a9b..2ffa97bf 100755 --- a/cmd/account/access-control/access-control.go +++ b/cmd/account/access-control/access-control.go @@ -18,6 +18,9 @@ var Cmd = &cobra.Command{ Long: `These APIs manage access rules on resources in an account. Currently, only grant rules are supported. A grant rule specifies a role assigned to a set of principals. A list of rules attached to a resource is called a rule set.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start get command diff --git a/cmd/account/billable-usage/billable-usage.go b/cmd/account/billable-usage/billable-usage.go index 3dc4eef4..01010483 100755 --- a/cmd/account/billable-usage/billable-usage.go +++ b/cmd/account/billable-usage/billable-usage.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Short: `This API allows you to download billable usage logs for the specified account and date range.`, Long: `This API allows you to download billable usage logs for the specified account and date range. This feature works with all account types.`, + Annotations: map[string]string{ + "package": "billing", + }, } // start download command diff --git a/cmd/account/budgets/budgets.go b/cmd/account/budgets/budgets.go index ff39aacf..0793228d 100755 --- a/cmd/account/budgets/budgets.go +++ b/cmd/account/budgets/budgets.go @@ -17,6 +17,9 @@ var Cmd = &cobra.Command{ Short: `These APIs manage budget configuration including notifications for exceeding a budget for a period.`, Long: `These APIs manage budget configuration including notifications for exceeding a budget for a period. They can also retrieve the status of each budget.`, + Annotations: map[string]string{ + "package": "billing", + }, } // start create command diff --git a/cmd/account/credentials/credentials.go b/cmd/account/credentials/credentials.go index 0b2abb80..c94b5d34 100755 --- a/cmd/account/credentials/credentials.go +++ b/cmd/account/credentials/credentials.go @@ -20,6 +20,9 @@ var Cmd = &cobra.Command{ Databricks can deploy clusters in the appropriate VPC for the new workspace. A credential configuration encapsulates this role information, and its ID is used when creating a new workspace.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/custom-app-integration/custom-app-integration.go b/cmd/account/custom-app-integration/custom-app-integration.go index 953a7c12..377c02a1 100755 --- a/cmd/account/custom-app-integration/custom-app-integration.go +++ b/cmd/account/custom-app-integration/custom-app-integration.go @@ -22,6 +22,9 @@ var Cmd = &cobra.Command{ **Note:** You can only add/use the OAuth custom application integrations when OAuth enrollment status is enabled. For more details see :method:OAuthEnrollment/create`, + Annotations: map[string]string{ + "package": "oauth2", + }, } // start create command diff --git a/cmd/account/encryption-keys/encryption-keys.go b/cmd/account/encryption-keys/encryption-keys.go index 4cd9c71f..b63610b9 100755 --- a/cmd/account/encryption-keys/encryption-keys.go +++ b/cmd/account/encryption-keys/encryption-keys.go @@ -31,6 +31,9 @@ var Cmd = &cobra.Command{ encryption requires that the workspace is on the E2 version of the platform. If you have an older workspace, it might not be on the E2 version of the platform. If you are not sure, contact your Databricks representative.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/groups/groups.go b/cmd/account/groups/groups.go index 6b5db414..78c6aafe 100755 --- a/cmd/account/groups/groups.go +++ b/cmd/account/groups/groups.go @@ -22,6 +22,9 @@ var Cmd = &cobra.Command{ in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/account/ip-access-lists/ip-access-lists.go b/cmd/account/ip-access-lists/ip-access-lists.go index 1719dce8..2cef636e 100755 --- a/cmd/account/ip-access-lists/ip-access-lists.go +++ b/cmd/account/ip-access-lists/ip-access-lists.go @@ -37,6 +37,9 @@ var Cmd = &cobra.Command{ After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.`, + Annotations: map[string]string{ + "package": "settings", + }, } // start create command diff --git a/cmd/account/log-delivery/log-delivery.go b/cmd/account/log-delivery/log-delivery.go index f42b9d54..79d1a4ae 100755 --- a/cmd/account/log-delivery/log-delivery.go +++ b/cmd/account/log-delivery/log-delivery.go @@ -75,6 +75,9 @@ var Cmd = &cobra.Command{ [Billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html [Usage page]: https://docs.databricks.com/administration-guide/account-settings/usage.html [create a new AWS S3 bucket]: https://docs.databricks.com/administration-guide/account-api/aws-storage.html`, + Annotations: map[string]string{ + "package": "billing", + }, } // start create command diff --git a/cmd/account/metastore-assignments/metastore-assignments.go b/cmd/account/metastore-assignments/metastore-assignments.go index 22b4091d..8e746801 100755 --- a/cmd/account/metastore-assignments/metastore-assignments.go +++ b/cmd/account/metastore-assignments/metastore-assignments.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Use: "metastore-assignments", Short: `These APIs manage metastore assignments to a workspace.`, Long: `These APIs manage metastore assignments to a workspace.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/account/metastores/metastores.go b/cmd/account/metastores/metastores.go index a828d605..1755e98a 100755 --- a/cmd/account/metastores/metastores.go +++ b/cmd/account/metastores/metastores.go @@ -15,6 +15,9 @@ var Cmd = &cobra.Command{ Short: `These APIs manage Unity Catalog metastores for an account.`, Long: `These APIs manage Unity Catalog metastores for an account. A metastore contains catalogs that can be associated with workspaces`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/account/networks/networks.go b/cmd/account/networks/networks.go index 4b0bf063..a1030eaa 100755 --- a/cmd/account/networks/networks.go +++ b/cmd/account/networks/networks.go @@ -17,6 +17,9 @@ var Cmd = &cobra.Command{ Short: `These APIs manage network configurations for customer-managed VPCs (optional).`, Long: `These APIs manage network configurations for customer-managed VPCs (optional). Its ID is used when creating a new workspace if you use customer-managed VPCs.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/o-auth-enrollment/o-auth-enrollment.go b/cmd/account/o-auth-enrollment/o-auth-enrollment.go index b790e2d7..44a3b7fa 100755 --- a/cmd/account/o-auth-enrollment/o-auth-enrollment.go +++ b/cmd/account/o-auth-enrollment/o-auth-enrollment.go @@ -18,6 +18,9 @@ var Cmd = &cobra.Command{ **Note:** Your account must be on the E2 version to use these APIs, this is because OAuth is only supported on the E2 version.`, + Annotations: map[string]string{ + "package": "oauth2", + }, } // start create command diff --git a/cmd/account/private-access/private-access.go b/cmd/account/private-access/private-access.go index bc91e1b5..3c45b30e 100755 --- a/cmd/account/private-access/private-access.go +++ b/cmd/account/private-access/private-access.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Use: "private-access", Short: `These APIs manage private access settings for this account.`, Long: `These APIs manage private access settings for this account.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/published-app-integration/published-app-integration.go b/cmd/account/published-app-integration/published-app-integration.go index cc544800..d7ff8a08 100755 --- a/cmd/account/published-app-integration/published-app-integration.go +++ b/cmd/account/published-app-integration/published-app-integration.go @@ -20,6 +20,9 @@ var Cmd = &cobra.Command{ **Note:** You can only add/use the OAuth published application integrations when OAuth enrollment status is enabled. For more details see :method:OAuthEnrollment/create`, + Annotations: map[string]string{ + "package": "oauth2", + }, } // start create command diff --git a/cmd/account/service-principal-secrets/service-principal-secrets.go b/cmd/account/service-principal-secrets/service-principal-secrets.go index ef69afe0..34f7e7d0 100755 --- a/cmd/account/service-principal-secrets/service-principal-secrets.go +++ b/cmd/account/service-principal-secrets/service-principal-secrets.go @@ -28,6 +28,9 @@ var Cmd = &cobra.Command{ [Authentication using OAuth tokens for service principals]: https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform Provider]: https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal`, + Annotations: map[string]string{ + "package": "oauth2", + }, } // start create command diff --git a/cmd/account/service-principals/service-principals.go b/cmd/account/service-principals/service-principals.go index 7be4bc5a..9cff5fff 100755 --- a/cmd/account/service-principals/service-principals.go +++ b/cmd/account/service-principals/service-principals.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ production data run with service principals, interactive users do not need any write, delete, or modify privileges in production. This eliminates the risk of a user overwriting production data by accident.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/account/settings/settings.go b/cmd/account/settings/settings.go index 2c689be7..556ceb55 100755 --- a/cmd/account/settings/settings.go +++ b/cmd/account/settings/settings.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "settings", Short: `TBD.`, Long: `TBD`, + Annotations: map[string]string{ + "package": "settings", + }, } // start read-personal-compute-setting command diff --git a/cmd/account/storage-credentials/storage-credentials.go b/cmd/account/storage-credentials/storage-credentials.go index 72e18750..1065ba25 100755 --- a/cmd/account/storage-credentials/storage-credentials.go +++ b/cmd/account/storage-credentials/storage-credentials.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "storage-credentials", Short: `These APIs manage storage credentials for a particular metastore.`, Long: `These APIs manage storage credentials for a particular metastore.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/account/storage/storage.go b/cmd/account/storage/storage.go index feedab5e..c3cf7ec3 100755 --- a/cmd/account/storage/storage.go +++ b/cmd/account/storage/storage.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ bucket for storage of non-production DBFS data. A storage configuration encapsulates this bucket information, and its ID is used when creating a new workspace.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/users/users.go b/cmd/account/users/users.go index 8d976b9a..4f61522c 100755 --- a/cmd/account/users/users.go +++ b/cmd/account/users/users.go @@ -26,6 +26,9 @@ var Cmd = &cobra.Command{ provider and that user’s account will also be removed from Databricks account. This ensures a consistent offboarding process and prevents unauthorized users from accessing sensitive data.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/account/vpc-endpoints/vpc-endpoints.go b/cmd/account/vpc-endpoints/vpc-endpoints.go index 1cb72927..abdbcfa8 100755 --- a/cmd/account/vpc-endpoints/vpc-endpoints.go +++ b/cmd/account/vpc-endpoints/vpc-endpoints.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Use: "vpc-endpoints", Short: `These APIs manage VPC endpoint configurations for this account.`, Long: `These APIs manage VPC endpoint configurations for this account.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/account/workspace-assignment/workspace-assignment.go b/cmd/account/workspace-assignment/workspace-assignment.go index f9a25bad..80f5b2d6 100755 --- a/cmd/account/workspace-assignment/workspace-assignment.go +++ b/cmd/account/workspace-assignment/workspace-assignment.go @@ -17,6 +17,9 @@ var Cmd = &cobra.Command{ Short: `The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account.`, Long: `The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start delete command diff --git a/cmd/account/workspaces/workspaces.go b/cmd/account/workspaces/workspaces.go index 2e2dd0b9..621e9e2c 100755 --- a/cmd/account/workspaces/workspaces.go +++ b/cmd/account/workspaces/workspaces.go @@ -24,6 +24,9 @@ var Cmd = &cobra.Command{ These endpoints are available if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.`, + Annotations: map[string]string{ + "package": "provisioning", + }, } // start create command diff --git a/cmd/workspace/alerts/alerts.go b/cmd/workspace/alerts/alerts.go index 5cdb0d48..2928dfeb 100755 --- a/cmd/workspace/alerts/alerts.go +++ b/cmd/workspace/alerts/alerts.go @@ -20,6 +20,9 @@ var Cmd = &cobra.Command{ its result, and notifies one or more users and/or notification destinations if the condition was met. Alerts can be scheduled using the sql_task type of the Jobs API, e.g. :method:jobs/create.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start create command diff --git a/cmd/workspace/catalogs/catalogs.go b/cmd/workspace/catalogs/catalogs.go index 4e8aa9d7..6bb30f59 100755 --- a/cmd/workspace/catalogs/catalogs.go +++ b/cmd/workspace/catalogs/catalogs.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ data centrally across all of the workspaces in a Databricks account. Users in different workspaces can share access to the same data, depending on privileges granted centrally in Unity Catalog.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/cluster-policies/cluster-policies.go b/cmd/workspace/cluster-policies/cluster-policies.go index 5de2067d..e4a7da0f 100755 --- a/cmd/workspace/cluster-policies/cluster-policies.go +++ b/cmd/workspace/cluster-policies/cluster-policies.go @@ -39,6 +39,9 @@ var Cmd = &cobra.Command{ Only admin users can create, edit, and delete policies. Admin users also have access to all policies.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start create command diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go index f33914d7..36862338 100755 --- a/cmd/workspace/clusters/clusters.go +++ b/cmd/workspace/clusters/clusters.go @@ -43,6 +43,9 @@ var Cmd = &cobra.Command{ recently terminated by the job scheduler. To keep an all-purpose cluster configuration even after it has been terminated for more than 30 days, an administrator can pin a cluster to the cluster list.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start change-owner command diff --git a/cmd/workspace/connections/connections.go b/cmd/workspace/connections/connections.go index 6b0f11a6..a585013b 100755 --- a/cmd/workspace/connections/connections.go +++ b/cmd/workspace/connections/connections.go @@ -26,6 +26,9 @@ var Cmd = &cobra.Command{ may create different types of connections with each connection having a unique set of configuration options to support credential management and other settings.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/current-user/current-user.go b/cmd/workspace/current-user/current-user.go index 8dc2e580..ef493208 100755 --- a/cmd/workspace/current-user/current-user.go +++ b/cmd/workspace/current-user/current-user.go @@ -13,6 +13,9 @@ var Cmd = &cobra.Command{ Short: `This API allows retrieving information about currently authenticated user or service principal.`, Long: `This API allows retrieving information about currently authenticated user or service principal.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start me command diff --git a/cmd/workspace/dashboards/dashboards.go b/cmd/workspace/dashboards/dashboards.go index 315d1e74..24277603 100755 --- a/cmd/workspace/dashboards/dashboards.go +++ b/cmd/workspace/dashboards/dashboards.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ since you can get a dashboard definition with a GET request and then POST it to create a new one. Dashboards can be scheduled using the sql_task type of the Jobs API, e.g. :method:jobs/create.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start create command diff --git a/cmd/workspace/data-sources/data-sources.go b/cmd/workspace/data-sources/data-sources.go index d9983eee..cd1d1ebc 100755 --- a/cmd/workspace/data-sources/data-sources.go +++ b/cmd/workspace/data-sources/data-sources.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ in your workspace. We advise you to use any text editor, REST client, or grep to search the response from this API for the name of your SQL warehouse as it appears in Databricks SQL.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start list command diff --git a/cmd/workspace/experiments/experiments.go b/cmd/workspace/experiments/experiments.go index 97b05c13..be5176c9 100755 --- a/cmd/workspace/experiments/experiments.go +++ b/cmd/workspace/experiments/experiments.go @@ -24,6 +24,9 @@ var Cmd = &cobra.Command{ Experiments are located in the workspace file tree. You manage experiments using the same tools you use to manage other workspace objects such as folders, notebooks, and libraries.`, + Annotations: map[string]string{ + "package": "ml", + }, } // start create-experiment command diff --git a/cmd/workspace/external-locations/external-locations.go b/cmd/workspace/external-locations/external-locations.go index 947460af..2ff6cea9 100755 --- a/cmd/workspace/external-locations/external-locations.go +++ b/cmd/workspace/external-locations/external-locations.go @@ -26,6 +26,9 @@ var Cmd = &cobra.Command{ To create external locations, you must be a metastore admin or a user with the **CREATE_EXTERNAL_LOCATION** privilege.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/functions/functions.go b/cmd/workspace/functions/functions.go index 34800f30..e3c9fef2 100755 --- a/cmd/workspace/functions/functions.go +++ b/cmd/workspace/functions/functions.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ invoked wherever a table reference is allowed in a query. In Unity Catalog, a function resides at the same level as a table, so it can be referenced with the form __catalog_name__.__schema_name__.__function_name__.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/git-credentials/git-credentials.go b/cmd/workspace/git-credentials/git-credentials.go index 7ac5b020..69f2c7e8 100755 --- a/cmd/workspace/git-credentials/git-credentials.go +++ b/cmd/workspace/git-credentials/git-credentials.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ See [more info]. [more info]: https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html`, + Annotations: map[string]string{ + "package": "workspace", + }, } // start create command diff --git a/cmd/workspace/global-init-scripts/global-init-scripts.go b/cmd/workspace/global-init-scripts/global-init-scripts.go index 3a2c3b64..850539bd 100755 --- a/cmd/workspace/global-init-scripts/global-init-scripts.go +++ b/cmd/workspace/global-init-scripts/global-init-scripts.go @@ -24,6 +24,9 @@ var Cmd = &cobra.Command{ script returns with a bad exit code, the Apache Spark container fails to launch and init scripts with later position are skipped. If enough containers fail, the entire cluster fails with a GLOBAL_INIT_SCRIPT_FAILURE error code.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start create command diff --git a/cmd/workspace/grants/grants.go b/cmd/workspace/grants/grants.go index c6fa81a7..9204f760 100755 --- a/cmd/workspace/grants/grants.go +++ b/cmd/workspace/grants/grants.go @@ -26,6 +26,9 @@ var Cmd = &cobra.Command{ automatically grants the privilege to all current and future objects within the catalog. Similarly, privileges granted on a schema are inherited by all current and future objects within that schema.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start get command diff --git a/cmd/workspace/groups/groups.go b/cmd/workspace/groups/groups.go index aa5a7e35..1aec4665 100755 --- a/cmd/workspace/groups/groups.go +++ b/cmd/workspace/groups/groups.go @@ -22,6 +22,9 @@ var Cmd = &cobra.Command{ in Unity Catalog to groups, instead of to users individually. All Databricks workspace identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/workspace/instance-pools/instance-pools.go b/cmd/workspace/instance-pools/instance-pools.go index c80feb59..322a5583 100755 --- a/cmd/workspace/instance-pools/instance-pools.go +++ b/cmd/workspace/instance-pools/instance-pools.go @@ -33,6 +33,9 @@ var Cmd = &cobra.Command{ Databricks does not charge DBUs while instances are idle in the pool. Instance provider billing does apply. See pricing.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start create command diff --git a/cmd/workspace/instance-profiles/instance-profiles.go b/cmd/workspace/instance-profiles/instance-profiles.go index c68b8f3d..a5bbb6f5 100755 --- a/cmd/workspace/instance-profiles/instance-profiles.go +++ b/cmd/workspace/instance-profiles/instance-profiles.go @@ -19,6 +19,9 @@ var Cmd = &cobra.Command{ instance profiles for more information. [Secure access to S3 buckets]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html`, + Annotations: map[string]string{ + "package": "compute", + }, } // start add command diff --git a/cmd/workspace/ip-access-lists/ip-access-lists.go b/cmd/workspace/ip-access-lists/ip-access-lists.go index bbefc063..ad74cd7c 100755 --- a/cmd/workspace/ip-access-lists/ip-access-lists.go +++ b/cmd/workspace/ip-access-lists/ip-access-lists.go @@ -36,6 +36,9 @@ var Cmd = &cobra.Command{ After changes to the IP access list feature, it can take a few minutes for changes to take effect.`, + Annotations: map[string]string{ + "package": "settings", + }, } // start create command diff --git a/cmd/workspace/jobs/jobs.go b/cmd/workspace/jobs/jobs.go index fd79ee86..ccf7d94d 100755 --- a/cmd/workspace/jobs/jobs.go +++ b/cmd/workspace/jobs/jobs.go @@ -34,6 +34,9 @@ var Cmd = &cobra.Command{ [Databricks CLI]: https://docs.databricks.com/dev-tools/cli/index.html [Secrets CLI]: https://docs.databricks.com/dev-tools/cli/secrets-cli.html [Secrets utility]: https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-secrets`, + Annotations: map[string]string{ + "package": "jobs", + }, } // start cancel-all-runs command diff --git a/cmd/workspace/libraries/libraries.go b/cmd/workspace/libraries/libraries.go index 368fe37e..b2d3badf 100755 --- a/cmd/workspace/libraries/libraries.go +++ b/cmd/workspace/libraries/libraries.go @@ -35,6 +35,9 @@ var Cmd = &cobra.Command{ When you uninstall a library from a cluster, the library is removed only when you restart the cluster. Until you restart the cluster, the status of the uninstalled library appears as Uninstall pending restart.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start all-cluster-statuses command diff --git a/cmd/workspace/metastores/metastores.go b/cmd/workspace/metastores/metastores.go index 4df439d4..b61974ee 100755 --- a/cmd/workspace/metastores/metastores.go +++ b/cmd/workspace/metastores/metastores.go @@ -28,6 +28,9 @@ var Cmd = &cobra.Command{ workspaces created before Unity Catalog was released. If your workspace includes a legacy Hive metastore, the data in that metastore is available in a catalog named hive_metastore.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start assign command diff --git a/cmd/workspace/model-registry/model-registry.go b/cmd/workspace/model-registry/model-registry.go index 1bfff481..e180b869 100755 --- a/cmd/workspace/model-registry/model-registry.go +++ b/cmd/workspace/model-registry/model-registry.go @@ -17,6 +17,9 @@ var Cmd = &cobra.Command{ Short: `MLflow Model Registry is a centralized model repository and a UI and set of APIs that enable you to manage the full lifecycle of MLflow Models.`, Long: `MLflow Model Registry is a centralized model repository and a UI and set of APIs that enable you to manage the full lifecycle of MLflow Models.`, + Annotations: map[string]string{ + "package": "ml", + }, } // start approve-transition-request command diff --git a/cmd/workspace/permissions/permissions.go b/cmd/workspace/permissions/permissions.go index e130dc3c..d053efac 100755 --- a/cmd/workspace/permissions/permissions.go +++ b/cmd/workspace/permissions/permissions.go @@ -15,6 +15,9 @@ var Cmd = &cobra.Command{ Short: `Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints.`, Long: `Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start get command diff --git a/cmd/workspace/pipelines/pipelines.go b/cmd/workspace/pipelines/pipelines.go index 95d49db8..358124f5 100755 --- a/cmd/workspace/pipelines/pipelines.go +++ b/cmd/workspace/pipelines/pipelines.go @@ -30,6 +30,9 @@ var Cmd = &cobra.Command{ quality with Delta Live Tables expectations. Expectations allow you to define expected data quality and specify how to handle records that fail those expectations.`, + Annotations: map[string]string{ + "package": "pipelines", + }, } // start create command diff --git a/cmd/workspace/policy-families/policy-families.go b/cmd/workspace/policy-families/policy-families.go index 284cfc99..fa68c430 100755 --- a/cmd/workspace/policy-families/policy-families.go +++ b/cmd/workspace/policy-families/policy-families.go @@ -22,6 +22,9 @@ var Cmd = &cobra.Command{ Policy families cannot be used directly to create clusters. Instead, you create cluster policies using a policy family. Cluster policies created using a policy family inherit the policy family's policy definition.`, + Annotations: map[string]string{ + "package": "compute", + }, } // start get command diff --git a/cmd/workspace/providers/providers.go b/cmd/workspace/providers/providers.go index 3fd23752..b6dc8b3c 100755 --- a/cmd/workspace/providers/providers.go +++ b/cmd/workspace/providers/providers.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Use: "providers", Short: `Databricks Providers REST API.`, Long: `Databricks Providers REST API`, + Annotations: map[string]string{ + "package": "sharing", + }, } // start create command diff --git a/cmd/workspace/queries/queries.go b/cmd/workspace/queries/queries.go index ea4d2bac..2f314cd8 100755 --- a/cmd/workspace/queries/queries.go +++ b/cmd/workspace/queries/queries.go @@ -19,6 +19,9 @@ var Cmd = &cobra.Command{ definitions include the target SQL warehouse, query text, name, description, tags, parameters, and visualizations. Queries can be scheduled using the sql_task type of the Jobs API, e.g. :method:jobs/create.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start create command diff --git a/cmd/workspace/query-history/query-history.go b/cmd/workspace/query-history/query-history.go index 0f1e83dc..76d3a931 100755 --- a/cmd/workspace/query-history/query-history.go +++ b/cmd/workspace/query-history/query-history.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "query-history", Short: `Access the history of queries through SQL warehouses.`, Long: `Access the history of queries through SQL warehouses.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start list command diff --git a/cmd/workspace/recipient-activation/recipient-activation.go b/cmd/workspace/recipient-activation/recipient-activation.go index 8897a611..873e62d4 100755 --- a/cmd/workspace/recipient-activation/recipient-activation.go +++ b/cmd/workspace/recipient-activation/recipient-activation.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "recipient-activation", Short: `Databricks Recipient Activation REST API.`, Long: `Databricks Recipient Activation REST API`, + Annotations: map[string]string{ + "package": "sharing", + }, } // start get-activation-url-info command diff --git a/cmd/workspace/recipients/recipients.go b/cmd/workspace/recipients/recipients.go index 0d615aa4..87e7ee2d 100755 --- a/cmd/workspace/recipients/recipients.go +++ b/cmd/workspace/recipients/recipients.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Use: "recipients", Short: `Databricks Recipients REST API.`, Long: `Databricks Recipients REST API`, + Annotations: map[string]string{ + "package": "sharing", + }, } // start create command diff --git a/cmd/workspace/repos/repos.go b/cmd/workspace/repos/repos.go index 09e497df..8ab48a43 100755 --- a/cmd/workspace/repos/repos.go +++ b/cmd/workspace/repos/repos.go @@ -25,6 +25,9 @@ var Cmd = &cobra.Command{ Within Repos you can develop code in notebooks or other files and follow data science and engineering code development best practices using Git for version control, collaboration, and CI/CD.`, + Annotations: map[string]string{ + "package": "workspace", + }, } // start create command diff --git a/cmd/workspace/schemas/schemas.go b/cmd/workspace/schemas/schemas.go index a1216dfa..ee73757e 100755 --- a/cmd/workspace/schemas/schemas.go +++ b/cmd/workspace/schemas/schemas.go @@ -20,6 +20,9 @@ var Cmd = &cobra.Command{ access (or list) a table or view in a schema, users must have the USE_SCHEMA data permission on the schema and its parent catalog, and they must have the SELECT permission on the table or view.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/secrets/secrets.go b/cmd/workspace/secrets/secrets.go index 75a6b123..6438a7f7 100755 --- a/cmd/workspace/secrets/secrets.go +++ b/cmd/workspace/secrets/secrets.go @@ -27,6 +27,9 @@ var Cmd = &cobra.Command{ Databricks secrets. While Databricks makes an effort to redact secret values that might be displayed in notebooks, it is not possible to prevent such users from reading secrets.`, + Annotations: map[string]string{ + "package": "workspace", + }, } // start create-scope command diff --git a/cmd/workspace/service-principals/service-principals.go b/cmd/workspace/service-principals/service-principals.go index db03aad0..15c3ef9f 100755 --- a/cmd/workspace/service-principals/service-principals.go +++ b/cmd/workspace/service-principals/service-principals.go @@ -21,6 +21,9 @@ var Cmd = &cobra.Command{ production data run with service principals, interactive users do not need any write, delete, or modify privileges in production. This eliminates the risk of a user overwriting production data by accident.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/workspace/serving-endpoints/serving-endpoints.go b/cmd/workspace/serving-endpoints/serving-endpoints.go index 08c455f9..28aaaff2 100755 --- a/cmd/workspace/serving-endpoints/serving-endpoints.go +++ b/cmd/workspace/serving-endpoints/serving-endpoints.go @@ -29,6 +29,9 @@ var Cmd = &cobra.Command{ define how requests should be routed to your served models behind an endpoint. Additionally, you can configure the scale of resources that should be applied to each served model.`, + Annotations: map[string]string{ + "package": "serving", + }, } // start build-logs command diff --git a/cmd/workspace/shares/shares.go b/cmd/workspace/shares/shares.go index 49d12ff2..6347deb1 100755 --- a/cmd/workspace/shares/shares.go +++ b/cmd/workspace/shares/shares.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "shares", Short: `Databricks Shares REST API.`, Long: `Databricks Shares REST API`, + Annotations: map[string]string{ + "package": "sharing", + }, } // start create command diff --git a/cmd/workspace/storage-credentials/storage-credentials.go b/cmd/workspace/storage-credentials/storage-credentials.go index 3532999b..b018256c 100755 --- a/cmd/workspace/storage-credentials/storage-credentials.go +++ b/cmd/workspace/storage-credentials/storage-credentials.go @@ -28,6 +28,9 @@ var Cmd = &cobra.Command{ To create storage credentials, you must be a Databricks account admin. The account admin who creates the storage credential can delegate ownership to another user or group to manage permissions on it.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/system-schemas/system-schemas.go b/cmd/workspace/system-schemas/system-schemas.go index 3e6d0719..a8aa750f 100755 --- a/cmd/workspace/system-schemas/system-schemas.go +++ b/cmd/workspace/system-schemas/system-schemas.go @@ -16,6 +16,9 @@ var Cmd = &cobra.Command{ Long: `A system schema is a schema that lives within the system catalog. A system schema may contain information about customer usage of Unity Catalog such as audit-logs, billing-logs, lineage information, etc.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start disable command diff --git a/cmd/workspace/table-constraints/table-constraints.go b/cmd/workspace/table-constraints/table-constraints.go index 2ff19ffd..8de9315e 100755 --- a/cmd/workspace/table-constraints/table-constraints.go +++ b/cmd/workspace/table-constraints/table-constraints.go @@ -28,6 +28,9 @@ var Cmd = &cobra.Command{ You can declare primary keys and foreign keys as part of the table specification during table creation. You can also add or drop constraints on existing tables.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/tables/tables.go b/cmd/workspace/tables/tables.go index a8bee878..bae67fa7 100755 --- a/cmd/workspace/tables/tables.go +++ b/cmd/workspace/tables/tables.go @@ -24,6 +24,9 @@ var Cmd = &cobra.Command{ A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind of table (rather than a managed or external table).`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start delete command diff --git a/cmd/workspace/token-management/token-management.go b/cmd/workspace/token-management/token-management.go index 0b56f7b5..405224ec 100755 --- a/cmd/workspace/token-management/token-management.go +++ b/cmd/workspace/token-management/token-management.go @@ -18,6 +18,9 @@ var Cmd = &cobra.Command{ Long: `Enables administrators to get all tokens and delete tokens for other users. Admins can either get every token, get a specific token by ID, or get all tokens for a particular user.`, + Annotations: map[string]string{ + "package": "settings", + }, } // start create-obo-token command diff --git a/cmd/workspace/tokens/tokens.go b/cmd/workspace/tokens/tokens.go index 7ee5f0c8..fbf64f00 100755 --- a/cmd/workspace/tokens/tokens.go +++ b/cmd/workspace/tokens/tokens.go @@ -17,6 +17,9 @@ var Cmd = &cobra.Command{ Short: `The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.`, Long: `The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.`, + Annotations: map[string]string{ + "package": "settings", + }, } // start create command diff --git a/cmd/workspace/users/users.go b/cmd/workspace/users/users.go index 95301548..776a95e6 100755 --- a/cmd/workspace/users/users.go +++ b/cmd/workspace/users/users.go @@ -26,6 +26,9 @@ var Cmd = &cobra.Command{ provider and that user’s account will also be removed from Databricks workspace. This ensures a consistent offboarding process and prevents unauthorized users from accessing sensitive data.`, + Annotations: map[string]string{ + "package": "iam", + }, } // start create command diff --git a/cmd/workspace/volumes/volumes.go b/cmd/workspace/volumes/volumes.go index a584dceb..d3b07399 100755 --- a/cmd/workspace/volumes/volumes.go +++ b/cmd/workspace/volumes/volumes.go @@ -23,6 +23,9 @@ var Cmd = &cobra.Command{ storing library and config files of arbitrary formats such as .whl or .txt centrally and providing secure access across workspaces to it, or transforming and querying non-tabular data files in ETL.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start create command diff --git a/cmd/workspace/warehouses/warehouses.go b/cmd/workspace/warehouses/warehouses.go index 2b2311ec..efea3c48 100755 --- a/cmd/workspace/warehouses/warehouses.go +++ b/cmd/workspace/warehouses/warehouses.go @@ -19,6 +19,9 @@ var Cmd = &cobra.Command{ Long: `A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL. Compute resources are infrastructure resources that provide processing capabilities in the cloud.`, + Annotations: map[string]string{ + "package": "sql", + }, } // start create command diff --git a/cmd/workspace/workspace-bindings/workspace-bindings.go b/cmd/workspace/workspace-bindings/workspace-bindings.go index 75ecb396..f29e0d49 100755 --- a/cmd/workspace/workspace-bindings/workspace-bindings.go +++ b/cmd/workspace/workspace-bindings/workspace-bindings.go @@ -19,6 +19,9 @@ var Cmd = &cobra.Command{ A catalog's workspace bindings can be configured by a metastore admin or the owner of the catalog.`, + Annotations: map[string]string{ + "package": "catalog", + }, } // start get command diff --git a/cmd/workspace/workspace-conf/workspace-conf.go b/cmd/workspace/workspace-conf/workspace-conf.go index a9a78f63..9bd09df5 100755 --- a/cmd/workspace/workspace-conf/workspace-conf.go +++ b/cmd/workspace/workspace-conf/workspace-conf.go @@ -14,6 +14,9 @@ var Cmd = &cobra.Command{ Use: "workspace-conf", Short: `This API allows updating known workspace settings for advanced users.`, Long: `This API allows updating known workspace settings for advanced users.`, + Annotations: map[string]string{ + "package": "settings", + }, } // start get-status command diff --git a/cmd/workspace/workspace/workspace.go b/cmd/workspace/workspace/workspace.go index 14ce4303..3985cffa 100755 --- a/cmd/workspace/workspace/workspace.go +++ b/cmd/workspace/workspace/workspace.go @@ -20,6 +20,9 @@ var Cmd = &cobra.Command{ A notebook is a web-based interface to a document that contains runnable code, visualizations, and explanatory text.`, + Annotations: map[string]string{ + "package": "workspace", + }, } // start delete command