[Generator] Stop generating an undocumented case for enums/oneOfs #205
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
czechboy0
changed the title
czechboy0
added a commit
to apple/swift-openapi-runtime
that referenced
this pull request
Aug 17, 2023
[Runtime] Stop generating an undocumented case for enums/oneOfs ### Motivation Runtime side of apple/swift-openapi-generator#205 ### Modifications Added a helper function that produces the right error. ### Result Generated code can use this error to throw when an unknown case is encountered. ### Test Plan Tested together with the generator. Reviewed by: glbrntt Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (api breakage) - Build finished. ✔︎ pull request validation (docc test) - Build finished. ✔︎ pull request validation (integration test) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #40
gjcairo
approved these changes
Aug 17, 2023
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.
Motivation
Fixes #204.
Depends on apple/swift-openapi-runtime#40.
Modifications
This introduces the feature flag
closedEnumsAndOneOfswhich stops generating theundocumentedcase for enums and oneOfs (no other places are affected, such as responses, and so on.). The default behavior in 0.1.x stays the same, but in 0.2.0 we'll stop generatingundocumentedcases unconditionally.This fixes our divergence from the OpenAPI specification, as we treated enums and oneOfs as open, but they're closed by default.
I also added docs on this pattern to make it easier for adopters to know how to create open enums and oneOfs on purpose.
Result
We get closer to being spec-compliant.
Test Plan
Created new snippet tests to verify the new functionality, will adapt file-based tests when we're preparing 0.2.0.