restapi

Documentation

Index

• Constants
• func ParsePeerIDParam(c echo.Context) (peer.ID, error)
• type AllowedRoute
• type DynamicProxy
  • func NewDynamicProxy(e *echo.Echo, prefix string) *DynamicProxy
  • func (p *DynamicProxy) AddGroup(prefix string) *echo.Group
  • func (p *DynamicProxy) AddReverseProxy(prefix string, host string, port uint32, path string) error
  • func (p *DynamicProxy) RemoveReverseProxy(prefix string)

Constants

const (
	// ParameterBlockID is used to identify a block by its ID.
	ParameterBlockID = "blockID"

	// ParameterTransactionID is used to identify a transaction by its ID.
	ParameterTransactionID = "transactionID"

	// ParameterOutputID is used to identify an output by its ID.
	ParameterOutputID = "outputID"

	// ParameterMilestoneIndex is used to identify a milestone by index.
	ParameterMilestoneIndex = "milestoneIndex"

	// ParameterMilestoneID is used to identify a milestone by its ID.
	ParameterMilestoneID = "milestoneID"

	// ParameterPeerID is used to identify a peer.
	ParameterPeerID = "peerID"
)

Functions

func ParsePeerIDParam

func ParsePeerIDParam(c echo.Context) (peer.ID, error)

Types

type AllowedRoute

type AllowedRoute func(echo.Context) bool

AllowedRoute defines a function to allow or disallow routes.

type DynamicProxy

type DynamicProxy struct {
	// contains filtered or unexported fields
}

func NewDynamicProxy

func NewDynamicProxy(e *echo.Echo, prefix string) *DynamicProxy

func (*DynamicProxy) AddGroup

func (p *DynamicProxy) AddGroup(prefix string) *echo.Group

func (*DynamicProxy) AddReverseProxy

func (p *DynamicProxy) AddReverseProxy(prefix string, host string, port uint32, path string) error

func (*DynamicProxy) RemoveReverseProxy

func (p *DynamicProxy) RemoveReverseProxy(prefix string)