restapi

Documentation

Index

• Variables
• type ParametersRestAPI
• type RoutesResponse

Variables

var (
	Component *app.Component
)

var ParamsRestAPI = &ParametersRestAPI{
	PublicRoutes: []string{
		"/health",
		"/api/routes",
		"/api/core/v3/info",
		"/api/core/v3/network*",
		"/api/core/v3/blocks*",
		"/api/core/v3/transactions*",
		"/api/core/v3/commitments*",
		"/api/core/v3/outputs*",
		"/api/core/v3/accounts*",
		"/api/core/v3/validators*",
		"/api/core/v3/rewards*",
		"/api/core/v3/committee*",
		"/api/debug/v2/*",
		"/api/indexer/v2/*",
		"/api/mqtt/v2",
		"/api/blockissuer/v1/*",
	},
	ProtectedRoutes: []string{
		"/api/*",
	},
}

Types

type ParametersRestAPI

type ParametersRestAPI struct {
	// the bind address on which the REST API listens on
	BindAddress string `default:"0.0.0.0:14265" usage:"the bind address on which the REST API listens on"`
	// the HTTP REST routes which can be called without authorization. Wildcards using * are allowed
	PublicRoutes []string `usage:"the HTTP REST routes which can be called without authorization. Wildcards using * are allowed"`
	// the HTTP REST routes which need to be called with authorization. Wildcards using * are allowed
	ProtectedRoutes []string `usage:"the HTTP REST routes which need to be called with authorization. Wildcards using * are allowed"`
	// whether the debug logging for requests should be enabled
	DebugRequestLoggerEnabled bool `default:"false" usage:"whether the debug logging for requests should be enabled"`
	// MaxPageSize defines the maximum number of results per page.
	MaxPageSize uint32 `default:"100" usage:"the maximum number of results per page"`
	// MaxCacheSize defines the maximum size of cache for results.
	MaxCacheSize string `default:"50MB" usage:"the maximum size of cache for results"`

	JWTAuth struct {
		// salt used inside the JWT tokens for the REST API. Change this to a different value to invalidate JWT tokens not matching this new value
		Salt string `` /* 158-byte string literal not displayed */
	} `name:"jwtAuth"`

	Limits struct {
		// the maximum number of characters that the body of an API call may contain
		MaxBodyLength string `default:"1M" usage:"the maximum number of characters that the body of an API call may contain"`
		// the maximum number of results that may be returned by an endpoint
		MaxResults int `default:"1000" usage:"the maximum number of results that may be returned by an endpoint"`
	}
}

ParametersRestAPI contains the definition of the parameters used by REST API.

type RoutesResponse

type RoutesResponse struct {
	Routes []string `json:"routes"`
}