alertapi

Documentation

Overview

Package alertapi provides the HTTP API handlers for Vigil's alerting system.

Index

• type API
  • func New(logger log.Logger, svc TriageService) *API
  • func (a *API) RegisterRoutes(r chi.Router)
• type TriageService

Types

type API

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

API holds dependencies for HTTP handlers.

func New

func New(logger log.Logger, svc TriageService) *API

New creates a new API handler.

func (*API) RegisterRoutes

func (a *API) RegisterRoutes(r chi.Router)

RegisterRoutes attaches API endpoints to the router.

type TriageService

type TriageService interface {
	Submit(ctx context.Context, al *alert.Alert) (*triage.SubmitResult, error)
	Get(ctx context.Context, id string) (*triage.Result, bool, error)
}

TriageService defines the business operations alertapi needs.