docs: add SSE streaming endpoints section to API Explorer documentation #2905
+14
−0
Conversation
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
Co-Authored-By: Fern Support <[email protected]>
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:
|
Contributor
|
Assignee Required This PR was opened by Devin AI but the requester's email ([email protected]) is not in the username mapping. Please add an assignee manually. |
Co-Authored-By: Fern Support <[email protected]>
Contributor
Contributor
Co-Authored-By: Fern Support <[email protected]>
Contributor
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| text: string | ||
| ``` | ||
|
|
||
| ## API Exploere |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'API Exploere' should use sentence-style capitalization.
Contributor
Contributor
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 documentation for SSE (Server-Sent Events) streaming support in the API Explorer. This documents an existing feature that allows users to test streaming endpoints directly from the documentation, with real-time response display as data arrives.
The new section in the API Explorer page:
x-fern-streaming) and Fern Definition (response-stream)Additionally, cross-links were added from the API definition SSE pages back to the API Explorer:
fern/products/api-def/openapi-pages/endpoints/sse.mdx)fern/products/api-def/ferndef-pages/endpoints/sse.mdx)Review & Testing Checklist for Human
/learn/api-definitions/openapi/extensions/server-sent-eventsand/learn/api-definitions/fern-definition/endpoints/server-sent-events/learn/docs/api-references/api-explorer#streaming-endpoints(verify anchor link works)Recommended test plan: Navigate to the API Explorer page in the preview deployment, verify the new "Streaming endpoints" section appears with the screenshot and links. Then navigate to both SSE documentation pages (OpenAPI and Fern Definition) and verify the new "Testing streaming endpoints" section appears with working links back to the API Explorer.
Notes
The screenshot was captured from the Hume example at https://dev.hume.ai/reference/text-to-speech-tts/synthesize-json-streaming which shows the STREAM badge in the sidebar navigation.
Link to Devin run: https://app.devin.ai/sessions/9a58d22e3a524bc99e56bdb848c7e964
Requested by: Fern Support ([email protected])