api

Documentation

Index

• func EngineStatus(c *gin.Context)
• func Fields(c *gin.Context)
• func GetAssets(prefix string) http.Handler
• func GetHome(prefix string) http.Handler
• func Healthz(c *gin.Context)
• func Info(c *gin.Context)
• func Refresh(c *gin.Context)
• func Resource(c *gin.Context)
• func Resources(c *gin.Context)
• func SetupRoutes(router *gin.Engine, cfg config.Config, logger *zap.Logger, ...)
• func StartWebServer(ctx context.Context, cfg config.Config, logger *zap.Logger, ...)
• func Stats(c *gin.Context)
• type EngineFunc
• type Error
  • func NewError(err error) Error

Functions

func EngineStatus

func EngineStatus(c *gin.Context)

EngineStatus returns the status of the engine

func Fields

func Fields(c *gin.Context)

Fields Return the list of fields available for filtering the resources

func GetAssets

func GetAssets(prefix string) http.Handler

func GetHome

func GetHome(prefix string) http.Handler

GetHome renders the home page

func Healthz

func Healthz(c *gin.Context)

func Info

func Info(c *gin.Context)

Info renders the system information

func Refresh

func Refresh(c *gin.Context)

Refresh trigger the engine to fetch the resources

func Resource

func Resource(c *gin.Context)

Resource retrieves a resource by its id

func Resources

func Resources(c *gin.Context)

Resources retrieves the cloud resources matching the query parameters

func SetupRoutes

func SetupRoutes(router *gin.Engine, cfg config.Config, logger *zap.Logger, ds datastore.Datastore, engineF EngineFunc)

func StartWebServer

func StartWebServer(ctx context.Context, cfg config.Config, logger *zap.Logger, ds datastore.Datastore, engineF EngineFunc)

func Stats

func Stats(c *gin.Context)

Stats provides stats about stored data

Types

type EngineFunc

type EngineFunc func(context.Context) error

type Error

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

func NewError

func NewError(err error) Error