web

Documentation

Index

• func MainCommand() *cobra.Command
• func NewContextWithWebEngine(ctx context.Context, webEngine *WebEngine) (context.Context, error)
• type EndpointDeclaration
• type GroupDeclaration
  • func (g *GroupDeclaration) Apply(appContext context.Context, target *gin.RouterGroup)
  • func (g *GroupDeclaration) RegisterEndpoint(method string, roles []string, handlers ...gin.HandlerFunc)
  • func (g *GroupDeclaration) RegisterEndpointPath(method string, relativePath string, roles []string, ...)
  • func (g *GroupDeclaration) RegisterGroup(relativePath string, roles []string) *GroupDeclaration
• type WebEngine
  • func NewWebEngine() (*WebEngine, error)
  • func WebEngineFromContext(ctx context.Context) *WebEngine
  • func (s *WebEngine) Start(ctx context.Context) error

Functions

func MainCommand

func MainCommand() *cobra.Command

func NewContextWithWebEngine

func NewContextWithWebEngine(ctx context.Context, webEngine *WebEngine) (context.Context, error)

Types

type EndpointDeclaration

type EndpointDeclaration interface {
	Apply(appContext context.Context, target *gin.RouterGroup)
}

type GroupDeclaration

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

func (*GroupDeclaration) Apply

func (g *GroupDeclaration) Apply(appContext context.Context, target *gin.RouterGroup)

func (*GroupDeclaration) RegisterEndpoint

func (g *GroupDeclaration) RegisterEndpoint(method string, roles []string, handlers ...gin.HandlerFunc)

func (*GroupDeclaration) RegisterEndpointPath

func (g *GroupDeclaration) RegisterEndpointPath(method string, relativePath string, roles []string, handlers ...gin.HandlerFunc)

func (*GroupDeclaration) RegisterGroup

func (g *GroupDeclaration) RegisterGroup(relativePath string, roles []string) *GroupDeclaration

type WebEngine

type WebEngine struct {
	GroupDeclaration
	// contains filtered or unexported fields
}

func NewWebEngine

func NewWebEngine() (*WebEngine, error)

# THE WEBENGINE GETS A SUPPLY OF ENV VARS TO WORK WITH (WHEN it gets deployed by ai-provisioner / deployment server within DSP) # # Security stuff # - JWT_ISSUER the token ISSUER that will be used to validate all provided tokens # (i.e. https://auth.tiki-dsp.io/auth/realms/tiki) # # - OAUTH_CLIENT_ID the client that will be used to validate all provided tokens # (i.e. ai-examples-python-dev-web-py36) # #

func WebEngineFromContext

func WebEngineFromContext(ctx context.Context) *WebEngine

func (*WebEngine) Start

func (s *WebEngine) Start(ctx context.Context) error