docs: document resumable SSE streams and automatic reconnection#6079
Merged
Conversation
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-devin-1783235733-sse-resumable-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
fern-support
approved these changes
Jul 5, 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
The
resumableflag on SSE endpoints (and the SDK auto-reconnection it enables) shipped across TypeScript, Python, Go, and C#, but nothing on the specs side or in the SDK deep-dives documented it. This adds that coverage.Specs side — documents the
resumablefield on both API-definition formats:x-fern-streaming.resumable: true, its interaction withterminator, and document-level vs. operation-level inheritance/override.response-stream.resumable: true.Generators side — the
sse-metadatadeep-dive previously described only manual stream resumption. Adds an "Automatic reconnection" section documenting the opt-in behavior (reconnect withLast-Event-ID, honor serverretry:with a 1s default / 30s cap, 5-attempt consecutive cap with reset-on-progress) and the per-SDK request options:stream.reconnectionEnabledstream.maxReconnectionAttemptsstream_reconnection_enabledmax_stream_reconnection_attemptsoption.WithoutStreamReconnection()option.WithMaxStreamReconnectAttempts(n)DisableStreamReconnectionMaxStreamReconnectAttemptsCross-references — the SDK capabilities SSE bullet now links to the automatic-reconnection section; the spec pages and deep-dive link to each other.
Vale passes with no new alerts (the remaining suggestions are pre-existing
simply/easilyhedges on untouched lines).Follow-up (not in this PR)
x-fern-discriminator-context(used for protocol- vs. data-level SSE union discrimination) is a supported extension that appears undocumented. Left out here since it's a separate, non-reconnection concern — happy to document it in a follow-up if wanted.Link to Devin session: https://app.devin.ai/sessions/e8bc7dce89d141feadc89b5f948721aa
Requested by: @Swimburger