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 3.1 generation for composed schema's with object type #18002

Merged

Conversation

g-getsov
Copy link
Contributor

@g-getsov g-getsov commented Feb 29, 2024

Composed schema request bodies (using oneOf, anyOf, allOf) with type:object currently fall within an edge case which causes generation to fail and in place where we should be generating ParamName or Type ParamName we instead get UNKNOWN_PARAM_NAME.

Example of bad generation

/*
   * @param UNKNOWN_PARAM_NAME  (optional)
   * @throws ApiException if fails to make API call
   */
  public void petsPatch( UNKNOWN_PARAM_NAME) throws ApiException {
    Object localVarPostBody = UNKNOWN_PARAM_NAME;

The additional check for composed schema's catches this edge case and ensures that the generation is correct

  /*
   * @param petsPatchRequest  (optional)
   * @throws ApiException if fails to make API call
   */
  public void petsPatch(PetsPatchRequest petsPatchRequest) throws ApiException {
    Object localVarPostBody = petsPatchRequest;

The generation works fine when the type is omitted (supported v3.1+) and now with the fix it also works when the type:object is present

I've added a test that tests the generation for a schema containing both requestBody objects with and without type

@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg

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.1.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.

@wing328
Copy link
Member

wing328 commented Mar 1, 2024

thanks for the fix, which looks good to me

@wing328 wing328 merged commit d3ebb0a into OpenAPITools:master Mar 1, 2024
14 checks passed
@wing328 wing328 added this to the 7.4.0 milestone Mar 9, 2024
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.

None yet

2 participants