feat: add SSE streaming API Reference example#14
Merged
Conversation
Co-Authored-By: Devin Logan <devinannlogan@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:
|
|
🌿 Preview Here are the markdown pages you've updated: |
devalog
approved these changes
May 28, 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
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 new
sse/example project demonstrating server-sent events (SSE) streaming endpoints in an API Reference. The OpenAPI spec uses thex-fern-streamingextension with three SSE patterns:POST /plants/{plantId}/monitorstreams real-time sensor readingsPOST /orders/{orderId}/trackstreams order status updates with a[DONE]terminatorPOST /plants/chatsupports both streamed and non-streamed responses via astreamrequest parameterThe example also includes standard REST endpoints (CRUD for plants and orders) alongside the streaming endpoints, following the plant-themed content convention.
Follows the same structure as existing examples (
grpc,graphql):fern.config.json,generators.yml,docs.yml,openapi.yaml, welcome page, API reference overview, shared assets, andstyles.css.CI workflows (
check.yml,publish-docs.yml,preview-docs.yml) andREADME.mdare updated to include the newsseproject.Review & Testing Checklist for Human
streamcondition endpoint (/plants/chat) shows both streamed and non-streamed response variantsNotes
fern checkpasses locally with 0 errors (1 warning about contrast ratio, same as all other examples using the shared color palette)fern.config.jsonversion (5.35.0) and organization (fern-docs-examples) as thegrpcandgraphqlexamplesLink to Devin session: https://app.devin.ai/sessions/411780f34776464e8c69ab07efb9b6c1
Requested by: @devalog