system

Documentation

Overview

Package system provides the system information and health check endpoints.

Index

• type App
• type Info
• type Manager
  • func NewManager(logger *logrus.Logger, systemInfo Info) *Manager
  • func (m *Manager) RegisterRoutes(r chi.Router)
• type Settings

Types

type App

type App struct {
	Name string `json:"name"`
}

App represents the application name

type Info

type Info struct {
	Version  string   `json:"version"`
	App      App      `json:"app"`
	Settings Settings `json:"settings"`
}

Info represents the system information

type Manager

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

Manager represents the system manager

func NewManager

func NewManager(logger *logrus.Logger, systemInfo Info) *Manager

NewManager creates a new system manager

func (*Manager) RegisterRoutes

func (m *Manager) RegisterRoutes(r chi.Router)

RegisterRoutes registers the search routes

type Settings

type Settings struct {
	AuthEnabled    bool     `json:"auth_enabled"`
	OAuthProviders []string `json:"oauth_providers"`
}

Settings represents the application settings