Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.0.5

Aug 4, 2025

v0.0.4

Aug 3, 2025

v0.0.3

Jul 22, 2025

v0.0.2

Jul 22, 2025

v0.0.1

Jul 18, 2025

Changes in this version

+ func GetValidator(c *gin.Context) *validation.APIValidator

+ func RateLimitMiddleware(requestsPerMinute int) gin.HandlerFunc

+ func SecurityHeadersMiddleware() gin.HandlerFunc

+ func SetupRouter(jobService jobs.JobService, storageService *storage.StorageService, ...) *gin.Engine

+ func SetupSwagger(router *gin.Engine)

+ func StandardErrorResponse() gin.HandlerFunc

+ func ValidateArchiveParams(c *gin.Context, v *validation.APIValidator) *validation.ValidationResult

+ func ValidationErrorLogger() gin.HandlerFunc

+ func ValidationMiddleware(validator *validation.APIValidator) gin.HandlerFunc

+ type ArchiveFormat string

+ const FormatTAR

+ const FormatZIP

+ type ArchiveHandlers struct

+ func NewArchiveHandlers(storageService *storage.StorageService) *ArchiveHandlers

+ func (h *ArchiveHandlers) CreateResultsArchive(c *gin.Context)

+ func (h *ArchiveHandlers) DownloadResultsArchive(c *gin.Context)

+ type ArchiveRequest struct

+ Compress bool

+ Exclude []string

+ Format ArchiveFormat

+ Include []string

+ type Handlers struct

+ func NewHandlers(jobService jobs.JobService) *Handlers

+ func (h *Handlers) CreateJob(c *gin.Context)

+ func (h *Handlers) GetJobStatus(c *gin.Context)

+ func (h *Handlers) Health(c *gin.Context)

+ func (h *Handlers) ListJobs(c *gin.Context)

+ type StorageHandlers struct

+ func NewStorageHandlers(storageService *storage.StorageService) *StorageHandlers

+ func (h *StorageHandlers) DownloadJobSource(c *gin.Context)

+ func (h *StorageHandlers) DownloadResult(c *gin.Context)

+ func (h *StorageHandlers) GetJobLogs(c *gin.Context)

+ func (h *StorageHandlers) GetStorageInfo(c *gin.Context)

+ func (h *StorageHandlers) ListJobSources(c *gin.Context)

+ func (h *StorageHandlers) ListResults(c *gin.Context)

+ func (h *StorageHandlers) UploadJobSources(c *gin.Context)

+ type SwaggerInfo struct

+ BasePath string

+ Description string

+ Host string

+ Title string

+ Version string

+ func GetSwaggerInfo() SwaggerInfo

+ type ThemeHandlers struct

+ func NewThemeHandlers(storageService *storage.StorageService, workspaceBase string) *ThemeHandlers

+ func (h *ThemeHandlers) DetectThemes(c *gin.Context)

+ func (h *ThemeHandlers) InstallJobThemes(c *gin.Context)

+ func (h *ThemeHandlers) InstallTheme(c *gin.Context)

+ func (h *ThemeHandlers) ListAvailableThemes(c *gin.Context)

+ type WorkerHandlers struct

+ func NewWorkerHandlers(workerPool *worker.WorkerPool) *WorkerHandlers

+ func (h *WorkerHandlers) CleanupOldWorkspaces(c *gin.Context)

+ func (h *WorkerHandlers) CleanupWorkspace(c *gin.Context)

+ func (h *WorkerHandlers) GetWorkerHealth(c *gin.Context)

+ func (h *WorkerHandlers) GetWorkerStats(c *gin.Context)

+ func (h *WorkerHandlers) GetWorkspaceInfo(c *gin.Context)

+ func (h *WorkerHandlers) ListWorkspaces(c *gin.Context)