create new type EnumSchema for enum options

Signed-off-by: Lukas Hoehl <[email protected]>

examples/internal/proto/examplepb/a_bit_of_everything.proto

@@ -420,19 +420,17 @@ message MessageWithBody {
 // NumericEnum is one or zero.
 enum NumericEnum {
   option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
-    json_schema: {
-      title: "NumericEnum"
-      description: "NumericEnum is one or zero."
-      extensions: {
-        key: "x-a-bit-of-everything-foo";
-        value {
-          string_value: "bar";
-        }
+    description: "NumericEnum is one or zero."
+    title: "NumericEnum"
+    extensions: {
+      key: "x-a-bit-of-everything-foo"
+      value {
+        string_value: "bar"
       }
     }
     external_docs: {
-      url: "https://github.com/grpc-ecosystem/grpc-gateway";
-      description: "Find out more about ABitOfEverything";
+      url: "https://github.com/grpc-ecosystem/grpc-gateway"
+      description: "Find out more about ABitOfEverything"
     }
     example: "\"ZERO\""
   };

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

@@ -940,7 +940,7 @@ func renderEnumerationsAsDefinition(enums enumMap, d openapiDefinitionsObject, r
 			panic(err)
 		}
 		if opts != nil {
-			protoSchema := openapiSchemaFromProtoSchema(opts, reg, customRefs, enum)
+			protoSchema := openapiSchemaFromProtoEnumSchema(opts, reg, customRefs, enum)
 			// Warning: Make sure not to overwrite any fields already set on the schema type.
 			// This is only a subset of the fields from JsonSchema since most of them only apply to arrays or objects not enums
 			enumSchemaObject.ExternalDocs = protoSchema.ExternalDocs
@@ -2819,19 +2819,19 @@ func extractSchemaOptionFromMessageDescriptor(msg *descriptorpb.DescriptorProto)
 	return opts, nil
 }
 
-// extractSchemaOptionFromEnumDescriptor extracts the message of type
-// openapi_options.Schema from a given proto enum's descriptor.
-func extractSchemaOptionFromEnumDescriptor(enum *descriptorpb.EnumDescriptorProto) (*openapi_options.Schema, error) {
+// extractEnumSchemaOptionFromEnumDescriptor extracts the message of type
+// openapi_options.EnumSchema from a given proto enum's descriptor.
+func extractEnumSchemaOptionFromEnumDescriptor(enum *descriptorpb.EnumDescriptorProto) (*openapi_options.EnumSchema, error) {
 	if enum.Options == nil {
 		return nil, nil
 	}
 	if !proto.HasExtension(enum.Options, openapi_options.E_Openapiv2Enum) {
 		return nil, nil
 	}
 	ext := proto.GetExtension(enum.Options, openapi_options.E_Openapiv2Enum)
-	opts, ok := ext.(*openapi_options.Schema)
+	opts, ok := ext.(*openapi_options.EnumSchema)
 	if !ok {
-		return nil, fmt.Errorf("extension is %T; want a Schema", ext)
+		return nil, fmt.Errorf("extension is %T; want a EnumSchema", ext)
 	}
 	return opts, nil
 }
@@ -2990,8 +2990,8 @@ func getMessageOpenAPIOption(reg *descriptor.Registry, msg *descriptor.Message)
 	return opts, nil
 }
 
-func getEnumOpenAPIOption(reg *descriptor.Registry, enum *descriptor.Enum) (*openapi_options.Schema, error) {
-	opts, err := extractSchemaOptionFromEnumDescriptor(enum.EnumDescriptorProto)
+func getEnumOpenAPIOption(reg *descriptor.Registry, enum *descriptor.Enum) (*openapi_options.EnumSchema, error) {
+	opts, err := extractEnumSchemaOptionFromEnumDescriptor(enum.EnumDescriptorProto)
 	if err != nil {
 		return nil, err
 	}
@@ -3169,6 +3169,24 @@ func updateSwaggerObjectFromFieldBehavior(s *openapiSchemaObject, j []annotation
 	}
 }
 
+func openapiSchemaFromProtoEnumSchema(s *openapi_options.EnumSchema, reg *descriptor.Registry, refs refMap, data interface{}) openapiSchemaObject {
+	ret := openapiSchemaObject{
+		ExternalDocs: protoExternalDocumentationToOpenAPIExternalDocumentation(s.GetExternalDocs(), reg, data),
+	}
+	jsonSchema := &openapi_options.JSONSchema{
+		Ref:         s.Ref,
+		Title:       s.Title,
+		Extensions:  s.Extensions,
+		Description: s.Description,
+		Default:     s.Default,
+		ReadOnly:    s.ReadOnly,
+		Example:     s.Example,
+	}
+	ret.schemaCore = protoJSONSchemaToOpenAPISchemaCore(jsonSchema, reg, refs)
+	updateswaggerObjectFromJSONSchema(&ret, jsonSchema, reg, data)
+	return ret
+}
+
 func openapiSchemaFromProtoSchema(s *openapi_options.Schema, reg *descriptor.Registry, refs refMap, data interface{}) openapiSchemaObject {
 	ret := openapiSchemaObject{
 		ExternalDocs: protoExternalDocumentationToOpenAPIExternalDocumentation(s.GetExternalDocs(), reg, data),

protoc-gen-openapiv2/options/annotations.proto

@@ -33,7 +33,7 @@ extend google.protobuf.EnumOptions {
   //
   // All IDs are the same, as assigned. It is okay that they are the same, as they extend
   // different descriptor messages.
-  Schema openapiv2_enum = 1042;
+  EnumSchema openapiv2_enum = 1042;
 }
 extend google.protobuf.ServiceOptions {
   // ID assigned by [email protected] for gRPC-Gateway project.