feat(PLU-354): remove connector config models from the SDK - #341
Conversation
Sorry, something went wrong.
Replace the typed unions in CreateSourceConnectorConfig, CreateDestinationConnectorConfig, etc. with Dict[str, Any] and delete the generated per-connector config models. New connector fields work without an SDK upgrade. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
|
||
| | Field | Type | Required | Description | | ||
| | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | ||
| | `config` | [shared.UpdateSourceConnectorConfig](../../models/shared/updatesourceconnectorconfig.md) | :heavy_check_mark: | N/A | No newline at end of file |
There was a problem hiding this comment.
why are most of these getting deleted but some staying? guessing the connector-specific ones are being deleted but not all?
Sorry, something went wrong.
There was a problem hiding this comment.
Yep, just the generic classes should stay, and they'll just wrap a dict. So we may be able to clean those up too longer term.
Sorry, something went wrong.
| @@ -1,83 +0,0 @@ | |||
| """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" | |||
There was a problem hiding this comment.
are all of these deletes a breaking change in any way? Is there a chance that customers are using these files on their side that will now break if they upgrade the package?
Sorry, something went wrong.
There was a problem hiding this comment.
Totally! We've had a deprecation notice since like September. So none of our live examples use these classes. If someone has a real old client, hopefully they'll find that migration guide. I'll make a docs pr to note that they're fully removed once this goes out.
Sorry, something went wrong.
Summary
This decouples the SDK from backend connector schemas — adding/removing fields on a connector no longer requires an SDK release.
These were deprecated in our docs last year. None of our SDK snippets use them.
Test plan
Note
Medium Risk
This is a breaking change to the SDK surface area: connector config fields switch from typed models/unions to Dict[str, Any], and many generated connector config classes/docs are removed, which may break downstream type checks and runtime imports.
Overview
Decouples connector configuration from generated SDK models. Connector config fields for create/update and *ConnectorInformation responses now use Dict[str, Any] instead of per-connector typed unions/models.
Removes the generated connector config model classes and their documentation, updates contract tests to assert config is a dict, and bumps the SDK version to 0.44.0 with a breaking-change entry in CHANGELOG.md (plus release metadata in RELEASES.md).
Reviewed by Cursor Bugbot for commit eb0ae92. Bugbot is set up for automated code reviews on this repo. Configure here.