Skip to content

feat(PLU-354): remove connector config models from the SDK#341

Merged
awalker4 merged 3 commits intomainfrom
austin/plu-354-delete-connector-config-models-from-the-sdk
May 7, 2026
Merged

feat(PLU-354): remove connector config models from the SDK#341
awalker4 merged 3 commits intomainfrom
austin/plu-354-delete-connector-config-models-from-the-sdk

Conversation

@awalker4
Copy link
Copy Markdown
Collaborator

@awalker4 awalker4 commented May 7, 2026

Summary

  • Replace the typed unions in CreateSourceConnectorConfig, CreateDestinationConnectorConfig, UpdateSourceConnectorConfig, UpdateDestinationConnectorConfig, and the *ConnectorInformation configs with Dict[str, Any].
  • Delete the per-connector config models and their docs (e.g. S3SourceConnectorConfig, AzureDestinationConnectorConfig, OpenSearchConnectorConfig, …).
  • Bump version to 0.44.0 and add a breaking-change changelog entry.

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

  • CI green
  • Smoke: create a source connector with a plain dict config against SND and confirm the request goes through

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.

awalker4 and others added 3 commits May 7, 2026 15:36
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why are most of these getting deleted but some staying? guessing the connector-specific ones are being deleted but not all?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

@@ -1,83 +0,0 @@
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

@awalker4 awalker4 merged commit 3577cd6 into main May 7, 2026
25 checks passed
@awalker4 awalker4 deleted the austin/plu-354-delete-connector-config-models-from-the-sdk branch May 7, 2026 20:08
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.

2 participants