feat: OpenAPI allow non-nominal cases in enum #2578
Merged
Conversation
This file contains 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
We used to collect the references of the child cases and fail in case we came across a case without a nominal ref. This is not needed to correctly generate the `pneOf` structure in the openapi document, but to include the children to the schemas. After the change, we simply skip cases without a nominal ref when collection children. This allows for schemas like `Enum2(String, Int)` to be turned into `oneOf: [string, int]` correctly. Obviously, there will be no child schemas in this case.
runtologist
requested review from
amitksingh1490,
jdegoes,
vigoo,
adamgfraser and
987Nabil
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2578 +/- ##
==========================================
+ Coverage 64.37% 64.40% +0.03%
==========================================
Files 140 140
Lines 8315 8314 -1
Branches 1504 1504
==========================================
+ Hits 5353 5355 +2
+ Misses 2962 2959 -3 ☔ View full report in Codecov by Sentry. |
987Nabil
approved these changes
Jan 2, 2024
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.
We used to collect the references of the child cases and fail in case we came across a case without a nominal ref. This is not needed to correctly generate the
oneOfstructure in the openapi document, but to include the children to the schemas. After the change, we simply skip cases without a nominal ref when collection children. This allows for schemas likeEnum2(String, Int)to be turned intooneOf: [string, number]correctly. Obviously, there will be no child schemas in this case.