swagger-api / swagger-api/swagger-ui
Awkward rendering of Parameter Object description
Open
Nobody has claimed this yet.
type: enhancement
version: 4.x
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
The goal of this issue is to find a way how to better display the description so that when the description is rendered, it doesn't looks like an actual bug in rendering.
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 by reviewing the attached screenshot and reproducing the Parameter Object description rendering in Swagger UI. Trace the rendering entry point for that description, then define the intended display and add coverage for the corrected output; the issue provides no file or test path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100