Merge pull request #9472 from kostyay/fix_issue9471_opts_struct_name_collision

[GO] Issue 9471 - opts struct name collision when operation has multiple tags

Author: HugoMario

modules/swagger-codegen/src/main/resources/go/api.mustache

@@ -1,3 +1,4 @@
+
 {{>partial_header}}
 package {{packageName}}
 
@@ -25,19 +26,19 @@ type {{classname}}Service service
 {{notes}}{{/notes}}
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
 {{#allParams}}{{#required}} * @param {{paramName}}{{#description}} {{.}}{{/description}}
-{{/required}}{{/allParams}}{{#hasOptionalParams}} * @param optional nil or *{{{nickname}}}Opts - Optional Parameters:
+{{/required}}{{/allParams}}{{#hasOptionalParams}} * @param optional nil or *{{{classname}}}{{{nickname}}}Opts - Optional Parameters:
 {{#allParams}}{{^required}}     * @param "{{vendorExtensions.x-exportParamName}}" ({{#isPrimitiveType}}optional.{{vendorExtensions.x-optionalDataType}}{{/isPrimitiveType}}{{^isPrimitiveType}}optional.Interface of {{dataType}}{{/isPrimitiveType}}) - {{#description}} {{.}}{{/description}}
 {{/required}}{{/allParams}}{{/hasOptionalParams}}
 {{#returnType}}@return {{{returnType}}}{{/returnType}}
 */
 {{#hasOptionalParams}}
 
-type {{{nickname}}}Opts struct { {{#allParams}}{{^required}}
+type {{{classname}}}{{{nickname}}}Opts struct { {{#allParams}}{{^required}}
 {{#isPrimitiveType}}	{{vendorExtensions.x-exportParamName}} optional.{{vendorExtensions.x-optionalDataType}}{{/isPrimitiveType}}{{^isPrimitiveType}}	{{vendorExtensions.x-exportParamName}} optional.Interface{{/isPrimitiveType}}{{/required}}{{/allParams}}
 }
 
 {{/hasOptionalParams}}
-func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}}, {{/hasParams}}{{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{#hasMore}}, {{/hasMore}}{{/required}}{{/allParams}}{{#hasOptionalParams}}localVarOptionals *{{{nickname}}}Opts{{/hasOptionalParams}}) ({{#returnType}}{{{returnType}}}, {{/returnType}}*http.Response, error) {
+func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}}, {{/hasParams}}{{#allParams}}{{#required}}{{paramName}} {{{dataType}}}{{#hasMore}}, {{/hasMore}}{{/required}}{{/allParams}}{{#hasOptionalParams}}localVarOptionals *{{{classname}}}{{{nickname}}}Opts{{/hasOptionalParams}}) ({{#returnType}}{{{returnType}}}, {{/returnType}}*http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("{{httpMethod}}")
 		localVarPostBody   interface{}

modules/swagger-codegen/src/main/resources/go/api_doc.mustache

@@ -22,10 +22,10 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.{{/-last}}{{/allParams}}{{#allParams}}{{#required}}
   **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}{{/required}}{{/allParams}}{{#hasOptionalParams}}
- **optional** | ***{{{nickname}}}Opts** | optional parameters | nil if no parameters
+ **optional** | ***{{{classname}}}{{{nickname}}}Opts** | optional parameters | nil if no parameters
 
 ### Optional Parameters
-Optional parameters are passed through a pointer to a {{{nickname}}}Opts struct
+Optional parameters are passed through a pointer to a {{{classname}}}{{{nickname}}}Opts struct
 {{#allParams}}{{#-last}}
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}}

samples/client/petstore/go/go-petstore-withXml/.swagger-codegen/VERSION

@@ -1 +1 @@
-2.4.3-SNAPSHOT
+2.4.6-SNAPSHOT

samples/client/petstore/go/go-petstore-withXml/api/swagger.yaml

@@ -107,11 +107,11 @@ paths:
         type: "array"
         items:
           type: "string"
+          default: "available"
           enum:
           - "available"
           - "pending"
           - "sold"
-          default: "available"
         collectionFormat: "csv"
         x-exportParamName: "Status"
       responses:
@@ -639,10 +639,10 @@ paths:
         type: "array"
         items:
           type: "string"
+          default: "$"
           enum:
           - ">"
           - "$"
-          default: "$"
         x-exportParamName: "EnumFormStringArray"
       - name: "enum_form_string"
         in: "formData"
@@ -663,10 +663,10 @@ paths:
         type: "array"
         items:
           type: "string"
+          default: "$"
           enum:
           - ">"
           - "$"
-          default: "$"
         x-exportParamName: "EnumHeaderStringArray"
       - name: "enum_header_string"
         in: "header"
@@ -687,10 +687,10 @@ paths:
         type: "array"
         items:
           type: "string"
+          default: "$"
           enum:
           - ">"
           - "$"
-          default: "$"
         x-exportParamName: "EnumQueryStringArray"
       - name: "enum_query_string"
         in: "query"
@@ -1108,12 +1108,12 @@ definitions:
     xml:
       name: "Order"
     example:
-      id: 0
       petId: 6
-      complete: false
-      status: "placed"
       quantity: 1
+      id: 0
       shipDate: "2000-01-23T04:56:07.000+00:00"
+      complete: false
+      status: "placed"
   Category:
     type: "object"
     properties:
@@ -1125,8 +1125,8 @@ definitions:
     xml:
       name: "Category"
     example:
-      id: 6
       name: "name"
+      id: 6
   User:
     type: "object"
     properties:
@@ -1153,14 +1153,14 @@ definitions:
     xml:
       name: "User"
     example:
-      id: 0
+      firstName: "firstName"
       lastName: "lastName"
+      password: "password"
+      userStatus: 6
       phone: "phone"
-      username: "username"
+      id: 0
       email: "email"
-      userStatus: 6
-      firstName: "firstName"
-      password: "password"
+      username: "username"
   Tag:
     type: "object"
     properties:
@@ -1172,8 +1172,8 @@ definitions:
     xml:
       name: "Tag"
     example:
-      id: 1
       name: "name"
+      id: 1
   Pet:
     type: "object"
     required:
@@ -1213,20 +1213,20 @@ definitions:
     xml:
       name: "Pet"
     example:
-      tags:
-      - id: 1
-        name: "name"
-      - id: 1
-        name: "name"
+      photoUrls:
+      - "photoUrls"
+      - "photoUrls"
+      name: "doggie"
       id: 0
       category:
-        id: 6
         name: "name"
+        id: 6
+      tags:
+      - name: "name"
+        id: 1
+      - name: "name"
+        id: 1
       status: "available"
-      name: "doggie"
-      photoUrls:
-      - "photoUrls"
-      - "photoUrls"
   ApiResponse:
     type: "object"
     properties:
@@ -1238,9 +1238,9 @@ definitions:
       message:
         type: "string"
     example:
-      message: "message"
       code: 0
       type: "type"
+      message: "message"
   $special[model.name]:
     properties:
       $special[property.name]:
@@ -1574,8 +1574,8 @@ definitions:
       my_boolean:
         $ref: "#/definitions/OuterBoolean"
     example:
-      my_number: {}
       my_string: {}
+      my_number: {}
       my_boolean: {}
   OuterNumber:
     type: "number"

samples/client/petstore/go/go-petstore-withXml/api_another_fake.go

@@ -1,3 +1,4 @@
+
 /*
  * Swagger Petstore
  *

samples/client/petstore/go/go-petstore-withXml/api_fake.go

@@ -1,3 +1,4 @@
+
 /*
  * Swagger Petstore
  *
@@ -30,17 +31,17 @@ type FakeApiService service
 FakeApiService
 Test serialization of outer boolean types
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param optional nil or *FakeOuterBooleanSerializeOpts - Optional Parameters:
+ * @param optional nil or *FakeApiFakeOuterBooleanSerializeOpts - Optional Parameters:
      * @param "Body" (optional.Interface of OuterBoolean) -  Input boolean as post body
 
 @return OuterBoolean
 */
 
-type FakeOuterBooleanSerializeOpts struct { 
+type FakeApiFakeOuterBooleanSerializeOpts struct { 
 	Body optional.Interface
 }
 
-func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals *FakeOuterBooleanSerializeOpts) (OuterBoolean, *http.Response, error) {
+func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterBooleanSerializeOpts) (OuterBoolean, *http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Post")
 		localVarPostBody   interface{}
@@ -133,17 +134,17 @@ func (a *FakeApiService) FakeOuterBooleanSerialize(ctx context.Context, localVar
 FakeApiService
 Test serialization of object with outer number type
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param optional nil or *FakeOuterCompositeSerializeOpts - Optional Parameters:
+ * @param optional nil or *FakeApiFakeOuterCompositeSerializeOpts - Optional Parameters:
      * @param "Body" (optional.Interface of OuterComposite) -  Input composite as post body
 
 @return OuterComposite
 */
 
-type FakeOuterCompositeSerializeOpts struct { 
+type FakeApiFakeOuterCompositeSerializeOpts struct { 
 	Body optional.Interface
 }
 
-func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals *FakeOuterCompositeSerializeOpts) (OuterComposite, *http.Response, error) {
+func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterCompositeSerializeOpts) (OuterComposite, *http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Post")
 		localVarPostBody   interface{}
@@ -236,17 +237,17 @@ func (a *FakeApiService) FakeOuterCompositeSerialize(ctx context.Context, localV
 FakeApiService
 Test serialization of outer number types
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param optional nil or *FakeOuterNumberSerializeOpts - Optional Parameters:
+ * @param optional nil or *FakeApiFakeOuterNumberSerializeOpts - Optional Parameters:
      * @param "Body" (optional.Interface of OuterNumber) -  Input number as post body
 
 @return OuterNumber
 */
 
-type FakeOuterNumberSerializeOpts struct { 
+type FakeApiFakeOuterNumberSerializeOpts struct { 
 	Body optional.Interface
 }
 
-func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals *FakeOuterNumberSerializeOpts) (OuterNumber, *http.Response, error) {
+func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterNumberSerializeOpts) (OuterNumber, *http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Post")
 		localVarPostBody   interface{}
@@ -339,17 +340,17 @@ func (a *FakeApiService) FakeOuterNumberSerialize(ctx context.Context, localVarO
 FakeApiService
 Test serialization of outer string types
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param optional nil or *FakeOuterStringSerializeOpts - Optional Parameters:
+ * @param optional nil or *FakeApiFakeOuterStringSerializeOpts - Optional Parameters:
      * @param "Body" (optional.Interface of OuterString) -  Input string as post body
 
 @return OuterString
 */
 
-type FakeOuterStringSerializeOpts struct { 
+type FakeApiFakeOuterStringSerializeOpts struct { 
 	Body optional.Interface
 }
 
-func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals *FakeOuterStringSerializeOpts) (OuterString, *http.Response, error) {
+func (a *FakeApiService) FakeOuterStringSerialize(ctx context.Context, localVarOptionals *FakeApiFakeOuterStringSerializeOpts) (OuterString, *http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Post")
 		localVarPostBody   interface{}
@@ -609,7 +610,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
  * @param double None
  * @param patternWithoutDelimiter None
  * @param byte_ None
- * @param optional nil or *TestEndpointParametersOpts - Optional Parameters:
+ * @param optional nil or *FakeApiTestEndpointParametersOpts - Optional Parameters:
      * @param "Integer" (optional.Int32) -  None
      * @param "Int32_" (optional.Int32) -  None
      * @param "Int64_" (optional.Int64) -  None
@@ -624,7 +625,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
 
 */
 
-type TestEndpointParametersOpts struct { 
+type FakeApiTestEndpointParametersOpts struct { 
 	Integer optional.Int32
 	Int32_ optional.Int32
 	Int64_ optional.Int64
@@ -637,7 +638,7 @@ type TestEndpointParametersOpts struct {
 	Callback optional.String
 }
 
-func (a *FakeApiService) TestEndpointParameters(ctx context.Context, number float32, double float64, patternWithoutDelimiter string, byte_ string, localVarOptionals *TestEndpointParametersOpts) (*http.Response, error) {
+func (a *FakeApiService) TestEndpointParameters(ctx context.Context, number float32, double float64, patternWithoutDelimiter string, byte_ string, localVarOptionals *FakeApiTestEndpointParametersOpts) (*http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Post")
 		localVarPostBody   interface{}
@@ -749,7 +750,7 @@ func (a *FakeApiService) TestEndpointParameters(ctx context.Context, number floa
 FakeApiService To test enum parameters
 To test enum parameters
  * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- * @param optional nil or *TestEnumParametersOpts - Optional Parameters:
+ * @param optional nil or *FakeApiTestEnumParametersOpts - Optional Parameters:
      * @param "EnumFormStringArray" (optional.Interface of []string) -  Form parameter enum test (string array)
      * @param "EnumFormString" (optional.String) -  Form parameter enum test (string)
      * @param "EnumHeaderStringArray" (optional.Interface of []string) -  Header parameter enum test (string array)
@@ -762,7 +763,7 @@ To test enum parameters
 
 */
 
-type TestEnumParametersOpts struct { 
+type FakeApiTestEnumParametersOpts struct { 
 	EnumFormStringArray optional.Interface
 	EnumFormString optional.String
 	EnumHeaderStringArray optional.Interface
@@ -773,7 +774,7 @@ type TestEnumParametersOpts struct {
 	EnumQueryDouble optional.Float64
 }
 
-func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals *TestEnumParametersOpts) (*http.Response, error) {
+func (a *FakeApiService) TestEnumParameters(ctx context.Context, localVarOptionals *FakeApiTestEnumParametersOpts) (*http.Response, error) {
 	var (
 		localVarHttpMethod = strings.ToUpper("Get")
 		localVarPostBody   interface{}

samples/client/petstore/go/go-petstore-withXml/api_fake_classname_tags123.go

@@ -1,3 +1,4 @@
+
 /*
  * Swagger Petstore
  *