api

Documentation

Index

• Constants
• Variables
• type Message
  • func (m Message) ToMap() map[string]interface{}
• type RESTApiV1
  • func NewRESTApiV1(opts RESTApiV1Options) *RESTApiV1
  • func (a *RESTApiV1) Build(resp http.ResponseWriter, req *http.Request)
  • func (a *RESTApiV1) GetAllAPIs() []string
  • func (a *RESTApiV1) IndexPage(resp http.ResponseWriter, _ *http.Request)
  • func (a *RESTApiV1) Serve(addr, originAllowed string) error
  • func (a *RESTApiV1) Shutdown() error
  • func (a *RESTApiV1) Status(resp http.ResponseWriter, req *http.Request)
• type RESTApiV1Options

Constants

const (
	MessageTypeInfo    = "info"
	MessageTypeWarning = "warning"
	MessageTypeError   = "error"
)

const (
	SlugBuildFailed          = "build-failed"
	SlugGetBuildStatusFailed = "get-build-status-failed"
	SlugBuildStatusNotFound  = "build-status-not-found"
	SlugJSONDecodeFailed     = "json-decode-failed"
	SlugTypeError            = "type-error"
)

Variables

var APIPath = &serviceEndpointPath{}

Types

type Message

type Message struct {
	Type    string `json:"type"` // info, warning, error
	Slug    string `json:"slug"`
	Title   string `json:"title"`
	Message string `json:"message"`
}

func (Message) ToMap

func (m Message) ToMap() map[string]interface{}

convert a Message to map[string]interface{}

type RESTApiV1

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

func NewRESTApiV1

func NewRESTApiV1(opts RESTApiV1Options) *RESTApiV1

func (*RESTApiV1) Build

func (a *RESTApiV1) Build(resp http.ResponseWriter, req *http.Request)

Build is the handler for the /api/v1/build endpoint

func (*RESTApiV1) GetAllAPIs

func (a *RESTApiV1) GetAllAPIs() []string

func (*RESTApiV1) IndexPage

func (a *RESTApiV1) IndexPage(resp http.ResponseWriter, _ *http.Request)

IndexPage implements GET /

func (*RESTApiV1) Serve

func (a *RESTApiV1) Serve(addr, originAllowed string) error

func (*RESTApiV1) Shutdown

func (a *RESTApiV1) Shutdown() error

Shutdown stops the API server

func (*RESTApiV1) Status

func (a *RESTApiV1) Status(resp http.ResponseWriter, req *http.Request)

Status is the handler for the /api/v1/status/{image_id} endpoint

type RESTApiV1Options

type RESTApiV1Options struct {
	ProductionMode bool
	Logger         *zap.Logger
	Builder        *builder.Builder
}