[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly #1200

fujigon · 2018-10-09T04:24:40Z

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 and ./bin/security/{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

This patch fixes #1201

fujigon · 2018-10-09T04:40:17Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java

@@ -500,6 +500,7 @@ public Schema modelFromProperty(ObjectSchema object, String path) {
        model.setExample(example);
        model.setName(object.getName());
        model.setXml(xml);
+        model.setRequired(object.getRequired());


don't forget copy "required" to the separated object

fujigon · 2018-10-09T04:43:00Z

...les/openapi-generator/src/main/java/org/openapitools/codegen/config/CodegenConfigurator.java

@@ -538,7 +538,6 @@ public ClientOptInput toClientOptInput() {
        final List<AuthorizationValue> authorizationValues = AuthParser.parse(auth);
        ParseOptions options = new ParseOptions();
        options.setResolve(true);
-        options.setFlatten(true);


this option makes swagger-parser to disassemble inline models into separated models.
but we don't won't to use swagger-parser's InlindeModelResolver, because we use openapi-generator's one.
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java#L818

fujigon · 2018-10-09T04:47:04Z

modules/openapi-generator/src/test/resources/2_0/petstore.yaml

@@ -596,6 +596,8 @@ definitions:
    title: Pet category
    description: A category for a pet
    type: object
+    required:


add nested required pattern to test case

fujigon · 2018-10-09T04:47:15Z

modules/openapi-generator/src/test/resources/3_0/petstore.yaml

@@ -600,6 +600,8 @@ components:
      title: Pet category
      description: A category for a pet
      type: object
+      required:


add nested required pattern to test case

fujigon · 2018-10-09T06:33:08Z

samples/client/petstore/spring-cloud/src/main/java/org/openapitools/model/Category.java

@@ -49,7 +49,8 @@ public Category name(String name) {
   * Get name
   * @return name
  **/
-  @ApiModelProperty(value = "")
+  @ApiModelProperty(required = true, value = "")


fujigon · 2018-10-09T08:23:03Z

@wing328 @jimschubert @cbornet @jaz-ah @ackintosh @JFCote @jmini

fujigon · 2018-10-12T02:04:56Z

@wing328 @jimschubert @cbornet @jaz-ah @ackintosh @JFCote @jmini
Could you kindly review this PR, please?
Thanks!

fujigon · 2018-10-12T06:51:03Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java

@@ -545,6 +546,9 @@ public Schema makeSchema(String ref, Schema property) {

    public void copyVendorExtensions(Schema source, Schema target) {
        Map<String, Object> vendorExtensions = source.getExtensions();
+        if (vendorExtensions == null) {


sometimes, vendorExtensions is still null...
add null check.

fujigon · 2018-10-12T06:51:36Z

modules/openapi-generator/src/test/resources/3_0/petstore.yaml

@@ -18,6 +18,18 @@ tags:
  - name: user
    description: Operations about user
 paths:
+  /foo:


this pattern causes NPE at https://github.com/OpenAPITools/openapi-generator/pull/1200/files#r224685854

wing328 · 2018-10-12T08:02:38Z

@fujigon thanks for the PR. Sure, I'll review and let you know if I've any question.

wing328 · 2018-10-15T05:23:30Z

@fujigon thanks again for the PR. For the additional test cases, please add to https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml instead of petstore.yaml (as we want to keep petstore.yaml in sync with the one used by the Petstore server)

…elResolver, so that nested "required" works correctly

…-with-fake-endpoints-models-for-testing.yaml

fujigon · 2018-10-16T09:11:34Z

@wing328 Hi! I reflected your review point, thanks :)

wing328 · 2018-10-23T08:51:51Z

I've reviewed it twice (today and over the weekend) and the change looks good to me. It's a high-quality PR 👍

wing328 · 2018-10-31T15:58:38Z

@fujigon thanks for the PR, which is included in the v3.3.2 release: https://twitter.com/oas_generator/status/1057649626101112832

… InlineModelResolver, so that nested "required" works correctly (OpenAPITools#1200) * fix InlineModelResolver's logis and use openapi-generator's InlineModelResolver, so that nested "required" works correctly * add "required" to nested model schema * update ensure-up-to-date to include openapi v3's jaxrs * change test required field * fix sample shell script, hide timestamp * fix NPE * move test case to petstore-with-fake-endpoints-models-for-testing.yaml * fix jaxrs-jersey (oas3) example generate shell script to use petstore-with-fake-endpoints-models-for-testing.yaml * add default value * re-generate samples

fujigon changed the title ~~[WIP] fix InlineModelResolver's logis and use openapi-generator's InlineModelResolver, so that nested "required" works correctly~~ [WIP] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly Oct 9, 2018

fujigon commented Oct 9, 2018

View reviewed changes

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch from 9f94cd6 to 64d3654 Compare October 9, 2018 04:45

fujigon commented Oct 9, 2018

View reviewed changes

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch 2 times, most recently from bf7db5c to 940f0d2 Compare October 9, 2018 06:32

fujigon commented Oct 9, 2018

View reviewed changes

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch 2 times, most recently from 8244f17 to cdf5cb1 Compare October 9, 2018 07:18

fujigon mentioned this pull request Oct 9, 2018

[General] nested "required" doesn't work #1201

Closed

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch from cdf5cb1 to 7ff34c9 Compare October 9, 2018 07:48

fujigon changed the title ~~[WIP] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly~~ fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly Oct 9, 2018

fujigon changed the title ~~fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly~~ [General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly Oct 9, 2018

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch from 01cbf7e to 0ef509a Compare October 12, 2018 06:49

fujigon commented Oct 12, 2018

View reviewed changes

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch 2 times, most recently from 812b2dc to 973e398 Compare October 15, 2018 04:57

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch 3 times, most recently from 7423381 to c255c7f Compare October 15, 2018 08:46

fujigon added 3 commits October 16, 2018 12:07

fix InlineModelResolver's logis and use openapi-generator's InlineMod…

9b10e8f

…elResolver, so that nested "required" works correctly

add "required" to nested model schema

f669e5a

update ensure-up-to-date to include openapi v3's jaxrs

1ac2ea2

fujigon added 5 commits October 16, 2018 12:07

change test required field

4c822f5

fix sample shell script, hide timestamp

aa31fd6

fix NPE

abac13e

move test case to petstore-with-fake-endpoints-models-for-testing.yaml

1d6a045

fix jaxrs-jersey (oas3) example generate shell script to use petstore…

199dea6

…-with-fake-endpoints-models-for-testing.yaml

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch 2 times, most recently from 74b69cc to 4cbf907 Compare October 16, 2018 03:29

add default value

7af2cd7

fujigon force-pushed the feature/use-openapi's-inline-model-resolver branch from 4cbf907 to 7af2cd7 Compare October 16, 2018 07:55

re-generate samples

986a1b1

wing328 merged commit bb056cc into OpenAPITools:master Oct 23, 2018

wing328 added Feature: Generator Issue: Bug labels Oct 23, 2018

wing328 added this to the 3.3.2 milestone Oct 23, 2018

fujigon deleted the feature/use-openapi's-inline-model-resolver branch March 13, 2019 14:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly #1200

[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly #1200

fujigon commented Oct 9, 2018 •

edited

Loading

fujigon Oct 9, 2018

fujigon Oct 9, 2018

fujigon Oct 9, 2018

fujigon Oct 9, 2018

fujigon Oct 9, 2018

fujigon commented Oct 9, 2018

fujigon commented Oct 12, 2018

fujigon Oct 12, 2018

fujigon Oct 12, 2018

wing328 commented Oct 12, 2018

wing328 commented Oct 15, 2018

fujigon commented Oct 16, 2018

wing328 commented Oct 23, 2018

wing328 commented Oct 31, 2018

[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly #1200

[General] fix InlineModelResolver's logic and use openapi-generator's InlineModelResolver, so that nested "required" works correctly #1200

Conversation

fujigon commented Oct 9, 2018 • edited Loading

PR checklist

Description of the PR

fujigon Oct 9, 2018

Choose a reason for hiding this comment

fujigon Oct 9, 2018

Choose a reason for hiding this comment

fujigon Oct 9, 2018

Choose a reason for hiding this comment

fujigon Oct 9, 2018

Choose a reason for hiding this comment

fujigon Oct 9, 2018

Choose a reason for hiding this comment

fujigon commented Oct 9, 2018

fujigon commented Oct 12, 2018

fujigon Oct 12, 2018

Choose a reason for hiding this comment

fujigon Oct 12, 2018

Choose a reason for hiding this comment

wing328 commented Oct 12, 2018

wing328 commented Oct 15, 2018

fujigon commented Oct 16, 2018

wing328 commented Oct 23, 2018

wing328 commented Oct 31, 2018

fujigon commented Oct 9, 2018 •

edited

Loading