Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !12129

Flatten inline schemas in requestBody components

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Administrator requested to merge github/fork/puppetlabs/fix-inline-request-body-schemas into master Apr 13, 2022
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 22

Created by: impl

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 (closed) Fixes #9123 Fixes #10435 (closed) Fixes #11811 (closed)

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.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/puppetlabs/fix-inline-request-body-schemas