Allow field type overrides

Author: Josh

api/oapi/v1/field.pb.go

@@ -62,4 +62,15 @@ message FieldOptions {
 
   // Values that value must be one of.
   repeated string enum = 14;
+
+  // The format of the value.
+  optional string format = 15;
+
+  // Marks the field as required.
+  bool required = 16;
+
+  // Use the specified type instead of the defined type. This is useful when you
+  // are using something like google.protobuf.Timestamp and it really should be
+  // a string.
+  optional string as_type = 17;
 }

api/oapi/v1/field.proto

@@ -259,7 +259,9 @@ func (g *Generator) parseParameters(in, path string, parameters []*oapiv1.Parame
 		}
 
 		if parameter.Options != nil {
-			err := setProperties(paramRef.Value.Schema.Value, parameter.Options)
+			err := setProperties(paramRef.Value.Schema.Value, parameter.Options, func() {
+				paramRef.Value.Required = true
+			})
 			if err != nil {
 				return nil, err
 			}

internal/generator/path.go

@@ -268,7 +268,7 @@ func (g *Generator) getPackageSchema(pkg, name string) string {
 	return path.Join(prefix, pkg+"."+name)
 }
 
-func setProperties(s *openapi3.Schema, fo *oapiv1.FieldOptions) error {
+func setProperties(s *openapi3.Schema, fo *oapiv1.FieldOptions, requiredFn func()) error {
 	s.Min = fo.Min
 	s.Max = fo.Max
 
@@ -316,6 +316,18 @@ func setProperties(s *openapi3.Schema, fo *oapiv1.FieldOptions) error {
 		}
 	}
 
+	if fo.Format != nil {
+		s.Format = *fo.Format
+	}
+
+	if fo.AsType != nil {
+		s.Type = *fo.AsType
+	}
+
+	if requiredFn != nil && fo.Required {
+		requiredFn()
+	}
+
 	return nil
 }
 
@@ -328,5 +340,7 @@ func (g *Generator) setSchemaProperties(s *openapi3.Schema, parent *openapi3.Sch
 
 	fo := extOptions.(*oapiv1.FieldOptions)
 
-	return setProperties(s, fo)
+	return setProperties(s, fo, func() {
+		parent.Required = append(parent.Required, g.getFieldName(field))
+	})
 }

internal/generator/schema.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"flag"
-
 	"github.com/technicallyjosh/protoc-gen-openapi/internal/generator"
 	"google.golang.org/protobuf/compiler/protogen"
 )

main.go

@@ -3,7 +3,7 @@ info:
   description: test description
   title: test title
   version: 1.1.0
-paths: {}
+paths: { }
 components:
   responses:
     default:
@@ -19,4 +19,3 @@ components:
           type: string
         msg:
           type: string
-

test/basic_test_openapi.yaml

@@ -6,6 +6,7 @@ import "oapi/v1/file.proto";
 import "oapi/v1/service.proto";
 import "oapi/v1/method.proto";
 import "oapi/v1/field.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/technicallyjosh/protoc-gen-openapi/test_api";
 
@@ -37,6 +38,7 @@ service TestService {
 message MessageRequest {
   string string = 1;
   string required_string = 2 [(oapi.v1.required) = true];
+  string required_string2 = 3 [(oapi.v1.options).required = true];
 }
 
 message TestFieldTypesRequest {
@@ -55,6 +57,12 @@ message TestFieldTypesRequest {
   repeated string repeated_string = 7;
   repeated Message repeated_message = 8;
   repeated MessageRequest repeated_request = 9;
+  google.protobuf.Timestamp message_at = 10 [
+    (oapi.v1.options) = {
+      as_type: "string"
+      format: "date-time"
+    }
+  ];
 }
 
 message TestFieldTypesResponse {}

test/field_test.proto

@@ -48,8 +48,14 @@ paths:
                         type: string
                       required_string:
                         type: string
+                      required_string2:
+                        type: string
                     required:
                       - required_string
+                      - required_string2
+                message_at:
+                  type: string
+                  format: date-time
 
       responses:
         "200":