rest

Documentation

Index

• Constants
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
• type BindServiceReq
• type DefineServiceReq
• type DisableServiceBindingReq
• type EnableServiceBindingReq
• type RefundServiceDepositReq
• type SetWithdrawAddrReq
• type UpdateServiceBindingReq

Constants

const (
	RestServiceName      = "service-name"
	RestRequestID        = "request-id"
	RestOwner            = "owner"
	RestProvider         = "provider"
	RestConsumer         = "consumer"
	RestRequestContextID = "request-context-id"
	RestBatchCounter     = "batch-counter"
	RestArg1             = "arg1"
	RestArg2             = "arg2"
	RestSchemaName       = "schema-name"
)

Rest variable names nolint

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)

RegisterRoutes defines routes that get registered by the main application

Types

type BindServiceReq

type BindServiceReq struct {
	BaseReq     rest.BaseReq `json:"base_req" yaml:"base_req"`
	ServiceName string       `json:"service_name" yaml:"service_name"`
	Provider    string       `json:"provider" yaml:"provider"`
	Deposit     string       `json:"deposit" yaml:"deposit"`
	Pricing     string       `json:"pricing" yaml:"pricing"`
	QoS         uint64       `json:"qos" yaml:"qos"`
	Owner       string       `json:"owner" yaml:"owner"`
}

BindServiceReq defines the properties of a bind service request's body.

type DefineServiceReq

type DefineServiceReq struct {
	BaseReq           rest.BaseReq `json:"base_req" yaml:"base_req"`
	Name              string       `json:"name" yaml:"name"`
	Description       string       `json:"description" yaml:"description"`
	Tags              []string     `json:"tags" yaml:"tags"`
	Author            string       `json:"author" yaml:"author"`
	AuthorDescription string       `json:"author_description" yaml:"author_description"`
	Schemas           string       `json:"schemas" yaml:"schemas"`
}

DefineServiceReq defines the properties of a define service request's body.

type DisableServiceBindingReq

type DisableServiceBindingReq struct {
	BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
	Owner   string       `json:"owner" yaml:"owner"`
}

DisableServiceBindingReq defines the properties of a disable service binding request's body.

type EnableServiceBindingReq

type EnableServiceBindingReq struct {
	BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
	Deposit string       `json:"deposit" yaml:"deposit"`
	Owner   string       `json:"owner" yaml:"owner"`
}

EnableServiceBindingReq defines the properties of an enable service binding request's body.

type RefundServiceDepositReq

type RefundServiceDepositReq struct {
	BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
	Owner   string       `json:"owner" yaml:"owner"`
}

RefundServiceDepositReq defines the properties of a refund service deposit request's body.

type SetWithdrawAddrReq

type SetWithdrawAddrReq struct {
	BaseReq         rest.BaseReq `json:"base_req" yaml:"base_req"`
	WithdrawAddress string       `json:"withdraw_address" yaml:"withdraw_address"`
}

SetWithdrawAddrReq defines the properties of a set withdraw address request's body.

type UpdateServiceBindingReq

type UpdateServiceBindingReq struct {
	BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
	Deposit string       `json:"deposit" yaml:"deposit"`
	Pricing string       `json:"pricing" yaml:"pricing"`
	QoS     uint64       `json:"qos" yaml:"qos"`
	Owner   string       `json:"owner" yaml:"owner"`
}

UpdateServiceBindingReq defines the properties of an update service binding request's body.