chore: rename shouldGenerateWebsocketClients to generateWebSocketClients#4284
Merged
fern-support merged 3 commits intomainfrom Mar 16, 2026
Merged
Conversation
…nts in docs Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 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-73758c12-8389-4d15-b659-e7371e7c2102.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
…me-websocket-clients-docs
| </ParamField> | ||
|
|
||
| <ParamField path="shouldGenerateWebsocketClients" type="boolean" toc={true}> | ||
| <ParamField path="generateWebSocketClients" type="boolean" toc={true}> |
Contributor
There was a problem hiding this comment.
mention the old name, just in case users are on an older generator version.
Contributor
There was a problem hiding this comment.
Done — added a note mentioning shouldGenerateWebsocketClients as a deprecated alias.
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
fern-support
approved these changes
Mar 16, 2026
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
2 participants
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
Updates documentation to reflect the renamed TypeScript SDK generator config option:
shouldGenerateWebsocketClients→generateWebSocketClients. This is the docs companion to fern-api/fern#13562, which renamed the config flag in the generator code (keeping the old name as a deprecated fallback).Files changed:
configuration.mdx— Updated the<ParamField>path fromshouldGenerateWebsocketClientstogenerateWebSocketClients, and added a note that the old name is still accepted as a deprecated aliaschangelog/2025-03-06.mdx— Updated the inline code reference to use the new config nameReview & Testing Checklist for Human
shouldGenerateWebsocketClientssince it's a historical record of what was released at that time, or use the new name for discoverabilityconfiguration.mdxreads well on the rendered docs siteNotes
The generator-side change preserves backwards compatibility:
generateWebSocketClientsis preferred, butshouldGenerateWebsocketClientsstill works as a fallback. The configuration page now documents this fallback.Link to Devin session: https://app.devin.ai/sessions/d8ce068101844e7b8b41db4d4546b912
Requested by: @Swimburger