Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JAVA] fix several anyOf/oneOf problems #19817

Merged
merged 6 commits into from
Oct 10, 2024

Conversation

martin-mfg
Copy link
Contributor

Fix various problems when using anyOf or oneOf. Mostly focusing on the Jersey libraries.

I separated the fixed problems into different commits in this PR:

  • commit 1: generate more child-specific methods where possible.
    e.g. in samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/model/FakeAnyOfWIthSameErasureGet200Response.java we now also generate the method "getListInteger". Previously this was skipped due to "getListString" already being created.
    The mustache file changes also include a small simplification of the relevant template part. The Jersey anyOf*.mustache templates were a bit out of sync and needed to be aligned with their oneOf counterparts - see here for context.
  • commit 2: When generating an anyOf/oneOf model with useBeanValidation=true, don't generate uncompilable code.
  • commit 3: When generating a oneOf model which also is a map, don't generate uncompilable code.
  • commit 4: Apply similar fixes to the Jersey anyOf*.mustache templates. As mentioned above, they were a bit out of sync.

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.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.
    @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@wing328
Copy link
Member

wing328 commented Oct 9, 2024

https://github.com/OpenAPITools/openapi-generator/actions/runs/11245644264/job/31266185926?pr=19817

please update the samples when you've time

overall the change looks good.

will merge after all tests pass

thank you

@martin-mfg
Copy link
Contributor Author

@wing328 done :)

@wing328 wing328 merged commit b730e36 into OpenAPITools:master Oct 10, 2024
77 checks passed
@wing328
Copy link
Member

wing328 commented Oct 10, 2024

looks good.

thank you.

@Csini
Copy link

Csini commented Oct 19, 2024

can you please correct the same issue in

<generatorName>java</generatorName>
<library>resttemplate</library>

?

@martin-mfg
Copy link
Contributor Author

Hi @Csini, I don't have the time to make the changes for resttemplate. Please create a PR yourself, or create a new issue describing your problem and add a bounty (like e.g. here) to increase the chance of someone else working on it.

@kulon
Copy link

kulon commented Dec 11, 2024

We upgraded from version 7.6.0 to 7.10.0 and found that changes between these versions break the java-camel generator's processing of the oneOf/anyOf definitions.

For example, the following schema generates proper code with version 7.6.0, but the generator version 7.10.0 creates a class with no fields. We are using version 3.0.3 of the OpenAPI spec.

"Request": {
      "type": "object",
      "properties": {
        "referenceNumber": {"type": "string", "nullable": true},
        "documentNumber": { "type": "string", "nullable": true},
        "stockNumber": {"type": "string", "nullable": true}
      },
      "oneOf": [
        {
          "required" : [ "referenceNumber" ]
        },
        {
          "anyOf": [
            {
              "required": [ "documentNumber" ]
            },
            {
              "required": [ "stockNumber" ]
            }
          ]
        }
      ]
    }

@martin-mfg
Copy link
Contributor Author

Hi @kulon, I wasn't able to reproduce your problem yet. Could you please share the full openAPI spec and generator settings?

@kulon
Copy link

kulon commented Dec 12, 2024

HI @martin-mfg, please take a look at this sample app:
https://github.com/kulon/code-samples/tree/main/openapi-generator-sample

Just changing the generator's version in the pom.xml from 7.6.0 to 7.10.0 will break the app.

@martin-mfg
Copy link
Contributor Author

The problem occurs already in OpenAPI Generator version 7.9.0, according to my tests. i.e. it is not caused by this PR. Please open a new issue for your problem (assuming no similar issue has been opened yet).

@kulon
Copy link

kulon commented Dec 12, 2024

Created a bug report #20312

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.

4 participants