-
Notifications
You must be signed in to change notification settings - Fork 130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release v0.17.0 #502
Release v0.17.0 #502
Conversation
* Use covariant type for `@retried(on=[...])` ([#486](#486)). * Configure request timeout using existing parameter from Config ([#489](#489)). * Make contents of `__init__.py` equal across projects ([#488](#488)). * Update SDK to Latest OpenAPI Specification ([#501](#501)). API Changes: * Changed `list()` method for [w.external_locations](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/external_locations.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass. * Changed `list()` method for [w.storage_credentials](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/storage_credentials.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass. * Added `next_page_token` field for `databricks.sdk.service.catalog.ListExternalLocationsResponse`. * Added `max_results` field for `databricks.sdk.service.catalog.ListFunctionsRequest`. * Added `page_token` field for `databricks.sdk.service.catalog.ListFunctionsRequest`. * Added `next_page_token` field for `databricks.sdk.service.catalog.ListFunctionsResponse`. * Added `max_results` field for `databricks.sdk.service.catalog.ListSchemasRequest`. * Added `page_token` field for `databricks.sdk.service.catalog.ListSchemasRequest`. * Added `next_page_token` field for `databricks.sdk.service.catalog.ListSchemasResponse`. * Added `next_page_token` field for `databricks.sdk.service.catalog.ListStorageCredentialsResponse`. * Added `omit_columns` field for `databricks.sdk.service.catalog.ListTablesRequest`. * Added `omit_properties` field for `databricks.sdk.service.catalog.ListTablesRequest`. * Removed `databricks.sdk.service.catalog.TableConstraintList` dataclass. * Added `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass. * Added `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass. * Added `init_scripts` field for `databricks.sdk.service.pipelines.PipelineCluster`. * Added `validate_only` field for `databricks.sdk.service.pipelines.StartUpdate`. * Added `validate_only` field for `databricks.sdk.service.pipelines.UpdateInfo`. * Changed `list()` method for [w.tokens](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/tokens.html) workspace-level service to return `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass. * Added `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass. * Changed `create()` method for [w.dashboards](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards.html) workspace-level service . New request type is `databricks.sdk.service.sql.DashboardPostContent` dataclass. * Added `update()` method for [w.dashboards](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards.html) workspace-level service. * Removed `databricks.sdk.service.sql.CreateDashboardRequest` dataclass. * Added `http_headers` field for `databricks.sdk.service.sql.ExternalLink`. * Added `run_as_role` field for `databricks.sdk.service.sql.QueryEditContent`. * Added `databricks.sdk.service.sql.DashboardEditContent` dataclass. * Added `databricks.sdk.service.sql.DashboardPostContent` dataclass. * Added `databricks.sdk.service.dashboards` package. * Added `databricks.sdk.service.vectorsearch` package. OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #502 +/- ##
=======================================
Coverage 57.69% 57.69%
=======================================
Files 40 40
Lines 27148 27148
=======================================
Hits 15664 15664
Misses 11484 11484 ☔ View full report in Codecov by Sentry. |
Integration tests are running ... |
* Make contents of `__init__.py` equal across projects ([#488](https://github.com/databricks/databricks-sdk-py/pull/488)). | ||
* Update SDK to Latest OpenAPI Specification ([#501](https://github.com/databricks/databricks-sdk-py/pull/501)). | ||
|
||
Note: This release contains breaking changes, please see below for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Highlight for breaking change. Clubbed similar types of changes in changelog manually for better readability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small question. Python doesn't have the same breaking/non-breaking issues as Go/Java as request objects are not used in Python directly.
CHANGELOG.md
Outdated
|
||
API Changes: | ||
|
||
* [Breaking] Changed `list()` method for [w.external_locations](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/external_locations.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass, [w.storage_credentials](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/storage_credentials.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass and [w.tokens](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/tokens.html) workspace-level service to return `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this breaking for the Python SDK?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed offline, mentioning for visibility:
Changed list() method for w.tokens workspace-level service to return databricks.sdk.service.settings.ListPublicTokensResponse dataclass.
would be breaking is someone is using mypy along with type annotations. Splitting up the breaking change from other list() method changes.
@retried(on=[...])
(#486).__init__.py
equal across projects (#488).Note: This release contains breaking changes, please see below for more details.
API Changes:
list()
method for w.tokens workspace-level service to returndatabricks.sdk.service.settings.ListPublicTokensResponse
dataclass.list()
method for w.external_locations workspace-level service to require request ofdatabricks.sdk.service.catalog.ListExternalLocationsRequest
dataclass and w.storage_credentials workspace-level service to require request ofdatabricks.sdk.service.catalog.ListStorageCredentialsRequest
dataclass.next_page_token
field fordatabricks.sdk.service.catalog.ListExternalLocationsResponse
,databricks.sdk.service.catalog.ListFunctionsResponse
,databricks.sdk.service.catalog.ListSchemasResponse
anddatabricks.sdk.service.catalog.ListStorageCredentialsResponse
.max_results
field fordatabricks.sdk.service.catalog.ListFunctionsRequest
anddatabricks.sdk.service.catalog.ListSchemasRequest
.page_token
field fordatabricks.sdk.service.catalog.ListFunctionsRequest
anddatabricks.sdk.service.catalog.ListSchemasRequest
.omit_columns
field fordatabricks.sdk.service.catalog.ListTablesRequest
.omit_properties
field fordatabricks.sdk.service.catalog.ListTablesRequest
.init_scripts
field fordatabricks.sdk.service.pipelines.PipelineCluster
.validate_only
field fordatabricks.sdk.service.pipelines.StartUpdate
anddatabricks.sdk.service.pipelines.UpdateInfo
.create()
method for w.dashboards workspace-level service . New request type isdatabricks.sdk.service.sql.DashboardPostContent
dataclass.update()
method for w.dashboards workspace-level service.http_headers
field fordatabricks.sdk.service.sql.ExternalLink
.run_as_role
field fordatabricks.sdk.service.sql.QueryEditContent
.databricks.sdk.service.dashboards
anddatabricks.sdk.service.vectorsearch
.databricks.sdk.service.catalog.ListExternalLocationsRequest
,databricks.sdk.service.catalog.ListStorageCredentialsRequest
,databricks.sdk.service.settings.ListPublicTokensResponse
,databricks.sdk.service.sql.DashboardEditContent
anddatabricks.sdk.service.sql.DashboardPostContent
.databricks.sdk.service.catalog.TableConstraintList
anddatabricks.sdk.service.sql.CreateDashboardRequest
.OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10