api

Documentation

Index

• type ErrorResponse
• type GetStatusResponse
• type Piece
• type PostBlobResponse
• type Replica

Types

type ErrorResponse

type ErrorResponse struct {
	// Error is the description of the error.
	Error string `json:"error"`
}

ErrorResponse represents the response that signal an error has occurred.

type GetStatusResponse

type GetStatusResponse struct {
	ID       string    `json:"id"`
	Replicas []Replica `json:"replicas,omitempty"`
}

type Piece

type Piece struct {
	Expiration   time.Time `json:"expiration"`
	LastVerified time.Time `json:"lastVerified"`
	PieceCID     string    `json:"pieceCid"`
	Status       string    `json:"status"`
}

type PostBlobResponse

type PostBlobResponse struct {
	// ID is the unique identifier for the uploaded blob.
	ID string `json:"id"`
}

PostBlobResponse represents the response to a successful POST request to upload a blob.

type Replica

type Replica struct {
	Provider string  `json:"provider"`
	Pieces   []Piece `json:"pieces"`
}