apitypes

package
v0.1.0-beta.45 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppStatusResponse

type AppStatusResponse struct {
	State        string          `json:"state"`
	DeploymentID string          `json:"deploymentId"`
	ContainerIDs []string        `json:"containerIds"`
	Domains      []config.Domain `json:"domains"`
}

type DeployRequest

type DeployRequest struct {
	DeploymentID string              `json:"deploymentID"`
	TargetConfig config.TargetConfig `json:"targetConfig"`
	// DeployConfig without resolved secrets and with target extracted. Saved on server for rollbacks
	RollbackDeployConfig config.DeployConfig `json:"rollbackDeployConfig"`
}

type ExecRequest

type ExecRequest struct {
	Command       []string `json:"command"`                 // Required: command to execute
	ContainerID   string   `json:"containerId,omitempty"`   // Optional: specific container ID
	AllContainers bool     `json:"allContainers,omitempty"` // Optional: run on all containers
}

type ExecResponse

type ExecResponse struct {
	Results []ExecResult `json:"results"`
}

type ExecResult

type ExecResult struct {
	ContainerID string `json:"containerId"`
	ExitCode    int    `json:"exitCode"`
	Stdout      string `json:"stdout"`
	Stderr      string `json:"stderr"`
	Error       string `json:"error,omitempty"` // Set if exec failed for this container
}

type HealthResponse

type HealthResponse struct {
	Status  string `json:"status"`
	Version string `json:"version,omitempty"`
	Service string `json:"service"`
}

type ImageAssembleRequest

type ImageAssembleRequest struct {
	ImageRef string             `json:"imageRef"`
	Config   []byte             `json:"config"`
	Manifest ImageManifestEntry `json:"manifest"`
}

ImageAssembleRequest contains metadata to reassemble an image from layers

type ImageAssembleResponse

type ImageAssembleResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

ImageAssembleResponse confirms image was loaded

type ImageDiskSpaceCheckRequest

type ImageDiskSpaceCheckRequest struct {
	UploadSizeBytes         uint64 `json:"uploadSizeBytes,omitempty"`
	LayerUploadBytes        uint64 `json:"layerUploadBytes,omitempty"`
	AssembledImageSizeBytes uint64 `json:"assembledImageSizeBytes,omitempty"`
}

type ImageDiskSpaceCheckResponse

type ImageDiskSpaceCheckResponse struct {
	OK             bool   `json:"ok"`
	Path           string `json:"path"`
	RequiredBytes  uint64 `json:"requiredBytes"`
	AvailableBytes uint64 `json:"availableBytes"`
}

type ImageManifestEntry

type ImageManifestEntry struct {
	Config   string   `json:"Config"`
	RepoTags []string `json:"RepoTags"`
	Layers   []string `json:"Layers"`
}

ImageManifestEntry represents one entry from docker save manifest.json

type ImagePruneRequest

type ImagePruneRequest struct {
	AppName string `json:"appName"`
	Keep    int    `json:"keep"`
	Apply   bool   `json:"apply,omitempty"`
}

type ImagePruneResponse

type ImagePruneResponse struct {
	AppName              string          `json:"appName"`
	Keep                 int             `json:"keep"`
	Applied              bool            `json:"applied"`
	RunningDeploymentIDs []string        `json:"runningDeploymentIds,omitempty"`
	Tags                 []ImagePruneTag `json:"tags"`
}

type ImagePruneTag

type ImagePruneTag struct {
	Tag          string `json:"tag"`
	DeploymentID string `json:"deploymentId"`
}

type ImageUploadResponse

type ImageUploadResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

type LayerCheckRequest

type LayerCheckRequest struct {
	Digests []string `json:"digests"`
}

LayerCheckRequest is sent by client to query which layers already exist on server

type LayerCheckResponse

type LayerCheckResponse struct {
	Missing []string `json:"missing"`
	Exists  []string `json:"exists"`
}

LayerCheckResponse tells client which layers are missing

type LayerUploadResponse

type LayerUploadResponse struct {
	Digest string `json:"digest"`
	Size   int64  `json:"size"`
}

LayerUploadResponse confirms a layer was stored

type RollbackRequest

type RollbackRequest struct {
	TargetDeploymentID string              `json:"targetDeploymentID"`
	NewDeploymentID    string              `json:"newDeploymentID"`
	NewTargetConfig    config.TargetConfig `json:"newTargetConfig"`
}

type RollbackTargetsResponse

type RollbackTargetsResponse struct {
	Targets []deploytypes.RollbackTarget `json:"targets"`
}

type VersionResponse

type VersionResponse struct {
	Version      string   `json:"haloyd"`
	Capabilities []string `json:"capabilities,omitempty"`
}

Jump to

Keyboard shortcuts

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