api

Mar 5, 2025

Changes in this version

+ const HealthRoute

+ const InfoRoute

+ const QueryRoute

+ const ReadyRoute

+ const SSEQueryRoute

+ const ValidationRoute

+ var ErrTooManyConcurrentRequest = errors.New("too many concurrent requests")

+ func ExtractSchemeAddr(addr string) (scheme string, address string)

+ func ExtractUnixSocket(addr string) (socketFile string)

+ func GetHealthHandler() func(context.Context, *struct{}) (*GetHealthOutput, error)

+ func GetHealthOperation() huma.Operation

+ func GetInfoOperation() huma.Operation

+ func GetReadyHandler() func(context.Context, *struct{}) (*GetReadyOutput, error)

+ func GetReadyOperation() huma.Operation

+ func GetServiceInfoHandler(serviceName string) func(context.Context, *struct{}) (*GetInfoOutput, error)

+ func OnKeepalive(send sse.Sender) error

+ func OnResult(res *results.Result, send sse.Sender) error

+ func RateLimitMiddleware(limiter *rate.Limiter) func(ctx huma.Context, next func(huma.Context))

+ func RecursionDetectorMiddleware(headerKey, match string) gin.HandlerFunc

+ func RegisterProfiling(router *gin.Engine)

+ func RegisterQueryAPI(a huma.API, caller string, querier query.Runner, middlewares huma.Middlewares)

+ func RequestLoggingMiddleware() gin.HandlerFunc

+ func TraceIDMiddleware() gin.HandlerFunc

+ type ArgsInput struct

+ Body *query.Args

+ type ArgsParamsInput struct

+ type FinalResult struct

+ type GetHealthOutput struct

+ Body struct{ ... }

+ type GetInfoOutput struct

+ Body struct{ ... }

+ type GetReadyOutput struct

+ Body struct{ ... }

+ type Keepalive struct

+ type PartialResult struct

+ type QueryResultOutput struct

+ Body *results.Result

+ type SSEQueryRunner interface

+ RunStreaming func(ctx context.Context, args *query.Args, send sse.Sender) (*results.Result, error)

+ type ServiceInfo struct

+ Commit string

+ Name string

+ Pod string

+ Version string

+ type StreamEventType string

+ const StreamEventFinalResult

+ const StreamEventKeepalive

+ const StreamEventPartialResult

+ const StreamEventQueryError