mirror of
https://github.com/logos-messaging/pm.git
synced 2026-01-04 07:03:10 +00:00
Merge pull request #313 from waku-org/furps-for-codex
docs: furps suggestion for simple codex poc
This commit is contained in:
commit
a115762d59
25
FURPS/application/codex_archiving.md
Normal file
25
FURPS/application/codex_archiving.md
Normal file
@ -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)
|
||||||
@ -52,14 +52,22 @@ Logos Movement Community Enabling
|
|||||||
|
|
||||||
### [Codex for Message Archival PoC](https://github.com/waku-org/pm/issues/293)
|
### [Codex for Message Archival PoC](https://github.com/waku-org/pm/issues/293)
|
||||||
|
|
||||||
TODO - Hanno is defining some FURPS and we can review.
|
**Owner**: App/Chat Dev
|
||||||
|
|
||||||
**Owner**: {one waku subteam}
|
**Feature**: [Codex Archiving PoC](/FURPS/application/codex_archiving.md)
|
||||||
|
|
||||||
**Feature**: [{Feature Name (only 1)}]({path/to/furps/file})
|
|
||||||
|
|
||||||
**FURPS**:
|
**FURPS**:
|
||||||
- {F1. copy-paste full furps statement}
|
|
||||||
|
- 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**:
|
**Checklist**:
|
||||||
- [ ] Specs: link to specs and/or API definition
|
- [ ] Specs: link to specs and/or API definition
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user