actions

Documentation

Index

• Variables
• func GetQueryParameters(c *gin.Context) (*datastore.QueryParams, *engine.Metadata, *map[string]interface{}, error)
• func MethodNotAllowed(c *gin.Context)
• func NotFound(c *gin.Context)
• func StatusOK(c *gin.Context)
• type Action
• type RequestParameters

Variables

var ErrBadTxConfig = errors.New("bad transaction config supplied")

ErrBadTxConfig is when the transaction config specified is not valid

var ErrTxConfigNotFound = errors.New("transaction config not found")

ErrTxConfigNotFound is when the transaction config is not found in request body

var ErrXpubNotFound = errors.New("xpub not found")

ErrXpubNotFound is when the xpub is not found (in Auth Header)

Functions

func GetQueryParameters

func GetQueryParameters(c *gin.Context) (*datastore.QueryParams, *engine.Metadata, *map[string]interface{}, error)

GetQueryParameters get all filtering parameters related to the db query

func MethodNotAllowed

func MethodNotAllowed(c *gin.Context)

MethodNotAllowed handles all 405 requests

func NotFound

func NotFound(c *gin.Context)

NotFound handles all 404 requests

func StatusOK

func StatusOK(c *gin.Context)

StatusOK is a basic response which sets the status to 200

Types

type Action

type Action struct {
	AppConfig *config.AppConfig
	Services  *config.AppServices
}

Action is the configuration for the actions and related services

type RequestParameters

type RequestParameters struct {
	Conditions  map[string]interface{} `json:"conditions"`
	Metadata    engine.Metadata        `json:"metadata"`
	QueryParams datastore.QueryParams  `json:"query_params"`
}

RequestParameters is a struct for handling basic request parameters