chore: swagger docs omit brower based credentials, rely on swagger auth #13742
Conversation
This file contains hidden or 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
Swagger has an "Authorize" button which should be the only authentication being used in the api requests
Closed
aslilac
approved these changes
Jul 1, 2024
| // | ||
| // So remove authenticating via a cookie, and rely on the authorization | ||
| // header passed in. | ||
| httpSwagger.UIConfig(map[string]string{ |
There was a problem hiding this comment.
I hate that they use a map[string]string for this instead of a struct 😭
There was a problem hiding this comment.
Not even a link to the docs 😢
Comment on lines
+109
to
+112
| "requestInterceptor": `(a => { | ||
| a.credentials = "omit"; | ||
| return a; | ||
| })`, |
There was a problem hiding this comment.
their recommendation is just to embed javascript in a string??? I extra hate that
There was a problem hiding this comment.
Yea, it is a bit crazy: https://github.com/swaggo/http-swagger/blob/master/swagger.go#L24-L27
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Swagger has an "Authorize" button which should be the only authentication being used in the api requests
Closes #13535
Note: I considered implementing CSRF in the interceptor which would just use the logged in user credentials. But the
Authorizebutton will still exist, and it would be even more confusing since the cookie auth supersedes the header based auth. So swagger requiring explicit authentication feels safer.