Skip to content

Adds ability to turn inline model resolver on or off and uses it in python-experimental#12198

Merged
spacether merged 10 commits intoOpenAPITools:masterfrom
spacether:feat_add_inline_model_resolver_cli_option
Apr 26, 2022
Merged

Adds ability to turn inline model resolver on or off and uses it in python-experimental#12198
spacether merged 10 commits intoOpenAPITools:masterfrom
spacether:feat_add_inline_model_resolver_cli_option

Conversation

@spacether
Copy link
Copy Markdown
Contributor

@spacether spacether commented Apr 21, 2022

Adds getUseInlineModelResolver and uses it
python-experimental defaults inline model resolver to off, which allows inline schemas at any location

Reason for this change:

Many issues have been filed because our tooling's handling of inline schemas does not always work.
With this generator I am seeking to show that code can be generated that supports inline schemas of any depth at any location. Turning inline model resolver off demonstrates that. The inline model resolver looks for complex inline schemas and extracts them into component schemas, replacing the original schema with a $ref to the new component schema.

Breaking change with fallback

This is a breaking change if users are depending upon the schemas that the inline model resolver extracts to exist as separate models. To return to the past behavior, pass in useInlineModelResolver=true when generating the client
Note: because the python-experimental generator is experimental status, breaking changes are allowed in non-major releases too.

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.

@spacether spacether changed the title Adds getUseInlineModelResolver and uses it Adds ability to turn inline model resolver on or off and uses it in python-experimental Apr 21, 2022
@spacether spacether merged commit c456de4 into OpenAPITools:master Apr 26, 2022
@spacether spacether deleted the feat_add_inline_model_resolver_cli_option branch April 26, 2022 04:44
@spacether
Copy link
Copy Markdown
Contributor Author

I missed turning a test back on and turned it on in a second PR:
#12240

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant