sphinx-contrib / sphinx-contrib/openapi
Array of string or integer doesn't show its description
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
When having a property like this:
permissions:
description: Actuators allowed
example:
- a0
- a1
items:
type: string
type: array
I get an output where description is not shown:
result.acl[].permissions[] (string) –
In cases like this (or array of integers maybe) it would be nice to show the description.
Contributor guide
No contributing guide indexed for this repository
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
Reproduce the reported OpenAPI property example with an array of strings, then compare the rendered output with the property's description. Trace the renderer entry point responsible for array item properties and inspect existing tests for descriptions or array rendering. Done means the description appears for arrays of strings and integers without regressing existing output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100