Categorygithub.com/kebohan1/ipfs-clusterapirest
package
0.0.0-20201201023048-a52a6fd3d10b
Repository: https://github.com/kebohan1/ipfs-cluster.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
42
Dependents
2
Files
1.7k SLOC

# Packages

Package client provides a Go Client for the IPFS Cluster API provided by the "api/rest" component.

# Functions

NewAPI creates a new REST API component with the given configuration.
NewAPIWithHost creates a new REST API component and enables the libp2p-http endpoint using the given Host, if not nil.

# Constants

These are the default values for Config.
These are the default values for Config.
These are the default values for Config.
These are the default values for Config.
These are the default values for Config.

# Variables

CORS defaults.
rs/cors this will set sensible defaults when empty: {"Origin", "Accept", "Content-Type", "X-Requested-With"}.
CORS defaults.
CORS defaults.
CORS defaults.
0.
These are the default values for Config.
DefaultHTTPListenAddrs contains default listen addresses for the HTTP API.
ErrHTTPEndpointNotEnabled is returned when trying to perform operations that rely on the HTTPEndpoint but it is disabled.
ErrNoEndpointEnabled is returned when the API is created but no HTTPListenAddr, nor libp2p configuration fields, nor a libp2p Host are provided.

# Structs

API implements an API and aims to provides a RESTful HTTP API for Cluster.
Config is used to intialize the API object and allows to customize the behaviour of it.
No description provided by the author