Categorygithub.com/kishansagathiya/ipfs-clusterapirest
package
0.5.0-rc1
Repository: https://github.com/kishansagathiya/ipfs-cluster.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
29
Dependents
0
Files
1.2k SLOC

# Packages

No description provided by the author

# 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

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.