api

Documentation

Index

• Constants
• func AppendHandler(c *gin.Context)
• func AppendsHandler(c *gin.Context)
• func HealthCheckHandler(c *gin.Context)
• func ScanHandler(c *gin.Context)
• func SetupRoutes(router *gin.Engine)
• func ToInterfaceSlice(s interface{}) []interface{}
• type AppendOffsetRequest
• type AppendRequest
• type AppendResponse
• type AppendsRequest
• type AppendsResponse
• type ScanRequest
• type ScanResponse

Constants

const (
	DEFAULT_LIMIT         = 500
	CLIENT_USER_ID_PREFIX = "client:"
)

Functions

func AppendHandler

func AppendHandler(c *gin.Context)

func AppendsHandler

func AppendsHandler(c *gin.Context)

func HealthCheckHandler

func HealthCheckHandler(c *gin.Context)

func ScanHandler

func ScanHandler(c *gin.Context)

func SetupRoutes

func SetupRoutes(router *gin.Engine)

func ToInterfaceSlice

func ToInterfaceSlice(s interface{}) []interface{}

Types

type AppendOffsetRequest

type AppendOffsetRequest struct {
	Append AppendRequest `json:"append"`
	Offset int64         `json:"offset"`
}

type AppendRequest

type AppendRequest struct {
	KeycloakId      null.String `json:"keycloak_id"`
	Namespace       string      `json:"namespace"`
	ClientId        null.String `json:"client_id"`
	ClientEventID   null.String `json:"client_event_id,omitempty"`
	ClientEventType string      `json:"client_event_type"`
	ClientFlowID    null.String `json:"client_flow_id,omitempty"`
	ClientFlowType  null.String `json:"client_flow_type,omitempty"`
	ClientSessionID null.String `json:"client_session_id,omitempty"`
	Data            null.JSON   `json:"data,omitempty"`
}

type AppendResponse

type AppendResponse struct {
	Id string `json:"id"`
}

type AppendsRequest

type AppendsRequest struct {
	AppendRequests []AppendOffsetRequest `json:"append_requests"`
}

type AppendsResponse

type AppendsResponse struct {
	Ids []string `json:"ids"`
}

type ScanRequest

type ScanRequest struct {
	Id    string `json:"id,omitempty"`
	Limit int    `json:"limit,omitempty"`

	// Filters.
	EventTypes []string  `json:"event_types,omitempty"`
	UserIds    []string  `json:"user_ids,omitempty"`
	Namespaces []string  `json:"namespaces,omitempty"`
	Keycloak   null.Bool `json:"keycloak,omitempty"`

	// Empty will bring all fields.
	Fields []string `json:"fields,omitempty"`

	// If true, will scan back.
	ScanBack null.Bool `json:"scan_back,omitempty"`
}

type ScanResponse

type ScanResponse struct {
	Entries []*models.Entry `json:"entries"`
}