search

data-preservation-programs / spade

A Fil-Network Storage-Proposal Management Service
Other
7 stars 1 forks source link

Piece source schema guideline #16

Closed xmcai2016 closed 9 months ago

xmcai2016 commented 10 months ago

ETA: 2023-11-11

We need to provide some guidance about how the csv/json needs to be structured for us to be able to ingest it.

xmcai2016 commented 10 months ago

Notion page here: https://www.notion.so/ecosystem-wg/Piece-Source-bc8bc0a392d542a3b4dbd83ea48e8235?pvs=4

xmcai2016 commented 10 months ago

Schema for the list of CIDs, Daghaus already has an idea what they want to provide for our reference: https://github.com/web3-storage/dealer/blob/main/docs/architecture.md#offer-store-schema 

interface Offer {
  aggregate: PieceCID
  pieces: PieceCID[]
  collection: string
  orderID: string // optional, we may or may not want to support ordering CIDs by priority 
}
xmcai2016 commented 10 months ago

Assume that the collections have already been created / established manually. Throw error if not. If they do not specify collection, add to default collection (every tenant has a default collection upon onboarding to Spade).

xmcai2016 commented 10 months ago

Drafted the schema on Notion. cc @ribasushi for feedback from Spade deal engine point of view.

xmcai2016 commented 9 months ago

talked with Riba in Iceland. updated the notion page linked above. @jcace the notion page has the upload schema that riba and I agreed on, let me know your comments!

xmcai2016 commented 9 months ago

This is complete.