fix: merge gnostic responses with the existing instead of overwritting

sudorandom · Dec 6, 2024 · eea3f4a · eea3f4a
1 parent 85a2a3b
commit eea3f4a
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 5 deletions.
diff --git a/internal/converter/gnostic/convertions.go b/internal/converter/gnostic/convertions.go
@@ -360,13 +360,16 @@ func toMediaTypes(items *goa3.MediaTypes) *orderedmap.Map[string, *v3.MediaType]
 	}
 	content := orderedmap.New[string, *v3.MediaType]()
 	for _, item := range items.GetAdditionalProperties() {
-		content.Set(item.Name, &v3.MediaType{
+		mt := &v3.MediaType{
 			Schema:     toSchemaOrReference(item.Value.Schema),
-			Example:    item.Value.Example.ToRawInfo(),
 			Examples:   toExamples(item.Value.GetExamples()),
 			Encoding:   toEncodings(item.Value.GetEncoding()),
 			Extensions: toExtensions(item.Value.GetSpecificationExtension()),
-		})
+		}
+		if val := item.GetValue().Example; val != nil {
+			mt.Example = val.ToRawInfo()
+		}
+		content.Set(item.Name, mt)
 	}
 	return content
 }
@@ -403,7 +406,11 @@ func toHeaders(v *goa3.HeadersOrReferences) *orderedmap.Map[string, *v3.Header]
 func toCodes(responses []*goa3.NamedResponseOrReference) *orderedmap.Map[string, *v3.Response] {
 	resps := orderedmap.New[string, *v3.Response]()
 	for _, resp := range responses {
-		resps.Set(resp.Name, toResponse(resp.Value.GetResponse()))
+		switch tt := resp.GetValue().Oneof.(type) {
+		case *goa3.ResponseOrReference_Reference:
+		case *goa3.ResponseOrReference_Response:
+			resps.Set(resp.Name, toResponse(tt.Response))
+		}
 	}
 	return resps
 }

diff --git a/internal/converter/gnostic/paths.go b/internal/converter/gnostic/paths.go
@@ -34,7 +34,16 @@ func PathItemWithMethodAnnotations(item *v3.PathItem, md protoreflect.MethodDesc
 		}
 
 		if opts.Responses != nil {
-			oper.Responses = toResponses(opts.Responses)
+			responses := toResponses(opts.Responses)
+			for pair := responses.Codes.First(); pair != nil; pair = pair.Next() {
+				oper.Responses.Codes.Set(pair.Key(), pair.Value())
+			}
+			if responses.Default != nil {
+				oper.Responses.Default = responses.Default
+			}
+			for pair := responses.Extensions.First(); pair != nil; pair = pair.Next() {
+				oper.Responses.Extensions.Set(pair.Key(), pair.Value())
+			}
 		}
 
 		if opts.Callbacks != nil {

diff --git a/internal/converter/testdata/fileset.binpb b/internal/converter/testdata/fileset.binpb
diff --git a/internal/converter/testdata/standard/gnostic.proto b/internal/converter/testdata/standard/gnostic.proto
@@ -42,6 +42,26 @@ service Greeter {
   rpc SayHello(HelloRequest) returns (HelloReply) {
     option idempotency_level = NO_SIDE_EFFECTS;
     option (gnostic.openapi.v3.operation) = {
+      responses: {
+        response_or_reference: {
+          name: "404"
+          value: {
+            response: {
+              description: "user is not found"
+              content: {
+                additional_properties: {
+                  name: "application/json"
+                  value: {
+                    schema: {
+                      reference: {_ref: "#/components/schemas/connect.error"}
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
       deprecated: true
       security: [
         {

diff --git a/internal/converter/testdata/standard/output/gnostic.openapi.json b/internal/converter/testdata/standard/output/gnostic.openapi.json
@@ -115,6 +115,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "user is not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/connect.error"
+                }
+              }
+            }
           }
         },
         "deprecated": true,
@@ -178,6 +188,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "user is not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/connect.error"
+                }
+              }
+            }
           }
         },
         "deprecated": true,

diff --git a/internal/converter/testdata/standard/output/gnostic.openapi.yaml b/internal/converter/testdata/standard/output/gnostic.openapi.yaml
@@ -71,6 +71,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/example_with_gnostic.HelloReply'
+        "404":
+          description: user is not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/connect.error'
       deprecated: true
       security:
         - BasicAuth: []
@@ -109,6 +115,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/example_with_gnostic.HelloReply'
+        "404":
+          description: user is not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/connect.error'
       deprecated: true
       security:
         - BasicAuth: []