Skip to content

docs(api): exclude retiring connection endpoints from the public spec #175

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.

Sign up for GitHub

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

Open
hotdata-automation wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −6,949
Open

docs(api): exclude retiring connection endpoints from the public spec #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 0 additions & 60 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,7 @@ docs/ColumnProfileDetailOneOf3.md
docs/ColumnProfileDetailOneOf4.md
docs/ColumnProfileInfo.md
docs/ColumnTypeSpec.md
docs/ConnectionHealthResponse.md
docs/ConnectionInfo.md
docs/ConnectionRefreshResult.md
docs/ConnectionSchemaError.md
docs/ConnectionTypeDetail.md
docs/ConnectionTypeSummary.md
docs/ConnectionTypesApi.md
docs/ConnectionsApi.md
docs/CreateConnectionRequest.md
docs/CreateConnectionResponse.md
Expand All @@ -41,8 +35,6 @@ docs/CreateEmbeddingProviderRequest.md
docs/CreateEmbeddingProviderResponse.md
docs/CreateIndexRequest.md
docs/CreateSavedQueryRequest.md
docs/CreateSecretRequest.md
docs/CreateSecretResponse.md
docs/CreateUploadRequest.md
docs/CreateWorkspaceRequest.md
docs/CreateWorkspaceResponse.md
Expand All @@ -69,7 +61,6 @@ docs/ForkDatabaseRequest.md
docs/GetConnectionResponse.md
docs/GetDatabaseContextResponse.md
docs/GetResultResponse.md
docs/GetSecretResponse.md
docs/IndexEntryResponse.md
docs/IndexInfoResponse.md
docs/IndexStatus.md
Expand All @@ -81,7 +72,6 @@ docs/JobStatus.md
docs/JobStatusResponse.md
docs/JobType.md
docs/JobsApi.md
docs/ListConnectionTypesResponse.md
docs/ListConnectionsResponse.md
docs/ListDatabaseContextsResponse.md
docs/ListDatabasesResponse.md
Expand All @@ -93,7 +83,6 @@ docs/ListQueryRunsResponse.md
docs/ListResultsResponse.md
docs/ListSavedQueriesResponse.md
docs/ListSavedQueryVersionsResponse.md
docs/ListSecretsResponse.md
docs/ListWorkspacesResponse.md
docs/LoadManagedTableRequest.md
docs/LoadManagedTableResponse.md
Expand All @@ -108,9 +97,6 @@ docs/QueryRequest.md
docs/QueryResponse.md
docs/QueryRunInfo.md
docs/QueryRunsApi.md
docs/RefreshApi.md
docs/RefreshRequest.md
docs/RefreshResponse.md
docs/RefreshWarning.md
docs/ResultInfo.md
docs/ResultsApi.md
Expand All @@ -119,23 +105,17 @@ docs/SavedQueriesApi.md
docs/SavedQueryDetail.md
docs/SavedQuerySummary.md
docs/SavedQueryVersionInfo.md
docs/SchemaRefreshResult.md
docs/SecretMetadataResponse.md
docs/SecretsApi.md
docs/SubmitJobResponse.md
docs/TableInfo.md
docs/TablePartitionKey.md
docs/TableProfileResponse.md
docs/TableRefreshError.md
docs/TableRefreshResult.md
docs/TableSortKey.md
docs/TemporalProfileDetail.md
docs/TextProfileDetail.md
docs/UpdateEmbeddingProviderRequest.md
docs/UpdateEmbeddingProviderResponse.md
docs/UpdateSavedQueryRequest.md
docs/UpdateSecretRequest.md
docs/UpdateSecretResponse.md
docs/UploadSessionResponse.md
docs/UploadsApi.md
docs/UpsertDatabaseContextRequest.md
Expand All @@ -147,7 +127,6 @@ docs/WorkspaceUsageResponse.md
docs/WorkspacesApi.md
hotdata/__init__.py
hotdata/api/__init__.py
hotdata/api/connection_types_api.py
hotdata/api/connections_api.py
hotdata/api/database_context_api.py
hotdata/api/databases_api.py
Expand All @@ -157,10 +136,8 @@ hotdata/api/information_schema_api.py
hotdata/api/jobs_api.py
hotdata/api/query_api.py
hotdata/api/query_runs_api.py
hotdata/api/refresh_api.py
hotdata/api/results_api.py
hotdata/api/saved_queries_api.py
hotdata/api/secrets_api.py
hotdata/api/uploads_api.py
hotdata/api/usage_api.py
hotdata/api/workspaces_api.py
Expand Down Expand Up @@ -193,12 +170,7 @@ hotdata/models/column_profile_detail_one_of3.py
hotdata/models/column_profile_detail_one_of4.py
hotdata/models/column_profile_info.py
hotdata/models/column_type_spec.py
hotdata/models/connection_health_response.py
hotdata/models/connection_info.py
hotdata/models/connection_refresh_result.py
hotdata/models/connection_schema_error.py
hotdata/models/connection_type_detail.py
hotdata/models/connection_type_summary.py
hotdata/models/create_connection_request.py
hotdata/models/create_connection_response.py
hotdata/models/create_database_request.py
Expand All @@ -207,8 +179,6 @@ hotdata/models/create_embedding_provider_request.py
hotdata/models/create_embedding_provider_response.py
hotdata/models/create_index_request.py
hotdata/models/create_saved_query_request.py
hotdata/models/create_secret_request.py
hotdata/models/create_secret_response.py
hotdata/models/create_upload_request.py
hotdata/models/create_workspace_request.py
hotdata/models/create_workspace_response.py
Expand All @@ -232,7 +202,6 @@ hotdata/models/fork_database_request.py
hotdata/models/get_connection_response.py
hotdata/models/get_database_context_response.py
hotdata/models/get_result_response.py
hotdata/models/get_secret_response.py
hotdata/models/index_entry_response.py
hotdata/models/index_info_response.py
hotdata/models/index_status.py
Expand All @@ -241,7 +210,6 @@ hotdata/models/job_result.py
hotdata/models/job_status.py
hotdata/models/job_status_response.py
hotdata/models/job_type.py
hotdata/models/list_connection_types_response.py
hotdata/models/list_connections_response.py
hotdata/models/list_database_contexts_response.py
hotdata/models/list_databases_response.py
Expand All @@ -253,7 +221,6 @@ hotdata/models/list_query_runs_response.py
hotdata/models/list_results_response.py
hotdata/models/list_saved_queries_response.py
hotdata/models/list_saved_query_versions_response.py
hotdata/models/list_secrets_response.py
hotdata/models/list_workspaces_response.py
hotdata/models/load_managed_table_request.py
hotdata/models/load_managed_table_response.py
Expand All @@ -266,30 +233,23 @@ hotdata/models/numeric_profile_detail.py
hotdata/models/query_request.py
hotdata/models/query_response.py
hotdata/models/query_run_info.py
hotdata/models/refresh_request.py
hotdata/models/refresh_response.py
hotdata/models/refresh_warning.py
hotdata/models/result_info.py
hotdata/models/results_format_query.py
hotdata/models/saved_query_detail.py
hotdata/models/saved_query_summary.py
hotdata/models/saved_query_version_info.py
hotdata/models/schema_refresh_result.py
hotdata/models/secret_metadata_response.py
hotdata/models/submit_job_response.py
hotdata/models/table_info.py
hotdata/models/table_partition_key.py
hotdata/models/table_profile_response.py
hotdata/models/table_refresh_error.py
hotdata/models/table_refresh_result.py
hotdata/models/table_sort_key.py
hotdata/models/temporal_profile_detail.py
hotdata/models/text_profile_detail.py
hotdata/models/update_embedding_provider_request.py
hotdata/models/update_embedding_provider_response.py
hotdata/models/update_saved_query_request.py
hotdata/models/update_secret_request.py
hotdata/models/update_secret_response.py
hotdata/models/upload_session_response.py
hotdata/models/upsert_database_context_request.py
hotdata/models/upsert_database_context_response.py
Expand Down Expand Up @@ -324,13 +284,7 @@ test/test_column_profile_detail_one_of3.py
test/test_column_profile_detail_one_of4.py
test/test_column_profile_info.py
test/test_column_type_spec.py
test/test_connection_health_response.py
test/test_connection_info.py
test/test_connection_refresh_result.py
test/test_connection_schema_error.py
test/test_connection_type_detail.py
test/test_connection_type_summary.py
test/test_connection_types_api.py
test/test_connections_api.py
test/test_create_connection_request.py
test/test_create_connection_response.py
Expand All @@ -340,8 +294,6 @@ test/test_create_embedding_provider_request.py
test/test_create_embedding_provider_response.py
test/test_create_index_request.py
test/test_create_saved_query_request.py
test/test_create_secret_request.py
test/test_create_secret_response.py
test/test_create_upload_request.py
test/test_create_workspace_request.py
test/test_create_workspace_response.py
Expand All @@ -368,7 +320,6 @@ test/test_fork_database_request.py
test/test_get_connection_response.py
test/test_get_database_context_response.py
test/test_get_result_response.py
test/test_get_secret_response.py
test/test_index_entry_response.py
test/test_index_info_response.py
test/test_index_status.py
Expand All @@ -380,7 +331,6 @@ test/test_job_status.py
test/test_job_status_response.py
test/test_job_type.py
test/test_jobs_api.py
test/test_list_connection_types_response.py
test/test_list_connections_response.py
test/test_list_database_contexts_response.py
test/test_list_databases_response.py
Expand All @@ -392,7 +342,6 @@ test/test_list_query_runs_response.py
test/test_list_results_response.py
test/test_list_saved_queries_response.py
test/test_list_saved_query_versions_response.py
test/test_list_secrets_response.py
test/test_list_workspaces_response.py
test/test_load_managed_table_request.py
test/test_load_managed_table_response.py
Expand All @@ -407,9 +356,6 @@ test/test_query_request.py
test/test_query_response.py
test/test_query_run_info.py
test/test_query_runs_api.py
test/test_refresh_api.py
test/test_refresh_request.py
test/test_refresh_response.py
test/test_refresh_warning.py
test/test_result_info.py
test/test_results_api.py
Expand All @@ -418,23 +364,17 @@ test/test_saved_queries_api.py
test/test_saved_query_detail.py
test/test_saved_query_summary.py
test/test_saved_query_version_info.py
test/test_schema_refresh_result.py
test/test_secret_metadata_response.py
test/test_secrets_api.py
test/test_submit_job_response.py
test/test_table_info.py
test/test_table_partition_key.py
test/test_table_profile_response.py
test/test_table_refresh_error.py
test/test_table_refresh_result.py
test/test_table_sort_key.py
test/test_temporal_profile_detail.py
test/test_text_profile_detail.py
test/test_update_embedding_provider_request.py
test/test_update_embedding_provider_response.py
test/test_update_saved_query_request.py
test/test_update_secret_request.py
test/test_update_secret_response.py
test/test_upload_session_response.py
test/test_uploads_api.py
test/test_upsert_database_context_request.py
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- docs(api): exclude retiring connection endpoints from the public spec

@claude claude Bot Aug 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this entry is filed under ### Changed, but the change removes public API surface that shipped in 0.10.0 — SecretsApi, RefreshApi, ConnectionTypesApi, ConnectionsApi.check_connection_health, and ~17 exported models. Anyone importing those breaks on upgrade. Consider a ### Removed section listing the dropped classes so the release notes make the break visible to users. (not blocking)

- feat(query): add dialect parameter to query request

## [0.10.0] - 2026-08-18
Expand Down
33 changes: 0 additions & 33 deletions docs/ConnectionHealthResponse.md
View file
Open in desktop

This file was deleted.

36 changes: 0 additions & 36 deletions docs/ConnectionRefreshResult.md
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions docs/ConnectionSchemaError.md
View file
Open in desktop

This file was deleted.

Loading
Loading