swagger-api / swagger-api/swagger-ui
Collapse "Response" section
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
The REST API I am using has a large number of endpoints and each endpoint again a rather large number of possible responses, hence the "Responses" section at every endpoint is very long, about 2/3 of the whole page consists of "Responses", and thus navigation requires constant scrolling.
"Responses" section should be collapsible and a config setting added to keep collapsed initially.
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 locating the endpoint Responses section in the Swagger UI frontend and the existing configuration settings that control response display. Confirm how a collapsible section should behave and how its initial collapsed state should be configured, then verify the expanded and collapsed states and the configuration option in the relevant UI tests.
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