swagger-api / swagger-api/swagger-ui
Description not shown in Definitions if $ref
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
a field's description doesn't end up getting shown anywhere in the Schema Definitions if the field ends up being a $ref
Note that the field's description renders just fine if the field is a type (e.g. boolean, integer, string, etc.). It only doesn't show up if the field is a $ref to another schema.
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
Reproduce the issue in Swagger UI with a schema field whose description is attached to a $ref, then compare it with an equivalent primitive field. Trace the Schema Definitions rendering path and identify the existing coverage for descriptions; done means the referenced-field description is visible while primitive-field behavior remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100