Flatten inline schemas in requestBody components#12129
Closed
impl wants to merge 1 commit intoOpenAPITools:masterfrom
puppetlabs:fix-inline-request-body-schemas
Closed
Flatten inline schemas in requestBody components#12129impl wants to merge 1 commit intoOpenAPITools:masterfrom puppetlabs:fix-inline-request-body-schemas
impl wants to merge 1 commit intoOpenAPITools:masterfrom
puppetlabs:fix-inline-request-body-schemas
Conversation
For request bodies that are completely inlined into a path's operations, the inline model resolver correctly generates both a schema component and a requestBody component and adds $refs. However, when an operation already contains an $ref to a requestBody that itself contains an inline schema, that schema was not being flattened to a separate component. This change adds a separate method to do such flattening and add an $ref if needed.
Member
|
@impl thanks for the PR. I'm also refactoring the inline model resolver and will review this PR shortly (or include this change in my PR for refactoring) |
4 tasks
Contributor
Author
|
Closing in favor of #12293. |
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
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.
For request bodies that are completely inlined into a path's operations, the inline model resolver correctly generates both a schema component and a requestBody component and adds $refs.
However, when an operation already contains an $ref to a requestBody that itself contains an inline schema, that schema was not being flattened to a separate component. This change adds a separate method to do such flattening and add an $ref if needed.
This fixes the dreaded error about a model having an unknown base type (with typically invalid code generated) in this situation.
I have included several tests to verify the corrected behavior, including one test each for the issues this fixes (I suspect there are more duplicates, but this is what I could find from an initial search). I know the issue-specific tests are a little redundant, but I wanted to make sure each was actually solved, as everyone's specs varied slightly.
Fixes #8605
Fixes #9123
Fixes #10435
Fixes #11811
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.