✨ Fix APIKeyQuery for WebSocket endpoints
#13758
Open
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
Harry-Lees
changed the title
starlette.requests.HTTPConnection classAPIKeyQuery for WebSocket endpoints
github-actions
bot
added
the
conflicts
Contributor
|
This pull request has a merge conflict that needs to be resolved. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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, the Security classes outlined in the documentation do not work for WebSocket endpoints. This has raised several questions on GitHub discussions/ issues.
There have been several PRs attempting to fix this issue, but it was always deemed not possible due to the WebSocket exception handling. I think this has changed with several recent updates to Starlette and FastAPI.
This uses the same theory behind the example in the Starlette docs on WebSockets.