v0.25.0

• Make sure path parameters are first in order in RequiredFields (#669).
• Added Field.IsRequestBodyField method for code generation (#670).
• Added regressions question to the issue template (#676).
• Added telemetry for CI/CD platform to useragent (#665).
• Skiped GCP Integration Tests using Statement Execution API (#678).
• Added more detailed error message on default credentials not found error (#679).
• Updated SDK to latest OpenAPI Spec (#685).

API Changes:

• Changed Create method for w.Functions and w.Metastores workspace-level service with new required argument order.
• Changed InputParams field for catalog.CreateFunction and catalog.FunctionInfo to catalog.FunctionParameterInfos.
• Changed Properties field for catalog.CreateFunction and catalog.FunctionInfo to string.
• Changed ReturnParams field for catalog.CreateFunction and catalog.FunctionInfo to catalog.FunctionParameterInfos
• Changed StorageRoot field for catalog.CreateMetastore to no longer be required.
• Added SkipValidation field for catalog.UpdateExternalLocation.
• Added Libraries field for compute.CreatePolicy, compute.EditPolicy and compute.Policy.
• Added compute.InitScriptEventDetails.
• Added InitScripts field for compute.EventDetails.
• Added File field for compute.InitScriptInfo.
• Added ZoneId field for compute.InstancePoolGcpAttributes.
• Added IncludeResolvedValues field for jobs.GetRunRequest.
• Added EditMode field for jobs.CreateJob and jobs.JobSettings.
• Added NetworkConnectivityConfigId field for provisioning.UpdateWorkspaceRequest.
• Added ContainerLogs and ExtraInfo field for serving.DeploymentStatus.
• Added catalog.CreateFunctionRequest, catalog.DependencyList and catalog.FunctionParameterInfos.
• Added compute.InitScriptExecutionDetails, compute.InitScriptExecutionDetailsStatus, compute.InitScriptInfoAndExecutionDetails, compute.LocalFileInfo.
• Added jobs.CreateJobEditMode and jobs.JobSettingsEditMode.
• Added DeleteApp, GetApp, GetAppDeploymentStatus, GetApps and GetEvents method for w.Apps workspace-level service.
• Added serving.AppEvents, serving.AppServiceStatus, serving.DeleteAppResponse, serving.GetAppDeploymentStatusRequest, serving.GetAppResponse, serving.GetEventsRequest, serving.ListAppEventsResponse and serving.ListAppsResponse.
• Added a.NetworkConnectivity account-level service.
• Added settings.CreateNetworkConnectivityConfigRequest, settings.CreatePrivateEndpointRuleRequest, settings.CreatePrivateEndpointRuleRequestGroupId, settings.DeleteNetworkConnectivityConfigurationRequest, settings.DeletePrivateEndpointRuleRequest, settings.GetNetworkConnectivityConfigurationRequest, settings.GetPrivateEndpointRuleRequest, settings.NccAzurePrivateEndpointRule, settings.NccAzurePrivateEndpointRuleConnectionState, settings.NccAzurePrivateEndpointRuleGroupId, settings.NccAzureServiceEndpointRule, settings.NccEgressConfig, settings.NccEgressDefaultRules, settings.NccEgressTargetRules, settings.NetworkConnectivityConfiguration.
• Removed Delete, Get, method for w.Apps workspace-level service.
• Removed jobs.JobSettingsUiState and jobs.CreateJobUiState.
• Removed a.OAuthEnrollment account-level service.
• Removed oauth2.CreateOAuthEnrollment and [oauth2.OAuthEnrollmen...

v0.24.0

• Implemented Iterator support for paginated endpoints or endpoints returning a list (#543). The Iterator interface allows users to get the next resource in the iterator and to check whether another resource is available in the iterator. Iterators for paginated endpoints fetch pages lazily, allowing users to only fetch the pages needed for their use case.
• Removed photon and graviton selectors in compute.SparkVersionRequ… (#622). Going forward, photon is determined by the RuntimeEngine field in compute.CreateCluster, and graviton is chosen depending on the aws_instance_type field in compute.CreateCluster.

API Changes:

• Added Attributes, Count, ExcludedAttributes, Filter, SortBy, SortOrder, and StartIndex fields to iam.GetAccountUserRequest and iam.GetUserRequest.
• Added Schemas field to iam.Group, iam.ListGroupsResponse, iam.ListServicePrincipalResponse, iam.ListUsersResponse, iam.ServicePrincipal, and iam.User.
• Added iam.GetSortOrder.
• Added iam.GroupSchema.
• Added iam.ListResponseSchema.
• Added iam.ServicePrincipalSchema.
• Added iam.UserSchema.
• Added WebhookNotifications field for jobs.SubmitTask.
• Added w.Apps workspace-level service and related methods.
• Added a.AccountNetworkPolicy account-level service and related methods.

Internal SDK Changes:

• Update to actions/checkout@v4 (#650).
• Skip unshallow step in test workflow (#649).
• Add integration tests for Jobs: ListRuns (#645).
• Only log pkg.Load after checking whether the operation is tagged (#655).
• Prefix library paths with the target directory to construct absolute paths (#656).
• Fixed HasRequiredNonBodyField method (#660).
• Added CanSetRequiredFieldsFromJson method for OpenAPI generator (#661).
• Add integration tests for ServicePrincipals: Patch (#662).
• Add integration tests for Users: Patch, Update (#663).
• Enforce running az login --service-principal on nightly runs (#659).
• Add integration tests for Connections: Create, Delete, Get, List, Update (#653).

OpenAPI SHA: 5903bb39137fd76ac384b2044e425f9c56840e00, Date: 2023-10-23

v0.23.0

Note: this release includes custom JSON marshalling that captures whether or
not a value is set and should be included in the marshalled output, if its
value is equal to Go's zero value (i.e. 0 for an int field).

• Add ForceSendFields and a custom marshaller (#615).
• Support text/plain response as streaming request body (#638).
• Added log statement if OIDC response is non 200 (#644).

API Changes:

• Changed Download method for a.BillableUsage account-level service to start returning billing.DownloadResponse.
• Added billing.DownloadResponse.
• Changed Delete method for a.AccountStorageCredentials account-level service with new required argument order.
• Changed Get method for a.AccountStorageCredentials account-level service with new required argument order.
• Changed Update method for a.AccountStorageCredentials account-level service with new required argument order.
• Added GetBindings method for w.WorkspaceBindings workspace-level service.
• Added UpdateBindings method for w.WorkspaceBindings workspace-level service.
• Removed Name field for catalog.AccountsUpdateStorageCredential.
• Added StorageCredentialName field for catalog.AccountsUpdateStorageCredential.
• Removed Name field for catalog.DeleteAccountStorageCredentialRequest.
• Added StorageCredentialName field for catalog.DeleteAccountStorageCredentialRequest.
• Removed Name field for catalog.GetAccountStorageCredentialRequest.
• Added StorageCredentialName field for catalog.GetAccountStorageCredentialRequest.
• Added Owner field for catalog.UpdateConnection.
• Added catalog.GetBindingsRequest.
• Added catalog.UpdateWorkspaceBindingsParameters.
• Added catalog.WorkspaceBinding.
• Added catalog.WorkspaceBindingBindingType.
• Added catalog.WorkspaceBindingsResponse.
• Added Spec field for compute.ClusterDetails.
• Added ApplyPolicyDefaultValues field for compute.ClusterSpec.
• Removed AwsAttributes field for compute.EditInstancePool.
• Removed AzureAttributes field for compute.EditInstancePool.
• Removed DiskSpec field for compute.EditInstancePool.
• Removed EnableElasticDisk field for compute.EditInstancePool.
• Removed GcpAttributes field for compute.EditInstancePool.
• Removed PreloadedDockerImages field for compute.EditInstancePool.
• Removed PreloadedSparkVersions field for compute.EditInstancePool.
• Added Deployment field for jobs.CreateJob.
• Added UiState field for jobs.CreateJob.
• Added Deployment field for jobs.JobSettings.
• Added UiState field for jobs.JobSettings.
• Removed ConditionTask field for jobs.RunOutput.
• Added WebhookNotifications field for jobs.Task.
• Added jobs.CreateJobUiState.
• Added jobs.JobDeployment.
• Added jobs.JobDeploymentKind.
• Added jobs.JobSettingsUiState.
• Added WorkloadType field for serving.ServedModelInput.
• Added WorkloadType field for serving.ServedModelOutput.
• Removed a.AccountNetworkPolicy account-level service.
• Changed List method for w.IpAccessLists workspace-level service to return settings.ListIpAccessListResponse.
• Removed settings.AccountNetworkPolicyMessage.
• Removed settings.DeleteAccountNetworkPolicyRequest.
• Removed settings.DeleteAccountNetworkPolicyResponse.
• Removed IpAccessLists field for settings.GetIpAccessListResponse.
• Added IpAccessList field for settings.GetIpAccessListResponse.
• Removed settings.ReadAccountNetworkPolicyRequest.
• Removed settings.UpdateAccountNetworkPolicyRequest.
• Added settings.ListIpAccessListResponse.

OpenAPI SHA: 493a76554afd3afdd15dc858773d01643f80352a, Date: 2023-10-12

Dependency updates:

• Bump golang.org/x/mod from 0.12.0 to 0.13.0 (#639).
• Bump google.golang.org/api from 0.140.0 to 0.146.0 (#643).
• Bump golang.org/x/net from 0.15.0 to 0.17.0 (#646).
• Bump golang.org/x/oauth2 from 0.12.0 to 0.13.0 (#642).
• Bump golang.org/x/net from 0.8.0 to 0.17.0 in /examples/zerolog (#647).
• Bump golang.org/x/net from 0.8.0 to 0.17.0 in /examples/slog (#648).

v0.22.0

Breaking API Changes:

• Changed List method for a.AccountMetastoreAssignments account-level service to return catalog.ListAccountMetastoreAssignmentsResponse.

API Changes:

• Added catalog.ListAccountMetastoreAssignmentsResponse.

Internal SDK Changes:

• Add support for template libraries (#635).

OpenAPI SHA: bcbf6e851e3d82fd910940910dd31c10c059746c, Date: 2023-10-02

v0.21.0

Breaking API Changes:

• Changed ArtifactMatchers field for catalog.ArtifactAllowlistInfo to catalog.ArtifactMatcherList.
• Removed Owner field for catalog.CreateConnection.
• Changed ArtifactMatchers field for catalog.SetArtifactAllowlist to catalog.ArtifactMatcherList.
• Removed Options field for catalog.UpdateCatalog.
• Changed CancelAllRuns method for w.Jobs workspace-level service with new required argument order.
• Changed JobId field for jobs.CancelAllRuns to no longer be required.
• Changed JobParameters field for jobs.RunNow to jobs.ParamPairs.
• Changed Query method for w.ServingEndpoints workspace-level service . New request type is serving.QueryEndpointInput.
• Removed serving.QueryRequest.
• Changed ExchangeToken method for w.CredentialsManager workspace-level service with new required argument order.
• Removed settings.CredentialPartitionId.
• Changed TokenType field for settings.ExchangeToken to settings.TokenType.
• Removed CredentialPartitionId field for settings.ExchangeTokenRequest.
• Changed List method for w.CleanRooms workspace-level service to require request of sharing.ListCleanRoomsRequest.

API Changes:

• Added AllQueuedRuns field for jobs.CancelAllRuns.
• Added Queue field for jobs.CreateJob.
• Added Queue field for jobs.JobSettings.
• Added JobParameters field for jobs.RepairRun.
• Added Queue field for jobs.RunNow.
• Added JobParameters field for jobs.RunParameters.
• Added QueueReason field for jobs.RunState.
• Added QueueDuration field for jobs.RunTask.
• Added Queue field for jobs.SubmitRun.
• Added jobs.QueueSettings.
• Added Notifications field for pipelines.CreatePipeline.
• Added Notifications field for pipelines.EditPipeline.
• Added Notifications field for pipelines.PipelineSpec.
• Added pipelines.Notifications.
• Added serving.DataframeSplitInput.
• Added serving.QueryEndpointInput.
• Added w.Settings workspace-level service.
• Added PartitionId field for settings.ExchangeTokenRequest.
• Added settings.DefaultNamespaceSetting.
• Added settings.DeleteDefaultWorkspaceNamespaceRequest.
• Added settings.DeleteDefaultWorkspaceNamespaceResponse.
• Added settings.PartitionId.
• Added settings.ReadDefaultWorkspaceNamespaceRequest.
• Added settings.StringMessage.
• Added settings.UpdateDefaultWorkspaceNamespaceRequest.
• Added NextPageToken field for sharing.ListCleanRoomsResponse.
• Added sharing.ListCleanRoomsRequest.

SDK Internal Changes:

• Remove use of cancel by job id in integration test (#632).

OpenAPI SHA: 94ddf8ff02df271daebdc5f001075e1ca2ce080d, Date: 2023-09-27

v0.20.0

• Adjust token expiry window to 40 seconds on Azure (#617).
• Rename variables in Azure code to match across auth types (#618).
• Add details to APIError (#613).
• Fixed code generation of primitive types (#623).
• Updated SDK to changes in OpenAPI specification (#625).

API Changes:

• Changed List method for a.AccountMetastoreAssignments account-level service to return catalog.WorkspaceIdList.
• Added catalog.WorkspaceId.
• Added a.OAuthPublishedApps account-level service.
• Added oauth2.GetPublishedAppsOutput.
• Added oauth2.ListOAuthPublishedAppsRequest.
• Added oauth2.PublishedAppOutput.
• Added Patch method for w.ServingEndpoints workspace-level service.
• Added Tags field for serving.CreateServingEndpoint.
• Added Tags field for serving.ServingEndpoint.
• Added Tags field for serving.ServingEndpointDetailed.
• Added serving.EndpointTag.
• Added serving.PatchServingEndpointTags.
• Added w.CredentialsManager workspace-level service.
• Added settings.CredentialPartitionId.
• Added settings.ExchangeToken.
• Added settings.ExchangeTokenRequest.
• Added settings.ExchangeTokenResponse.
• Added settings.TokenType.
• Changed ExecuteStatement method for w.StatementExecution workspace-level service with new required argument order.
• Added EmptyResultState field for sql.AlertOptions.
• Removed sql.ChunkInfo.
• Changed OnWaitTimeout field for sql.ExecuteStatementRequest to sql.ExecuteStatementRequestOnWaitTimeout.
• Changed Statement field for sql.ExecuteStatementRequest to be required.
• Changed WarehouseId field for sql.ExecuteStatementRequest to be required.
• Changed Chunks field for sql.ResultManifest to sql.BaseChunkInfoList.
• Added Truncated field for sql.ResultManifest.
• Removed sql.TimeoutAction.
• Added sql.AlertOptionsEmptyResultState.
• Added sql.BaseChunkInfo.
• Added sql.ExecuteStatementRequestOnWaitTimeout.

OpenAPI SHA: 51e3d27c0553c891bc418bd0cd07c9240e0476dd, Date: 2023-09-13
Dependency updates:

• Bump golang.org/x/oauth2 from 0.11.0 to 0.12.0 (#606).
• Bump google.golang.org/api from 0.138.0 to 0.140.0 (#612).

v0.19.2

• Fix case where retry of a request without body fails (#614).

v0.19.1

• Handled Azure authentication when WorkspaceResourceID is provided (#597).
• Reverted error message changes from client.go (#604).
• Reused tokens after first call to Azure CLI (#605).
• Updated error message assertions (#607).

v0.19.0

• Added ErrNotWorkspaceClient (#596).
• Fix loading of databrickscfg with a password containing a hash (#595).
• Use an operation's request type name if specified (#598).
• Update OpenAPI spec (#600).

API Changes:

• Renamed permissions APIs to no longer include the service name, for example:
  • GetJobPermissionLevels -> GetPermissionLevels
  • GetJobPermissions -> GetPermissions
  • SetJobPermissions -> SetPermissions
  • UpdateJobPermissions -> UpdatePermissions
• Changed Create method for w.Volumes workspace-level service with new required argument order.
• Added SupportsElasticDisk field for compute.NodeType.
• Changed Create method for w.Dashboards workspace-level service with new required argument order.
• Added w.DashboardWidgets workspace-level service.
• Added w.QueryVisualizations workspace-level service.
• Changed Name field for sql.CreateDashboardRequest to be required.
• Added DashboardFiltersEnabled field for sql.CreateDashboardRequest.
• Added RunAsRole field for sql.CreateDashboardRequest.
• Added RunAsRole field for sql.Query.
• Added RunAsRole field for sql.QueryPostContent.
• Removed DashboardId field for sql.WidgetOptions.
• Changed Position field for sql.WidgetOptions to sql.WidgetPosition.
• Removed Text field for sql.WidgetOptions.
• Added Description field for sql.WidgetOptions.
• Added Title field for sql.WidgetOptions.
• Added sql.CreateQueryVisualizationRequest.
• Added sql.CreateWidget.
• Added sql.DeleteDashboardWidgetRequest.
• Added sql.DeleteQueryVisualizationRequest.
• Added sql.RunAsRole.
• Added sql.WidgetPosition.

OpenAPI SHA: 09a7fa63d9ae243e5407941f200960ca14d48b07, Date: 2023-09-04

Dependency updates:

• Bump google.golang.org/api from 0.136.0 to 0.138.0 (#587).

v0.18.0

Breaking Changes:

• Added support Files API (application/octet-stream) in OpenAPI Spec (#572). The signatures of Upload, Download and Delete have changed; these methods now take UploadRequest, DownloadRequest, and DeleteRequest structures, respectively. Shortcut methods are generated for DownloadByFileName and DeleteByFileName for convenience. The WriteFile and ReadFile methods are removed.
• Propagated Request Headers to client.go (#589). The Do method of Client now requires an additional parameter for request headers. Add headers to requests using this parameter, or pass nil if no headers are needed.

Breaking API Changes:

• Removed w.SecurableTags workspace-level service and all associated structures.
• Removed w.SubentityTags workspace-level service and all associated structures.
• Renamed ProvisioningState field to ProvisioningInfo for catalog.ConnectionInfo.
• Changed catalog.ProvisioningState to catalog.ProvisioningInfoState.
• Removed InstancePoolFleetAttributes field for compute.CreateInstancePool.
• Removed InstancePoolFleetAttributes field for compute.EditInstancePool.
• Removed compute.FleetLaunchTemplateOverride.
• Removed compute.FleetOnDemandOption.
• Removed compute.FleetOnDemandOptionAllocationStrategy.
• Removed compute.FleetSpotOption.
• Removed compute.FleetSpotOptionAllocationStrategy.
• Removed InstancePoolFleetAttributes field for compute.GetInstancePool.
• Removed InstancePoolFleetAttributes field for compute.InstancePoolAndStats.
• Removed compute.InstancePoolFleetAttributes.
• Changed GetByName method for w.Experiments workspace-level service to return ml.GetExperimentResponse.
• Changed GetExperiment method for w.Experiments workspace-level service to return ml.GetExperimentResponse.
• Renamed ml.GetExperimentByNameResponse to ml.GetExperimentResponse.

API Changes:

• Changed List method for a.AccountStorageCredentials account-level service to return catalog.StorageCredentialInfoList.
• Added w.ModelVersions workspace-level service.
• Added w.RegisteredModels workspace-level service.
• Added BrowseOnly field for catalog.CatalogInfo.
• Added FullName field for catalog.CatalogInfo.
• Added ProvisioningInfo field for catalog.CatalogInfo.
• Added SecurableKind field for catalog.CatalogInfo.
• Added SecurableType field for catalog.CatalogInfo.
• Added Options field for catalog.CreateCatalog.
• Added Options field for catalog.UpdateCatalog.
• Added catalog.CreateRegisteredModelRequest.
• Added catalog.DeleteAliasRequest.
• Added catalog.DeleteModelVersionRequest.
• Added catalog.DeleteRegisteredModelRequest.
• Added catalog.GetByAliasRequest.
• Added catalog.GetModelVersionRequest.
• Added catalog.GetRegisteredModelRequest.
• Added catalog.ListModelVersionsRequest.
• Added catalog.ListModelVersionsResponse.
• Added catalog.ListRegisteredModelsRequest.
• Added catalog.ListRegisteredModelsResponse.
• Added catalog.ModelVersionInfo.
• Added catalog.ModelVersionInfoStatus.
• Added catalog.ProvisioningInfo.
• Added catalog.ProvisioningInfoState.
• Added catalog.RegisteredModelAlias.
• Added catalog.RegisteredModelInfo.
• Added catalog.SetRegisteredModelAliasRequest.
• Added catalog.UpdateModelVersionRequest.
• Added catalog.UpdateRegisteredModelRequest.
• Added Volumes field for compute.InitScriptInfo.
• Added compute.VolumesStorageInfo.
• Added w.Files workspace-level service.
• Added files.DeleteFileRequest.
• Added files.DownloadRequest.
• Added files.DownloadResponse.
• Added files.UploadRequest.
• Added CustomTags field for provisioning.CreateWorkspaceRequest.
• Added CustomTags field for provisioning.UpdateWorkspaceRequest.
• Added CustomTags field for [provisioning.Workspace](https://pkg.go.dev/github.com...