systemapi

Documentation

Overview

Package systemapi provides components for the System API service.

Index

• Variables
• func BasicAuth(realm, salt string, getHashedCredentials func() map[string]string) func(next http.Handler) http.Handler
• type Event
• type Server
  • func NewServer(log *httplog.Logger, cfg *SystemAPIConfig) (server *Server, err error)
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() (err error)
• type SystemAPIConfig
  • func NewConfig() *SystemAPIConfig
  • func NewConfigFromFile(path string) (*SystemAPIConfig, error)
  • func NewConfigFromTOML(content []byte) (*SystemAPIConfig, error)

Variables

var DefaultLogMaxEntries = common.GetEnvInt("MAX_EVENTS", 1000)

Functions

func BasicAuth

func BasicAuth(realm, salt string, getHashedCredentials func() map[string]string) func(next http.Handler) http.Handler

BasicAuth implements a simple middleware handler for adding basic http auth to a route.

Types

type Event

type Event struct {
	ReceivedAt time.Time `json:"received_at"`
	Message    string    `json:"message"`
}

type Server

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

func NewServer

func NewServer(log *httplog.Logger, cfg *SystemAPIConfig) (server *Server, err error)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

func (*Server) Start

func (s *Server) Start() (err error)

type SystemAPIConfig

type SystemAPIConfig struct {
	General systemAPIConfigGeneral

	Actions     map[string]string
	FileUploads map[string]string `toml:"file_uploads"`
}

func NewConfig

func NewConfig() *SystemAPIConfig

func NewConfigFromFile

func NewConfigFromFile(path string) (*SystemAPIConfig, error)

func NewConfigFromTOML

func NewConfigFromTOML(content []byte) (*SystemAPIConfig, error)