Skip to content

chore(databases): clarify name field default behavior - #180

Closed
hotdata-automation[bot] wants to merge 1 commit into
mainfrom
openapi-update-32824532376
Closed

chore(databases): clarify name field default behavior#180
hotdata-automation[bot] wants to merge 1 commit into
mainfrom
openapi-update-32824532376

Conversation

@hotdata-automation

Copy link
Copy Markdown
Contributor

Auto-generated from the updated HotData OpenAPI spec.
Source: https://github.com/hotdata-dev/www.hotdata.dev/pull/390

@hotdata-automation
hotdata-automation Bot requested a review from a team as a code owner August 25, 2026 08:02
@hotdata-automation
hotdata-automation Bot requested review from anoop-narang and removed request for a team August 25, 2026 08:02
@hotdata-automation
hotdata-automation Bot enabled auto-merge (squash) August 25, 2026 08:02

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review

Note: the full diff could not be included in the review prompt and gh pr diff returns HTTP 406 (>300 files), so I reviewed by reading the post-merge checkout directly — hotdata/api/, hotdata/models/job_type.py, hotdata/models/job_result.py, hotdata/models/create_database_request.py, hotdata/__init__.py, CHANGELOG.md, and all of tests/integration/.

Blocking Issues

1. tests/integration/conftest.py imports three modules this PR deletes — the entire integration suite fails at collection.

  • tests/integration/conftest.py:17from hotdata.api.connection_types_api import ConnectionTypesApi
  • tests/integration/conftest.py:25from hotdata.api.refresh_api import RefreshApi
  • tests/integration/conftest.py:27from hotdata.api.secrets_api import SecretsApi

All three modules are gone from the checkout (hotdata/api/ now contains only 14 API modules). Because these are top-level imports in conftest.py, this is an ImportError during collection: every integration test fails, not just the secrets/refresh/connection-type ones. The secrets_api, connection_types_api, and refresh_api fixtures at lines 155, 170, and 190 need to go with them.

2. Orphaned integration tests for deleted APIs.

  • tests/integration/test_secrets_crud.py — imports hotdata.api.secrets_api, hotdata.models.create_secret_request, hotdata.models.update_secret_request (all deleted).
  • tests/integration/test_connection_types_read.py — imports hotdata.api.connection_types_api (deleted).

The PR deleted the corresponding generated tests under test/ (test_secrets_api.py, test_connection_types_api.py, etc.) but left these hand-written scenario tests behind. They should be deleted too — and since scenario-parity cross-checks against api/test-scenarios.yaml upstream, confirm those scenarios were dropped from the manifest in the linked www.hotdata.dev PR as well, or that job will disagree either way.

3. tests/integration/test_connections_read.py:31 calls the removed connections_api.check_connection_health(...).

check_connection_health is no longer a method on ConnectionsApi (that is most of the -267 in connections_api.py), and ConnectionHealthResponse is deleted. The test is currently @pytest.mark.skip-ed, so it will not fail today — but it is a latent AttributeError for whoever re-enables it per the skip reason. Drop the health-check assertions (lines 31-33) and the "health check" mention in the module docstring.

4. Breaking removals are undocumented in CHANGELOG.md. See the inline comment on CHANGELOG.md:12.

Action Required

  • Remove the secrets_api / connection_types_api / refresh_api imports and fixtures from tests/integration/conftest.py.
  • Delete tests/integration/test_secrets_crud.py and tests/integration/test_connection_types_read.py.
  • Remove the check_connection_health block from tests/integration/test_connections_read.py.
  • Add a Removed / Breaking CHANGELOG entry covering the removed APIs, models, JobType members, and JobResult variant.

Non-blocking

README.md:3 still advertises secrets in the list of covered API areas; worth dropping in the same pass.

I have not run anything — the Integration Tests checks were still queued when this review started, so treat item 1 as a prediction from reading the imports, not an observed failure.

Comment thread CHANGELOG.md

### Changed

- chore(databases): clarify name field default behavior

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This entry describes only the name-field docstring tweak, but the diff also removes a large amount of public API surface:

  • hotdata.SecretsApi and the whole secrets model set (CreateSecretRequest, UpdateSecretRequest, GetSecretResponse, ListSecretsResponse, SecretMetadataResponse, …)
  • hotdata.RefreshApi plus RefreshRequest/RefreshResponse/RefreshWarning/SchemaRefreshResult/TableRefreshResult/TableRefreshError/ConnectionRefreshResult/ConnectionSchemaError
  • hotdata.ConnectionTypesApi plus ConnectionTypeSummary/ConnectionTypeDetail/ListConnectionTypesResponse
  • ConnectionsApi.check_connection_health and ConnectionHealthResponse
  • three JobType enum members, and RefreshResponse from the JobResult oneOf

Every one of those is an import-breaking change for downstream users. The repo already has a convention for this (see the ### Removed / **Breaking:** block for 0.10.0) — please add an equivalent entry so the removals are discoverable, rather than landing them under a chore line.
true

@eddietejeda

Copy link
Copy Markdown
Contributor

Superseded by #181, which was regenerated from the latest spec and includes this change.

@eddietejeda eddietejeda closed this Sep 3, 2026
auto-merge was automatically disabled September 3, 2026 00:09

Pull request was closed

@eddietejeda
eddietejeda deleted the openapi-update-32824532376 branch September 3, 2026 00:10
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.

1 participant