Is there a known workaround for handling an array of string/enum?

[lzhoucs]

I have an array of simple enum called weathers. Although I can get to the array itself:

fieldWithPath("weathers").type(JsonFieldType.ARRAY).description("an array of weathers")

I can't get to the element inside it currently due to the exact same limitation as: spring-projects/spring-restdocs#505. As such, I got the following openapi3 spec:

weathers:
          type: array
          description: an array of weathers
          items:
            oneOf:
            - type: object
            - type: boolean
            - type: string
            - type: number

It seems the relevant logic is added in this PR: #62 as "default behavior".

Here is a minified demo: https://github.com/lzhoucs/spring-restdocs/tree/87-demo/samples/junit5

What I would like to see is as follows:

weathers:
          type: array
          description: an array of weathers
          items:
            type: string
            enum: [SPRING, SUMMER...]

Is there any workaround to get close to what I expected above?

[mduesterhoeft]

Yes this is a limitation that is originating in spring-restdocs. We just have the json type of a field and we do not know any more. We could try to extend the field descriptor to add the enum values. The descriptor itself has a dynamic attributes field that we could use to add the hint that the field is an enum field and could also add the list of possible values. We could then make use of this knowledge in JsonSchemaFromFieldDescriptorsGenerator to add the enum type to the property.

Do you want to give it a try?

[ozscheyge]

With the api-spec now supporting enum values, the generators (gradle plugins) would still need to be adapted to leverage the change.

[thowimmer]

Yes I guess I missed that. I will implement the support in the generators in the next few days and open a PR.