Skip to content
GitLab

Single inheritance alias 13784

Open Administrator requested to merge github/fork/tzeH/single-inheritance-alias-13784 into master

Created by: tzeH

The current aliasing mechanism makes sure, that aliases for primitve types are resolved to that basic type. It doesn't take into account, that an alias to an alias is still an alias. This PR changes that.

The problem appeared in a 3rd party openapi spec that I had to use (https://github.com/astm-utm/Protocol/blob/cb7cf962d3a0c01b5ab12502f5f54789624977bf/utm.yaml), where they used anyOf with a single subtype to achieve that.

Here is the issue https://github.com/OpenAPITools/openapi-generator/issues/13784.

Basically, two methods needed to change: DefaultCodegen.getAlias(String name) and DefaultCodegen.unaliasSchema(Schema schema). This is achieved in two ways:

  1. The typeAliases now holds the Schema, that a type is an alias for, not just the String. This is necessary since unaliasSchema needs to return a Schema.
  2. The typeAliases need to be initialized properly and include the recursion for "alias to alias" resolution. This is contained in getAllAliases(Map<String, Schema> schemas).

Cleanup work: Some Tests didn't call setOpenAPI on the generator, which I added. The initialization of the aliases was done in fromModel, which I moved to setOpenAPI.

This merge request comes with a unit test in DefaultCodegenTest and a integration Test in AbstractJavaCodegenTest.

I am unsure if this is too breaking for 6.x or should be merged to 7.x.

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.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.