Skip to content

feat: add SSE streaming API Reference example#14

Merged
devalog merged 1 commit into
mainfrom
devin/1779996141-sse-example
May 28, 2026
Merged

feat: add SSE streaming API Reference example#14
devalog merged 1 commit into
mainfrom
devin/1779996141-sse-example

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Adds a new sse/ example project demonstrating server-sent events (SSE) streaming endpoints in an API Reference. The OpenAPI spec uses the x-fern-streaming extension with three SSE patterns:

  • Basic SSEPOST /plants/{plantId}/monitor streams real-time sensor readings
  • SSE with terminatorPOST /orders/{orderId}/track streams order status updates with a [DONE] terminator
  • Stream conditionPOST /plants/chat supports both streamed and non-streamed responses via a stream request parameter

The 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, and styles.css.

CI workflows (check.yml, publish-docs.yml, preview-docs.yml) and README.md are updated to include the new sse project.

Review & Testing Checklist for Human

  • Verify the live demo at sse.docs.buildwithfern.com renders correctly after merge (publishing happens on push to main)
  • Confirm the streaming endpoints show SSE-specific UI in the API Reference tab
  • Check that the stream condition endpoint (/plants/chat) shows both streamed and non-streamed response variants

Notes

  • fern check passes locally with 0 errors (1 warning about contrast ratio, same as all other examples using the shared color palette)
  • Uses the same fern.config.json version (5.35.0) and organization (fern-docs-examples) as the grpc and graphql examples

Link to Devin session: https://app.devin.ai/sessions/411780f34776464e8c69ab07efb9b6c1
Requested by: @devalog

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
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, CI, and merge conflict monitoring

@github-actions
Copy link
Copy Markdown

🌿 Preview sse: https://fern-docs-examples-preview-pr14-sse.docs.buildwithfern.com

Here are the markdown pages you've updated:

@devalog devalog merged commit 9e963cf into main May 28, 2026
13 checks passed
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