Array with enum values in items: nested description not displayed

[AnnikaStrupp-initAG]

Array with enum values in items: nested description not displayed

[sserrata]

Hi @AnnikaStrupp-initAG, thanks for opening this issue. Can you explain why it wouldn't make sense to define description at the same level as type? Also, can you help me find where in the official OpenAPI documentation this feature is defined/described? Thanks!

[aldafu]

why it wouldn't make sense to define description at the same level as type?

It makes sense and is really useful when you want define the items of the array in a OpenAPI ReferenceObject that you then can reference in multiple places without repeating yourself. And then obviously have the description property as part of that same ReferenceObject to describe the enum in detail.

Let me also add that rapidoc and openapi-explorer handle this case as expected, i.e. the description property is rendered and displayed.

can you help me find where in the official OpenAPI documentation this feature is defined/described? Thanks!

Sure thing, go here https://swagger.io/specification/v3/#schema-object and have a look at the second part under the "Properties" section where you will find type and description properties equally, i.e. same level.