httpserver

Documentation

Index

• Constants
• Variables
• func Start(port, certFile, privateKeyFile string)
• type APIHandler
  • func NewAPIHandler() *APIHandler
  • func (g *APIHandler) Health(w http.ResponseWriter, r *http.Request)
• type APIServer
  • func NewAPIServer() *APIServer
  • func (g *APIServer) Routes() []*Route
• type IacProvider
• type Route

Constants

const (
	// GatewayDefaultPort - default port at which the http server listens
	GatewayDefaultPort = "9010"

	// APIVersion - default api version for REST endpoints
	APIVersion = "v1"

	// TerrascanServerPort allows user to configure server at a port other than default
	TerrascanServerPort = "TERRASCAN_SERVER_PORT"
)

Variables

var ErrDashboardDisabled = fmt.Errorf("set 'dashboard=true' in terrascan config file to enable database logs")

ErrDashboardDisabled would be the error returned back when log endpoint is hit while the dashboard mode is disabled

Functions

func Start

func Start(port, certFile, privateKeyFile string)

Start initializes api routes and starts http server

Types

type APIHandler

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

APIHandler struct for http api server

func NewAPIHandler

func NewAPIHandler() *APIHandler

NewAPIHandler returns a new APIHandler{}

func (*APIHandler) Health

func (g *APIHandler) Health(w http.ResponseWriter, r *http.Request)

Health returns the health of the http server

type APIServer

type APIServer struct {
}

APIServer struct for http api server

func NewAPIServer

func NewAPIServer() *APIServer

NewAPIServer returns a new APIServer{}

func (*APIServer) Routes

func (g *APIServer) Routes() []*Route

Routes returns a slice of routes of API endpoints to be registered with http server

type IacProvider

type IacProvider struct {
	Type           string   `json:"type"`
	Versions       []string `json:"versions"`
	DefaultVersion string   `json:"defaultVersion"`
}

IacProvider contains response body for iac providers

type Route

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

Route is a specification and handler for a REST endpoint.