docs: add /v1/sse bridge endpoint#4396
Merged
Merged
Conversation
Documents the SSE bridge endpoint in: - api-reference.md: full endpoint spec with auth, tenant scoping, connection limits, and error responses - api-quick-ref.md: quick reference entry - real-time-events.md: SSE bridge section alongside global/per-session Endpoint was introduced in #4373 and hardened in #4395 but never documented.
![aegis-gh-agent[bot]](https://avatars.githubusercontent.com/u/106186915?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ Approved.
Docs-only PR: +43/-0, 3 files. CI 14/14 green, mergeable.
What I checked:
api-reference.md: Full endpoint spec with auth, tenant scoping, connection limits, heartbeat, error responses — complete and accurate.api-quick-ref.md: Clean quick reference entry with SSE Token/Cookie auth note.real-time-events.md: Concise SSE Bridge section, correctly differentiates from global stream.
All gates pass. Merging to develop.
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.
Summary
Documents the
GET /v1/sseSSE bridge endpoint introduced in #4373 and hardened in #4395.What's added
Why
The
/v1/sseendpoint was live but undocumented. Users connecting to the API had no reference for this endpoint's behavior, auth requirements, or how it differs fromGET /v1/events.