rest

Documentation

Index

• Constants
• type BuildRequest
• type CreateSystemRequest
• type DeployRequest
• type RunJobRequest
• type SetSecretRequest

Constants

const (
	RootPath = "/v1"

	SystemsPath      = RootPath + "/systems"
	SystemPathFormat = SystemsPath + "/%v"

	BuildsPathFormat    = SystemPathFormat + "/builds"
	BuildPathFormat     = BuildsPathFormat + "/%v"
	BuildLogsPathFormat = BuildPathFormat + "/logs"

	DeploysPathFormat = SystemPathFormat + "/deploys"
	DeployPathFormat  = DeploysPathFormat + "/%v"

	NodePoolsPathFormat = SystemPathFormat + "/node-pools"
	NodePoolPathFormat  = NodePoolsPathFormat + "/%v"

	SystemSecretsPathFormat = SystemPathFormat + "/secrets"
	SystemSecretPathFormat  = SystemSecretsPathFormat + "/%v"

	JobsPathFormat    = SystemPathFormat + "/jobs"
	JobPathFormat     = JobsPathFormat + "/%v"
	JobLogsPathFormat = JobPathFormat + "/logs"

	ServicesPathFormat    = SystemPathFormat + "/services"
	ServicePathFormat     = ServicesPathFormat + "/%v"
	ServiceLogsPathFormat = ServicePathFormat + "/logs"

	TeardownsPathFormat = SystemPathFormat + "/teardowns"
	TeardownPathFormat  = TeardownsPathFormat + "/%v"

	VersionsPathFormat = SystemPathFormat + "/versions"
	VersionPathFormat  = VersionsPathFormat + "/%v"
)

Types

type BuildRequest

type BuildRequest struct {
	Path    *tree.Path  `json:"path,omitempty"`
	Version *v1.Version `json:"version,omitempty"`
}

type CreateSystemRequest

type CreateSystemRequest struct {
	ID            v1.SystemID `json:"id"`
	DefinitionURL string      `json:"definitionUrl"`
}

type DeployRequest

type DeployRequest struct {
	BuildID *v1.BuildID `json:"buildId,omitempty"`
	Path    *tree.Path  `json:"path,omitempty"`
	Version *v1.Version `json:"version,omitempty"`
}

type RunJobRequest

type RunJobRequest struct {
	Path        tree.Path                         `json:"path"`
	Command     []string                          `json:"command,omitempty"`
	Environment definitionv1.ContainerEnvironment `json:"environment,omitempty"`
}

type SetSecretRequest

type SetSecretRequest struct {
	Value string `json:"value"`
}