jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-10-27 12:40:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(vision): add /buzz/v1 read endpoints to the protocol contract (#7879)

Browse Source 
Adds a short paragraph to the Protocol section of `VISION.md` about
`/buzz/v1` endpoints, which are backend-for-frontend (BFF) reads.

- **Dividing line:** every write is a signed Nostr event. Nostr reads
must cover all of that state. `/buzz/v1/...` can add reads shaped for
specific use cases (thread catch-up, sync) over the same store.
- We start with this rule and refine it as more exceptions come up.
This commit is contained in:
Bradley Axen
2026-09-25 08:09:44 -07:00
committed by GitHub
parent 2013148852
commit 930b8bb800
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
VISION.md
View File

@@ -74,6 +74,8 @@ Buzz extends the standard Nostr event format with custom kind numbers for enterp
New message type? New kind integer. Zero breaking changes. New message type? New kind integer. Zero breaking changes.
**The conversation is Nostr; Buzz adds accessories around it.** Messages, threads, reactions, and the rest of the conversation are signed Nostr events, and Nostr reads must cover all of that state, so a standards-leaning Buzz client stays possible. Around it, the relay serves accessories that don't fit that shape: Blossom media, git smart HTTP, workflow webhooks, derived unread counts, and namespaced `/buzz/v1/...` endpoints for backend-for-frontend reads (thread catch-up, sync) over the same authoritative store. We start with this rule and refine it as more cases show up.
--- ---
## Architecture ## Architecture