swagger-api / swagger-api/swagger-ui

Suggestion to replace some text in Auth popup

Open
#4,331 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

As I have been testing with different services and multiples Authentications mechanism, I have been struggling with the content of the "Authorize" pop-up screen, and I have some suggestions.

Some context: You can have multiple sections in the screen and may found that some are mandatory while other are not. When using Basic Auth, you are not authenticated with the remote server when you store the value - this will be done, later when you execute a service call with those credentials.

So, with this in mind, here are the suggestions:

  • Green "Authorize" button -> Store (or Save)
  • "Logout" button -> Reset
  • "Authorized" texted displayed below the title when green button was clicked -> Stored (or Saved)
Q A
Bug or feature request? feature request
Which Swagger/OpenAPI version? OpenAPI 3
Which Swagger-UI version? 3.12.0
How did you install Swagger-UI? webjar
Which browser & version? Chrome 65
Which operating system? Mac OS-X

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

Start by locating the Auth popup entry point and the displayed "Authorize", "Logout", and "Authorized" text in Swagger UI. Check the OpenAPI 3 authentication flow described here, then verify that the labels communicate storing and resetting credentials without implying remote authentication.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
authentication, frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.