Remediate ClickHouse Cloud OpenAPI drift - #343
Open
sdairs wants to merge 2 commits into
Open
Conversation
This was referenced Jul 31, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the clickhouse-cloud-api crate (and the shared OpenAPI analyzer metadata) to match the current live ClickHouse Cloud OpenAPI spec: it removes obsolete ClickStack connection endpoints, adds the new beta UDF API surface (client methods + models), and extends models for ClickPipes schema discovery and SCIM enterprise extension compatibility.
Changes:
- Removed five stale ClickStack connection client methods and updated beta-operation metadata accordingly.
- Added beta UDF client methods plus new request/response models (tolerant response structs, strict discriminated request unions).
- Added model updates + tests for ClickPipe schema discovery
meta, SCIM enterprise extension, andDegradedClickPipe state.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/clickhouse-openapi-analyzer/src/config.rs | Extends acknowledged unsupported enum pointers for UDF attach 424 error response enums. |
| crates/clickhouse-cloud-api/src/client.rs | Removes ClickStack connection endpoints; adds UDF client endpoints (CRUD, attachments, versions, upload session). |
| crates/clickhouse-cloud-api/src/models.rs | Adds Degraded ClickPipe state; adds ClickPipe schema discovery meta; adds SCIM enterprise extension field; introduces UDF models (requests + tolerant responses). |
| crates/clickhouse-cloud-api/src/meta.rs | Updates BETA_OPERATIONS to drop removed ClickStack ops and add UDF operations. |
| crates/clickhouse-cloud-api/tests/client_test.rs | Replaces ClickStack connection wiremock tests with UDF wiremock coverage (pagination, request shapes, attach/detach, etc.). |
| crates/clickhouse-cloud-api/tests/models_test.rs | Adds compatibility tests for new tolerant response models, schema discovery meta, SCIM enterprise extension, and UDF request strictness. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sdairs
temporarily deployed
to
cloud-integration
August 3, 2026 18:31 — with
GitHub Actions
Inactive
sdairs
marked this pull request as ready for review
August 3, 2026 18:48
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DegradedClickPipe stateWhy
The live Cloud OpenAPI document moved beyond the snapshot recorded by #323: ClickStack connection operations were removed and a beta UDF API was added. The library and snapshot must move together so the shared analyzer, generated metadata, and public Rust surface remain aligned.
Impact
clickhouse-cloud-apinow covers the current live spec with direction-aware request strictness and tolerant all-Optionresponse models. Removed ClickStack connection methods no longer expose endpoints absent from the API.Closes #323.
Validation
cargo fmt --all --checkcargo build -p clickhouse-cloud-api -p clickhouse-openapi-analyzer --all-targetscargo test -p clickhouse-cloud-api -p clickhouse-openapi-analyzercargo clippy -p clickhouse-cloud-api -p clickhouse-openapi-analyzer --all-targets -- -D warningspython3 -m unittest discover -s scripts/tests -p 'test_*.py'cargo check --workspace --all-featurespython3 scripts/check-openapi-drift.py --dry-run— 0 actionable drift