swagger-api / swagger-api/swagger-ui
[Feature Request] Show status code description in tooltip for responses
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
I'm using the "SwashBuckle" library on ASP.NET Core.
Is your feature request related to a problem?
no
Describe the solution you'd like
When a response's description is set, it overrides the default description. For example:
For response 201, the UI shows "Returns the newly created item". If a custom description is not set, it would show the default of "Created".
I often forget which status code is which, especially for the ones I don't use often.
A clear and concise description of what you want to happen.
It would be nice if when hovering over the status code ("201"), it would show "Created" in a tooltip.
Describe alternatives you've considered
no
Additional context
no
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
No file or test is named in the issue. Start by locating the response status-code rendering in Swagger UI and review how response descriptions are displayed. Done means hovering over a status code shows its standard description when no custom description is set.
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
- 45/100