📝 Add API reference page for fastapi.sse#15930
Open
SAURABHSALVE wants to merge 1 commit into
Open
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
📝 Docs previewLast commit 2fe7d30 at: https://0ccf013b.fastapitiangolo.pages.dev Modified Pages |
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
1 participant
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.
The new SSE support (
EventSourceResponseandServerSentEventinfastapi.sse) is already covered in the tutorial, but it doesn't have a dedicated page in the API Reference like the other public modules (such asresponses,websockets, andtemplating).This PR adds a new
docs/en/docs/reference/sse.mdpage following the same pattern as the existing reference pages. It includes:::directives forEventSourceResponseandServerSentEvent, and adds the page to the navigation alongside the other response-related reference pages.I didn't include
format_sse_eventfor now because the tutorial currently documents only the two public classes. If you'd prefer it to be part of the API reference as well, I'm happy to add it.I also verified that the documentation builds successfully locally without any warnings, and the generated page correctly picks up the existing docstrings and
Doc()annotations.