api

Documentation

Index

• Variables
• func GetAssets(prefix string) http.Handler
• func GetHome(prefix string) http.Handler
• func GetInfo(c *gin.Context)
• func GetResources(c *gin.Context)
• func SetupRoutes(router *gin.Engine, cfg config.Config, ds datastore.Datastore)
• func StartWebServer(ctx context.Context, cfg config.Config, ds datastore.Datastore)
• func Stats(c *gin.Context)
• type Error
  • func NewError(err error) Error

Variables

var (
	// Version is the current application version
	Version = "dev"

	// GitCommit contains the Git commit SHA for the binary
	GitCommit string

	// BuildTime contains the binary build time
	BuildTime string

	// GoVersion contains the build time Go version
	GoVersion string
)

Functions

func GetAssets

func GetAssets(prefix string) http.Handler

func GetHome

func GetHome(prefix string) http.Handler

GetHome renderes the home page

func GetInfo

func GetInfo(c *gin.Context)

GetInfo renders the system information

func GetResources

func GetResources(c *gin.Context)

GetResources retrieves the cloud resources matching the query parameters

func SetupRoutes

func SetupRoutes(router *gin.Engine, cfg config.Config, ds datastore.Datastore)

func StartWebServer

func StartWebServer(ctx context.Context, cfg config.Config, ds datastore.Datastore)

func Stats

func Stats(c *gin.Context)

Stats provides stats about stored data

Types

type Error

type Error struct {
	Message string `json:"error"`
}

func NewError

func NewError(err error) Error