swagger-api / swagger-api/swagger-ui
Support OAuth redirection handling in swagger-ui-react
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Is your feature request related to a problem?
When using swagger-ui-react and clicking the authorize button, upon entering details into the OAuth section and launching the flow, the error "validation erroroauth2RedirectUrl configuration is not passed. Oauth2 authorization cannot be performed." appears. I believe this is what is meant when in the limitations of swagger-ui-react it states "OAuth redirection handling is not supported.".
Describe the solution you'd like
Support OAuth redirection handling, or allow a prop to be passed to not show OAuth flow as a temporary hotfix.
Describe alternatives you've considered
Not using swagger-ui-react and instead using a different swagger-ui package but would rather use the react wrapper.
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-react OAuth authorize flow and where the oauth2RedirectUrl configuration error is produced. Compare the wrapper's behavior with the stated limitation that OAuth redirection handling is unsupported. Done means OAuth redirection works through the React wrapper, or a documented prop can hide the OAuth flow as a temporary workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- authentication, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100