Skip to content
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

[Fix] Fix docs generation when two services have the same name #872

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

hectorcast-db
Copy link
Contributor

@hectorcast-db hectorcast-db commented Jan 24, 2025

What changes are proposed in this pull request?

Fix docs generation when two services have the same name. Currently, only one service docs will be generated.

How is this tested?

Regenerated current Docs

Copy link

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-py

Inputs:

  • PR number: 872
  • Commit SHA: 8c5be291fbe6d925458cda35010b8b092b20eed4

Checks will be approved automatically on success.

@hectorcast-db hectorcast-db added this pull request to the merge queue Jan 24, 2025
Merged via the queue into main with commit 4bcfb0a Jan 24, 2025
20 checks passed
@hectorcast-db hectorcast-db deleted the hectorcast-db/fix-docs-duple branch January 24, 2025 14:51
renaudhartert-db added a commit that referenced this pull request Jan 30, 2025
### Bug Fixes

 * Fix docs generation when two services have the same name ([#872](#872)).

### Internal Changes

 * Add CICD environment to the User Agent ([#866](#866)).
 * Add unit tests for retriable requests ([#879](#879)).
 * Extract "before retry" handler, use it to rewind the stream ([#878](#878)).
 * Update Model Serving `http_request` mixin to correctly use the underlying API.  ([#876](#876)).

### API Changes:

 * Added [a.budget_policy](https://databricks-sdk-py.readthedocs.io/en/latest/account/budget_policy.html) account-level service.
 * Added [a.enable_ip_access_lists](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings/enable_ip_access_lists.html) account-level service.
 * Added `review_state`, `reviews` and `runner_collaborators` fields for `databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook`.
 * Added `statement_id` field for `databricks.sdk.service.dashboards.QueryAttachment`.
 * Added `effective_performance_target` field for `databricks.sdk.service.jobs.BaseRun`.
 * Added `performance_target` field for `databricks.sdk.service.jobs.CreateJob`.
 * Added `performance_target` field for `databricks.sdk.service.jobs.JobSettings`.
 * Added `effective_performance_target` field for `databricks.sdk.service.jobs.Run`.
 * Added `performance_target` field for `databricks.sdk.service.jobs.RunNow`.
 * Added `effective_performance_target` field for `databricks.sdk.service.jobs.RunTask`.
 * Added `run_as_repl` field for `databricks.sdk.service.jobs.SparkJarTask`.
 * Added `user_authorized_scopes` field for `databricks.sdk.service.oauth2.CreateCustomAppIntegration`.
 * Added `user_authorized_scopes` field for `databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput`.
 * Added `user_authorized_scopes` field for `databricks.sdk.service.oauth2.UpdateCustomAppIntegration`.
 * Added `contents` field for `databricks.sdk.service.serving.HttpRequestResponse`.
 * Added .
 * Added .
 * Added .
 * Changed `create()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service with new required argument order.
 * Changed `http_request()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service to type `http_request()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service.
 * Changed `http_request()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service to return `databricks.sdk.service.serving.HttpRequestResponse` dataclass.
 * Changed `config` field for `databricks.sdk.service.serving.CreateServingEndpoint` to no longer be required.
 * Removed `securable_kind` field for `databricks.sdk.service.catalog.CatalogInfo`.
 * Removed `securable_kind` field for `databricks.sdk.service.catalog.ConnectionInfo`.
 * Removed `status_code` and `text` fields for `databricks.sdk.service.serving.ExternalFunctionResponse`.

OpenAPI SHA: 840c660106f820a1a5dff931d51fa5f65cd9fdd9, Date: 2025-01-28
github-merge-queue bot pushed a commit that referenced this pull request Jan 30, 2025
### Bug Fixes

* Fix docs generation when two services have the same name
([#872](#872)).


### Internal Changes

* Add CICD environment to the User Agent
([#866](#866)).
* Add unit tests for retriable requests
([#879](#879)).
* Extract "before retry" handler, use it to rewind the stream
([#878](#878)).
* Update Model Serving `http_request` mixin to correctly use the
underlying API.
([#876](#876)).

### Backward Incompatible Changes

* Changed `create()` method for
[w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving/serving_endpoints.html)
workspace-level service with new required argument order.
* Changed `http_request()` method for
[w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving/serving_endpoints.html)
workspace-level service to type `http_request()` method for
[w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving/serving_endpoints.html)
workspace-level service.
* Changed `http_request()` method for
[w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving/serving_endpoints.html)
workspace-level service to return
`databricks.sdk.service.serving.HttpRequestResponse` dataclass.
* Changed `config` field for
`databricks.sdk.service.serving.CreateServingEndpoint` to no longer be
required.
* Removed `securable_kind` field for
`databricks.sdk.service.catalog.CatalogInfo`.
* Removed `securable_kind` field for
`databricks.sdk.service.catalog.ConnectionInfo`.
* Removed `status_code` and `text` fields for
`databricks.sdk.service.serving.ExternalFunctionResponse`.

### API Changes:

* Added
[a.budget_policy](https://databricks-sdk-py.readthedocs.io/en/latest/account/billing/budget_policy.html)
account-level service.
* Added
[a.enable_ip_access_lists](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/settings/enable_ip_access_lists.html)
account-level service.
* Added `review_state`, `reviews` and `runner_collaborators` fields for
`databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook`.
* Added `statement_id` field for
`databricks.sdk.service.dashboards.QueryAttachment`.
* Added `effective_performance_target` field for
`databricks.sdk.service.jobs.BaseRun`.
* Added `performance_target` field for
`databricks.sdk.service.jobs.CreateJob`.
* Added `performance_target` field for
`databricks.sdk.service.jobs.JobSettings`.
* Added `effective_performance_target` field for
`databricks.sdk.service.jobs.Run`.
* Added `performance_target` field for
`databricks.sdk.service.jobs.RunNow`.
* Added `effective_performance_target` field for
`databricks.sdk.service.jobs.RunTask`.
* Added `run_as_repl` field for
`databricks.sdk.service.jobs.SparkJarTask`.
* Added `user_authorized_scopes` field for
`databricks.sdk.service.oauth2.CreateCustomAppIntegration`.
* Added `user_authorized_scopes` field for
`databricks.sdk.service.oauth2.GetCustomAppIntegrationOutput`.
* Added `user_authorized_scopes` field for
`databricks.sdk.service.oauth2.UpdateCustomAppIntegration`.
* Added `contents` field for
`databricks.sdk.service.serving.HttpRequestResponse`.
* Added `clean_room` enum value for
`databricks.sdk.service.catalog.SecurableType`.
* Added `budget_policy_limit_exceeded` enum value for
`databricks.sdk.service.jobs.TerminationCodeCode`.
* Added `arclight_azure_exchange_token_with_user_delegation_key` enum
value for `databricks.sdk.service.settings.TokenType`.

OpenAPI SHA: 840c660106f820a1a5dff931d51fa5f65cd9fdd9, Date: 2025-01-28

---------

Signed-off-by: Renaud Hartert <renaud.hartert@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants