Fix openapi codegen: don't skip ref types

Author: keyz

examples/internal/clients/abe/BUILD.bazel

@@ -25,12 +25,15 @@ go_library(
         "model_book.go",
         "model_examplepb_a_bit_of_everything.go",
         "model_examplepb_a_bit_of_everything_repeated.go",
+        "model_examplepb_bar.go",
         "model_examplepb_body.go",
         "model_examplepb_book.go",
         "model_examplepb_check_status_response.go",
         "model_examplepb_error_object.go",
         "model_examplepb_error_response.go",
+        "model_examplepb_foo.go",
         "model_examplepb_numeric_enum.go",
+        "model_examplepb_required_message_type_request.go",
         "model_examplepb_snake_enum_response.go",
         "model_examplepbsnake_case_0_enum.go",
         "model_examplepbsnake_case_enum.go",

examples/internal/clients/abe/api/swagger.yaml

@@ -4905,6 +4905,8 @@ definitions:
         $ref: "#/definitions/examplepbErrorObject"
   examplepbFoo:
     type: "object"
+    required:
+    - "bar"
     properties:
       bar:
         $ref: "#/definitions/examplepbBar"
@@ -4919,6 +4921,7 @@ definitions:
   examplepbRequiredMessageTypeRequest:
     type: "object"
     required:
+    - "foo"
     - "id"
     properties:
       id:

examples/internal/clients/abe/model_examplepb_foo.go

@@ -11,5 +11,5 @@
 package abe
 
 type ExamplepbFoo struct {
-	Bar *ExamplepbBar `json:"bar,omitempty"`
+	Bar *ExamplepbBar `json:"bar"`
 }

examples/internal/clients/abe/model_examplepb_required_message_type_request.go

@@ -12,5 +12,5 @@ package abe
 
 type ExamplepbRequiredMessageTypeRequest struct {
 	Id string `json:"id"`
-	Foo *ExamplepbFoo `json:"foo,omitempty"`
+	Foo *ExamplepbFoo `json:"foo"`
 }

examples/internal/proto/examplepb/a_bit_of_everything.swagger.json

@@ -6984,7 +6984,10 @@
         "bar": {
           "$ref": "#/definitions/examplepbBar"
         }
-      }
+      },
+      "required": [
+        "bar"
+      ]
     },
     "examplepbNumericEnum": {
       "type": "string",
@@ -7007,7 +7010,8 @@
       },
       "title": "Required message type -\u003e OpenAPI\nhttps://github.com/grpc-ecosystem/grpc-gateway/issues/2837",
       "required": [
-        "id"
+        "id",
+        "foo"
       ]
     },
     "examplepbSnakeEnumResponse": {

examples/internal/server/a_bit_of_everything.go

@@ -411,3 +411,7 @@ func (s *_ABitOfEverythingServer) TraceRequest(ctx context.Context, msg *example
 func (s *_ABitOfEverythingServer) PostOneofEnum(ctx context.Context, msg *oneofenum.OneofEnumMessage) (*emptypb.Empty, error) {
 	return new(emptypb.Empty), nil
 }
+
+func (s *_ABitOfEverythingServer) PostRequiredMessageType(ctx context.Context, req *examples.RequiredMessageTypeRequest) (*emptypb.Empty, error) {
+	return new(emptypb.Empty), nil
+}

protoc-gen-openapiv2/internal/genopenapi/template.go

@@ -2652,12 +2652,6 @@ func updateswaggerObjectFromJSONSchema(s *openapiSchemaObject, j *openapi_option
 }
 
 func updateSwaggerObjectFromFieldBehavior(s *openapiSchemaObject, j []annotations.FieldBehavior, reg *descriptor.Registry, field *descriptor.Field) {
-	// Per the JSON Reference syntax: Any members other than "$ref" in a JSON Reference object SHALL be ignored.
-	// https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3
-	if s.Ref != "" {
-		return
-	}
-
 	for _, fb := range j {
 		switch fb {
 		case annotations.FieldBehavior_REQUIRED:

protoc-gen-openapiv2/internal/genopenapi/template_test.go

@@ -4340,6 +4340,7 @@ func TestSchemaOfField(t *testing.T) {
 				schemaCore: schemaCore{
 					Ref: "#/definitions/exampleMessage",
 				},
+				Required: []string{"message_field"},
 			},
 		},
 		{