diff --git a/FURPS/application/codex.md b/FURPS/application/codex.md deleted file mode 100644 index a15b17f..0000000 --- a/FURPS/application/codex.md +++ /dev/null @@ -1,26 +0,0 @@ -# Codex Archiving PoC - -## Functionality - -1. Any admin in a Qaku Q&A can publish a backup snapshot of the entire thread to Codex once it's reached 20 responses. -2. The admin can publish the corresponding Codex CID with metadata over Waku to a dedicated snapshot content topic -3. Participants can query the Waku snapshot topic for the latest CID -4. Participants can retrieve the archived Q&A from Codex -5. Participants can perform a Store Query for more recent messages following the snapshot timestamp - -## Usability - -1. Workflow should be conceptually identical, whether the Codex interaction is via a local node or Codex gateway -2. Publishing or retrieving via Codex should be optional - -## Reliability - - -## Performance - - -## Supportability - -1. Web app - -## + (Privacy, Anonymity, Deployments) diff --git a/FURPS/application/codex_archiving.md b/FURPS/application/codex_archiving.md new file mode 100644 index 0000000..090c86e --- /dev/null +++ b/FURPS/application/codex_archiving.md @@ -0,0 +1,25 @@ +# Codex Archiving PoC FURPS + +## Functionality + +1. Any end user can publish a backup snapshot of the entire SDS log to Codex. +2. End user (may be privileged) can publish the corresponding Codex CID with metadata over Waku to a dedicated snapshot content topic. +3. Participants can query the Waku snapshot topic for the latest CID. +4. Participants can retrieve the archived messages from Codex. +5. Participants can perform a store Query for more recent messages following the snapshot timestamp and SDS state. + +## Usability + +1. Workflow should be conceptually identical, whether the Codex interaction is via a local node or Codex gateway. +2. Publishing or retrieving via Codex should be optional. + +## Reliability + +## Performance + + +## Supportability + +1. Developers can use this protocol in web applications. + +## + (Privacy, Anonymity, Deployments) diff --git a/draft-roadmap/formalize_and_expand_waku_web_apps.md b/draft-roadmap/formalize_and_expand_waku_web_apps.md index 05b136a..e1febf7 100644 --- a/draft-roadmap/formalize_and_expand_waku_web_apps.md +++ b/draft-roadmap/formalize_and_expand_waku_web_apps.md @@ -54,12 +54,20 @@ Logos Movement Community Enabling **Owner**: App/Chat Dev -**Feature**: [Codex Archiving PoC](/FURPS/application/codex.md) +**Feature**: [Codex Archiving PoC](/FURPS/application/codex_archiving.md) **FURPS**: -- F1-5 -- U1-2 -- S1 + +- F1. Any end user can publish a backup snapshot of the entire SDS log to Codex. +- F2. End user (may be privileged) can publish the corresponding Codex CID with metadata over Waku to a dedicated snapshot content topic. +- F3. Participants can query the Waku snapshot topic for the latest CID. +- F4. Participants can retrieve the archived messages from Codex. +- F5. Participants can perform a store Query for more recent messages following the snapshot timestamp and SDS state. + +- U1. Workflow should be conceptually identical, whether the Codex interaction is via a local node or Codex gateway. +- U2. Publishing or retrieving via Codex should be optional. + +- S1. Developers can use this protocol in web applications. **Checklist**: - [ ] Specs: link to specs and/or API definition