api

package

Go to main page

Versions in this module

v0

v0.5.8

Nov 1, 2026

Changes in this version

+ func BodyLimit(requestMax, uploadMax int64) gin.HandlerFunc

type IssuerDeps

+ ServiceUsage UsageEventReader

+ type LivenessCheck func() error

type ObservabilityDeps

+ Liveness LivenessCheck

+ ProbeBudget time.Duration

type ObservabilityOption

+ func WithLivenessCheck(check LivenessCheck) ObservabilityOption

+ func WithProbeBudget(d time.Duration) ObservabilityOption

type ServerDeps

+ MaxRequestBodyBytes int64

+ MaxUploadBodyBytes int64

+ Pools bool

type ServiceTenantStore

+ ResumeTenant func(ctx context.Context, tenant string) error

+ SuspendTenant func(ctx context.Context, tenant string, s domain.TenantSuspension) error

+ TenantSuspension func(ctx context.Context, tenant string) (domain.TenantSuspension, error)

+ type UsageEventReader interface

+ ReadEvents func(ctx context.Context, after domain.UsageCursor, limit int) (domain.UsagePage, error)

v0.5.8-rc.3

Nov 1, 2026

v0.5.8-rc.2

Nov 1, 2026

v0.5.8-rc.1

Oct 29, 2026

v0.5.7

Oct 27, 2026

Changes in this version

type ConnectionStore

+ ListConnectionsFiltered func(ctx context.Context, tenant, pattern, prefixPattern string, limit, offset int) ([]domain.Connection, int, error)

type DagRepository

+ ListDagTags func(ctx context.Context, tenant, pattern, prefixPattern string, limit, offset int) (tags []string, total int, err error)

+ ListDagsWithFilter func(ctx context.Context, tenant string, filter domain.DagFilter) ([]domain.DAG, int, error)

type DagRunRepository

+ ListDagRunsWithFilter func(ctx context.Context, tenant, dagID string, filter domain.DagRunFilter) ([]domain.DagRun, int, error)

type ImportErrorStore

+ ListImportErrorsFiltered func(ctx context.Context, tenant, filename, bundleName string, limit, offset int) ([]domain.ImportError, int, error)

type StoreDeps

+ EphemeralLogs bool

type TaskInstanceRepository

+ ListTaskInstancesWithFilter func(ctx context.Context, tenant, dagID, runID string, ...) ([]domain.TaskInstance, int, error)

type VariableStore

+ ListVariablesFiltered func(ctx context.Context, tenant, pattern, prefixPattern string, limit, offset int) ([]domain.Variable, int, error)

v0.5.7-rc.1

Oct 27, 2026

v0.5.6

Oct 23, 2026

Changes in this version

+ var ErrMissingDependency = errors.New("missing required dependency")

+ func SchemaWaitHandler(registry *prometheus.Registry, reason func() string, ...) http.Handler

+ type AuthDeps struct

+ AuthAudit AuthAuditWriter

+ Authenticator auth.Authenticator

+ CLIDevices CLIDeviceStore

+ DevNoAuth bool

+ ExternalSignInURL string

+ ExternalSignOutURL string

+ JWTSecret string

+ OIDCEnabled bool

+ OIDCFlow *oidc.Flow

+ OIDCSettings OIDCSettings

+ OIDCUsers OIDCUserStore

+ RateLimiter *auth.RateLimiter

+ SessionCookieInsecure bool

+ SessionCookieName string

+ TokenMaxLifetimeSecs int

+ TokenRenewer TokenRenewer

+ TokenTTLSecs int

type Dependencies

+ Auth AuthDeps

+ Execution ExecutionDeps

+ Issuers IssuerDeps

+ Observability ObservabilityDeps

+ Server ServerDeps

+ Stores StoreDeps

+ func (d Dependencies) Validate() error

+ type ExecutionDeps struct

+ DeployDefaults domain.DeployDefaults

+ ExecutionPolicy *domain.ExecutionPolicy

+ RequireDigest domain.DigestRequirement

+ ResourceUnit *domain.ResourceUnit

+ SourceModeImage string

+ TaskPods TaskPodSettings

+ UnitMisfits UnitMisfitRecorder

+ UnpinnedImages UnpinnedImageRecorder

+ WarmPolicy domain.WarmPolicy

+ WarmPools domain.WarmPoolDefaults

+ WarmWorkersAbsent string

+ type IssuerDeps struct

+ CIOIDC CIOIDCVerifier

+ CIOIDCExchanges CIOIDCExchangeRecorder

+ CIOIDCRoles auth.RolePermissionStore

+ CIOIDCSessionTTL time.Duration

+ DeployViaIssuer bool

+ ServiceAllowedTenants []string

+ ServiceTenants ServiceTenantStore

+ ServiceToken string

+ TrustedIssuer TrustedIssuer

+ TrustedIssuerBearer TrustedIssuerBearer

+ TrustedIssuerHostPattern string

+ TrustedIssuerOrigins []string

+ TrustedIssuerUsers TrustedIssuerUserStore

+ type OIDCSettings struct

+ AutoRedirect bool

+ BreakGlassEmails []string

+ DefaultRole string

+ Issuer string

+ JITProvisioning bool

+ RedirectURL string

+ RoleMappings map[string]string

+ type ObservabilityDeps struct

+ ExecutorInfo ExecutorInfo

+ HealthChecks map[string]HealthChecker

+ Logger *slog.Logger

+ Metrics Metrics

+ Registry *prometheus.Registry

+ SchedulerHealth Heartbeater

+ Tracer trace.Tracer

+ type ServerDeps struct

+ CORSOrigins []string

+ Edition string

+ GzipResponses bool

+ MaxPageLimit int

+ PoolsReadOnly bool

+ TrustedProxies []string

+ type StoreDeps struct

+ APITokens TokenStore

+ Audit AuditWriter

+ AuditLog AuditLogReader

+ ConnectionTest ConnectionTester

+ Connections ConnectionStore

+ DagRuns DagRunRepository

+ DagSources DagSourceReader

+ DagVersions DagVersionLister

+ Dags DagRepository

+ DashboardStats DashboardStatsReader

+ Favorites FavoriteStore

+ ImportErrors ImportErrorStore

+ LatestRuns DagLatestRunsReader

+ Logs LogReader

+ Pools PoolStore

+ Specs DagSpecReader

+ TaskSummary TaskSummaryReader

+ Tasks TaskInstanceRepository

+ UserAudit UserAuditWriter

+ Users UserStore

+ Variables VariableStore

+ Versions DagVersionRepository

+ Xcoms XComReader

+ type UIDeps struct

+ AutoRefreshIntervalSeconds int

+ ETagRevalidation bool

+ ExamplesFS fs.FS

+ InstanceName string

+ MonacoDir string

+ SPA UIServer

+ Theme json.RawMessage

+ Workspace WorkspaceFS

v0.5.6-rc.2

Oct 23, 2026

v0.5.6-rc.1

Oct 23, 2026

v0.5.5

Oct 22, 2026

Changes in this version

+ func RequireUndeployPermission(viaIssuer bool) gin.HandlerFunc

+ type CIOIDCExchangeRecorder interface

+ RecordCIOIDCExchange func(issuer, outcome string)

+ type CIOIDCVerifier interface

+ Advertised func(tenant string) []domain.CIOIDCIssuer

+ Verify func(ctx context.Context, raw string) (*cioidc.Identity, error)

type Dependencies

+ CIOIDC CIOIDCVerifier

+ CIOIDCExchanges CIOIDCExchangeRecorder

+ CIOIDCRoles auth.RolePermissionStore

+ CIOIDCSessionTTL time.Duration

+ DeployViaIssuer bool

+ TaskPods TaskPodSettings

+ type ServiceAccountReader interface

+ ImagePullSecrets func(ctx context.Context, name string) (count int, found bool, err error)

type TaskInstanceRepository

+ RunsKeepingVersion func(ctx context.Context, tenant, dagID string, runIDs []string, ...) ([]domain.ClearVersionKept, error)

+ type TaskPodSettings struct

+ DefaultServiceAccount string

+ Enabled bool

+ RunAsNonRoot bool

+ ServiceAccounts ServiceAccountReader

+ Unread string

v0.5.5-rc.3

Oct 22, 2026

v0.5.5-rc.2

Oct 22, 2026

v0.5.5-rc.1

Oct 21, 2026

v0.5.4

Oct 16, 2026

Changes in this version

+ func RequireDeployPermission() gin.HandlerFunc

+ func RequireDeployRead() gin.HandlerFunc

type AuditWriter

+ RecordRunActionAudit func(ctx context.Context, tenant, userID, action, dagID, runID string, ...) error

+ type CLIDeviceStore interface

+ CreateCLIDeviceAuthorization func(ctx context.Context, req auth.DeviceAuthorizationRequest) (auth.DeviceAuthorization, error)

+ DecideCLIDeviceAuthorization func(ctx context.Context, id string, approve bool, user auth.User) error

+ FindCLIDeviceByUserCode func(ctx context.Context, userCodeHash string) (auth.DeviceAuthorization, error)

+ PollCLIDeviceAuthorization func(ctx context.Context, deviceCodeHash string) (auth.DevicePoll, error)

type DagRepository

+ SetPausedBy func(ctx context.Context, tenant, actorUserID, dagID string, paused bool) (domain.DAG, error)

+ type DagSourceReader interface

+ GetDagVersionSpec func(ctx context.Context, tenant, dagID string, versionNumber int) (domain.DagVersion, domain.DAGSpec, error)

type DagVersionRepository

+ RegisterDagVersionAs func(ctx context.Context, tenant string, reg domain.DagRegistration) (domain.DagRegistered, error)

+ SetCurrentDagVersionAs func(ctx context.Context, tenant string, req domain.DagSetCurrent) (domain.CurrentVersionChange, error)

type Dependencies

+ APITokens TokenStore

+ CLIDevices CLIDeviceStore

+ DagSources DagSourceReader

+ DeployDefaults domain.DeployDefaults

+ ExecutionPolicy *domain.ExecutionPolicy

+ RequireDigest domain.DigestRequirement

+ SessionCookieName string

+ TrustedIssuerHostPattern string

+ UnpinnedImages UnpinnedImageRecorder

+ WarmPolicy domain.WarmPolicy

+ WarmPools config.ExecutionSection

+ WarmWorkersAbsent string

type TaskInstanceRepository

+ CheckClearVersion func(ctx context.Context, tenant, dagID string, runIDs []string, ...) error

+ type TokenStore interface

+ CreateAPIToken func(ctx context.Context, tenant, userID, name, hash string, scopes []string, ...) (auth.APIToken, error)

+ ListAPITokens func(ctx context.Context, tenant, ownerID string, limit, offset int) ([]auth.APIToken, int, error)

+ RevokeAPIToken func(ctx context.Context, tenant, id, ownerID string) (auth.APIToken, error)

+ type UnpinnedImageRecorder interface

+ RecordUnpinnedImage func(stage, outcome string)

v0.5.4-rc.1

Oct 15, 2026

v0.5.3

Oct 12, 2026

Changes in this version

+ func GzipJSON() gin.HandlerFunc

+ func RequireScope(scope string) gin.HandlerFunc

+ func RequireScopedPermission(action, resource, scope string) gin.HandlerFunc

type Dependencies

+ GzipResponses bool

+ MaxPageLimit int

+ SourceModeImage string

+ TrustedIssuerBearer TrustedIssuerBearer

+ type TrustedIssuerBearer interface

+ Provider func() string

+ VerifyBearer func(ctx context.Context, raw string) (*issuer.Identity, error)

v0.5.3-rc.1

Oct 10, 2026

v0.5.2

Oct 8, 2026

Changes in this version

+ func RejectEncodedPathSeparators() gin.HandlerFunc

type Dependencies

+ ResourceUnit *domain.ResourceUnit

+ UnitMisfits UnitMisfitRecorder

+ type UnitMisfitRecorder interface

+ RecordUnitMisfit func(stage string)

v0.5.2-rc.1

Oct 8, 2026

v0.5.1

Oct 6, 2026

Changes in this version

+ const PoolsReadOnlyDetail

+ type AuditLogPageReader interface

+ ListAuditLogsAfter func(ctx context.Context, tenant, dagID string, after domain.PageCursor, limit int) ([]domain.AuditLogEntry, int, error)

+ type DagRunPageReader interface

+ ListDagRunsAfter func(ctx context.Context, tenant, dagID string, states []string, ...) ([]domain.DagRun, int, error)

type Dependencies

+ PoolsReadOnly bool

+ UIETagRevalidation bool

+ type ObservabilityOption func(*observabilityOptions)

+ func WithoutLegacyMetricNames() ObservabilityOption

v0.5.1-rc.1

Oct 5, 2026

v0.5.0

Oct 3, 2026

Changes in this version

+ const DefaultUIAutoRefreshIntervalSeconds

+ var ErrNotFound = domain.ErrNotFound

+ func AbortProblem(c *gin.Context, status int, title, detail string)

+ func AbortProblemCause(c *gin.Context, status int, title, detail string, cause error)

+ func CORS(allowed []string) gin.HandlerFunc

+ func DevBypassAuth() gin.HandlerFunc

+ func JWTAuth(authn auth.Authenticator) gin.HandlerFunc

+ func NewServer(deps Dependencies) *gin.Engine

+ func NoStoreOnVolatileRoutes() gin.HandlerFunc

+ func ObservabilityHandler(registry *prometheus.Registry, checks map[string]HealthChecker) http.Handler

+ func Observe(metrics Metrics, tracer trace.Tracer) gin.HandlerFunc

+ func RequestID() gin.HandlerFunc

+ func RequirePermission(action, resource string) gin.HandlerFunc

+ func StructuredLogger(logger *slog.Logger) gin.HandlerFunc

+ func UserFromContext(c *gin.Context) (*auth.User, bool)

+ type AuditLogReader interface

+ ListAuditLogs func(ctx context.Context, tenant, dagID string, limit, offset int) ([]domain.AuditLogEntry, int, error)

+ type AuditWriter interface

+ RecordTaskActionAudit func(ctx context.Context, tenant, userID, action, dagID, runID, taskID string, ...) error

+ type AuthAuditWriter interface

+ RecordAuthEvent func(ctx context.Context, tenant, actorUserID, action, email, outcome string, ...) error

+ type ConnectionStore interface

+ DeleteConnection func(ctx context.Context, tenant, connID string) error

+ GetConnection func(ctx context.Context, tenant, connID string) (domain.Connection, error)

+ ListConnections func(ctx context.Context, tenant string, limit, offset int) ([]domain.Connection, int, error)

+ SetConnectionPatch func(ctx context.Context, tenant string, p domain.ConnectionPatch) error

+ type ConnectionTester interface

+ Test func(ctx context.Context, c domain.Connection) (ok bool, message string)

+ type DagLatestRunsReader interface

+ LatestRunsForDags func(ctx context.Context, tenant string, dagIDs []string, perDag int) (map[string][]domain.DagRun, error)

+ type DagRepository interface

+ ClearDagHistory func(ctx context.Context, tenant, dagID string) error

+ DeleteDag func(ctx context.Context, tenant, dagID string) error

+ GetDag func(ctx context.Context, tenant, dagID string) (domain.DAG, error)

+ ListDags func(ctx context.Context, tenant string, limit, offset int) ([]domain.DAG, int, error)

+ ListDagsFiltered func(ctx context.Context, tenant, runState string, paused *bool, limit, offset int) ([]domain.DAG, int, error)

+ SetPaused func(ctx context.Context, tenant, dagID string, paused bool) (domain.DAG, error)

+ type DagRunRepository interface

+ CreateDagRun func(ctx context.Context, tenant, dagID string, run domain.DagRun) (domain.DagRun, error)

+ DeleteDagRun func(ctx context.Context, tenant, dagID, runID string) error

+ GetDagRun func(ctx context.Context, tenant, dagID, runID string) (domain.DagRun, error)

+ ListDagRuns func(ctx context.Context, tenant, dagID string, limit, offset int) ([]domain.DagRun, int, error)

+ SetDagRunState func(ctx context.Context, tenant, dagID, runID, state string) error

+ type DagSpecReader interface

+ GetCurrentSpec func(ctx context.Context, tenant, dagID string) (domain.DAGSpec, error)

+ type DagVersionLister interface

+ ListDagVersions func(ctx context.Context, tenant, dagID string) ([]domain.DagVersion, error)

+ type DagVersionRepository interface

+ RegisterDagVersion func(ctx context.Context, tenant string, spec domain.DAGSpec, specHash string) (bool, error)

+ type DashboardStatsReader interface

+ DagStats func(ctx context.Context, tenant string) (domain.DagStats, error)

+ HistoricalMetrics func(ctx context.Context, tenant string, since, until time.Time) (domain.HistoricalMetrics, error)

+ type Dependencies struct

+ Audit AuditWriter

+ AuditLog AuditLogReader

+ AuthAudit AuthAuditWriter

+ Authenticator auth.Authenticator

+ CORSOrigins []string

+ ConnectionTest ConnectionTester

+ Connections ConnectionStore

+ DagRuns DagRunRepository

+ DagVersions DagVersionLister

+ Dags DagRepository

+ DashboardStats DashboardStatsReader

+ DevNoAuth bool

+ Edition string

+ ExamplesFS fs.FS

+ ExecutorInfo ExecutorInfo

+ ExternalSignInURL string

+ ExternalSignOutURL string

+ Favorites FavoriteStore

+ HealthChecks map[string]HealthChecker

+ ImportErrors ImportErrorStore

+ InstanceName string

+ JWTSecret string

+ LatestRuns DagLatestRunsReader

+ Logger *slog.Logger

+ Logs LogReader

+ Metrics Metrics

+ MonacoDir string

+ OIDCEnabled bool

+ OIDCFlow *oidc.Flow

+ OIDCSettings config.OIDCSection

+ OIDCUsers OIDCUserStore

+ Pools PoolStore

+ RateLimiter *auth.RateLimiter

+ Registry *prometheus.Registry

+ SchedulerHealth Heartbeater

+ ServiceAllowedTenants []string

+ ServiceTenants ServiceTenantStore

+ ServiceToken string

+ SessionCookieInsecure bool

+ Specs DagSpecReader

+ TaskSummary TaskSummaryReader

+ Tasks TaskInstanceRepository

+ TokenMaxLifetimeSecs int

+ TokenRenewer TokenRenewer

+ TokenTTLSecs int

+ Tracer trace.Tracer

+ TrustedIssuer TrustedIssuer

+ TrustedIssuerOrigins []string

+ TrustedIssuerUsers TrustedIssuerUserStore

+ TrustedProxies []string

+ UI UIServer

+ UIAutoRefreshIntervalSeconds int

+ UITheme json.RawMessage

+ UserAudit UserAuditWriter

+ Users UserStore

+ Variables VariableStore

+ Versions DagVersionRepository

+ Workspace WorkspaceFS

+ Xcoms XComReader

+ type ExecutorInfo struct

+ AgentControlPlaneAddr string

+ PodDispatchEnabled bool

+ TaskNamespace string

+ type FavoriteStore interface

+ AddFavorite func(ctx context.Context, tenant, userID, dagID string) error

+ FavoriteDagIDs func(ctx context.Context, tenant, userID string) (map[string]bool, error)

+ RemoveFavorite func(ctx context.Context, tenant, userID, dagID string) error

+ type HealthChecker interface

+ Ping func(ctx context.Context) error

+ type Heartbeater interface

+ Heartbeat func() (healthy bool, last time.Time)

+ type ImportErrorStore interface

+ ClearImportError func(ctx context.Context, tenant, filename string) error

+ ListImportErrors func(ctx context.Context, tenant string) ([]domain.ImportError, error)

+ SetImportError func(ctx context.Context, tenant string, e domain.ImportError) error

+ type LogReader interface

+ ReadLogs func(ctx context.Context, tenant, dagID, runID, taskID string, tryNumber int) (io.ReadCloser, error)

+ Tail func(ctx context.Context, tenant, dagID, runID, taskID string, tryNumber int) (<-chan string, func(), error)

+ type Metrics interface

+ RecordHTTPRequest func(method, path string, status int, dur time.Duration)

+ type OIDCUserStore interface

+ CreateOIDCUser func(ctx context.Context, tenant, email, provider, subject string, roles []string) (*auth.User, error)

+ FindUserByOIDCSubject func(ctx context.Context, provider, subject string) (*auth.User, bool, error)

+ ReconcileUserRoles func(ctx context.Context, userID string, roleNames []string) error

+ RoleExists func(ctx context.Context, tenant, role string) (bool, error)

+ type PoolStore interface

+ DeletePool func(ctx context.Context, tenant, name string) error

+ GetPool func(ctx context.Context, tenant, name string) (domain.Pool, error)

+ ListPools func(ctx context.Context, tenant string, limit, offset int) ([]domain.Pool, int, error)

+ PoolSlotUsage func(ctx context.Context, tenant string) (map[string]domain.PoolUsage, error)

+ SetPool func(ctx context.Context, tenant string, p domain.Pool) error

+ type Problem struct

+ Detail string

+ Instance string

+ Status int

+ Title string

+ Type string

+ type SchemaChecker interface

+ SchemaReady func(ctx context.Context) error

+ type ServiceTenantStore interface

+ EnsureIssuerUser func(ctx context.Context, tenant, email, provider, subject string, roles []string) (*auth.User, bool, error)

+ EnsureTenant func(ctx context.Context, name, displayName string) (created bool, err error)

+ type TaskInstanceRepository interface

+ ClearTaskInstances func(ctx context.Context, tenant, dagID, runID string, taskIDs []string, ...) (int, error)

+ ListTaskInstanceAttempts func(ctx context.Context, tenant, dagID, runID, taskID string) ([]domain.TaskInstance, error)

+ ListTaskInstances func(ctx context.Context, tenant, dagID, runID string, limit, offset int) ([]domain.TaskInstance, int, error)

+ SetTaskInstanceState func(ctx context.Context, tenant, dagID, runID, taskID, state string) error

+ type TaskSummaryReader interface

+ TaskInstancesForRuns func(ctx context.Context, tenant, dagID string, runIDs []string) ([]domain.TaskInstance, error)

+ type TokenRenewer interface

+ RenewUserToken func(ctx context.Context, token string, ttl, maxLifetime time.Duration) (renewed string, ok bool, err error)

+ type TrustedIssuer interface

+ Provider func() string

+ Verify func(ctx context.Context, raw string) (*issuer.Identity, error)

+ type TrustedIssuerUserStore interface

+ FindUserByOIDCSubject func(ctx context.Context, provider, subject string) (*auth.User, bool, error)

+ type UIServer interface

+ Index func(w http.ResponseWriter, basePath string)

+ StaticHandler func() http.Handler

+ type UserAuditWriter interface

+ RecordUserCreatedAudit func(ctx context.Context, tenant, actorUserID, createdUserID, email, roles string) error

+ type UserStore interface

+ CreateUser func(ctx context.Context, tenant, email, password string, roles []string) (domain.User, error)

+ ListUsers func(ctx context.Context, tenant string, limit, offset int) ([]domain.User, int, error)

+ type VariableStore interface

+ DeleteVariable func(ctx context.Context, tenant, key string) error

+ GetVariable func(ctx context.Context, tenant, key string) (domain.Variable, error)

+ ListVariables func(ctx context.Context, tenant string, limit, offset int) ([]domain.Variable, int, error)

+ SetVariablePatch func(ctx context.Context, tenant string, p domain.VariablePatch) error

+ type WorkspaceFS interface

+ Create func(rel string, dir bool) error

+ Delete func(rel string) error

+ Move func(from, to string) error

+ Read func(rel string) ([]byte, error)

+ Tree func() ([]workspace.Entry, error)

+ Write func(rel string, data []byte) error

+ type XComReader interface

+ GetXCom func(ctx context.Context, tenant, dagID, runID, taskID, key string) (xcom.Entry, error)

+ ListXComEntries func(ctx context.Context, tenant, dagID, runID, taskID string) ([]domain.XComEntryMeta, error)

v0.5.0-rc.1

Oct 2, 2026

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