swagger-api / swagger-api/swagger-ui
Suppress text "Default" on UI
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
2 similar requests were closed before but I still believe that this is important for users.
https://github.com/swagger-api/swagger-ui/issues/1311
https://github.com/swagger-api/swagger-js/issues/788
We understand that tag helps grouping but for many of us users we do not need any tag for entire API documentation. Regardless how necessary the default tag is needed internally for implementation, it does not make sense from user perspective that there is a big bold text "Default" displayed in UI with no clue about it is for. And it took me quite a while to figure out where this "Default" is coming from (I had to try each file - version, description, license, contact, etc. to finally find out this field is from tags). Apparently I am not the only one who has this confusion according to other 2 closed tickets I found. Thus I am reopening this request again. Thanks.
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 two linked prior issues (#1311 and #788), then locate the Swagger UI entry point that renders the default tag. Define the behavior for APIs that do not need a user-visible tag, add coverage for that case, and verify the UI no longer shows “Default” while grouping still works.
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
- Needs clarification
- Newbie friendliness
- 35/100