feat: enable forward-compatible enums - #20
Open
atonks2 wants to merge 1 commit into
Open
Conversation
Sets forwardCompatibleEnumsByDefault: true so the generated SDK treats unrecognized enum values as open/unknown instead of raising a validation error, per Speakeasy's SDK resilience guidance. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Speakeasy generator configuration for Ruby in .speakeasy/gen.yaml by enabling forward-compatible enums by default (forwardCompatibleEnumsByDefault: true). There are no review comments, and I have no feedback to provide.
![moov-review-bot[bot]](https://avatars.githubusercontent.com/in/4053684?s=60&v=4){kind=small}
| enableFormatting: false | ||
| flattenGlobalSecurity: true | ||
| forwardCompatibleEnumsByDefault: false | ||
| forwardCompatibleEnumsByDefault: true |
There was a problem hiding this comment.
PR title feat: enable forward-compatible enums violates Conventional Commits convention. Add component: feat(ruby): enable forward-compatible enums
(95% confidence — The convention is clearly documented; only uncertainty is the exact preferred component name (ruby vs sdk vs gen).)
bpross
approved these changes
Aug 27, 2026
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
2 participants
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.
Description
Sets
forwardCompatibleEnumsByDefault: truein.speakeasy/gen.yamlso this SDK treats unrecognized enum values in API responses as open/unknown instead of raising a validation error. Today, when the API starts returning a new enum value, older pinned SDKs throw an exception on the response with no way for the caller to know whether their request actually succeeded.Per Speakeasy's SDK resilience docs.
Config-only change — the next scheduled/triggered SDK generation run will regenerate against this setting.