PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Array with enum values in items: nested description not displayed
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
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.
Version used:
- node.js 20.12.1
- Docusaurus 3.4.0
- Docusaurus OpenAPI Docs 3.0.1
- Windows desktop
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the example-array.yaml reproduction and the generated OpenAPI documentation in Docusaurus. Trace how array items render enum values and descriptions, then verify that the nested description appears alongside the existing “Possible values” output for the provided example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, openapi, react, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100