route

Documentation

Index

• func NewAPIRoute(services *service.Services) codegen.ServerInterface
• func NewAPIRouter(swagger *openapi3.T, services *service.Services) (http.Handler, error)
• func NewDocRouter(swagger *openapi3.T, docHTML string, docYAML string) (http.Handler, error)
• type APIRoute
  • func (r *APIRoute) DeleteYskCard(ctx echo.Context, id string) error
  • func (r *APIRoute) GetActionType(c echo.Context, sourceID codegen.SourceID, name codegen.EventName) error
  • func (r *APIRoute) GetActionTypes(c echo.Context) error
  • func (r *APIRoute) GetActionTypesBySourceID(c echo.Context, sourceID codegen.SourceID) error
  • func (r *APIRoute) GetEventType(ctx echo.Context, sourceID codegen.SourceID, name codegen.EventName) error
  • func (r *APIRoute) GetEventTypes(ctx echo.Context) error
  • func (r *APIRoute) GetEventTypesBySourceID(ctx echo.Context, sourceID codegen.SourceID) error
  • func (r *APIRoute) GetYskCard(ctx echo.Context) error
  • func (r *APIRoute) PollSIO(ctx echo.Context) error
  • func (r *APIRoute) PollSIO2(ctx echo.Context) error
  • func (r *APIRoute) PublishEvent(ctx echo.Context, sourceID codegen.SourceID, name codegen.EventName) error
  • func (r *APIRoute) RegisterActionTypes(c echo.Context) error
  • func (r *APIRoute) RegisterEventTypes(ctx echo.Context) error
  • func (r *APIRoute) SubscribeActionWS(c echo.Context, sourceID codegen.SourceID, ...) error
  • func (r *APIRoute) SubscribeEventWS(c echo.Context, sourceID codegen.SourceID, ...) error
  • func (r *APIRoute) SubscribeSIO(ctx echo.Context) error
  • func (r *APIRoute) SubscribeSIO2(ctx echo.Context) error
  • func (r *APIRoute) TriggerAction(c echo.Context, sourceID codegen.SourceID, name codegen.EventName) error

Functions

func NewAPIRoute

func NewAPIRoute(services *service.Services) codegen.ServerInterface

func NewAPIRouter

func NewAPIRouter(swagger *openapi3.T, services *service.Services) (http.Handler, error)

func NewDocRouter

func NewDocRouter(swagger *openapi3.T, docHTML string, docYAML string) (http.Handler, error)

Types

type APIRoute

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

func (*APIRoute) DeleteYskCard

func (r *APIRoute) DeleteYskCard(ctx echo.Context, id string) error

func (*APIRoute) GetActionType

func (r *APIRoute) GetActionType(c echo.Context, sourceID codegen.SourceID, name codegen.EventName) error

func (*APIRoute) GetActionTypes

func (r *APIRoute) GetActionTypes(c echo.Context) error

func (*APIRoute) GetActionTypesBySourceID

func (r *APIRoute) GetActionTypesBySourceID(c echo.Context, sourceID codegen.SourceID) error

func (*APIRoute) GetEventType

func (r *APIRoute) GetEventType(ctx echo.Context, sourceID codegen.SourceID, name codegen.EventName) error

func (*APIRoute) GetEventTypes

func (r *APIRoute) GetEventTypes(ctx echo.Context) error

func (*APIRoute) GetEventTypesBySourceID

func (r *APIRoute) GetEventTypesBySourceID(ctx echo.Context, sourceID codegen.SourceID) error

func (*APIRoute) GetYskCard

func (r *APIRoute) GetYskCard(ctx echo.Context) error

func (*APIRoute) PollSIO

func (r *APIRoute) PollSIO(ctx echo.Context) error

func (*APIRoute) PollSIO2

func (r *APIRoute) PollSIO2(ctx echo.Context) error

unfortunately need to duplicate the func to support both `/socket.io` and `/socket.io/` (with a trailing slash) API endpoints

func (*APIRoute) PublishEvent

func (r *APIRoute) PublishEvent(ctx echo.Context, sourceID codegen.SourceID, name codegen.EventName) error

func (*APIRoute) RegisterActionTypes

func (r *APIRoute) RegisterActionTypes(c echo.Context) error

func (*APIRoute) RegisterEventTypes

func (r *APIRoute) RegisterEventTypes(ctx echo.Context) error

func (*APIRoute) SubscribeActionWS

func (r *APIRoute) SubscribeActionWS(c echo.Context, sourceID codegen.SourceID, params codegen.SubscribeActionWSParams) error

func (*APIRoute) SubscribeEventWS

func (r *APIRoute) SubscribeEventWS(c echo.Context, sourceID codegen.SourceID, params codegen.SubscribeEventWSParams) error

func (*APIRoute) SubscribeSIO

func (r *APIRoute) SubscribeSIO(ctx echo.Context) error

func (*APIRoute) SubscribeSIO2

func (r *APIRoute) SubscribeSIO2(ctx echo.Context) error

unfortunately need to duplicate the func to support both `/socket.io` and `/socket.io/` (with a trailing slash) API endpoints

func (*APIRoute) TriggerAction

func (r *APIRoute) TriggerAction(c echo.Context, sourceID codegen.SourceID, name codegen.EventName) error