api

package

Go to main page

Versions in this module

v0

v0.1.4

Feb 19, 2026

v0.1.3

Jan 12, 2026

Changes in this version

+ type GitHubClientStatus struct

+ Connected bool

+ Error string

+ RateLimitRemaining int

+ RateLimitReset string

+ ResetIn string

+ Status ComponentStatus

+ type GitHubClientsStatus struct

+ Dispatch *GitHubClientStatus

+ Runners *GitHubClientStatus

+ type HealthAuthConfig struct

+ Basic bool

+ GitHub bool

+ type HealthConfig struct

+ Auth HealthAuthConfig

type HealthResponse

+ Config HealthConfig

+ type IPRateLimiter struct

+ func NewIPRateLimiter(requestsPerMinute int) *IPRateLimiter

+ func (l *IPRateLimiter) Middleware(next http.Handler) http.Handler

+ type RateLimitErrorResponse struct

+ Error string

v0.1.2

Jan 12, 2026

v0.1.1

Jan 9, 2026

Changes in this version

type GitHubStatus

+ Connected bool

+ Error string

v0.1.0

Jan 9, 2026

Changes in this version

+ func ServeWs(hub *Hub, authSvc auth.Service, allowedOrigins []string, w http.ResponseWriter, ...)

+ func SyncGroupsFromConfig(ctx context.Context, log logrus.FieldLogger, st store.Store, ...) error

+ type AddJobRequest struct

+ AutoRequeue bool

+ Inputs map[string]string

+ Labels map[string]string

+ Name string

+ Owner string

+ Ref string

+ Repo string

+ RequeueLimit *int

+ TemplateID string

+ WorkflowID string

+ type Client struct

+ func NewClient(hub *Hub, conn *websocket.Conn, user *store.User, id string) *Client

+ func (c *Client) ReadPump()

+ func (c *Client) WritePump()

+ type ComponentStatus string

+ const ComponentStatusDegraded

+ const ComponentStatusHealthy

+ const ComponentStatusUnhealthy

+ type DatabaseStatus struct

+ Error string

+ Latency string

+ Status ComponentStatus

+ type ErrorResponse struct

+ Error string

+ type GitHubStatus struct

+ RateLimitRemaining int

+ RateLimitReset string

+ ResetIn string

+ Status ComponentStatus

+ type GroupWithStats struct

+ BusyRunners int

+ IdleRunners int

+ QueuedJobs int

+ RunningJobs int

+ TemplateCount int

+ TotalRunners int

+ type HealthResponse struct

+ Status string

+ type HistoryResponse struct

+ HasMore bool

+ Jobs []*store.Job

+ NextCursor string

+ TotalCount int

+ type HistoryStatsBucket struct

+ Cancelled int

+ Completed int

+ Failed int

+ Timestamp string

+ type HistoryStatsRange struct

+ BucketDuration string

+ End string

+ Start string

+ type HistoryStatsResponse struct

+ Buckets []HistoryStatsBucket

+ Range HistoryStatsRange

+ Totals HistoryStatsTotals

+ type HistoryStatsTotals struct

+ Cancelled int

+ Completed int

+ Failed int

+ type Hub struct

+ func NewHub(log logrus.FieldLogger) *Hub

+ func (h *Hub) Broadcast(msg *Message)

+ func (h *Hub) BroadcastDispatch(job *store.Job)

+ func (h *Hub) BroadcastJobState(job *store.Job)

+ func (h *Hub) BroadcastQueueUpdate(groupID string, jobs []*store.Job)

+ func (h *Hub) BroadcastRunnerStatus(runner *store.Runner, groupID string)

+ func (h *Hub) BroadcastToGroup(groupID string, msg *Message)

+ func (h *Hub) ClientCount() int

+ func (h *Hub) Run(ctx context.Context)

+ func (h *Hub) Subscribe(client *Client, groupID string)

+ func (h *Hub) Unsubscribe(client *Client, groupID string)

+ type LoginRequest struct

+ Password string

+ Username string

+ type LoginResponse struct

+ Token string

+ User *store.User

+ type Message struct

+ GroupID string

+ Payload any

+ Type MessageType

+ type MessageType string

+ const MessageTypeDispatch

+ const MessageTypeError

+ const MessageTypeJobState

+ const MessageTypePing

+ const MessageTypeQueueUpdate

+ const MessageTypeRunnerStatus

+ const MessageTypeSubscribe

+ const MessageTypeSubscribed

+ const MessageTypeSystemStatus

+ const MessageTypeUnsubscribe

+ const MessageTypeUnsubscribed

+ type QueueStats struct

+ PendingJobs int

+ RunningJobs int

+ TriggeredJobs int

+ type ReorderQueueRequest struct

+ JobIDs []string

+ type Server interface

+ BroadcastRunnerChange func(runner *store.Runner)

+ Start func(ctx context.Context) error

+ Stop func() error

+ func NewServer(log logrus.FieldLogger, cfg *config.Config, st store.Store, q queue.Service, ...) Server

+ type SystemStatusResponse struct

+ Database DatabaseStatus

+ GitHub GitHubStatus

+ Queue QueueStats

+ Status ComponentStatus

+ Timestamp string

+ Version VersionInfo

+ type UpdateAutoRequeueRequest struct

+ AutoRequeue bool

+ RequeueLimit *int

+ type UpdateJobRequest struct

+ Inputs map[string]string

+ Labels map[string]string

+ Name *string

+ Owner *string

+ Ref *string

+ Repo *string

+ WorkflowID *string

+ type VersionInfo struct

+ BuildDate string

+ GitCommit string

+ Version string

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