halapi

Documentation

Index

• Constants
• type ClientAPI
• type HalClient
  • func (api *HalClient) CreateRoutes()
• type Response

Constants

const ContainerCountRoute = "/api/container/count"

ContainerCountRoute GET request for total running containers

const RunContainerRoute = "/api/container/run"

RunContainerRoute POST request for running a specified container Requires specified image name

Types

type ClientAPI

type ClientAPI interface {
	CreateRoutes()
}

ClientAPI is the base interface for creating different clients

type HalClient

type HalClient struct {
	Engine compose.Engine
	Router router.HalRouter
	Log    logger.Log
}

HalClient is the implementation of the Hal api

func (*HalClient) CreateRoutes

func (api *HalClient) CreateRoutes()

CreateRoutes adds specific route endpoints

type Response

type Response struct {
	Error          string
	ContainerCount int
}

Response to send back to requesting service