Fix object array and add tests

Josh Newman · Josh Newman · commit b9bc40095030 · 2023-03-21T23:14:41.000-06:00
diff --git a/internal/generator/schema.go b/internal/generator/schema.go
@@ -83,7 +83,7 @@ func (g *Generator) buildSchema(doc *openapi3.T, message *protogen.Message, pare
 			fieldSchemaRef.Value.Example = example
 		}
 
-		// Try to set deprecated
+		// Deprecated option.
 		if standardOptions, ok := field.Desc.Options().(*descriptorpb.FieldOptions); ok {
 			fieldSchemaRef.Value.Deprecated = standardOptions.GetDeprecated()
 		}
@@ -172,7 +172,7 @@ func (g *Generator) buildSchema(doc *openapi3.T, message *protogen.Message, pare
 					msg := allMessages.Get(fieldMessageName)
 					if msg != nil {
 						// Use the message to build it out inline instead of using a ref.
-						err := g.buildSchema(doc, msg, fieldSchemaRef)
+						err := g.buildSchema(doc, msg, fieldSchemaRef.Value.Items)
 						if err != nil {
 							return err
 						}
@@ -223,7 +223,7 @@ func newSchemaRef(name string) string {
 func newFieldSchema(field protoreflect.FieldDescriptor) *openapi3.Schema {
 	kind := field.Kind()
 	schema := &openapi3.Schema{
-		Type:       protoKindToAPIType(field.Kind()),
+		Type:       protoKindToAPIType(kind),
 		Properties: make(openapi3.Schemas),
 	}
 
@@ -238,11 +238,14 @@ func newFieldSchema(field protoreflect.FieldDescriptor) *openapi3.Schema {
 // protoKindToAPIType returns an OAPI type based on the proto kind sent.
 func protoKindToAPIType(kind protoreflect.Kind) string {
 	switch kind {
-	case protoreflect.StringKind:
+	case protoreflect.StringKind,
+		protoreflect.Int64Kind,
+		protoreflect.Uint64Kind,
+		protoreflect.Sint64Kind:
 		return openapi3.TypeString
-	case protoreflect.Int32Kind, protoreflect.Int64Kind,
-		protoreflect.Uint32Kind, protoreflect.Uint64Kind,
-		protoreflect.Sint32Kind, protoreflect.Sint64Kind:
+	case protoreflect.Int32Kind,
+		protoreflect.Uint32Kind,
+		protoreflect.Sint32Kind:
 		return openapi3.TypeInteger
 	case protoreflect.BoolKind:
 		return openapi3.TypeBoolean
diff --git a/main_test.go b/main_test.go
@@ -45,6 +45,8 @@ func (s *TestSuite) BeforeTest(suite, name string) {
 		filename = "service_test.proto"
 	case "TestMethod":
 		filename = "method_test.proto"
+	case "TestField":
+		filename = "field_test.proto"
 	default:
 		s.FailNow("invalid test name")
 	}
@@ -72,8 +74,6 @@ func (s *TestSuite) BeforeTest(suite, name string) {
 	if err != nil {
 		s.FailNow(err.Error())
 	}
-
-	fmt.Println(string(s.rawDoc))
 }
 
 func (s *TestSuite) TestBasic() {
@@ -92,6 +92,10 @@ func (s *TestSuite) TestMethod() {
 	s.YAMLEq(readFile("method_test_openapi.yaml"), string(s.rawDoc))
 }
 
+func (s *TestSuite) TestField() {
+	s.YAMLEq(readFile("field_test_openapi.yaml"), string(s.rawDoc))
+}
+
 func TestMain(t *testing.T) {
 	suite.Run(t, new(TestSuite))
 }
diff --git a/test/basic_test_openapi.yaml b/test/basic_test_openapi.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.3
 info:
   description: test description
   title: test title
diff --git a/test/field_test.proto b/test/field_test.proto
@@ -0,0 +1,70 @@
+syntax = "proto3";
+
+package test.api;
+
+import "oapi/v1/file.proto";
+import "oapi/v1/service.proto";
+import "oapi/v1/method.proto";
+import "oapi/v1/field.proto";
+
+option go_package = "github.com/technicallyjosh/protoc-gen-openapi/test_api";
+
+option (oapi.v1.file) = {
+  host: "swagger.io"
+  prefix: "/v1"
+};
+
+service TestService {
+  option (oapi.v1.service) = {
+    host: "api.swagger.io"
+    x_display_name: "Test Service"
+    x_tag_group: "Test Group"
+  };
+
+  rpc TestFieldTypes(TestFieldTypesRequest) returns (TestFieldTypesResponse) {
+    option (oapi.v1.method) = {
+      post: "TestFieldTypes"
+    };
+  };
+
+  rpc TestFieldExamples(TestFieldExamplesRequest) returns (TestFieldExamplesResponse) {
+    option (oapi.v1.method) = {
+      post: "TestFieldExamples"
+    };
+  }
+}
+
+message MessageRequest {
+  string string = 1;
+  string required_string = 2 [(oapi.v1.required) = true];
+}
+
+message TestFieldTypesRequest {
+  message Message {
+    string string = 1;
+  }
+
+  string string = 1;
+  bool bool = 2;
+  int32 int32 = 3;
+  int64 int64 = 4;
+  uint32 uint32 = 5;
+  uint64 uint64 = 6;
+  repeated string repeated_string = 7;
+  repeated Message repeated_message = 8;
+  repeated MessageRequest repeated_request = 9;
+}
+
+message TestFieldTypesResponse {}
+
+message TestFieldExamplesRequest {
+  // Example: test-string
+  string string = 1;
+}
+
+message TestFieldExamplesResponse {}
+
+message Error {
+  string code = 1;
+  string msg = 2;
+}
diff --git a/test/field_test_openapi.yaml b/test/field_test_openapi.yaml
@@ -0,0 +1,118 @@
+openapi: 3.0.3
+
+info:
+  description: test description
+  title: test title
+  version: 1.1.0
+
+paths:
+  /v1/TestFieldTypes:
+    post:
+      operationId: TestService_TestFieldTypes
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                string:
+                  type: string
+                bool:
+                  type: boolean
+                int32:
+                  type: integer
+                int64:
+                  type: string
+                uint32:
+                  type: integer 
+                uint64:
+                  type: string
+                repeated_string:
+                  items:
+                    type: string
+                  type: array
+                repeated_message:
+                  items:
+                    properties:
+                      string:
+                        type: string
+                    type: object
+                  type: array
+                repeated_request:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      string:
+                        type: string
+                      required_string:
+                        type: string
+                    required:
+                      - required_string
+
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                properties: {}
+          description: ""
+        default:
+          $ref: '#/components/responses/default'
+      servers:
+        - url: https://api.swagger.io
+      tags:
+        - TestService
+
+  /v1/TestFieldExamples:
+    post:
+      operationId: TestService_TestFieldExamples
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                string:
+                  example: test-string
+                  type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                properties: {}
+          description: ""
+        default:
+          $ref: '#/components/responses/default'
+      servers:
+        - url: https://api.swagger.io
+      tags:
+        - TestService
+
+components:
+  responses:
+    default:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/test.api.Error'
+      description: ""
+  schemas:
+    test.api.Error:
+      properties:
+        code:
+          type: string
+        msg:
+          type: string
+
+servers:
+  - url: https://swagger.io
+  - url: https://api.swagger.io
+
+tags:
+  - name: TestService
+    x-displayName: Test Service
+
+x-tagGroups:
+  - name: Test Group
+    tags:
+      - TestService
diff --git a/test/file_test_openapi.yaml b/test/file_test_openapi.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.3
 
 info:
   description: test description
diff --git a/test/method_test_openapi.yaml b/test/method_test_openapi.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.3
 
 info:
   description: test description
diff --git a/test/service_test_openapi.yaml b/test/service_test_openapi.yaml
@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.0.3
 
 info:
   description: test description

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ func (s *TestSuite) BeforeTest(suite, name string) {`
`45`	`45`	`filename = "service_test.proto"`
`46`	`46`	`case "TestMethod":`
`47`	`47`	`filename = "method_test.proto"`
	`48`	`+ case "TestField":`
	`49`	`+ filename = "field_test.proto"`
`48`	`50`	`default:`
`49`	`51`	`s.FailNow("invalid test name")`
`50`	`52`	`}`
`@@ -72,8 +74,6 @@ func (s *TestSuite) BeforeTest(suite, name string) {`
`72`	`74`	`if err != nil {`
`73`	`75`	`s.FailNow(err.Error())`
`74`	`76`	`}`
`75`		`-`
`76`		`- fmt.Println(string(s.rawDoc))`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`func (s *TestSuite) TestBasic() {`
`@@ -92,6 +92,10 @@ func (s *TestSuite) TestMethod() {`
`92`	`92`	`s.YAMLEq(readFile("method_test_openapi.yaml"), string(s.rawDoc))`
`93`	`93`	`}`
`94`	`94`
	`95`	`+func (s *TestSuite) TestField() {`
	`96`	`+ s.YAMLEq(readFile("field_test_openapi.yaml"), string(s.rawDoc))`
	`97`	`+}`
	`98`	`+`
`95`	`99`	`func TestMain(t *testing.T) {`
`96`	`100`	`suite.Run(t, new(TestSuite))`
`97`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-openapi: 3.1.0`
	`1`	`+openapi: 3.0.3`
`2`	`2`	`info:`
`3`	`3`	`description: test description`
`4`	`4`	`title: test title`