api

Documentation

Index

• Constants
• Variables
• func UnescapeUnicode(raw string) (string, error)
• type AllRequest
• type AllResponse
• type FileInfo
• type ListResponse
• type ManifestAction
• type Options
• type PageResponse
• type RegisterResponse
• type Service
  • func New(storer storage.Storer, resolver resolver.Interface, addr boson.Address, ...) Service
• type TransactionResponse
• type UpgradedResponseWriter
• type UploadResponse

Constants

const (
	PinHeader            = "Pin"
	EncryptHeader        = "Encrypt"
	IndexDocumentHeader  = "Index-Document"
	ErrorDocumentHeader  = "Error-Document"
	CollectionHeader     = "Collection"
	CollectionNameHeader = "Collection-Name"
	ReferenceLinkHeader  = "Reference-Link"
	// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
	TargetsRecoveryHeader = "recovery-targets"
)

const (
	StringTrue = "true"
)

Variables

var (
	ErrNotFound    = errors.New("manifest: not found")
	ErrServerError = errors.New("manifest: ServerError")
)

var BufferSizeMul int

Functions

func UnescapeUnicode

func UnescapeUnicode(raw string) (string, error)

UnescapeUnicode convert the raw Unicode encoding to character

Types

type AllRequest

type AllRequest struct {
	Id      int           `json:"id"`
	JsonRpc string        `json:"jsonrpc"`
	Method  string        `json:"method"`
	Params  []interface{} `json:"params"`
}

type AllResponse

type AllResponse struct {
	Id      int         `json:"id"`
	JsonRpc string      `json:"jsonrpc"`
	Result  interface{} `json:"result"`
}

type FileInfo

type FileInfo struct {
	Path        string
	Name        string
	ContentType string
	Size        int64
	Reader      io.Reader
}

type ListResponse

type ListResponse struct {
	RootCid   boson.Address          `json:"rootCid"`
	PinState  bool                   `json:"pinState"`
	BitVector address.BitVectorApi   `json:"bitVector"`
	Register  bool                   `json:"register"`
	Manifest  *fileinfo.ManifestNode `json:"manifest"`
}

type ManifestAction

type ManifestAction struct {
	Target    string              `json:"target"`
	Source    string              `json:"source"`
	Reference string              `json:"ref"`
	Operation filestore.Operation `json:"op"`
}

type Options

type Options struct {
	CORSAllowedOrigins []string
	GatewayMode        bool
	WsPingPeriod       time.Duration
	BufferSizeMul      int
	Restricted         bool
	DebugApiAddr       string
	RPCWSAddr          string
}

type PageResponse

type PageResponse struct {
	Total int            `json:"total"`
	List  []ListResponse `json:"list"`
}

type RegisterResponse

type RegisterResponse struct {
	Hash common.Hash `json:"hash"`
}

type Service

type Service interface {
	http.Handler
	m.Collector
	io.Closer
}

Service is the API service interface.

func New

func New(storer storage.Storer, resolver resolver.Interface, addr boson.Address, chunkInfo chunkinfo.Interface, fileInfo fileinfo.Interface,
	traversalService traversal.Traverser, pinning pinning.Interface, auth authenticator, logger logging.Logger, kad topology.Driver,
	tracer *tracing.Tracer, traffic traffic.ApiInterface, commonChain chain.Common, oracleChain chain.Resolver, netRelay netrelay.NetRelay,
	multicast multicast.GroupInterface, route routetab.RouteTab, o Options) Service

New will create a and initialize a new API service.

type TransactionResponse

type TransactionResponse struct {
	Hash     common.Hash
	Address  boson.Address
	Register bool
}

type UpgradedResponseWriter

type UpgradedResponseWriter interface {
	http.ResponseWriter
	http.Pusher
	http.Hijacker
	http.Flusher
	http.CloseNotifier
}

UpgradedResponseWriter adds more functionality on top of ResponseWriter

type UploadResponse

type UploadResponse struct {
	Reference boson.Address `json:"reference"`
}

UploadResponse is returned when an HTTP request to upload a file or collection is successful