Skip to content

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#12129
impl wants to merge 1 commit intoOpenAPITools:masterfrom
puppetlabs:fix-inline-request-body-schemas

Conversation

@impl
Copy link
Copy Markdown
Contributor

@impl impl commented Apr 13, 2022

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

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.
@wing328
Copy link
Copy Markdown
Member

wing328 commented Apr 25, 2022

@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)

@impl
Copy link
Copy Markdown
Contributor Author

impl commented May 7, 2022

Closing in favor of #12293.

@impl impl closed this May 7, 2022
@impl impl deleted the fix-inline-request-body-schemas branch May 7, 2022 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment