feat: enable forward-compatible enums - #21
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>
![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 is missing the required (<component>) segment. Per Moov's Conventional Commits convention, feat requires a component. Suggested corrected title: feat(sdk): enable forward-compatible enums by default
(95% confidence — Convention is clear; only minor uncertainty is the exact component name (ruby vs sdk vs speakeasy).)
![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 in .speakeasy/gen.yaml to enable forward-compatible enums by default (forwardCompatibleEnumsByDefault: true) for the Ruby client SDK. There are no review comments, and I have no additional feedback to provide on this change.
2 participants
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.