Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ParamsWebAPI = &ParametersWebAPI{ Auth: authentication.AuthConfiguration{ Scheme: "jwt", }, }
View Source
var (
Plugin *app.Plugin
)
Functions ¶
func CreateEchoSwagger ¶
func CreateEchoSwagger(e *echo.Echo, version string) echoswagger.ApiRoot
Types ¶
type ParametersWebAPI ¶ added in v0.3.1
type ParametersWebAPI struct {
Enabled bool `default:"true" usage:"whether the web api plugin is enabled"`
BindAddress string `default:"0.0.0.0:9090" usage:"the bind address for the node web api"`
NodeOwnerAddresses []string `default:"" usage:"defines a list of node owner addresses (bech32)"`
Auth authentication.AuthConfiguration `usage:"configures the authentication for the API service"`
Limits struct {
Timeout time.Duration `default:"30s" usage:"the timeout after which a long running operation will be canceled"`
ReadTimeout time.Duration `default:"10s" usage:"the read timeout for the HTTP request body"`
WriteTimeout time.Duration `default:"10s" usage:"the write timeout for the HTTP response body"`
MaxBodyLength string `default:"2M" usage:"the maximum number of characters that the body of an API call may contain"`
}
DebugRequestLoggerEnabled bool `default:"false" usage:"whether the debug logging for requests should be enabled"`
}
Click to show internal directories.
Click to hide internal directories.