Skip to content

Modern Docker Management, Designed for Everyone

23.2 KB
Raw Blame
// Package types provides the Arcane API endpoint path builders and CLI
// configuration types.
//
// Each endpoint is a plain function that returns the request path, escaping
// every caller-supplied segment so resource names with special characters
// cannot alter the route.
package types

import (
	"fmt"
	"net/url"
)

// pathf formats an API path, path-escaping every string argument.
func pathf(format string, args ...any) string {
	escaped := make([]any, len(args))
	for i, arg := range args {
		if s, ok := arg.(string); ok {
			escaped[i] = url.PathEscape(s)
		} else {
			escaped[i] = arg
		}
	}
	return fmt.Sprintf(format, escaped...)
}

// Version
const (
	VersionEndpoint    = "/api/version"
	AppVersionEndpoint = "/api/app-version"
)

// Auth endpoints

func AuthLogout() string    { return "/api/auth/logout" }
func AuthMe() string        { return "/api/auth/me" }
func AuthPassword() string  { return "/api/auth/password" }
func AuthRefresh() string   { return "/api/auth/refresh" }
func AuthFederated() string { return "/api/auth/federated/token" }

// OIDC endpoints

func OIDCDeviceCode() string  { return "/api/oidc/device/code" }
func OIDCDeviceToken() string { return "/api/oidc/device/token" }
func OIDCStatus() string      { return "/api/oidc/status" }

// API key endpoints

func ApiKeys() string         { return "/api/api-keys" }
func ApiKey(id string) string { return pathf("/api/api-keys/%s", id) }

// Self-service API key endpoints

func AuthMeApiKeys() string         { return "/api/auth/me/api-keys" }
func AuthMeApiKey(id string) string { return pathf("/api/auth/me/api-keys/%s", id) }

// User endpoints

func Users() string         { return "/api/users" }
func User(id string) string { return pathf("/api/users/%s", id) }
func UserRoleAssignments(userID string) string {
	return pathf("/api/users/%s/role-assignments", userID)
}

// Role (RBAC) endpoints

func Roles() string                     { return "/api/roles" }
func Role(id string) string             { return pathf("/api/roles/%s", id) }
func RolesAvailablePermissions() string { return "/api/roles/available-permissions" }

// OIDC role mapping endpoints

func OidcRoleMappings() string         { return "/api/oidc/role-mappings" }
func OidcRoleMapping(id string) string { return pathf("/api/oidc/role-mappings/%s", id) }

// Federated credential endpoints

func FederatedCredentials() string         { return "/api/federated-credentials" }
func FederatedCredential(id string) string { return pathf("/api/federated-credentials/%s", id) }

// Environment endpoints

func Environments() string                { return "/api/environments" }
func Environment(id string) string        { return pathf("/api/environments/%s", id) }
func EnvironmentTest(envID string) string { return pathf("/api/environments/%s/test", envID) }
func EnvironmentVersion(envID string) string {
	return pathf("/api/environments/%s/version", envID)
}

// Container endpoints

func Containers(envID string) string { return pathf("/api/environments/%s/containers", envID) }

func Container(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s", envID, containerID)
}

func ContainerStart(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/start", envID, containerID)
}

func ContainerStop(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/stop", envID, containerID)
}

func ContainerRestart(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/restart", envID, containerID)
}

func ContainerKill(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/kill", envID, containerID)
}

func ContainerPause(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/pause", envID, containerID)
}

func ContainerUnpause(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/unpause", envID, containerID)
}

func ContainerCommit(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/commit", envID, containerID)
}

func ContainerUpdate(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/update", envID, containerID)
}

func ContainerRedeploy(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/redeploy", envID, containerID)
}

func ContainerEditConfig(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/edit-config", envID, containerID)
}

func ContainerEdit(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/edit", envID, containerID)
}

func ContainerAutoUpdate(envID, containerID string) string {
	return pathf("/api/environments/%s/containers/%s/auto-update", envID, containerID)
}

func ContainersCounts(envID string) string {
	return pathf("/api/environments/%s/containers/counts", envID)
}

// Image endpoints

func Images(envID string) string { return pathf("/api/environments/%s/images", envID) }

func Image(envID, imageID string) string {
	return pathf("/api/environments/%s/images/%s", envID, imageID)
}
func ImagesPull(envID string) string   { return pathf("/api/environments/%s/images/pull", envID) }
func ImagesPrune(envID string) string  { return pathf("/api/environments/%s/images/prune", envID) }
func ImagesCounts(envID string) string { return pathf("/api/environments/%s/images/counts", envID) }
func ImagesUpload(envID string) string { return pathf("/api/environments/%s/images/upload", envID) }
func ImagesSearch(envID string) string { return pathf("/api/environments/%s/images/search", envID) }
func ImageHistory(envID, name string) string {
	return pathf("/api/environments/%s/images/%s/history", envID, name)
}

func ImageTag(envID, name string) string {
	return pathf("/api/environments/%s/images/%s/tag", envID, name)
}

func ImageExport(envID, name string) string {
	return pathf("/api/environments/%s/images/%s/export", envID, name)
}

func ImageAttestations(envID, name string) string {
	return pathf("/api/environments/%s/images/%s/attestations", envID, name)
}
func ImagesBuild(envID string) string { return pathf("/api/environments/%s/images/build", envID) }
func ImageBuilds(envID string) string { return pathf("/api/environments/%s/images/builds", envID) }
func ImageBuild(envID, buildID string) string {
	return pathf("/api/environments/%s/images/builds/%s", envID, buildID)
}

// Upload session endpoints

func UploadSessions(envID, kind string) string {
	return pathf("/api/environments/%s/uploads/%s", envID, kind)
}

func UploadSession(envID, kind, uploadID string) string {
	return pathf("/api/environments/%s/uploads/%s/%s", envID, kind, uploadID)
}

func UploadSessionChunk(envID, kind, uploadID string, index int) string {
	return pathf("/api/environments/%s/uploads/%s/%s/chunks/%d", envID, kind, uploadID, index)
}

// Image update endpoints

func ImageUpdatesCheck(envID, imageRef string) string {
	return pathf("/api/environments/%s/image-updates/check", envID) + "?" + url.Values{"imageRef": {imageRef}}.Encode()
}

func ImageUpdatesCheckAll(envID string) string {
	return pathf("/api/environments/%s/image-updates/check-all", envID)
}

func ImageUpdatesCheckById(envID, imageID string) string {
	return pathf("/api/environments/%s/image-updates/check/%s", envID, imageID)
}

func ImageUpdatesCheckBatch(envID string) string {
	return pathf("/api/environments/%s/image-updates/check-batch", envID)
}

func ImageUpdatesSummary(envID string) string {
	return pathf("/api/environments/%s/image-updates/summary", envID)
}

// Network endpoints

func Networks(envID string) string { return pathf("/api/environments/%s/networks", envID) }

func Network(envID, networkID string) string {
	return pathf("/api/environments/%s/networks/%s", envID, networkID)
}

func NetworksCounts(envID string) string {
	return pathf("/api/environments/%s/networks/counts", envID)
}

func NetworksPrune(envID string) string { return pathf("/api/environments/%s/networks/prune", envID) }

func NetworksTopology(envID string) string {
	return pathf("/api/environments/%s/networks/topology", envID)
}

func NetworkConnect(envID, networkID string) string {
	return pathf("/api/environments/%s/networks/%s/connect", envID, networkID)
}

func NetworkDisconnect(envID, networkID string) string {
	return pathf("/api/environments/%s/networks/%s/disconnect", envID, networkID)
}

// Volume endpoints

func Volumes(envID string) string { return pathf("/api/environments/%s/volumes", envID) }

func Volume(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s", envID, volumeName)
}

func VolumesCounts(envID string) string { return pathf("/api/environments/%s/volumes/counts", envID) }

func VolumesPrune(envID string) string { return pathf("/api/environments/%s/volumes/prune", envID) }

func VolumesSizes(envID string) string { return pathf("/api/environments/%s/volumes/sizes", envID) }

func VolumeUsage(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/usage", envID, volumeName)
}

func VolumeRename(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/rename", envID, volumeName)
}

// Volume backup endpoints

func VolumeBackupPolicy(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/backup-policy", envID, volumeName)
}

func VolumeBackups(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/backups", envID, volumeName)
}

func VolumeBackup(envID, backupID string) string {
	return pathf("/api/environments/%s/volumes/backups/%s", envID, backupID)
}

func VolumeBackupRestore(envID, volumeName, backupID string) string {
	return pathf("/api/environments/%s/volumes/%s/backups/%s/restore", envID, volumeName, backupID)
}

func VolumeBackupRestoreFiles(envID, volumeName, backupID string) string {
	return pathf("/api/environments/%s/volumes/%s/backups/%s/restore-files", envID, volumeName, backupID)
}

func VolumeBackupUpload(envID, backupID string) string {
	return pathf("/api/environments/%s/volumes/backups/%s/upload", envID, backupID)
}

func VolumeBackupDownload(envID, backupID string) string {
	return pathf("/api/environments/%s/volumes/backups/%s/download", envID, backupID)
}

func VolumeBackupFiles(envID, backupID string) string {
	return pathf("/api/environments/%s/volumes/backups/%s/files", envID, backupID)
}

func VolumeBackupUploadRestore(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/backups/upload", envID, volumeName)
}

// Volume workspace endpoints

func VolumeWorkspace(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/workspace", envID, volumeName)
}

func VolumeWorkspaceFile(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/workspace/file", envID, volumeName)
}

func VolumeWorkspaceFileDownload(envID, volumeName string) string {
	return pathf("/api/environments/%s/volumes/%s/workspace/file/download", envID, volumeName)
}

// Project endpoints

func Projects(envID string) string { return pathf("/api/environments/%s/projects", envID) }

func Project(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s", envID, projectID)
}

func ProjectsCounts(envID string) string {
	return pathf("/api/environments/%s/projects/counts", envID)
}
func ProjectsTags(envID string) string { return pathf("/api/environments/%s/projects/tags", envID) }
func ProjectTags(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/tags", envID, projectID)
}

func ProjectDestroy(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/destroy", envID, projectID)
}

func ProjectUp(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/up", envID, projectID)
}

func ProjectDown(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/down", envID, projectID)
}

func ProjectRestart(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/restart", envID, projectID)
}

func ProjectRedeploy(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/redeploy", envID, projectID)
}

func ProjectPull(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/pull", envID, projectID)
}

func ProjectBuild(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/build", envID, projectID)
}

func ProjectArchive(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/archive", envID, projectID)
}

func ProjectUnarchive(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/unarchive", envID, projectID)
}

func ProjectUpdateServices(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/update-services", envID, projectID)
}

func ProjectWorkspace(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/workspace", envID, projectID)
}

func ProjectWorkspaceFile(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/workspace/file", envID, projectID)
}

func ProjectWorkspaceFileDownload(envID, projectID string) string {
	return pathf("/api/environments/%s/projects/%s/workspace/file/download", envID, projectID)
}

// System endpoints

func SystemPrune(envID string) string { return pathf("/api/environments/%s/system/prune", envID) }

func SystemDockerInfo(envID string) string {
	return pathf("/api/environments/%s/system/docker/info", envID)
}

func SystemContainersStartAll(envID string) string {
	return pathf("/api/environments/%s/system/containers/start-all", envID)
}

func SystemContainersStopAll(envID string) string {
	return pathf("/api/environments/%s/system/containers/stop-all", envID)
}

func SystemStartStopped(envID string) string {
	return pathf("/api/environments/%s/system/containers/start-stopped", envID)
}

func SystemConvert(envID string) string { return pathf("/api/environments/%s/system/convert", envID) }

func SystemUpgrade(envID string) string { return pathf("/api/environments/%s/system/upgrade", envID) }

func SystemUpgradeCheck(envID string) string {
	return pathf("/api/environments/%s/system/upgrade/check", envID)
}

func SystemUpgradeAll(envID string) string {
	return pathf("/api/environments/%s/system/upgrade/all", envID)
}

func SystemUpgradeAllStatus(envID string) string {
	return pathf("/api/environments/%s/system/upgrade/all/status", envID)
}

// Updater endpoints

func UpdaterStatus(envID string) string { return pathf("/api/environments/%s/updater/status", envID) }
func UpdaterRun(envID string) string    { return pathf("/api/environments/%s/updater/run", envID) }
func UpdaterHistory(envID string) string {
	return pathf("/api/environments/%s/updater/history", envID)
}

// Job endpoints

func JobSchedules(envID string) string { return pathf("/api/environments/%s/job-schedules", envID) }
func Jobs(envID string) string         { return pathf("/api/environments/%s/jobs", envID) }
func JobRun(envID, jobID string) string {
	return pathf("/api/environments/%s/jobs/%s/run", envID, jobID)
}

// Settings endpoints

func Settings(envID string) string { return pathf("/api/environments/%s/settings", envID) }

func SettingsPublic(envID string) string {
	return pathf("/api/environments/%s/settings/public", envID)
}

// Notification endpoints

func NotificationsSettings(envID string) string {
	return pathf("/api/environments/%s/notifications/settings", envID)
}

func NotificationSettingsProvider(envID, provider string) string {
	return pathf("/api/environments/%s/notifications/settings/%s", envID, provider)
}

func NotificationsTestProvider(envID, provider string) string {
	return pathf("/api/environments/%s/notifications/test/%s", envID, provider)
}

// Container registry endpoints

func ContainerRegistries() string        { return "/api/container-registries" }
func ContainerRegistry(id string) string { return pathf("/api/container-registries/%s", id) }
func ContainerRegistryTest(id string) string {
	return pathf("/api/container-registries/%s/test", id)
}
func ContainerRegistriesPullUsage() string { return "/api/container-registries/pull-usage" }

// Event endpoints

func Events() string         { return "/api/events" }
func Event(id string) string { return pathf("/api/events/%s", id) }
func EventsEnvironment(envID string) string {
	return pathf("/api/events/environment/%s", envID)
}
func EventsStats() string { return "/api/events/stats" }

// Template endpoints

func Templates() string           { return "/api/templates" }
func Template(id string) string   { return pathf("/api/templates/%s", id) }
func TemplatesAll() string        { return "/api/templates/all" }
func TemplatesDefault() string    { return "/api/templates/default" }
func TemplatesRegistries() string { return "/api/templates/registries" }
func TemplateRegistry(id string) string {
	return pathf("/api/templates/registries/%s", id)
}
func TemplateContent(id string) string  { return pathf("/api/templates/%s/content", id) }
func TemplateDownload(id string) string { return pathf("/api/templates/%s/download", id) }
func TemplateFetch() string             { return "/api/templates/fetch" }

// Variable endpoints

func Variables() string           { return "/api/variables" }
func Variable(id string) string   { return pathf("/api/variables/%s", id) }
func VariablesSync() string       { return "/api/variables/sync" }
func VariablesSyncStatus() string { return "/api/variables/sync-status" }

// System backup endpoints (admin-only)

func Backups() string                    { return "/api/backups" }
func Backup(id string) string            { return pathf("/api/backups/%s", id) }
func BackupsPolicies() string            { return "/api/backups/policies" }
func BackupsRecoveryKey() string         { return "/api/backups/recovery-key" }
func BackupsRecoveryKeyGenerate() string { return "/api/backups/recovery-key/generate" }
func BackupsDiscover() string            { return "/api/backups/discover" }
func BackupRestore(id string) string     { return pathf("/api/backups/%s/restore", id) }
func BackupUpload(id string) string      { return pathf("/api/backups/%s/upload", id) }

// S3 backup destination endpoints (admin-only)

func BackupsS3() string        { return "/api/backups/s3" }
func BackupsS3Options() string { return "/api/backups/s3/options" }
func BackupsS3Destination(id string) string {
	return pathf("/api/backups/s3/%s", id)
}
func BackupsS3Test() string { return "/api/backups/s3/test" }
func BackupsS3DestinationTest(id string) string {
	return pathf("/api/backups/s3/%s/test", id)
}

func BackupsS3DestinationInUse(id string) string {
	return pathf("/api/backups/s3/%s/in-use", id)
}

// Vulnerability endpoints

func ImageVulnerabilitiesScan(envID, imageID string) string {
	return pathf("/api/environments/%s/images/%s/vulnerabilities/scan", envID, imageID)
}

func ImageVulnerabilities(envID, imageID string) string {
	return pathf("/api/environments/%s/images/%s/vulnerabilities", envID, imageID)
}

func ImageVulnerabilitiesSummary(envID, imageID string) string {
	return pathf("/api/environments/%s/images/%s/vulnerabilities/summary", envID, imageID)
}

func ImageVulnerabilitiesList(envID, imageID string) string {
	return pathf("/api/environments/%s/images/%s/vulnerabilities/list", envID, imageID)
}

func ImagesVulnerabilitiesSummaries(envID string) string {
	return pathf("/api/environments/%s/images/vulnerabilities/summaries", envID)
}

func VulnerabilitiesScannerStatus(envID string) string {
	return pathf("/api/environments/%s/vulnerabilities/scanner-status", envID)
}

func VulnerabilitiesSummary(envID string) string {
	return pathf("/api/environments/%s/vulnerabilities/summary", envID)
}

func VulnerabilitiesAll(envID string) string {
	return pathf("/api/environments/%s/vulnerabilities/all", envID)
}

func VulnerabilitiesIgnored(envID string) string {
	return pathf("/api/environments/%s/vulnerabilities/ignored", envID)
}

func VulnerabilitiesIgnore(envID string) string {
	return pathf("/api/environments/%s/vulnerabilities/ignore", envID)
}

func VulnerabilityIgnore(envID, ignoreID string) string {
	return pathf("/api/environments/%s/vulnerabilities/ignore/%s", envID, ignoreID)
}

// Activity endpoints

func Activities(envID string) string { return pathf("/api/environments/%s/activities", envID) }

func Activity(envID, activityID string) string {
	return pathf("/api/environments/%s/activities/%s", envID, activityID)
}

func ActivityCancel(envID, activityID string) string {
	return pathf("/api/environments/%s/activities/%s/cancel", envID, activityID)
}

func ActivitiesHistory(envID string) string {
	return pathf("/api/environments/%s/activities/history", envID)
}

// Webhook endpoints

func Webhooks(envID string) string { return pathf("/api/environments/%s/webhooks", envID) }

func Webhook(envID, webhookID string) string {
	return pathf("/api/environments/%s/webhooks/%s", envID, webhookID)
}
func WebhookTrigger(token string) string { return pathf("/api/webhooks/trigger/%s", token) }

func PodmanStatus(envID string) string { return pathf("/api/environments/%s/podman/status", envID) }
func PodmanAutoUpdate(envID string) string {
	return pathf("/api/environments/%s/podman/autoupdate", envID)
}
func PodmanPods(envID string) string { return pathf("/api/environments/%s/podman/pods", envID) }
func PodmanPod(envID, podID string) string {
	return pathf("/api/environments/%s/podman/pods/%s", envID, podID)
}

func PodmanPodAction(envID, podID, action string) string {
	return pathf("/api/environments/%s/podman/pods/%s/%s", envID, podID, action)
}

func PodmanQuadlets(envID string) string {
	return pathf("/api/environments/%s/podman/quadlets", envID)
}

func PodmanQuadlet(envID, name string) string {
	return pathf("/api/environments/%s/podman/quadlets/%s", envID, name)
}

func PodmanQuadletAction(envID, name, action string) string {
	return pathf("/api/environments/%s/podman/quadlets/%s/%s", envID, name, action)
}

func PodmanKube(envID, action string) string {
	return pathf("/api/environments/%s/podman/kube/%s", envID, action)
}

func PodmanSecrets(envID string) string { return pathf("/api/environments/%s/podman/secrets", envID) }

func PodmanSecret(envID, secretID string) string {
	return pathf("/api/environments/%s/podman/secrets/%s", envID, secretID)
}

// GitOps sync endpoints

func GitOpsSyncs(envID string) string { return pathf("/api/environments/%s/gitops-syncs", envID) }

func GitOpsSync(envID, syncID string) string {
	return pathf("/api/environments/%s/gitops-syncs/%s", envID, syncID)
}

func GitOpsSyncStatus(envID, syncID string) string {
	return pathf("/api/environments/%s/gitops-syncs/%s/status", envID, syncID)
}

func GitOpsSyncTrigger(envID, syncID string) string {
	return pathf("/api/environments/%s/gitops-syncs/%s/sync", envID, syncID)
}

func GitOpsSyncFiles(envID, syncID string) string {
	return pathf("/api/environments/%s/gitops-syncs/%s/files", envID, syncID)
}

func GitOpsSyncsImport(envID string) string {
	return pathf("/api/environments/%s/gitops-syncs/import", envID)
}

// Git repository endpoints

func GitRepositories() string        { return "/api/customize/git-repositories" }
func GitRepository(id string) string { return pathf("/api/customize/git-repositories/%s", id) }
func GitRepositoryTest(id string) string {
	return pathf("/api/customize/git-repositories/%s/test", id)
}

func GitRepositoryBranches(id string) string {
	return pathf("/api/customize/git-repositories/%s/branches", id)
}

func GitRepositoryFiles(id string) string {
	return pathf("/api/customize/git-repositories/%s/files", id)
}