Skip to content

docs(backend): refresh SSE endpoint guidance - #995

Open
bamiebot-maker wants to merge 1 commit into
LabsCrypt:mainfrom
bamiebot-maker:docs/refresh-sse-readme
Open

docs(backend): refresh SSE endpoint guidance#995
bamiebot-maker wants to merge 1 commit into
LabsCrypt:mainfrom
bamiebot-maker:docs/refresh-sse-readme

Conversation

@bamiebot-maker

Copy link
Copy Markdown

Summary

  • restore and refresh the focused SSE README
  • replace deprecated unversioned examples with authenticated /v1/events/subscribe and /v1/streams examples
  • document the JWT requirement and 410 Gone behavior of the old unversioned subscription path
  • mark JWT, per-IP limits, and Redis pub/sub as shipped with direct implementation links while retaining outstanding production TODOs

Closes #848

Validation

  • verified every linked implementation file exists
  • checked that no deprecated curl or stream endpoint examples remain
  • git diff --check passes

Docs only; docs/SSE_ARCHITECTURE.md was not changed.

@bamiebot-maker

Copy link
Copy Markdown
Author

CI audit: the docs-specific validation and both CodeQL jobs pass. The remaining matrix failures occur before or outside this README change: backend/frontend/Docker dependency installation fails on the existing Vitest 3.2.7 vs @vitest/coverage-v8 2.1.9 peer conflict, and contract jobs fail in existing Rust dependencies/tests. This PR changes only �ackend/SSE_README.md.

@bamiebot-maker
bamiebot-maker force-pushed the docs/refresh-sse-readme branch from a86e678 to 428c99f Compare July 29, 2026 10:37
@bamiebot-maker
bamiebot-maker force-pushed the docs/refresh-sse-readme branch from 428c99f to d21ec71 Compare July 31, 2026 11:34
@bamiebot-maker

Copy link
Copy Markdown
Author

Hi maintainers! 👋 This PR branch has been cleanly rebased onto the latest main branch with 0 merge conflicts. Ready for review and merge!

@ogazboiz ogazboiz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

most of this checks out against the code (v1 subscribe with JWT, stats endpoint, redis pub/sub, per-IP capacity). two fixes:

  1. the claim that the old unversioned GET /events/subscribe returns HTTP 410 Gone is not true, there is no 410 anywhere in the backend; unversioned paths fall through to the deprecated handlers or 404. document the actual behavior.
  2. #1001 also creates backend/SSE_README.md, whichever merges second needs a rebase, so coordinate.

if you want to keep contributing, join us on Telegram: https://t.me/+DOylgFv1jyJlNzM0

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.

[Docs] backend/SSE_README.md is stale: marks shipped auth/per-IP/Redis as TODO and uses deprecated endpoints

2 participants