Integer enum with value description

[sbahloul]

First of all, thank you for the great work.

Quick question: which annotations should be used to specify an integer enum with values description ?

components:
  schemas:
    RequestTypeEnum:
      type: integer
      enum:
        - 1
        - 2
      description: >
        Sort order:
          * `1` - Description of the requestType = 1
          * `2` - Description of the requestType = 2

Thank you,
Sebastien

[dzikoysk]

Hey, thanks :)

Unfortunately, it's currently not possible to declare enums as ints. We're only supporting string values that are valid Java/Kotlin identifiers for name-based matching. We'd need to implement something like @IndexedEnum to enforce position based schema 🤔

[dzikoysk]

This is now supported indirectly by other annotations we've developed so far:

@OpenApiPropertyType(definedBy = Integer.class)
@OpenApiDescription("Request type:\n * 1 - Type A\n * 2 - Type B\n * 3 - Type C")
enum IntegerEnumEntity {
    @OpenApiName("1") TYPE_A,
    @OpenApiName("2") TYPE_B,
    @OpenApiName("3") TYPE_C
}

Results in:

"IntegerEnumEntity" : {
  "type" : "integer",
  "format" : "int32",
  "enum" : [ 1, 2, 3 ],
  "description" : "Request type:\n * 1 - Type A\n * 2 - Type B\n * 3 - Type C"
}