api

package
v0.17.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 14, 2026 License: MIT Imports: 47 Imported by: 0

Documentation

Index

Constants

View Source
const (
	StatusRunning     = "running"
	StatusCompleted   = "completed"
	StatusFailed      = "failed"
	StatusInterrupted = "interrupted"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Document

type Document struct {
	Name      string    `json:"name"`
	YAML      string    `json:"yaml"`
	UpdatedAt time.Time `json:"updatedAt"`
}

type DocumentRequest

type DocumentRequest struct {
	Name string `json:"name"`
	YAML string `json:"yaml"`
}

type EnvVar

type EnvVar struct {
	Name  string  `yaml:"name"`
	Type  string  `yaml:"type"`
	Value *string `yaml:"value,omitempty"`
}

type Examples

type Examples struct {
	Pattern string   `json:"pattern"`
	Files   []string `json:"files"`
}

type File

type File struct {
	Path string `json:"path"`
	Size int64  `json:"size"`
}

type Run

type Run struct {
	RoomName     string                  `json:"roomName,omitempty"`
	PluginName   string                  `json:"pluginName,omitempty"`
	DeploymentID string                  `json:"deploymentId,omitempty"`
	ID           string                  `json:"id"`
	Name         string                  `json:"name"`
	ConfigName   string                  `json:"configName,omitempty"`
	EnvName      string                  `json:"envName,omitempty"`
	Status       string                  `json:"status"`
	StartedAt    time.Time               `json:"startedAt"`
	EndedAt      *time.Time              `json:"endedAt,omitempty"`
	StartAt      int64                   `json:"startAt,omitempty"`
	CPUProfile   bool                    `json:"cpuProfile,omitempty"`
	Env          map[string]string       `json:"env,omitempty"`
	Error        string                  `json:"error,omitempty"`
	Failures     []string                `json:"failures,omitempty"`
	Summary      *core.RunMetricsSummary `json:"summary,omitempty"`
}

type Server

type Server struct {
	Register func(*core.Client)
	Examples fs.FS
	Plugins  fs.FS

	Web fs.FS
	// contains filtered or unexported fields
}

func New

func New(dir, settingsFile, version string, console io.Writer, plugins ...deploy.Plugin) (*Server, error)

func (*Server) Handler

func (s *Server) Handler() http.Handler

func (*Server) Logf

func (s *Server) Logf(format string, args ...any)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context)

type StartRequest

type StartRequest struct {
	DeploymentID string `json:"deploymentId,omitempty"`
	Name         string `json:"name"`
	ConfigName   string `json:"configName,omitempty"`
	Config       string `json:"config"`
	EnvName      string `json:"envName,omitempty"`
	StartAt      int64  `json:"startAt,omitempty"`
	CPUProfile   bool   `json:"cpuProfile,omitempty"`
}

type UpdateRequest

type UpdateRequest struct {
	Name string `json:"name"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL