restapi

Documentation

Index

• type Controller
  • func New(ctx *context.Provider, opts ...Opt) (*Controller, error)
  • func (c *Controller) GetOperations() []operation.Handler
• type Opt
  • func WithAutoAccept(autoAccept bool) Opt
  • func WithDefaultLabel(defaultLabel string) Opt
  • func WithMessageHandler(handler operation.MessageHandler) Opt
  • func WithWebhookURLs(webhookURLs ...string) Opt

Types

type Controller

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

Controller contains handlers for controller REST API

func New

func New(ctx *context.Provider, opts ...Opt) (*Controller, error)

New returns new controller REST API instance.

func (*Controller) GetOperations

func (c *Controller) GetOperations() []operation.Handler

GetOperations returns all controller REST API endpoints

type Opt

type Opt func(opts *allOpts)

Opt represents a REST Api option.

func WithAutoAccept

func WithAutoAccept(autoAccept bool) Opt

WithAutoAccept is an option allowing for the auto accept to be set.

func WithDefaultLabel

func WithDefaultLabel(defaultLabel string) Opt

WithDefaultLabel is an option allowing for the defaultLabel to be set.

func WithMessageHandler

func WithMessageHandler(handler operation.MessageHandler) Opt

WithMessageHandler is an option allowing for the message handler to be set.

func WithWebhookURLs

func WithWebhookURLs(webhookURLs ...string) Opt

WithWebhookURLs is an option for setting up a webhook dispatcher which will notify clients of events