chore(embedding-providers): clarify secret_name usage - #177
chore(embedding-providers): clarify secret_name usage#177hotdata-automation[bot] wants to merge 1 commit into
Conversation
|
|
||
| ### Changed | ||
|
|
||
| - chore(embedding-providers): clarify secret_name usage |
There was a problem hiding this comment.
Blocking: this is the only changelog entry, but the diff also deletes the entire Secrets API (hotdata/api/secrets_api.py, 8 secret models), the Connection Types API (hotdata/api/connection_types_api.py, 3 models), the Refresh API (hotdata/api/refresh_api.py, RefreshRequest/RefreshResponse/SchemaRefreshResult/ConnectionRefreshResult/TableRefreshError), ConnectionsApi.check_connection_health + ConnectionHealthResponse, and two JobResult oneOf variants.
That is a breaking removal of a large part of the public SDK surface with no ### Removed / **Breaking:** entry — the repo documents removals that way for 0.10.0 (see lines 17-28), and no prior release deprecated any of these. Either the spec regression is unintended (most likely, given the title/description only mention the secret_name description tweak) and should be fixed upstream, or it is intended and needs a Breaking changelog entry plus a major/minor version bump.
There was a problem hiding this comment.
Review
Note: the full diff was omitted from my review context (7943 lines). I fetched the file list with gh pr diff --name-only and read the post-change files from the checkout: CHANGELOG.md, hotdata/models/create_embedding_provider_request.py, hotdata/models/job_result.py, hotdata/models/table_refresh_result.py, hotdata/api/connections_api.py, hotdata/api/ (listing), tests/integration/conftest.py, plus repo-wide greps for every removed symbol.
Blocking Issues
1. The change is far larger than the title implies. The only intended edit appears to be the secret_name description on CreateEmbeddingProviderRequest (hotdata/models/create_embedding_provider_request.py:34). Everything else is deletion of live public API surface:
hotdata/api/secrets_api.py(entire Secrets API) +CreateSecretRequest,CreateSecretResponse,GetSecretResponse,ListSecretsResponse,SecretMetadataResponse,UpdateSecretRequest,UpdateSecretResponsehotdata/api/connection_types_api.py+ConnectionTypeDetail,ConnectionTypeSummary,ListConnectionTypesResponsehotdata/api/refresh_api.py+RefreshRequest,RefreshResponse,SchemaRefreshResult,ConnectionRefreshResult,TableRefreshErrorConnectionsApi.check_connection_healthandConnectionHealthResponse(hotdata/api/connections_api.py, -266 lines)- two oneOf variants dropped from
JobResult(hotdata/models/job_result.py)
If the upstream spec change was only meant to reword a description, this is a spec-build regression and should be fixed in https://github.com/hotdata-dev/www.hotdata.dev/pull/387 before regenerating.
2. Hand-written integration tests are left importing deleted modules. The generated test/ fixtures were regenerated, but tests/ was not updated, so these now fail at import/collection time:
tests/integration/conftest.py:17--from hotdata.api.connection_types_api import ConnectionTypesApitests/integration/conftest.py:25--from hotdata.api.refresh_api import RefreshApitests/integration/conftest.py:27--from hotdata.api.secrets_api import SecretsApi
Because these are in conftest.py, the ImportError takes down collection for the whole tests/integration package, not just the affected tests. Also broken:
tests/integration/test_secrets_crud.py:15-18-- importsSecretsApi,CreateSecretRequest,UpdateSecretRequesttests/integration/test_connection_types_read.py:9-- importsConnectionTypesApitests/integration/test_connections_read.py:31-- callsconnections_api.check_connection_health(connection_id), which no longer exists onConnectionsApi
Integration Tests / integration and Integration Tests / unit had not reported when this review started, so I am not claiming they failed -- but these are import-time breakages visible in the source.
3. No breaking-change record. CHANGELOG.md gains only - chore(embedding-providers): clarify secret_name usage under Changed. Removing three API classes and a ConnectionsApi method is breaking, and none of it was deprecated in an earlier release. The repo's own convention for this is a Removed section with a **Breaking:** note (see the 0.10.0 entry). Check release metadata / Verify changelog matches version bump had not reported yet either.
Action Required
- Confirm with the upstream spec PR whether the Secrets / Connection Types / Refresh endpoints were actually removed from the API. If not, regenerate from a corrected spec so this PR contains only the
secret_namedescription change. - If the removals are intentional: update
tests/integration/conftest.pyand the three affected integration tests, add a Removed /**Breaking:**changelog entry, and bump the version accordingly.
Auto-generated from the updated HotData OpenAPI spec.
Source: https://github.com/hotdata-dev/www.hotdata.dev/pull/387