docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Array with enum values in items: nested description not displayed

Open AnnikaStrupp-initAG opened this issue 1 year ago • 2 comments

Describe the bug

The generated documentation does not display a 'description' text provided on the level of 'enum' in array 'items'.

Expected behavior

The 'description' is rendered and displayed on screen. This would be particularly useful for $ref referenced codelists in 'items' that come with their own description.

Current behavior

The generated documentation does not display a 'description' text provided on the level of 'enum' in array 'items'. The specified set of 'enum' values is correctly displayed as 'Possible values'.

Steps to reproduce

example-array .yaml

  example:
    type: array
    items:
      enum:
        - 1
        - 2
        - 3
        - string
      description: >
        This description is sadly not rendered.
example

Version used:

  • node.js 20.12.1
  • Docusaurus 3.4.0
  • Docusaurus OpenAPI Docs 3.0.1
  • Windows desktop

AnnikaStrupp-initAG avatar Sep 03 '24 18:09 AnnikaStrupp-initAG