Support a configurable oauth redirect URL #442
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Addresses: #438 |
ziirish
force-pushed
the
master
branch
2 times, most recently
from
0db7d06
to
4eaf373
Compare
peter-doggart
requested changes
Jul 24, 2024
| {% if config.SWAGGER_UI_OAUTH_REDIRECT_URL -%} | ||
| oauth2RedirectUrl: "{{ config.SWAGGER_UI_OAUTH_REDIRECT_URL }}", | ||
| {% else -%} | ||
| oauth2RedirectUrl: "{{ url_for('restx_doc.static', filename='oauth2-redirect.html', _external=True) }}", |
There was a problem hiding this comment.
Correct me if I'm wrong here, but does this introduce a small behaviour change to previously? By default, config.SWAGGER_UI_OAUTH_CLIENT_ID is not defined and therefore no oauth2RedirectUrl should be set? I think we maybe just need to introduce another if statement? I don't have any OAUTH flows set up to easily test this change.
There was a problem hiding this comment.
I've put back the original check and then nested the new check inside it
There was a problem hiding this comment.
Testing this.... hold off merging...
There was a problem hiding this comment.
OK testing done, could you re-review please
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently an oauth redirect URL is hardcoded as
oauth2-redirect.html, this works fine for example applications but for production apps you probably want to specify your own URL so you can add logic such as creating a user account etc.This change adds a new config variable called
SWAGGER_UI_OAUTH_REDIRECT_URLwhich will tell swagger which URL to use when submitting to the oauth endpoint. This will need to match what has been previously configured with the oauth provider.I've also included a simple github oauth example for reference.
As this is my first PR into this project please let me know if there are any changes or additions I need to make this to comply with the prioject standards.
Resolves: #438