description:"One of the log levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL"
example:DEBUG
EthereumAddress:
type:string
description:Address of Ethereum address
Reward:
type:string
description:The maximum amount of tokens paid per second per slot to hosts the client is willing to pay
Duration:
type:string
description:The duration of the request in seconds as decimal string
ProofProbability:
type:string
description:How often storage proofs are required as decimal string
Expiry:
type:string
description:A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data.
default:10minutes
SPR:
type:string
description:Signed Peer Record (libp2p)
SPRRead:
type:object
properties:
spr:
$ref:"#/components/schemas/SPR"
PeerIdRead:
type:object
properties:
id:
$ref:"#/components/schemas/PeerId"
ErasureParameters:
type:object
properties:
totalChunks:
type:integer
PoRParameters:
description:Parameters for Proof of Retrievability
type:object
properties:
u:
type:string
publicKey:
type:string
name:
type:string
Content:
type:object
description:Parameters specifying the content
properties:
cid:
$ref:"#/components/schemas/Cid"
erasure:
$ref:"#/components/schemas/ErasureParameters"
por:
$ref:"#/components/schemas/PoRParameters"
DebugInfo:
type:object
properties:
id:
$ref:"#/components/schemas/PeerId"
addrs:
type:array
items:
$ref:"#/components/schemas/MultiAddress"
repo:
type:string
description:Path of the data repository where all nodes data are stored
spr:
$ref:"#/components/schemas/SPR"
SalesAvailability:
type:object
properties:
id:
$ref:"#/components/schemas/Id"
totalSize:
type:string
description:Total size of availability's storage in bytes as decimal string
duration:
$ref:"#/components/schemas/Duration"
minPrice:
type:string
description:Minimum price to be paid (in amount of tokens) as decimal string
maxCollateral:
type:string
description:Maximum collateral user is willing to pay per filled Slot (in amount of tokens) as decimal string
SalesAvailabilityREAD:
allOf:
- $ref:"#/components/schemas/SalesAvailability"
- type:object
properties:
freeSize:
type:string
description:Unused size of availability's storage in bytes as decimal string
description:Minimal number of nodes the content should be stored on
type:integer
default:1
tolerance:
description:Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost
type:integer
default:0
collateral:
type:string
description:Number as decimal string that represents how much collateral is asked from hosts that wants to fill a slots
expiry:
type:string
description:Number as decimal string that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.
StorageAsk:
type:object
required:
- reward
properties:
slots:
description:Number of slots (eq. hosts) that the Request want to have the content spread over
type:integer
slotSize:
type:string
description:Amount of storage per slot (in bytes) as decimal string
duration:
$ref:"#/components/schemas/Duration"
proofProbability:
$ref:"#/components/schemas/ProofProbability"
reward:
$ref:"#/components/schemas/Reward"
maxSlotLoss:
type:integer
description:Max slots that can be lost without data considered to be lost
The address has to target the listening address of the peer,
which is specified with the `--listen-addrs` CLI flag.
responses:
"200":
description:Successfully connected to peer
"400":
description:Peer either not found or was not possible to dial
"/data":
get:
summary:"Lists manifest CIDs stored locally in node."
tags:[Data ]
operationId:listData
responses:
"200":
description:Retrieved list of content CIDs
content:
application/json:
schema:
$ref:"#/components/schemas/DataList"
"400":
description:Invalid CID is specified
"404":
description:Content specified by the CID is not found
"500":
description:Well it was bad-bad
post:
summary:"Upload a file in a streaming manner. Once finished, the file is stored in the node and can be retrieved by any node in the network using the returned CID."
tags:[Data ]
operationId:upload
requestBody:
content:
application/octet-stream:
schema:
type:string
format:binary
responses:
"200":
description:CID of uploaded file
content:
text/plain:
schema:
type:string
"500":
description:Well it was bad-bad and the upload did not work out
"/data/{cid}":
get:
summary:"Download a file from the local node in a streaming manner. If the file is not available locally, a 404 is returned."
description:Content specified by the CID is unavailable locally
"500":
description:Well it was bad-bad
"/data/{cid}/network":
get:
summary:"Download a file from the network in a streaming manner. If the file is not available locally, it will be retrieved from other nodes in the network if able."
