protoc-gen-openapi: Enum types that use stringified boolean values like "TRUE" are treated as the real boolean values

[zaakn]

env

• protoc-gen-openapi: v0.6.8
• protoc flags: --openapi_opt naming=proto,enum_type=string

proto file

enum Trinary {
	NULL = 0;
	TRUE = 1;
	FALSE = 2;
}

message Condition {
	Trinary attached = 1;
}

expected output

Condition:
    type: object
    properties:
        attached:
            enum:
                - 'NULL'
                - 'TRUE'
                - 'FALSE'
            type: string
            format: enum

actual output

Condition:
    type: object
    properties:
        attached:
            enum:
                - NULL
                - TRUE
                - FALSE
            type: string
            format: enum

---

I know it's better not to use reserved words, so this is just for usage feedback.

[zaakn]

Related code lines:

gnostic/cmd/protoc-gen-openapi/generator/wellknown/schemas.go

Lines 53 to 63 in ee84fd2

	func NewEnumSchema(enum_type *string, field protoreflect.FieldDescriptor) *v3.SchemaOrReference {
	schema := &v3.Schema{Format: "enum"}
	if enum_type != nil && *enum_type == "string" {
	schema.Type = "string"
	schema.Enum = make([]*v3.Any, 0, field.Enum().Values().Len())
	for i := 0; i < field.Enum().Values().Len(); i++ {
	schema.Enum = append(schema.Enum, &v3.Any{
	Yaml: string(field.Enum().Values().Get(i).Name()),
	})
	}
	} else {

My simple solution is:

schema.Enum = append(schema.Enum, &v3.Any{
	Yaml: strconv.Quote(string(field.Enum().Values().Get(i).Name())),
})

But is it correct to add Quote here?
It has to be said that TRUE (string without quotes) will be treated as a boolean which is the expected behavior of YAML.

See also:
https://github.com/google/gnostic-models/blob/c7be7c783f49e86348a1081eb387e01a347a4f23/openapiv3/OpenAPIv3.go#L6712-L6716

[nightlyone]

@zaakn a safer way to handle that instead of using quoting might be to set data type annotation like !!str in the schema.Enum.Yaml field and strip them again when rendering JSON. This allows to avoid adding annotations,