model

Documentation

Index

• type AllFlagRequest
• type CollectEvalDataRequest
• type CollectEvalDataResponse
• type EvalFlagRequest
• type EvaluationContextRequest
• type FlagEval
• type HealthResponse
• type InfoResponse
• type OFREPBulkEvaluateSuccessResponse
• type OFREPCommonErrorResponse
  • func (o *OFREPCommonErrorResponse) Error() string
• type OFREPConfigCapabilities
• type OFREPConfigCapabilitiesCacheInvalidation
• type OFREPConfigCapabilitiesCacheInvalidationPolling
• type OFREPConfigCapabilitiesFlagEvaluation
• type OFREPConfiguration
• type OFREPEvalFlagRequest
• type OFREPEvaluateErrorResponse
• type OFREPEvaluateSuccessResponse
• type OFREPFlagBulkEvaluateSuccessResponse
• type UserRequest

Types

type AllFlagRequest

type AllFlagRequest struct {
	// Deprecated: User The representation of a user for your feature flag system.
	User *UserRequest `json:"user,omitempty" xml:"user,omitempty" form:"user" query:"user" deprecated:"true"`
	// EvaluationContext The representation of a EvaluationContext for your feature flag system.
	EvaluationContext *EvaluationContextRequest `json:"evaluationContext,omitempty" xml:"evaluationContext,omitempty" form:"evaluationContext" query:"evaluationContext"` // nolint: lll
}

type CollectEvalDataRequest

type CollectEvalDataRequest struct {
	// Meta are the extra information added during the configuration
	Meta map[string]string `json:"meta"`

	// Events is the list of the event we send in the payload
	Events []exporter.FeatureEvent `json:"events"`
}

CollectEvalDataRequest is the request to collect data in

type CollectEvalDataResponse

type CollectEvalDataResponse struct {
	// IngestedContentCount number of model.FeatureEvents that have been sent to the data exporter
	IngestedContentCount int `json:"ingestedContentCount" xml:"ingestedContentCount" form:"ingestedContentCount" query:"ingestedContentCount"` // nolint: lll
}

CollectEvalDataResponse is the object returned by the health API

type EvalFlagRequest

type EvalFlagRequest struct {
	AllFlagRequest `json:",inline" yaml:",inline" toml:",inline"`
	// The value will we use if we are not able to get the variation of the flag.
	DefaultValue interface{} `json:"defaultValue" xml:"defaultValue" form:"defaultValue" query:"defaultValue"`
}

type EvaluationContextRequest

type EvaluationContextRequest struct {
	// Key is the identifier of the UserRequest.
	Key string `json:"key" xml:"key" form:"key" query:"key" example:"08b5ffb7-7109-42f4-a6f2-b85560fbd20f"`

	// Custom is a map containing all extra information for this user.
	Custom map[string]interface{} `` // nolint: lll
	/* 178-byte string literal not displayed */
}

EvaluationContextRequest The representation of a EvaluationContext for your feature flag system.

type FlagEval

type FlagEval struct {
	Value interface{} `json:"value"`
}

type HealthResponse

type HealthResponse struct {
	// Set to true if the HTTP server is started
	Initialized bool `json:"initialized" example:"true"`
}

HealthResponse is the object returned by the health API

type InfoResponse

type InfoResponse struct {
	// This is the last time when your flag file was read and store in the internal cache.
	LatestCacheRefresh time.Time `json:"cacheRefresh" example:"2022-06-13T11:22:55.941628+02:00"`
}

InfoResponse is the object returned by the info API

type OFREPBulkEvaluateSuccessResponse

type OFREPBulkEvaluateSuccessResponse struct {
	Flags []OFREPFlagBulkEvaluateSuccessResponse `json:"flags"`
}

type OFREPCommonErrorResponse

type OFREPCommonErrorResponse struct {
	ErrorCode    flag.ErrorCode `json:"errorCode"`
	ErrorDetails string         `json:"errorDetails"`
}

func (*OFREPCommonErrorResponse) Error

func (o *OFREPCommonErrorResponse) Error() string

type OFREPConfigCapabilities

type OFREPConfigCapabilities struct {
	CacheInvalidation OFREPConfigCapabilitiesCacheInvalidation `json:"cacheInvalidation,omitempty"`
	FlagEvaluation    OFREPConfigCapabilitiesFlagEvaluation    `json:"flagEvaluation,omitempty"`
}

type OFREPConfigCapabilitiesCacheInvalidation

type OFREPConfigCapabilitiesCacheInvalidation struct {
	Polling OFREPConfigCapabilitiesCacheInvalidationPolling `json:"polling,omitempty"`
}

type OFREPConfigCapabilitiesCacheInvalidationPolling

type OFREPConfigCapabilitiesCacheInvalidationPolling struct {
	Enabled            bool  `json:"enabled,omitempty"`
	MinPollingInterval int64 `json:"minPollingInterval,omitempty"`
}

type OFREPConfigCapabilitiesFlagEvaluation

type OFREPConfigCapabilitiesFlagEvaluation struct {
	UnsupportedTypes []string `json:"unsupportedTypes"`
}

type OFREPConfiguration

type OFREPConfiguration struct {
	Name         string                  `json:"name"`
	Capabilities OFREPConfigCapabilities `json:"capabilities,omitempty"`
}

type OFREPEvalFlagRequest

type OFREPEvalFlagRequest struct {
	Context map[string]any `` /* 199-byte string literal not displayed */
}

nolint: lll

type OFREPEvaluateErrorResponse

type OFREPEvaluateErrorResponse struct {
	OFREPCommonErrorResponse `json:",inline" yaml:",inline" toml:",inline"`
	Key                      string `json:"key"`
}

type OFREPEvaluateSuccessResponse

type OFREPEvaluateSuccessResponse struct {
	Key      string         `json:"key"`
	Value    any            `json:"value"`
	Reason   string         `json:"reason"`
	Variant  string         `json:"variant"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type OFREPFlagBulkEvaluateSuccessResponse

type OFREPFlagBulkEvaluateSuccessResponse struct {
	OFREPEvaluateSuccessResponse `json:",inline"`
	ErrorCode                    string `json:"errorCode,omitempty"`
	ErrorDetails                 string `json:"errorDetails,omitempty"`
}

type UserRequest

type UserRequest struct {
	// Key is the identifier of the UserRequest.
	Key string `json:"key" xml:"key" form:"key" query:"key" example:"08b5ffb7-7109-42f4-a6f2-b85560fbd20f"`

	// Anonymous set if this is a logged-in user or not.
	Anonymous bool `json:"anonymous" xml:"anonymous" form:"anonymous" query:"anonymous" example:"false"`

	// Custom is a map containing all extra information for this user.
	Custom map[string]interface{} `` // nolint: lll
	/* 178-byte string literal not displayed */
}

Deprecated: UserRequest The representation of a user for your feature flag system.