Document blocked headers for WebSocket Playground proxy#4163
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Document blocked headers for WebSocket Playground proxy#4163devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
Co-Authored-By: David Konigsberg <davidakonigsberg@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-7380eb83-def0-434e-8275-aa4bc51fe10b.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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.
Summary
Adds a "Blocked headers" subsection under the WebSocket Playground section of the API Explorer docs page. This documents the set of headers that the WebSocket proxy strips during the connection handshake for security reasons, so users know which headers won't be forwarded to upstream servers.
This accompanies the security fix in fern-platform#8267, which adds header sanitization to the WebSocket proxy worker.
Review & Testing Checklist for Human
DENIED_HEADERSset inpackages/workers/proxy/src/websocket.tsin fern-platform#8267. If either PR's list changes, they must stay in sync.### Blocked headerssubsection is placed under## WebSocket Playground. Verify this is the best location — an alternative could be the WebSocket definition page or the WebSocket reference page.Notes