swagger-api / swagger-api/swagger-ui
Add option to display only the tag description in the header
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Describe the solution you'd like
Currently tag names are used in the bold part of the UIs header. However they are usually not nice display names but codes used also for anchor links. Therefore I think that an option to put the tag description text in the place the tags name text currently resides (and not display the tag name it self) would be useful.
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
The issue does not name a file, test, or entry point. Start by locating the tag header rendering and the existing tag-name display option or configuration, then determine how tag descriptions are exposed there. Done means an option displays the tag description in the bold header position without displaying the tag name, with coverage for the new behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100