Skip to content

Add get_workspace_id to docgen blocklist#549

Merged
mgyucht merged 1 commit intomainfrom
fix-gen-client-docs
Feb 19, 2024
Merged

Add get_workspace_id to docgen blocklist#549
mgyucht merged 1 commit intomainfrom
fix-gen-client-docs

Conversation

@mgyucht
Copy link
Copy Markdown
Contributor

@mgyucht mgyucht commented Feb 19, 2024 •
edited
Loading

Changes

Doc generation is done automatically for all services in the WorkspaceClient and AccountClient classes. However, get_workspace_id() does not need to go through the same process, as its docs will appear on the WorkspaceClient doc page anyways: https://databricks-sdk-py--549.org.readthedocs.build/en/549/clients/workspace.html#databricks.sdk.WorkspaceClient.get_workspace_id.

Tests

  • make test run locally
  • make fmt applied
  • relevant integration tests applied

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (94fc5e4) 57.92% compared to head (2c550f2) 57.92%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #549   +/-   ##
=======================================
  Coverage   57.92%   57.92%           
=======================================
  Files          45       45           
  Lines       27993    27993           
=======================================
  Hits        16216    16216           
  Misses      11777    11777

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mgyucht mgyucht requested a review from fjakobs February 19, 2024 12:17
@mgyucht mgyucht added this pull request to the merge queue Feb 19, 2024
Merged via the queue into main with commit 94abc16 Feb 19, 2024
@mgyucht mgyucht deleted the fix-gen-client-docs branch February 19, 2024 12:23
hectorcast-db added a commit that referenced this pull request Feb 19, 2024
@hectorcast-db
Release v0.20.0
06582d2 
Major Changes:

* Updated behaviour for raw parameter in `ApiClient.do()` method. The ainaryIO is not returned directly anymore, but as part of a dict which can contain response headers. The raw

Internal Changes:

* Add get_workspace_id to docgen blocklist ([#549](#549)).
* Support HEAD operation and response Headers ([#547](#547)).

API Changes:

 * Changed `delete()` method for [w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html) workspace-level service with new required argument order.
 * Changed `get()` method for [w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html) workspace-level service with new required argument order.
 * Changed `update()` method for [w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html) workspace-level service with new required argument order.
 * Changed `update()` method for [w.lakehouse_monitors](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/lakehouse_monitors.html) workspace-level service with new required argument order.
 * Changed `delete()` method for [w.volumes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/volumes.html) workspace-level service with new required argument order.
 * Changed `read()` method for [w.volumes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/volumes.html) workspace-level service with new required argument order.
 * Changed `update()` method for [w.volumes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/volumes.html) workspace-level service with new required argument order.
 * Added [w.online_tables](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/online_tables.html) workspace-level service.
 * Removed `name_arg` field for `databricks.sdk.service.catalog.DeleteConnectionRequest`.
 * Added `name` field for `databricks.sdk.service.catalog.DeleteConnectionRequest`.
 * Removed `full_name_arg` field for `databricks.sdk.service.catalog.DeleteVolumeRequest`.
 * Added `name` field for `databricks.sdk.service.catalog.DeleteVolumeRequest`.
 * Removed `name_arg` field for `databricks.sdk.service.catalog.GetConnectionRequest`.
 * Added `name` field for `databricks.sdk.service.catalog.GetConnectionRequest`.
 * Added `max_results` field for `databricks.sdk.service.catalog.ListVolumesRequest`.
 * Added `page_token` field for `databricks.sdk.service.catalog.ListVolumesRequest`.
 * Added `next_page_token` field for `databricks.sdk.service.catalog.ListVolumesResponseContent`.
 * Removed `full_name_arg` field for `databricks.sdk.service.catalog.ReadVolumeRequest`.
 * Added `name` field for `databricks.sdk.service.catalog.ReadVolumeRequest`.
 * Removed `name_arg` field for `databricks.sdk.service.catalog.UpdateConnection`.
 * Added `name` field for `databricks.sdk.service.catalog.UpdateConnection`.
 * Removed `assets_dir` field for `databricks.sdk.service.catalog.UpdateMonitor`.
 * Removed `full_name_arg` field for `databricks.sdk.service.catalog.UpdateVolumeRequestContent`.
 * Added `name` field for `databricks.sdk.service.catalog.UpdateVolumeRequestContent`.
 * Added `databricks.sdk.service.catalog.ContinuousUpdateStatus` dataclass.
 * Added `databricks.sdk.service.catalog.DeleteOnlineTableRequest` dataclass.
 * Added `databricks.sdk.service.catalog.FailedStatus` dataclass.
 * Added `databricks.sdk.service.catalog.GetOnlineTableRequest` dataclass.
 * Added `databricks.sdk.service.catalog.OnlineTable` dataclass.
 * Added `databricks.sdk.service.catalog.OnlineTableSpec` dataclass.
 * Added `databricks.sdk.service.catalog.OnlineTableState` dataclass.
 * Added `databricks.sdk.service.catalog.OnlineTableStatus` dataclass.
 * Added `databricks.sdk.service.catalog.PipelineProgress` dataclass.
 * Added `databricks.sdk.service.catalog.ProvisioningStatus` dataclass.
 * Added `databricks.sdk.service.catalog.TriggeredUpdateStatus` dataclass.
 * Added `databricks.sdk.service.catalog.ViewData` dataclass.
 * Added `get_directory_metadata()` method for [w.files](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/files.html) workspace-level service.
 * Added `get_metadata()` method for [w.files](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/files.html) workspace-level service.
 * Added `content_length` field for `databricks.sdk.service.files.DownloadResponse`.
 * Added `content_type` field for `databricks.sdk.service.files.DownloadResponse`.
 * Added `last_modified` field for `databricks.sdk.service.files.DownloadResponse`.
 * Added `databricks.sdk.service.files.FileSize` dataclass.
 * Added `databricks.sdk.service.files.GetDirectoryMetadataRequest` dataclass.
 * Added `databricks.sdk.service.files.GetMetadataRequest` dataclass.
 * Added `databricks.sdk.service.files.GetMetadataResponse` dataclass.
 * Added `databricks.sdk.service.files.LastModifiedHttpDate` dataclass.
 * Removed `trigger_history` field for `databricks.sdk.service.jobs.Job`.
 * Removed `databricks.sdk.service.jobs.TriggerEvaluation` dataclass.
 * Removed `databricks.sdk.service.jobs.TriggerHistory` dataclass.
 * Added `table` field for `databricks.sdk.service.jobs.TriggerSettings`.
 * Added `databricks.sdk.service.jobs.Condition` dataclass.
 * Added `databricks.sdk.service.jobs.TableTriggerConfiguration` dataclass.
 * Removed `config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `ai21labs_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `anthropic_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `aws_bedrock_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `cohere_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `databricks_model_serving_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `openai_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Added `palm_config` field for `databricks.sdk.service.serving.ExternalModel`.
 * Removed `databricks.sdk.service.serving.ExternalModelConfig` dataclass.
 * Added `max_provisioned_throughput` field for `databricks.sdk.service.serving.ServedEntityInput`.
 * Added `min_provisioned_throughput` field for `databricks.sdk.service.serving.ServedEntityInput`.
 * Added `max_provisioned_throughput` field for `databricks.sdk.service.serving.ServedEntityOutput`.
 * Added `min_provisioned_throughput` field for `databricks.sdk.service.serving.ServedEntityOutput`.
 * Changed `delete()` method for [w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html) workspace-level service with new required argument order.
 * Changed `get()` method for [w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html) workspace-level service with new required argument order.
 * Changed `update()` method for [w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html) workspace-level service with new required argument order.
 * Removed `name_arg` field for `databricks.sdk.service.sharing.DeleteCleanRoomRequest`.
 * Added `name` field for `databricks.sdk.service.sharing.DeleteCleanRoomRequest`.
 * Removed `name_arg` field for `databricks.sdk.service.sharing.GetCleanRoomRequest`.
 * Added `name` field for `databricks.sdk.service.sharing.GetCleanRoomRequest`.
 * Removed `name_arg` field for `databricks.sdk.service.sharing.UpdateCleanRoom`.
 * Added `name` field for `databricks.sdk.service.sharing.UpdateCleanRoom`.
 * Added `enum_options` field for `databricks.sdk.service.sql.Parameter`.
 * Added `multi_values_options` field for `databricks.sdk.service.sql.Parameter`.
 * Added `query_id` field for `databricks.sdk.service.sql.Parameter`.
 * Added `databricks.sdk.service.sql.MultiValuesOptions` dataclass.

OpenAPI SHA: cdd76a98a4fca7008572b3a94427566dd286c63b, Date: 2024-02-19
@hectorcast-db hectorcast-db mentioned this pull request Feb 19, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Feb 19, 2024
@hectorcast-db
Release v0.20.0 (#550)
47dfc6d 
Major Changes:

* Updated behaviour for raw parameter in `ApiClient.do()` method. The
raw data is not returned directly anymore, but as part of a dict with
the `contents` key. This dict will also contain response headers if
returned by the API.

Internal Changes:

* Add get_workspace_id to docgen blocklist
([#549](#549)).
* Support HEAD operation and response Headers
([#547](#547)).

API Changes:

* Changed `delete()`, `get()` and `update()` methods for
[w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html)
workspace-level service with new required argument order.
* Changed `update()` method for
[w.lakehouse_monitors](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/lakehouse_monitors.html)
workspace-level service with new required argument order.
* Changed `delete()`, `get()` and `update()` methods for
[w.volumes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/volumes.html)
workspace-level service with new required argument order.
* Added
[w.online_tables](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/online_tables.html)
workspace-level service.
* Renamed `name_arg` field to `name` for the following dataclasses:
`databricks.sdk.service.catalog.DeleteConnectionRequest`,
   `databricks.sdk.service.catalog.GetConnectionRequest`,
   `databricks.sdk.service.catalog.UpdateConnection`,
   `databricks.sdk.service.sharing.DeleteCleanRoomRequest`, 
   `databricks.sdk.service.sharing.GetCleanRoomRequest` and
   `databricks.sdk.service.sharing.UpdateCleanRoom`.
* Removed `full_name_arg` field for
`databricks.sdk.service.catalog.DeleteVolumeRequest`.
* Added `name` field for
`databricks.sdk.service.catalog.DeleteVolumeRequest`.
* Added `max_results` field for
`databricks.sdk.service.catalog.ListVolumesRequest`.
* Added `page_token` field for
`databricks.sdk.service.catalog.ListVolumesRequest`.
* Added `next_page_token` field for
`databricks.sdk.service.catalog.ListVolumesResponseContent`.
* Removed `full_name_arg` field for
`databricks.sdk.service.catalog.ReadVolumeRequest`.
* Added `name` field for
`databricks.sdk.service.catalog.ReadVolumeRequest`.
* Removed `assets_dir` field for
`databricks.sdk.service.catalog.UpdateMonitor`.
* Removed `full_name_arg` field for
`databricks.sdk.service.catalog.UpdateVolumeRequestContent`.
* Added `name` field for
`databricks.sdk.service.catalog.UpdateVolumeRequestContent`.
* Added the following catalog dataclasses: `ContinuousUpdateStatus`,
`DeleteOnlineTableRequest`, `FailedStatus`,
`GetOnlineTableRequest`, `OnlineTable`, `OnlineTableSpec`,
`OnlineTableState`, `OnlineTableStatus`,
`PipelineProgress`, `ProvisioningStatus`, `TriggeredUpdateStatus` and
`ViewData`.
* Added `get_directory_metadata()` method for
[w.files](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/files.html)
workspace-level service.
* Added `get_metadata()` method for
[w.files](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/files.html)
workspace-level service.
* Added `content_length`, `content_type` and `last_modified` fields for
`databricks.sdk.service.files.DownloadResponse`.
* Added the following files dataclasses: `FileSize`,
`GetDirectoryMetadataRequest`, `GetMetadataRequest`,
   `GetMetadataResponse` and `LastModifiedHttpDate`.
* Removed `trigger_history` field for `databricks.sdk.service.jobs.Job`.
 * Removed `databricks.sdk.service.jobs.TriggerEvaluation` dataclass.
 * Removed `databricks.sdk.service.jobs.TriggerHistory` dataclass.
* Added `table` field for `databricks.sdk.service.jobs.TriggerSettings`.
 * Added `databricks.sdk.service.jobs.Condition` dataclass.
* Added `databricks.sdk.service.jobs.TableTriggerConfiguration`
dataclass.
* Removed `config` field for
`databricks.sdk.service.serving.ExternalModel`.
* Removed `databricks.sdk.service.serving.ExternalModelConfig`
dataclass. Fields moved to
`databricks.sdk.service.serving.ExternalModel`.
* Added `max_provisioned_throughput` and `min_provisioned_throughput`
fields for `databricks.sdk.service.serving.ServedEntityInput`.
* Added `max_provisioned_throughput` and `min_provisioned_throughput`
fields for `databricks.sdk.service.serving.ServedEntityOutput`.
* Changed `delete()` method for
[w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html)
workspace-level service with new required argument order.
* Changed `get()` method for
[w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html)
workspace-level service with new required argument order.
* Changed `update()` method for
[w.clean_rooms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/clean_rooms.html)
workspace-level service with new required argument order.
* Added `enum_options` field for `databricks.sdk.service.sql.Parameter`.
* Added `multi_values_options` field for
`databricks.sdk.service.sql.Parameter`.
 * Added `query_id` field for `databricks.sdk.service.sql.Parameter`.
 * Added `databricks.sdk.service.sql.MultiValuesOptions` dataclass.

OpenAPI SHA: cdd76a98a4fca7008572b3a94427566dd286c63b, Date: 2024-02-19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tanmay-db tanmay-db tanmay-db approved these changes

@fjakobs fjakobs Awaiting requested review from fjakobs

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mgyucht @codecov-commenter @tanmay-db