Skip to content

Document blocked headers for WebSocket Playground proxy#4163

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773150992-websocket-blocked-headers-docs
Open

Document blocked headers for WebSocket Playground proxy#4163
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773150992-websocket-blocked-headers-docs

Conversation

@devin-ai-integration
Copy link
Contributor

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

  • Verify the blocked header list matches the code: Cross-reference the list in this PR against the DENIED_HEADERS set in packages/workers/proxy/src/websocket.ts in fern-platform#8267. If either PR's list changes, they must stay in sync.
  • Confirm placement: The new ### Blocked headers subsection is placed under ## WebSocket Playground. Verify this is the best location — an alternative could be the WebSocket definition page or the WebSocket reference page.
  • Check Vale/style compliance: Vale wasn't run locally. Confirm the new content passes Vale linting in CI, especially sentence-case heading rules and the conciseness/verbosity guidelines.

Notes

Co-Authored-By: David Konigsberg <davidakonigsberg@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

🌿 Preview your docs: https://fern-preview-7380eb83-def0-434e-8275-aa4bc51fe10b.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

@davidkonigsberg davidkonigsberg self-assigned this Mar 11, 2026
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.

1 participant