Link query parameter to model object

[Zomzog]

PR checklist

• Read the contribution guidelines.
• Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
• Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
• Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Must fix #2655

I have changed the code in defaultCodgen. Maybe it's too low level and must be done in abstractJava?

Another solution is to create another fromProperty for fromParameter with more parameters and force complexType with the $ref. But I'm afraid of losing all language-specific overriding.

@wing328 (2015/07)
@jimschubert (2016/05)
@cbornet (2016/05)
@ackintosh (2018/02)
@jmini (2018/04)

[jimschubert]

I've evaluated this locally, and it appears to almost fix the linked issue.

Generating with the following from this branch:

openapi-generator generate -g spring \
  -i modules/openapi-generator/src/test/resources/3_0/objectQueryParam.yaml \
  -o .bak/2655 \
  --additional-properties=library=spring-boot,beanValidations=true,reactive=true \
  --skip-validate-spec

And modifying the output in .bak/2655 for PonyApi.java to remove the @RequestParam as requested in the linked issue:

    @ApiOperation(value = "", nickname = "list", notes = "", tags={  })
    @ApiResponses(value = {  })
    @RequestMapping(value = "/pony",
        method = RequestMethod.GET)
    default Mono<ResponseEntity<PageQuery>> list(@ApiParam(value = "", defaultValue = "null") @Valid PageQuery pageQuery, ServerWebExchange exchange) {
        exchange.getResponse().setStatusCode(HttpStatus.OK);
        return Mono.just(new ResponseEntity(pageQuery, HttpStatus.OK));
    }

starting via mvn spring-boot:run and curling:

curl -X GET \
  'http://localhost:8080/pony?offset=1&limit=2' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache'

I have the input parameters echoed as seems to be expected by the linked issue: {"offset":1,"limit":2}.

Should the @RequestParam modification be done as part of this PR or as a separate one?

[Zomzog]

Thx for the review, I will try to fix the @RequestParam in this PR.

[Zomzog]

@jimschubert
I've fixed the @RequestParam, but there are still issues with typescript generator. I'm not sure if I must fix them on typescript generator or limit my modification to java generator.

[wing328]

@Zomzog Can you please resolve the merge conflicts when you've time?

[wing328]

Looks like the change results in additional incorrect import in TS generators:

--- a/samples/client/petstore/typescript-angular-v2/npm/api/pet.service.ts
+++ b/samples/client/petstore/typescript-angular-v2/npm/api/pet.service.ts
@@ -21,6 +21,8 @@ import { Observable }                                        from 'rxjs/Observab
 import '../rxjs-operators';
 
 import { ApiResponse } from '../model/apiResponse';
+import { Array<'available' | 'pending' | 'sold'> } from '../model/arrayavailablePendingSold';
+import { Array<string> } from '../model/arraystring';
 import { Pet } from '../model/pet';

My guess is that it's due to https://github.com/OpenAPITools/openapi-generator/pull/2710/files#diff-7cb46fa53f89a458a7b7cb201d2214a8R3059

[wing328]

Should the import below (line 3059) already do the job?

[Zomzog]

I've changed my solution for using line 3059. It looks better.

[jimschubert]

I think this looks great, thank you!

[mikhail-putilov]

Hey guys, looks like this PR broke code generation of my api.yml:
Previously I had:

parameters:
  - name: after_last_modified_date
    in: query
    description: >
      timestamp in ISO...
    schema:
      type: string
      format: date-time
      example: "2019-06-17T15:53:00+01:00"

And it led to the generation of the following:

@ApiParam(value = "timestamp in ISO ...") @Valid @RequestParam(value = "after_last_modified_date", required = false) OffsetDateTime afterLastModifiedDate

And after this PR now the generated code lacks @RequestParam:

@ApiParam(value = "timestamp in ISO ...") @Valid OffsetDateTime afterLastModifiedDate

[mikhail-putilov]

I believe SpringCodeGen have no notion of HandlerMethodArgumentResolver. That creates all problems with adding such arguments like Pageable pageable and UriComponentsBuilder uriComponentsBuilder. As well as there is no way to generate throws URISyntaxException which occurs quite naturally when one wants to return ResponseEntity.created(...) from a controller.

Ofc there is always a way to bypass all small problems. But gosh, that's probably the main problem why I can't just introduce API-first approach with generation of code out of OpenAPI spec for my current company. This is a big blocker for API-first approach in current spring boot development.

[mikhail-putilov]

Sorry for being cloudy. That's just devastating.

[wing328]

@mikhail-putilov please use an older stable version (e.g. 4.0.0) for the time being.