api

Documentation

Overview

The API package implements an HTTP interface that is responsible for - serving build artifacts - sending build status updates via websocket - provide metadata in form of a manifest to the UI Extension host on the client

Index

• type ExtensionsApi
  • func New(config *core.Config) *ExtensionsApi
  • func (api *ExtensionsApi) GetDevConsoleUrl() string
  • func (api *ExtensionsApi) GetWebsocketUrl() string
  • func (api *ExtensionsApi) Notify(extensions []core.Extension)
  • func (api *ExtensionsApi) Shutdown()
• type Response

Types

type ExtensionsApi

type ExtensionsApi struct {
	*core.ExtensionService
	*mux.Router
	*root.RootHandler
	// contains filtered or unexported fields
}

func New

func New(config *core.Config) *ExtensionsApi

func (*ExtensionsApi) GetDevConsoleUrl

func (api *ExtensionsApi) GetDevConsoleUrl() string

func (*ExtensionsApi) GetWebsocketUrl

func (api *ExtensionsApi) GetWebsocketUrl() string

func (*ExtensionsApi) Notify

func (api *ExtensionsApi) Notify(extensions []core.Extension)

func (*ExtensionsApi) Shutdown

func (api *ExtensionsApi) Shutdown()

type Response

type Response struct {
	App        core.App `json:"app" yaml:"-"`
	Version    string   `json:"version"`
	Root       core.Url `json:"root"`
	Socket     core.Url `json:"socket"`
	DevConsole core.Url `json:"devConsole"`
	Store      string   `json:"store"`
}