Enum values with hyphens or starting with numbers don't end up in the generated OpenAPI spec

[dennisameling]

Actual behavior (the bug)

Consider the following enum (Kotlin):

enum class ExampleEnum {
    `five-minutes`,
    FIVE_MINUTES, // This is the only one that ends up in the spec
    `5m`,
}

This is valid Kotlin code and the OpenAPI spec also doesn't prevent us from setting enum values like five-minutes and 5m. However, the library converts it into the following in the spec:

"ExampleEnum" : {
  "type" : "string",
  "enum" : [ "FIVE_MINUTES" ]
},

Expected behavior

We would expect the generated spec to look like this instead:

"ExampleEnum" : {
  "type" : "string",
  "enum" : [ "five-minutes", "FIVE_MINUTES", "5m" ]
},

To Reproduce

• Use the ExampleEnum mentioned above with this library
• Use it in any property by doing something like val exampleProperty: List<ExampleEnum>
• Notice that the generated spec misses most of the enum values

Additional context

We're on the latest version (5.6.2-1) of this library.

Please let me know if I can provide more details or examples. Happy to provide a fix if you could point me at the place where I should be looking in the library. Thank you!

[dzikoysk]

I didn't even know I can use such names for enum values. I think it could be Kotlin-only feature that is simply invisible for the Java annotation processor 🤔 This is the code we use for that:

javalin-openapi/openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/processor/generators/TypeSchemaGenerator.kt

Lines 70 to 81 in 8b3f86a

	source.kind == ENUM -> {
	val values = JsonArray()
	source.enclosedElements
	.filterIsInstance<VariableElement>()
	.filter { it.modifiers.contains(Modifier.STATIC) }
	.filter { context.isAssignable(it.asType(), type.mirror) }
	.map { it.toSimpleName() }
	.forEach { values.add(it) }
	schema.addProperty("type", "string")
	schema.add("enum", values)
	}

[dzikoysk]

Yup, it won't work. This value simply does not exist as a constant value in the compiled enum, so it's beyond our scope.