Issue 1766 Modified mustache files for Go to support nullable in the … #1869

alex-korobko · 2019-01-09T21:34:31Z

…spec v3.0+; Updated model files running .sh scripts for Go.

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

Updated mustache files to enable the nullable support (#1766)
Ran all ./bin/go*.sh files to update the models;
Not sure though how to test the changes though/ The integration test (as it recommended in the guide) classes for the Golang are using specs from the ver 2.0, so it seems like there is no reason to use them. Should we try to make new classes for that? Do you have any guide for that?

@antihax @bvwells @grokify @kemokemo

…spec v3.0+; Updated model files running .sh scripts for Go.

alex-korobko · 2019-01-09T21:40:24Z

modules/openapi-generator/src/main/resources/go-gin-server/model.mustache

@@ -19,6 +19,6 @@ const (
 type {{classname}} struct {
 {{#vars}}{{#description}}
 	// {{{description}}}{{/description}}
-	{{name}} {{^isEnum}}{{^isPrimitiveType}}{{^isContainer}}{{^isDateTime}}*{{/isDateTime}}{{/isContainer}}{{/isPrimitiveType}}{{/isEnum}}{{{dataType}}} `json:"{{baseName}}{{^required}},omitempty{{/required}}"{{#vendorExtensions.x-go-custom-tag}} {{{.}}}{{/vendorExtensions.x-go-custom-tag}}`


This is the change that I'd like to discuss. In a previous version relative model objects were generated as classes. As we have nullable support now, I don't think we need to keep this implicit behavior. I'd rather expect to have the pointer defined as it should be - using the nullable property.

Thank you for your PR! 😃
I agree with you.

alex-korobko · 2019-01-09T21:40:37Z

modules/openapi-generator/src/main/resources/go-server/model.mustache

@@ -19,6 +19,6 @@ const (
 type {{classname}} struct {
 {{#vars}}{{#description}}
 	// {{{description}}}{{/description}}
-	{{name}} {{^isEnum}}{{^isPrimitiveType}}{{^isContainer}}{{^isDateTime}}*{{/isDateTime}}{{/isContainer}}{{/isPrimitiveType}}{{/isEnum}}{{{dataType}}} `json:"{{baseName}}{{^required}},omitempty{{/required}}"{{#vendorExtensions.x-go-custom-tag}} {{{.}}}{{/vendorExtensions.x-go-custom-tag}}`


This is the change that I'd like to discuss. In a previous version relative model objects were generated as classes. As we have nullable support now, I don't think we need to keep this implicit behavior. I'd rather expect to have the pointer defined as it should be - using the nullable property.

kemokemo · 2019-01-10T15:17:11Z

I have made a brief review.
There is something I want to check one point so please give me some time.

ackintosh · 2019-01-11T10:07:23Z

@alex-korobko Thanks for the PR! 👍

TO: @OpenAPITools/generator-core-team

#1869 (comment)

Updated mustache files to enable the nullable support (#1766)
Ran all ./bin/go*.sh files to update the models;
Not sure though how to test the changes though

I think we need to add nullable to "3_0/petstore-with-fake-endpoints-models-for-testing.yaml" to make sure that the output is generated as we expected. do you have any concerns?

alex-korobko · 2019-01-14T22:21:38Z

@alex-korobko Thanks for the PR! 👍

TO: @OpenAPITools/generator-core-team

#1869 (comment)

Updated mustache files to enable the nullable support (#1766)
Ran all ./bin/go*.sh files to update the models;
Not sure though how to test the changes though

I think we need to add nullable to "3_0/petstore-with-fake-endpoints-models-for-testing.yaml" to make sure that the output is generated as we expected. do you have any concerns?

Not sure if it could help, the 3_0/petstore-with-fake-endpoints-models-for-testing.yaml file is not used in go test scripts yet, so we should probably need more changes in order to get nullable testable for Golang model generation.

ackintosh · 2019-01-16T08:06:44Z

Sorry I didn't explain it enough. 💦
I think we need to add a shell script under ./bin/*openapi3* like bin/openapi3/php-petstore.sh before adding nullable to the yaml file.
(The script uses petstore-with-fake-endpoints-models-for-testing.yaml)

alex-korobko · 2019-01-17T22:41:20Z

Sorry I didn't explain it enough. 💦
I think we need to add a shell script under ./bin/*openapi3* like bin/openapi3/php-petstore.sh before adding nullable to the yaml file.
(The script uses petstore-with-fake-endpoints-models-for-testing.yaml)

Got it, thanks! So who should create that Shell script to test v3 spec features for Go? Did you recommend me to make the script in this PR or guys from the team are adding such scripts using some other internal workflow?

kemokemo · 2019-01-20T11:48:42Z

Sorry for the late review.
I have completed checking for the code you had already committed. They looks good. 👍
There is still content to discuss, but I will report it. 👀

kemokemo · 2019-02-02T09:31:34Z

To: @alex-korobko @ackintosh

Hi!

I had added the nullable property to the petstore-with-fake-endpoints-models-for-testing.yaml and created go-petstore.sh.
I could not push to alex-korobko/openapi-generator repository so I saved it to my gist. Sorry.. 🙇

Can you confirm the content? Also, if it seems good, please apply it to this repository.
Then I want you to run the script and update the sample.

ackintosh · 2019-02-04T10:08:03Z

@kemokemo Thanks for your good job! I'm working on that applying your changes to this PR. 😉

ackintosh · 2019-02-05T10:02:35Z

The updates from @kemokemo has been pushed to this PR. Please take a look if the sample (which is generated from a spec that contains nullable) is generated as you guys expected. @kemokemo @alex-korobko

alex-korobko · 2019-02-05T15:12:38Z

Thanks a lot for your help! Let me check the updates.

ackintosh · 2019-02-09T01:22:05Z

FYI: The updates before has generated only "go client",
so in order to generate "go gin server" and "go server" samples I've added bin/openapi3/go-gin-petstore-server.sh and updated bin/openapi3/go-petstore-server.sh.

ackintosh · 2019-02-09T01:32:55Z

The samples added by this PR:

client
- 376e1ba
server
- 58d2b14
gin server
- ed1dde6

It looks good for me as the parameter defined as nullable is generated as pointer like below.

NullableMessage *string `json:"NullableMessage,omitempty"`

kemokemo · 2019-02-10T05:17:52Z

@ackintosh Thank you so much for your merging! 😄
I had checked the sample code generated using petstore-with-fake-endpoints-models-for-testing.yaml and found a potential problem with go-server and go-gin-server.

issue

The import statement is duplicated.

plan to resolve above

 {{>partial_header}}
 package {{packageName}}
 {{#models}}{{#imports}}
-import ({{/imports}}{{#imports}}
-	"{{import}}"{{/imports}}{{#imports}}
-)
+{{#-first}}import ({{/-first}}
+    "{{import}}"
+{{#-last}}){{/-last}}
 {{/imports}}{{#model}}{{#isEnum}}{{#description}}// {{{classname}}} : {{{description}}}{{/description}}
 type {{{name}}} {{^format}}{{dataType}}{{/format}}{{#format}}{{{format}}}{{/format}}

I am sorry many times.
Could @ackintosh or @alex-korobko please apply the above contents to the following file? 🙇

ackintosh · 2019-02-13T10:15:33Z

I'm working on the issue. 😉

ackintosh · 2019-02-14T10:19:04Z

I've updated the templates, please have a look when you have time. ✨

kemokemo · 2019-02-14T12:56:20Z

@ackintosh , thanks a lot for your support! 😉
It looks very nice. My review has been completed.

Everyone, please point out if you notice any problems.
Thank you!

samples/openapi3/client/petstore/go/go-petstore/model_health_check_result.go

ackintosh · 2019-02-15T02:10:20Z

The PR has been merged into master. Thanks for your contribution! @alex-korobko @kemokemo 👍 👍 👍

OpenAPITools#1869) * Issue 1766 Modified mustache files for Go to support nullable in the spec v3.0+; Updated model files running .sh scripts for Go. * Add "nullable" to fake yaml * Add sample script for OAS3 * Fix output folder (openapi3) * Run bin/openapi3/go-petstore.sh * Update samples * Update jaxrs-jersey * Update python and php samples * Add bin/openapi3/go-gin-petstore-server.sh * Run bin/openapi3/go-gin-petstore-server.sh * Update bin/openapi3/go-petstore-server.sh to generate "nullable" samples * Run bin/openapi3/go-petstore-server.sh * Fix duplicated `import`

Issue 1766 Modified mustache files for Go to support nullable in the …

b632422

…spec v3.0+; Updated model files running .sh scripts for Go.

alex-korobko mentioned this pull request Jan 9, 2019

[go-gin-server] Add nullable support #1766

Closed

alex-korobko commented Jan 9, 2019

View reviewed changes

ackintosh added Feature: OAS 3.0 spec support Server: Go labels Jan 10, 2019

ackintosh added 8 commits February 4, 2019 19:15

Add "nullable" to fake yaml

7037ca8

Add sample script for OAS3

2a09e8f

Fix output folder (openapi3)

f498681

Run bin/openapi3/go-petstore.sh

376e1ba

Update samples

1641e5f

Merge remote-tracking branch 'upstream/master' into fix_issue_1766

2a18295

Update jaxrs-jersey

0e00f63

Update python and php samples

4ca8c2b

ackintosh added 4 commits February 9, 2019 10:08

Add bin/openapi3/go-gin-petstore-server.sh

20677e8

Run bin/openapi3/go-gin-petstore-server.sh

ed1dde6

Update bin/openapi3/go-petstore-server.sh to generate "nullable" samples

90e4bb2

Run bin/openapi3/go-petstore-server.sh

58d2b14

ackintosh added this to the 4.0.0 milestone Feb 9, 2019

bonifaido mentioned this pull request Feb 13, 2019

openapi: support nullable attribute with temporary generator image banzaicloud/pipeline#1747

Merged

6 tasks

Fix duplicated import

6714db3

alex-korobko commented Feb 14, 2019

View reviewed changes

samples/openapi3/client/petstore/go/go-petstore/model_health_check_result.go Show resolved Hide resolved

ackintosh merged commit 42544b8 into OpenAPITools:master Feb 15, 2019

ackintosh mentioned this pull request Feb 17, 2019

[BUG] [Go] object nullable not working #2119

Closed

dvacca-onfido mentioned this pull request Jun 7, 2024

Update OpenAPI generator version to 7.6.0 (was 7.5.0) onfido/onfido-openapi-spec#86

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 1766 Modified mustache files for Go to support nullable in the … #1869

Issue 1766 Modified mustache files for Go to support nullable in the … #1869

alex-korobko commented Jan 9, 2019

alex-korobko Jan 9, 2019

kemokemo Jan 10, 2019

alex-korobko Jan 9, 2019

kemokemo commented Jan 10, 2019

ackintosh commented Jan 11, 2019 •

edited

alex-korobko commented Jan 14, 2019 •

edited

ackintosh commented Jan 16, 2019

alex-korobko commented Jan 17, 2019 •

edited

kemokemo commented Jan 20, 2019

kemokemo commented Feb 2, 2019 •

edited

ackintosh commented Feb 4, 2019

ackintosh commented Feb 5, 2019 •

edited

alex-korobko commented Feb 5, 2019

ackintosh commented Feb 9, 2019

ackintosh commented Feb 9, 2019

kemokemo commented Feb 10, 2019

ackintosh commented Feb 13, 2019

ackintosh commented Feb 14, 2019

kemokemo commented Feb 14, 2019

ackintosh commented Feb 15, 2019

Issue 1766 Modified mustache files for Go to support nullable in the … #1869

Issue 1766 Modified mustache files for Go to support nullable in the … #1869

Conversation

alex-korobko commented Jan 9, 2019

PR checklist

Description of the PR

alex-korobko Jan 9, 2019

Choose a reason for hiding this comment

kemokemo Jan 10, 2019

Choose a reason for hiding this comment

alex-korobko Jan 9, 2019

Choose a reason for hiding this comment

kemokemo commented Jan 10, 2019

ackintosh commented Jan 11, 2019 • edited

alex-korobko commented Jan 14, 2019 • edited

ackintosh commented Jan 16, 2019

alex-korobko commented Jan 17, 2019 • edited

kemokemo commented Jan 20, 2019

kemokemo commented Feb 2, 2019 • edited

ackintosh commented Feb 4, 2019

ackintosh commented Feb 5, 2019 • edited

alex-korobko commented Feb 5, 2019

ackintosh commented Feb 9, 2019

ackintosh commented Feb 9, 2019

kemokemo commented Feb 10, 2019

issue

plan to resolve above

ackintosh commented Feb 13, 2019

ackintosh commented Feb 14, 2019

kemokemo commented Feb 14, 2019

ackintosh commented Feb 15, 2019

ackintosh commented Jan 11, 2019 •

edited

alex-korobko commented Jan 14, 2019 •

edited

alex-korobko commented Jan 17, 2019 •

edited

kemokemo commented Feb 2, 2019 •

edited

ackintosh commented Feb 5, 2019 •

edited