mirror of
https://github.com/logos-storage/logos-storage-nim.git
synced 2026-01-02 13:33:10 +00:00
7deeb7d2b3
* Add availability enabled parameter * Return bytes to availability when finished * Add until parameter * Remove debug message * Clean up and fix tests * Update documentations and cleanup * Avoid swallowing CancelledError * Move until validation to reservations module * Call onAvailabilityAdded callabck when the availability is enabled in sales * Remove until validation in restapi when creating an availability * Add openapi documentation * Use results instead of stew/results (#1112) * feat: request duration limit (#1057) * feat: request duration limit * Fix tests and duration type * Add custom error * Remove merge issue * Update codex contracts eth * Update market config and fix test * Fix SlotReservationsConfig syntax * Update dependencies * test: remove doubled test * chore: update contracts repo --------- Co-authored-by: Arnaud <arnaud@status.im> * fix(statemachine): do not raise from state.run (#1115) * fix(statemachine): do not raise from state.run * fix rebase * fix exception handling in SaleProvingSimulated.prove - re-raise CancelledError - don't return State on CatchableError - expect the Proofs_InvalidProof custom error instead of checking a string * asyncSpawn salesagent.onCancelled This was swallowing a KeyError in one of the tests (fixed in the previous commit) * remove error handling states in asyncstatemachine * revert unneeded changes * formatting * PR feedback, logging updates * chore(integration): simplify block expiration integration test (#1100) * chore(integration): simplify block expiration integration test * clean up * fix after rebase * perf: contract storage optimizations (#1094) * perf: contract storage optimizations * Apply optimization changes * Apply optimizing parameters sizing * Update codex-contracts-eth * bump latest changes in contracts branch * Change requestDurationLimit to uint64 * fix tests * fix tests --------- Co-authored-by: Arnaud <arnaud@status.im> Co-authored-by: Eric <5089238+emizzle@users.noreply.github.com> * bump contracts to master (#1122) * Add availability enabled parameter * Return bytes to availability when finished * Add until parameter * Clean up and fix tests * Move until validation to reservations module * Apply suggestion changes: return the reservation module error * Apply suggestion changes for until dates * Apply suggestion changes: reorganize tests * Fix indent * Remove test related to timing issue * Add raises errors to async pragram and remove useless try except * Update open api documentation * Fix wording * Remove the httpClient restart statements * Use market.getRequestEnd to set validUntil * Remove returnBytes * Use clock.now in testing * Move the api validation file to the right file --------- Co-authored-by: Adam Uhlíř <adam@uhlir.dev> Co-authored-by: Eric <5089238+emizzle@users.noreply.github.com>
931 lines
27 KiB
YAML
931 lines
27 KiB
YAML
openapi: 3.0.3
|
|
|
|
info:
|
|
version: 0.0.1
|
|
title: Codex API
|
|
description: "List of endpoints and interfaces available to Codex API users"
|
|
|
|
security:
|
|
- {}
|
|
|
|
components:
|
|
schemas:
|
|
MultiAddress:
|
|
type: string
|
|
description: Address of node as specified by the multi-address specification https://multiformats.io/multiaddr/
|
|
example: /ip4/127.0.0.1/tcp/8080
|
|
|
|
PeerId:
|
|
type: string
|
|
description: Peer Identity reference as specified at https://docs.libp2p.io/concepts/fundamentals/peers/
|
|
example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
|
|
|
|
Id:
|
|
type: string
|
|
description: 32bits identifier encoded in hex-decimal string.
|
|
minLength: 66
|
|
maxLength: 66
|
|
example: 0x...
|
|
|
|
BigInt:
|
|
type: string
|
|
description: Integer represented as decimal string
|
|
|
|
Cid:
|
|
type: string
|
|
description: Content Identifier as specified at https://github.com/multiformats/cid
|
|
example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
|
|
|
|
SlotId:
|
|
type: string
|
|
description: Keccak hash of the abi encoded tuple (RequestId, slot index)
|
|
example: 268a781e0db3f7cf36b18e5f4fdb7f586ec9edd08e5500b17c0e518a769f114a
|
|
|
|
LogLevel:
|
|
type: string
|
|
description: "One of the log levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL"
|
|
example: DEBUG
|
|
|
|
EthereumAddress:
|
|
type: string
|
|
description: Address of Ethereum address
|
|
|
|
PricePerBytePerSecond:
|
|
type: string
|
|
description: The amount of tokens paid per byte 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: 10 minutes
|
|
|
|
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"
|
|
|
|
Content:
|
|
type: object
|
|
description: Parameters specifying the content
|
|
properties:
|
|
cid:
|
|
$ref: "#/components/schemas/Cid"
|
|
|
|
Node:
|
|
type: object
|
|
properties:
|
|
nodeId:
|
|
type: string
|
|
peerId:
|
|
type: string
|
|
record:
|
|
type: string
|
|
address:
|
|
type: string
|
|
seen:
|
|
type: boolean
|
|
|
|
CodexVersion:
|
|
type: object
|
|
properties:
|
|
version:
|
|
type: string
|
|
example: v0.1.7
|
|
revision:
|
|
type: string
|
|
example: 0c647d8
|
|
|
|
PeersTable:
|
|
type: object
|
|
properties:
|
|
localNode:
|
|
$ref: "#/components/schemas/Node"
|
|
nodes:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Node"
|
|
|
|
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"
|
|
announceAddresses:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/MultiAddress"
|
|
table:
|
|
$ref: "#/components/schemas/PeersTable"
|
|
codex:
|
|
$ref: "#/components/schemas/CodexVersion"
|
|
|
|
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"
|
|
minPricePerBytePerSecond:
|
|
type: string
|
|
description: Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string
|
|
totalCollateral:
|
|
type: string
|
|
description: Total collateral (in amount of tokens) that can be used for matching requests
|
|
enabled:
|
|
type: boolean
|
|
description: Enable the ability to receive sales on this availability.
|
|
default: true
|
|
until:
|
|
type: integer
|
|
description: Specifies the latest timestamp, after which the availability will no longer host any slots. If set to 0, there will be no restrictions.
|
|
default: 0
|
|
|
|
SalesAvailabilityREAD:
|
|
allOf:
|
|
- $ref: "#/components/schemas/SalesAvailability"
|
|
- type: object
|
|
properties:
|
|
freeSize:
|
|
type: string
|
|
description: Unused size of availability's storage in bytes as decimal string
|
|
|
|
SalesAvailabilityCREATE:
|
|
allOf:
|
|
- $ref: "#/components/schemas/SalesAvailability"
|
|
- required:
|
|
- totalSize
|
|
- minPricePerBytePerSecond
|
|
- totalCollateral
|
|
- duration
|
|
|
|
Slot:
|
|
type: object
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/SlotId"
|
|
request:
|
|
$ref: "#/components/schemas/StorageRequest"
|
|
slotIndex:
|
|
type: string
|
|
description: Slot Index as decimal string
|
|
|
|
SlotAgent:
|
|
type: object
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/SlotId"
|
|
slotIndex:
|
|
type: string
|
|
description: Slot Index as decimal string
|
|
requestId:
|
|
$ref: "#/components/schemas/Id"
|
|
request:
|
|
$ref: "#/components/schemas/StorageRequest"
|
|
reservation:
|
|
$ref: "#/components/schemas/Reservation"
|
|
state:
|
|
type: string
|
|
description: Description of the slot's
|
|
enum:
|
|
- SaleCancelled
|
|
- SaleDownloading
|
|
- SaleErrored
|
|
- SaleFailed
|
|
- SaleFilled
|
|
- SaleFilling
|
|
- SaleFinished
|
|
- SaleIgnored
|
|
- SaleInitialProving
|
|
- SalePayout
|
|
- SalePreparing
|
|
- SaleProving
|
|
- SaleUnknown
|
|
|
|
Reservation:
|
|
type: object
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/Id"
|
|
availabilityId:
|
|
$ref: "#/components/schemas/Id"
|
|
size:
|
|
$ref: "#/components/schemas/BigInt"
|
|
requestId:
|
|
$ref: "#/components/schemas/Id"
|
|
slotIndex:
|
|
type: string
|
|
description: Slot Index as decimal string
|
|
validUntil:
|
|
type: integer
|
|
description: Timestamp after which the reservation will no longer be valid.
|
|
|
|
StorageRequestCreation:
|
|
type: object
|
|
required:
|
|
- pricePerBytePerSecond
|
|
- duration
|
|
- proofProbability
|
|
- collateralPerByte
|
|
- expiry
|
|
properties:
|
|
duration:
|
|
$ref: "#/components/schemas/Duration"
|
|
pricePerBytePerSecond:
|
|
$ref: "#/components/schemas/PricePerBytePerSecond"
|
|
proofProbability:
|
|
$ref: "#/components/schemas/ProofProbability"
|
|
nodes:
|
|
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
|
|
collateralPerByte:
|
|
type: string
|
|
description: Number as decimal string that represents how much collateral per byte 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:
|
|
- pricePerBytePerSecond
|
|
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"
|
|
pricePerBytePerSecond:
|
|
$ref: "#/components/schemas/PricePerBytePerSecond"
|
|
maxSlotLoss:
|
|
type: integer
|
|
description: Max slots that can be lost without data considered to be lost
|
|
|
|
StorageRequest:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Request ID
|
|
client:
|
|
$ref: "#/components/schemas/EthereumAddress"
|
|
ask:
|
|
$ref: "#/components/schemas/StorageAsk"
|
|
content:
|
|
$ref: "#/components/schemas/Content"
|
|
expiry:
|
|
$ref: "#/components/schemas/Expiry"
|
|
nonce:
|
|
type: string
|
|
description: Random data
|
|
|
|
Purchase:
|
|
type: object
|
|
properties:
|
|
state:
|
|
type: string
|
|
description: Description of the Request's state
|
|
enum:
|
|
- cancelled
|
|
- error
|
|
- failed
|
|
- finished
|
|
- pending
|
|
- started
|
|
- submitted
|
|
- unknown
|
|
error:
|
|
type: string
|
|
nullable: true
|
|
description: If Request failed, then here is presented the error message
|
|
request:
|
|
$ref: "#/components/schemas/StorageRequest"
|
|
|
|
DataList:
|
|
type: object
|
|
properties:
|
|
content:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/DataItem"
|
|
|
|
DataItem:
|
|
type: object
|
|
properties:
|
|
cid:
|
|
$ref: "#/components/schemas/Cid"
|
|
manifest:
|
|
$ref: "#/components/schemas/ManifestItem"
|
|
|
|
ManifestItem:
|
|
type: object
|
|
properties:
|
|
treeCid:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: "Unique data identifier"
|
|
datasetSize:
|
|
type: integer
|
|
format: int64
|
|
description: "Length of original content in bytes"
|
|
blockSize:
|
|
type: integer
|
|
description: "Size of blocks"
|
|
protected:
|
|
type: boolean
|
|
description: "Indicates if content is protected by erasure-coding"
|
|
filename:
|
|
type: string
|
|
nullable: true
|
|
description: "The original name of the uploaded content (optional)"
|
|
example: codex.png
|
|
mimetype:
|
|
type: string
|
|
nullable: true
|
|
description: "The original mimetype of the uploaded content (optional)"
|
|
example: image/png
|
|
|
|
Space:
|
|
type: object
|
|
properties:
|
|
totalBlocks:
|
|
description: "Number of blocks stored by the node"
|
|
type: integer
|
|
format: int64
|
|
quotaMaxBytes:
|
|
type: integer
|
|
format: int64
|
|
description: "Maximum storage space (in bytes) available for the node in Codex's local repository."
|
|
quotaUsedBytes:
|
|
type: integer
|
|
format: int64
|
|
description: "Amount of storage space (in bytes) currently used for storing files in Codex's local repository."
|
|
quotaReservedBytes:
|
|
type: integer
|
|
format: int64
|
|
description: "Amount of storage reserved (in bytes) in the Codex's local repository for future use when storage requests will be picked up and hosted by the node using node's availabilities. This does not include the storage currently in use."
|
|
|
|
servers:
|
|
- url: "http://localhost:8080/api/codex/v1"
|
|
|
|
tags:
|
|
- name: Marketplace
|
|
description: Marketplace information and operations
|
|
- name: Data
|
|
description: Data operations
|
|
- name: Node
|
|
description: Node management
|
|
- name: Debug
|
|
description: Debugging configuration
|
|
|
|
paths:
|
|
"/connect/{peerId}":
|
|
get:
|
|
summary: "Connect to a peer"
|
|
description: |
|
|
If `addrs` param is supplied, it will be used to dial the peer, otherwise the `peerId` is used
|
|
to invoke peer discovery, if it succeeds the returned addresses will be used to dial.
|
|
tags: [Node]
|
|
operationId: connectPeer
|
|
parameters:
|
|
- in: path
|
|
name: peerId
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/PeerId"
|
|
description: Peer that should be dialed.
|
|
- in: query
|
|
name: addrs
|
|
schema:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
$ref: "#/components/schemas/MultiAddress"
|
|
description: |
|
|
If supplied, it will be used to dial the peer.
|
|
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
|
|
"422":
|
|
description: The content type is not a valid content type or the filename is not valid
|
|
"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
|
|
parameters:
|
|
- name: content-type
|
|
in: header
|
|
required: false
|
|
description: The content type of the file. Must be valid.
|
|
schema:
|
|
type: string
|
|
example: "image/png"
|
|
- name: content-disposition
|
|
in: header
|
|
required: false
|
|
description: The content disposition used to send the filename.
|
|
schema:
|
|
type: string
|
|
example: 'attachment; filename="codex.png"'
|
|
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."
|
|
tags: [Data]
|
|
operationId: downloadLocal
|
|
parameters:
|
|
- in: path
|
|
name: cid
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: File to be downloaded.
|
|
|
|
responses:
|
|
"200":
|
|
description: Retrieved content specified by CID
|
|
content:
|
|
application/octet-stream:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
"400":
|
|
description: Invalid CID is specified
|
|
"404":
|
|
description: Content specified by the CID is unavailable locally
|
|
"500":
|
|
description: Well it was bad-bad
|
|
|
|
"/data/{cid}/network":
|
|
post:
|
|
summary: "Download a file from the network to the local node if it's not available locally. Note: Download is performed async. Call can return before download is completed."
|
|
tags: [Data]
|
|
operationId: downloadNetwork
|
|
parameters:
|
|
- in: path
|
|
name: cid
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: "File to be downloaded."
|
|
responses:
|
|
"200":
|
|
description: Manifest information for download that has been started.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DataItem"
|
|
"400":
|
|
description: Invalid CID is specified
|
|
"404":
|
|
description: Failed to download dataset manifest
|
|
"500":
|
|
description: Well it was bad-bad
|
|
|
|
"/data/{cid}/network/stream":
|
|
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."
|
|
tags: [Data]
|
|
operationId: downloadNetworkStream
|
|
parameters:
|
|
- in: path
|
|
name: cid
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: "File to be downloaded."
|
|
responses:
|
|
"200":
|
|
description: Retrieved content specified by CID
|
|
content:
|
|
application/octet-stream:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
"400":
|
|
description: Invalid CID is specified
|
|
"404":
|
|
description: Content specified by the CID is not found
|
|
"500":
|
|
description: Well it was bad-bad
|
|
|
|
"/data/{cid}/network/manifest":
|
|
get:
|
|
summary: "Download only the dataset manifest from the network to the local node if it's not available locally."
|
|
tags: [Data]
|
|
operationId: downloadNetworkManifest
|
|
parameters:
|
|
- in: path
|
|
name: cid
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: "File for which the manifest is to be downloaded."
|
|
responses:
|
|
"200":
|
|
description: Manifest information.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DataItem"
|
|
"400":
|
|
description: Invalid CID is specified
|
|
"404":
|
|
description: Failed to download dataset manifest
|
|
"500":
|
|
description: Well it was bad-bad
|
|
|
|
"/space":
|
|
get:
|
|
summary: "Gets a summary of the storage space allocation of the node."
|
|
tags: [Data]
|
|
operationId: space
|
|
responses:
|
|
"200":
|
|
description: "Summary of storage allocation"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Space"
|
|
|
|
"500":
|
|
description: "It's not working as planned"
|
|
|
|
"/sales/slots":
|
|
get:
|
|
summary: "Returns active slots"
|
|
tags: [Marketplace]
|
|
operationId: getActiveSlots
|
|
responses:
|
|
"200":
|
|
description: Retrieved active slots
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Slot"
|
|
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/sales/slots/{slotId}":
|
|
get:
|
|
summary: "Returns active slot with id {slotId} for the host"
|
|
tags: [Marketplace]
|
|
operationId: getActiveSlotById
|
|
parameters:
|
|
- in: path
|
|
name: slotId
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: File to be downloaded.
|
|
responses:
|
|
"200":
|
|
description: Retrieved active slot
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SlotAgent"
|
|
|
|
"400":
|
|
description: Invalid or missing SlotId
|
|
|
|
"404":
|
|
description: Host is not in an active sale for the slot
|
|
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/sales/availability":
|
|
get:
|
|
summary: "Returns storage that is for sale"
|
|
tags: [Marketplace]
|
|
operationId: getAvailabilities
|
|
responses:
|
|
"200":
|
|
description: Retrieved storage availabilities of the node
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/SalesAvailabilityREAD"
|
|
"500":
|
|
description: Error getting unused availabilities
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
post:
|
|
summary: "Offers storage for sale"
|
|
operationId: offerStorage
|
|
tags: [Marketplace]
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SalesAvailabilityCREATE"
|
|
responses:
|
|
"201":
|
|
description: Created storage availability
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SalesAvailabilityREAD"
|
|
"400":
|
|
description: Invalid data input
|
|
"422":
|
|
description: Not enough node's storage quota available or the provided parameters did not pass validation
|
|
"500":
|
|
description: Error reserving availability
|
|
"503":
|
|
description: Persistence is not enabled
|
|
"/sales/availability/{id}":
|
|
patch:
|
|
summary: "Updates availability"
|
|
description: |
|
|
The new parameters will be only considered for new requests.
|
|
Existing Requests linked to this Availability will continue as is.
|
|
operationId: updateOfferedStorage
|
|
tags: [Marketplace]
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: ID of Availability
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SalesAvailability"
|
|
responses:
|
|
"204":
|
|
description: Availability successfully updated
|
|
"400":
|
|
description: Invalid data input
|
|
"404":
|
|
description: Availability not found
|
|
"422":
|
|
description: The provided parameters did not pass validation
|
|
"500":
|
|
description: Error reserving availability
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/sales/availability/{id}/reservations":
|
|
get:
|
|
summary: "Get availability's reservations"
|
|
description: Return's list of Reservations for ongoing Storage Requests that the node hosts.
|
|
operationId: getReservations
|
|
tags: [Marketplace]
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: ID of Availability
|
|
responses:
|
|
"200":
|
|
description: Retrieved storage availabilities of the node
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Reservation"
|
|
"400":
|
|
description: Invalid Availability ID
|
|
"404":
|
|
description: Availability not found
|
|
"500":
|
|
description: Error getting reservations
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/storage/request/{cid}":
|
|
post:
|
|
summary: "Creates a new Request for storage"
|
|
tags: [Marketplace]
|
|
operationId: createStorageRequest
|
|
parameters:
|
|
- in: path
|
|
name: cid
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/Cid"
|
|
description: CID of the uploaded data that should be stored
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/StorageRequestCreation"
|
|
responses:
|
|
"200":
|
|
description: Returns the Request ID as decimal string
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
"400":
|
|
description: Invalid or missing Request ID
|
|
"422":
|
|
description: The storage request parameters are not valid
|
|
"404":
|
|
description: Request ID not found
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/storage/purchases":
|
|
get:
|
|
summary: "Returns list of purchase IDs"
|
|
tags: [Marketplace]
|
|
operationId: getPurchases
|
|
responses:
|
|
"200":
|
|
description: Gets all purchase IDs stored in node
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/storage/purchases/{id}":
|
|
get:
|
|
summary: "Returns purchase details"
|
|
tags: [Marketplace]
|
|
operationId: getPurchase
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Hexadecimal ID of a Purchase
|
|
responses:
|
|
"200":
|
|
description: Purchase details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Purchase"
|
|
"400":
|
|
description: Invalid or missing Purchase ID
|
|
"404":
|
|
description: Purchase not found
|
|
"503":
|
|
description: Persistence is not enabled
|
|
|
|
"/spr":
|
|
get:
|
|
summary: "Get Node's SPR"
|
|
operationId: getSPR
|
|
tags: [Node]
|
|
responses:
|
|
"200":
|
|
description: Node's SPR
|
|
content:
|
|
plain/text:
|
|
schema:
|
|
$ref: "#/components/schemas/SPR"
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SPRRead"
|
|
"503":
|
|
description: Node SPR not ready, try again later
|
|
|
|
"/peerid":
|
|
get:
|
|
summary: "Get Node's PeerID"
|
|
operationId: getPeerId
|
|
tags: [Node]
|
|
responses:
|
|
"200":
|
|
description: Node's Peer ID
|
|
content:
|
|
plain/text:
|
|
schema:
|
|
$ref: "#/components/schemas/PeerId"
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/PeerIdRead"
|
|
|
|
"/debug/chronicles/loglevel":
|
|
post:
|
|
summary: "Set log level at run time"
|
|
tags: [Debug]
|
|
operationId: setDebugLogLevel
|
|
|
|
parameters:
|
|
- in: query
|
|
name: level
|
|
required: true
|
|
schema:
|
|
$ref: "#/components/schemas/LogLevel"
|
|
|
|
responses:
|
|
"200":
|
|
description: Successfully log level set
|
|
"400":
|
|
description: Invalid or missing log level
|
|
"500":
|
|
description: Well it was bad-bad
|
|
|
|
"/debug/info":
|
|
get:
|
|
summary: "Gets node information"
|
|
operationId: getDebugInfo
|
|
tags: [Debug]
|
|
responses:
|
|
"200":
|
|
description: Node's information
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DebugInfo"
|