Skip to content

chore(databases): clarify fork naming behavior #181

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

Merged
hotdata-automation merged 2 commits into from
Sep 3, 2026
Merged

chore(databases): clarify fork naming behavior #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c5129a
chore(databases): clarify fork naming behavior
hotdata-automation[bot] Aug 25, 2026
f7284fd
fix: drop integration-test references to retired Secrets/Refresh/Conn…
eddietejeda Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
66 changes: 0 additions & 66 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,34 +97,23 @@ 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
docs/ResultsFormatQuery.md
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 +125,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 +134,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 +168,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 +177,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 +200,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 +208,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 +219,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 +231,21 @@ 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 +280,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 +290,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 +316,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 +327,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 +338,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,34 +352,23 @@ 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
test/test_results_format_query.py
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
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Removed

- **Breaking:** the Secrets, Refresh, and Connection Types endpoints were retired
from the HotData API and are gone from the SDK: `SecretsApi`, `RefreshApi`,
`ConnectionTypesApi`, and their request/response models
(`CreateSecretRequest`, `UpdateSecretRequest`, `RefreshRequest`, etc.).
- **Breaking:** `ConnectionsApi.check_connection_health` and
`ConnectionHealthResponse` are removed.
- **Breaking:** the `data_refresh_table` / `data_refresh_connection` `JobType`
values and the corresponding `JobResult` variants
(`TableRefreshResult` / `ConnectionRefreshResult`) are removed.

### Changed

- chore(databases): clarify fork naming behavior

@claude claude Bot Aug 25, 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.

Blocking: the only changelog entry for this PR is the fork-naming doc tweak, but the regeneration also deletes a large slice of the public surface:

  • SecretsApi, RefreshApi, ConnectionTypesApi (dropped from hotdata/api/__init__.py and hotdata/__init__.py)
  • ~20 models (CreateSecretRequest, GetSecretResponse, RefreshRequest/RefreshResponse, ConnectionHealthResponse, ConnectionTypeDetail, SchemaRefreshResult, …)
  • ConnectionsApi.check_connection_health (see docs/ConnectionsApi.md, −87)
  • JobType members (the refresh-related variants) and the refresh variants of the JobResult oneOf

Per the repo's own SemVer policy — and the precedent set by the 0.10.0 entry — this needs a ### Removed block flagged **Breaking:** describing what callers lose and what to use instead, not a single chore(databases) line under ### Changed.

Also worth confirming this removal is intentional: the PR title/description only mention fork naming, so a spec that silently dropped three whole tag groups is worth double-checking before merge.

- docs: adopt "instant database" / "instant catalog" terminology in hand-written
prose. Documentation only — all public API symbols (`ManagedTableResponse`,
`load_managed_table`, the `managed` source type, etc.) are unchanged for
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# hotdata

Official Python client for the [Hotdata](https://www.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.
Official Python client for the [Hotdata](https://www.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, uploads, indexes, jobs, embedding providers, and workspace context.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/BulkCreateDatabasesRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**default_schema** | **str** | Schema that unqualified table names resolve to inside each database. | [optional]
**expires_at** | **str** | When the created databases expire. Accepts an RFC 3339 timestamp or a relative duration such as `24h`, `90m`, or `7d`. | [optional]
**idempotency_key** | **str** | Repeat this value to retry a request safely. A retry carrying a key that was already used returns the original batch — the same `batch_id` and the same databases — instead of creating a second set. The key identifies the request, not its contents: reusing a key with a different `count` or template returns the original batch unchanged rather than reporting a mismatch. Use a fresh key per distinct request. | [optional]
**name_template** | **str** | Optional display-label pattern for each database. `{index}` is replaced with the database's zero-based position — for example `tenant-{index}` produces `tenant-0`, `tenant-1`, and so on. Labels are not identifiers and are not required to be unique. | [optional]
**name_template** | **str** | Optional display-label pattern for each database. `{index}` is replaced with the database's zero-based position — for example `tenant-{index}` produces `tenant-0`, `tenant-1`, and so on. When omitted, each database is labelled from its own ID. Labels are not identifiers and are not required to be unique. | [optional]
**schemas** | [**List[DatabaseDefaultSchemaDecl]**](DatabaseDefaultSchemaDecl.md) | Schemas and tables to declare on every database in the batch, in the same shape a single create accepts. The declaration applies identically to each database, so a batch of 10,000 declaring one table yields 10,000 databases that each hold that table and are ready to load — with no follow-up call per database. Omitted or empty means each database starts with no tables. | [optional]

## Example
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.

Loading
Loading