apirouter

package

Go to main page

Versions in this module

v0

v0.13.1

Feb 20, 2026

v0.13.0

Feb 6, 2026

Changes in this version

+ func AuthMiddleware(apiKey, jwtSecret string, tenantRetriever TenantRetriever, opts AuthOptions) gin.HandlerFunc

+ func CursorToPtr(cursor string) *string

+ func ParseArrayParam(c *gin.Context, fieldName string) []string

+ func ParseCursors(c *gin.Context) (CursorParams, *ErrorResponse)

+ func ParseDateFilter(c *gin.Context, fieldName string) (*DateFilterResult, *ErrorResponse)

+ type APIAttempt struct

+ AttemptNumber int

+ Code string

+ DestinationID string

+ Event interface{}

+ EventID string

+ ID string

+ Manual bool

+ ResponseData map[string]interface{}

+ Status string

+ TenantID string

+ Time time.Time

+ type APIEvent struct

+ Data map[string]interface{}

+ DestinationID string

+ EligibleForRetry bool

+ ID string

+ Metadata map[string]string

+ TenantID string

+ Time time.Time

+ Topic string

+ type APIEventFull struct

+ Data map[string]interface{}

+ DestinationID string

+ EligibleForRetry bool

+ ID string

+ Metadata map[string]string

+ TenantID string

+ Time time.Time

+ Topic string

+ type APIEventSummary struct

+ DestinationID string

+ EligibleForRetry bool

+ ID string

+ Metadata map[string]string

+ TenantID string

+ Time time.Time

+ Topic string

+ type AttemptPaginatedResult struct

+ Models []APIAttempt

+ Pagination SeekPagination

+ type AuthOptions struct

+ AdminOnly bool

+ RequireTenant bool

+ type CursorParams struct

+ Next string

+ Prev string

+ type DateFilterResult struct

+ GT *time.Time

+ GTE *time.Time

+ LT *time.Time

+ LTE *time.Time

type ErrorResponse

+ Status int

+ func ParseDir(c *gin.Context) (string, *ErrorResponse)

+ func ParseOrderBy(c *gin.Context, allowedValues []string) (string, *ErrorResponse)

+ type EventPaginatedResult struct

+ Models []APIEvent

+ Pagination SeekPagination

+ type IncludeOptions struct

+ Event bool

+ EventData bool

+ ResponseData bool

+ type JWTClaims struct

+ DeploymentID string

+ TenantID string

type LogHandlers

+ func (h *LogHandlers) ListAttempts(c *gin.Context)

+ func (h *LogHandlers) ListDestinationAttempts(c *gin.Context)

+ func (h *LogHandlers) ListEvents(c *gin.Context)

+ func (h *LogHandlers) RetrieveAttempt(c *gin.Context)

type RouteDefinition

+ AdminOnly bool

+ RequireTenant bool

type RouterConfig

+ DeploymentID string

+ type RouterDeps struct

+ DeliveryPublisher deliveryPublisher

+ EventHandler eventHandler

+ LogStore logstore.LogStore

+ Logger *logging.Logger

+ Telemetry telemetry.Telemetry

+ TenantStore tenantstore.TenantStore

+ type SeekPagination struct

+ Dir string

+ Limit int

+ Next *string

+ OrderBy string

+ Prev *string

+ type TenantRetriever interface

+ RetrieveTenant func(ctx context.Context, tenantID string) (*models.Tenant, error)

v0.12.0

Jan 15, 2026

Changes in this version

type TenantHandlers

+ func (h *TenantHandlers) List(c *gin.Context)

v0.11.0

Jan 6, 2026

v0.10.0

Dec 17, 2025

Changes in this version

type CreateDestinationRequest

+ Filter models.Filter

type UpdateDestinationRequest

+ Filter models.Filter

v0.9.1

Dec 10, 2025

v0.9.0

Nov 17, 2025

Changes in this version

+ const MaxRequestBodySize

+ const RoleAdmin

+ const RoleTenant

+ const SensitiveFieldMask

+ var ErrDestinationDisabled = errors.New("destination is disabled")

+ var ErrInvalidBearerToken = errors.New("invalid bearer token format")

+ var ErrInvalidToken = errors.New("invalid token")

+ var ErrMissingAuthHeader = errors.New("missing authorization header")

+ var ErrTenantIDNotFound = errors.New("tenantID not found in context")

+ var JWT = jsonwebtoken

+ func APIKeyAuthMiddleware(apiKey string) gin.HandlerFunc

+ func APIKeyOrTenantJWTAuthMiddleware(apiKey string, jwtKey string) gin.HandlerFunc

+ func AbortWithError(c *gin.Context, code int, err error)

+ func AbortWithValidationError(c *gin.Context, err error)

+ func ErrorHandlerMiddleware() gin.HandlerFunc

+ func GetRequestLatency(c *gin.Context) time.Duration

+ func LatencyMiddleware() gin.HandlerFunc

+ func LoggerMiddleware(logger *logging.Logger) gin.HandlerFunc

+ func LoggerMiddlewareWithSanitizer(logger *logging.Logger, sanitizer *RequestBodySanitizer) gin.HandlerFunc

+ func MetricsMiddleware() gin.HandlerFunc

+ func NewRouter(cfg RouterConfig, logger *logging.Logger, redisClient redis.Cmdable, ...) http.Handler

+ func RequireTenantMiddleware(entityStore models.EntityStore) gin.HandlerFunc

+ func SetTenantIDMiddleware() gin.HandlerFunc

+ func TenantJWTAuthMiddleware(apiKey string, jwtKey string) gin.HandlerFunc

+ type AuthScope string

+ const AuthScopeAdmin

+ const AuthScopeAdminOrTenant

+ const AuthScopeTenant

+ type BufferedReader struct

+ func NewBufferedReader(r io.Reader) (*BufferedReader, error)

+ func (br *BufferedReader) Bytes() []byte

+ func (br *BufferedReader) NewReadCloser() io.ReadCloser

+ func (br *BufferedReader) NewReader() io.Reader

+ func (br *BufferedReader) Read(p []byte) (n int, err error)

+ type CreateDestinationRequest struct

+ Config models.Config

+ Credentials models.Credentials

+ DeliveryMetadata models.DeliveryMetadata

+ ID string

+ Metadata models.Metadata

+ Topics models.Topics

+ Type string

+ func (r *CreateDestinationRequest) ToDestination(tenantID string) models.Destination

+ type DeliveryResponse struct

+ Code string

+ DeliveredAt string

+ ID string

+ ResponseData map[string]interface{}

+ Status string

+ type DestinationHandlers struct

+ func NewDestinationHandlers(logger *logging.Logger, telemetry telemetry.Telemetry, ...) *DestinationHandlers

+ func (h *DestinationHandlers) Create(c *gin.Context)

+ func (h *DestinationHandlers) Delete(c *gin.Context)

+ func (h *DestinationHandlers) Disable(c *gin.Context)

+ func (h *DestinationHandlers) Enable(c *gin.Context)

+ func (h *DestinationHandlers) List(c *gin.Context)

+ func (h *DestinationHandlers) ListProviderMetadata(c *gin.Context)

+ func (h *DestinationHandlers) Retrieve(c *gin.Context)

+ func (h *DestinationHandlers) RetrieveProviderMetadata(c *gin.Context)

+ func (h *DestinationHandlers) Update(c *gin.Context)

+ type ErrorResponse struct

+ Code int

+ Data interface{}

+ Err error

+ Message string

+ func NewErrBadRequest(err error) ErrorResponse

+ func NewErrInternalServer(err error) ErrorResponse

+ func NewErrNotFound(resource string) ErrorResponse

+ func (e *ErrorResponse) Parse(err error)

+ func (e ErrorResponse) Error() string

+ type LogHandlers struct

+ func NewLogHandlers(logger *logging.Logger, logStore logstore.LogStore) *LogHandlers

+ func (h *LogHandlers) ListDeliveryByEvent(c *gin.Context)

+ func (h *LogHandlers) ListEvent(c *gin.Context)

+ func (h *LogHandlers) ListEventByDestination(c *gin.Context)

+ func (h *LogHandlers) RetrieveEvent(c *gin.Context)

+ func (h *LogHandlers) RetrieveEventByDestination(c *gin.Context)

+ type PublishHandlers struct

+ func NewPublishHandlers(logger *logging.Logger, eventHandler publishmq.EventHandler) *PublishHandlers

+ func (h *PublishHandlers) Ingest(c *gin.Context)

+ type PublishedEvent struct

+ Data map[string]interface{}

+ DestinationID string

+ EligibleForRetry *bool

+ ID string

+ Metadata map[string]string

+ TenantID string

+ Time time.Time

+ Topic string

+ type RequestBodySanitizer struct

+ func NewRequestBodySanitizer(registry destregistry.Registry) *RequestBodySanitizer

+ func (s *RequestBodySanitizer) SanitizeRequestBody(body io.Reader) ([]byte, error)

+ type RetryHandlers struct

+ func NewRetryHandlers(logger *logging.Logger, entityStore models.EntityStore, ...) *RetryHandlers

+ func (h *RetryHandlers) Retry(c *gin.Context)

+ type RouteDefinition struct

+ AllowTenantFromJWT bool

+ AuthScope AuthScope

+ Handler gin.HandlerFunc

+ Method string

+ Middlewares []gin.HandlerFunc

+ Mode RouteMode

+ Path string

+ type RouteMode string

+ const RouteModeAlways

+ const RouteModePortal

+ type RouterConfig struct

+ APIKey string

+ GinMode string

+ JWTSecret string

+ PortalConfig portal.PortalConfig

+ Registry destregistry.Registry

+ ServiceName string

+ Topics []string

+ type TenantHandlers struct

+ func NewTenantHandlers(logger *logging.Logger, telemetry telemetry.Telemetry, jwtSecret string, ...) *TenantHandlers

+ func (h *TenantHandlers) Delete(c *gin.Context)

+ func (h *TenantHandlers) Retrieve(c *gin.Context)

+ func (h *TenantHandlers) RetrievePortal(c *gin.Context)

+ func (h *TenantHandlers) RetrieveToken(c *gin.Context)

+ func (h *TenantHandlers) Upsert(c *gin.Context)

+ type TopicHandlers struct

+ func NewTopicHandlers(logger *logging.Logger, topics []string) *TopicHandlers

+ func (h *TopicHandlers) List(c *gin.Context)

+ type UpdateDestinationRequest struct

+ Config models.Config

+ Credentials models.Credentials

+ DeliveryMetadata models.DeliveryMetadata

+ Metadata models.Metadata

+ Topics models.Topics

+ Type string

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