Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improvement: generate default oauth2RedirectUrl based on page location #7476

Merged
merged 4 commits into from
Feb 2, 2022

Conversation

astellingwerf
Copy link
Contributor

… including the path (an omission of #5085)

Description

The previous improvement (#5085) assumed that the Swagger UI was hosted at the root path.

Motivation and Context

Though this might be true for some situation, it's likely to be false for many deployments. By involving the path into the oauth2RedirectUrl, the Oauth2 flow would typically work more often.

How Has This Been Tested?

I initally wrote a rewriting filter that applied the fix to a running deployment of Spring Boot. When that worked, I applied the same fix to the code, and wrote 3 additional tests that prove the fix.

Screenshots (if appropriate):

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai merged commit a89c90e into swagger-api:master Feb 2, 2022
@tim-lai
Copy link
Contributor

tim-lai commented Feb 2, 2022

@astellingwerf PR merged! Thanks for the contribution!

Also, thanks @mitasov-ra for the review!

@mitasov-ra
Copy link

@tim-lai please close related issues: #5384 and #6591

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants