feat: Enable arbitrary input for ConnectorType enums #304
Conversation
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
Use the openapi overlay file to add `x-speakeasy-unknown-values` to the models for
`SourceConnectorType` and `DestinationConnectorType`. This allows the client to send any string
outside of the enum definitions. This provides forward compatibility in the client, we can create
sources with types that don't exist yet, without requiring a new client version.
Example:
This throws an error that the type is not in our enum. Now, it just warns that this is an unknown
value, but it's sent to the server anyway.
```
res = unstructured_client.sources.create_source(
request={
"create_source_connector": {
"name": "My fancy new source",
"type": "future_source_type",
"config": {
...
...
}
}
}
)
'''
The change will take effect when the client regenerates and uses the new overlay config. By setting
`gen.yaml` to `0.42.2`, the new client will propagate this version change.
gavinchen2025
approved these changes
Aug 6, 2025
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.
Use the openapi overlay file to add
x-speakeasy-unknown-valuesto the models forSourceConnectorTypeandDestinationConnectorType. This allows the client to send any string outside of the enum definitions. This provides forward compatibility in the client, we can create sources with types that don't exist yet, without requiring a new client version.Example:
This throws an error that the type is not in our enum. Now, it just warns that this is an unknown value, but it's sent to the server anyway.
The change will take effect when the client regenerates and uses the new overlay config. By setting
gen.yamlto0.42.2, the new client will propagate this version change.