Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0
Labels: documentation, Stellar Wave, docs
The SSE README lists three things as TODO that are already shipped, and its examples point at dead endpoints.
SSE_README.md:103-110 has "Add JWT authentication", "Implement per-IP connection limits" and "Add Redis pub/sub" sitting as unchecked TODOs, but all three are done. The curl/endpoint examples still use the deprecated unversioned /events/subscribe and POST /streams, which now return 410 and require auth. Anyone following the doc will hit walls.
What the fix has to hold to
- the doc matches what's actually implemented
- examples use endpoints that still work
Done when
Where to start
backend/SSE_README.md, that's the whole thing. Rewriting docs/SSE_ARCHITECTURE.md is out of scope. Docs-only, quick.
Labels:
documentation,Stellar Wave,docsThe SSE README lists three things as TODO that are already shipped, and its examples point at dead endpoints.
SSE_README.md:103-110has "Add JWT authentication", "Implement per-IP connection limits" and "Add Redis pub/sub" sitting as unchecked TODOs, but all three are done. The curl/endpoint examples still use the deprecated unversioned/events/subscribeandPOST /streams, which now return 410 and require auth. Anyone following the doc will hit walls.What the fix has to hold to
Done when
/v1/events/subscribeand the authenticated v1 stream endpoints/events/subscribenow needs a JWT and the unversioned path returns 410Where to start
backend/SSE_README.md, that's the whole thing. Rewritingdocs/SSE_ARCHITECTURE.mdis out of scope. Docs-only, quick.