swagger-api / swagger-api/swagger-ui

Improvements to execution and clear button

Open
#2,809 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

cat: user experience needs: UX/design input P2 type: feature version: 3.x
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

I think we could improve the look and feel of the execution flow if the execute button is a fixed sized (ie: the same size as the other buttons).

At the moment, the execute button initially covers the whole screen:

screen shot 2017-03-27 at 8 08 32 pm

Then after we press it, the screen gets divided with Execute and Clear buttons:

screen shot 2017-03-27 at 8 08 39 pm

Maybe the clear button should be a bit lower, after the invocation's response payload and headers? That way it could act as a separator between the actual invocation's response and the other possible responses. Something like this (the clear button would go around where the red rectangle is):

screen shot 2017-03-27 at 8 10 40 pm

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by locating the execution flow and its Execute/Clear button layout, then compare the current behavior with the screenshots in the issue. Done means the Execute button keeps a fixed size consistent with the other buttons and Clear appears below the invocation response payload and headers.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html, javascript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.