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
  • !13550

Fix AbstractJavaCodegen ability to customize container types

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/dmivankov/fix_custom_java_types into master Sep 29, 2022
  • Overview 3
  • Commits 2
  • Pipelines 1
  • Changes 3

Created by: dmivankov

Fix for https://github.com/OpenAPITools/openapi-generator/issues/13549

After https://github.com/OpenAPITools/openapi-generator/pull/5466 java codegen emits Set for array with uniqueItems=true which has its downsides

  • easy to lose track of element order (it can be important)
  • easy to lose ordering by switching between java Set flavors (HashSet vs LinkedHashSet) somewhere down the line
  • bigger divergence from original json types (either array or object)

Luckily types can be customized/overriden by extending the generator:

  • extend JavaClientCodegen for example
  • in constructor do
    super();
    // import/interface type
    typeMapping().put("set", typeMapping().get("array"));
    // concrete type
    instantiationTypes().put("set", instantiationTypes().get("array"));

But sometimes it won't work because of missing ArrayList import, can be fixed by also doing

    // workaround for https://github.com/OpenAPITools/openapi-generator/issues/13549
    // to be fixed in https://github.com/OpenAPITools/openapi-generator/pull/13550
    importMapping().put("LinkedHashSet", importMapping().get("ArrayList"));

Looks like a bug of assuming "set" fields are instantiated with LinkedHashSet, let's fix it by using type mappings.

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.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/dmivankov/fix_custom_java_types