swagger-api / swagger-api/swagger-ui
Remove edit / cancel button
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
When in the "Try it out" mode for POST/PUT endpoints, there's a button that appears below the text editor box that toggles between Cancel and Edit.
Why do we need it? I think it's much simpler to not have these buttons, and just remain in "edit mode" when someone is already inside the "development mode" (try it out mode).
Having the Cancel button there confused me into thinking that this button would Cancel the request (not the editor mode).
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 Swagger UI component that renders the Try it out editor and its Cancel/Edit controls for POST and PUT operations. Confirm how the controls affect editor state, then remove the buttons while keeping the request editing flow usable and verify that the Try it out interface no longer presents the confusing labels.
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
- 42/100