Documentation
¶
Index ¶
- type AllFlagRequest
- type CollectEvalDataRequest
- type CollectEvalDataResponse
- type EvalFlagRequest
- type EvaluationContextRequest
- type FlagEval
- type HealthResponse
- type InfoResponse
- type OFREPBulkEvaluateSuccessResponse
- type OFREPCommonResponseError
- type OFREPConfigCapabilities
- type OFREPConfigCapabilitiesCacheInvalidation
- type OFREPConfigCapabilitiesCacheInvalidationPolling
- type OFREPConfigCapabilitiesFlagEvaluation
- type OFREPConfiguration
- type OFREPEvalFlagRequest
- type OFREPEvaluateResponseError
- type OFREPEvaluateSuccessResponse
- type OFREPFlagBulkEvaluateSuccessResponse
- type UserRequestdeprecated
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AllFlagRequest ¶
type AllFlagRequest struct {
// Deprecated: User The representation of a user for your feature flag system.
User *UserRequest `` // nolint: lll
/* 158-byte string literal not displayed */
// 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 exporter.FeatureEventMetadata `json:"meta"`
// Events is the list of the event we send in the payload
// here the type is any because we will unmarshal later in the different event types
Events []map[string]any `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"`
// The value will we use if we are not able to get the variation of the flag.
DefaultValue any `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]any `` // nolint: lll
/* 177-byte string literal not displayed */
}
EvaluationContextRequest The representation of a EvaluationContext for your feature flag system.
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 {
// LatestCacheRefresh is the last time when your flag file was read and stored in the internal cache.
// This field is used for backward compatibility when using the default flagset.
LatestCacheRefresh *time.Time `json:"cacheRefresh,omitempty" example:"2022-06-13T11:22:55.941628+02:00"`
// Flagsets contains the cache refresh dates for each flagset when using multiple flagsets.
// The format is {"flagset name": "2022-06-13T11:22:55.941628+02:00"}
Flagsets map[string]time.Time `json:"flagsets,omitempty" example:"default:2022-06-13T11:22:55.941628+02:00,feature-flags:2022-06-13T11:22:55.941628+02:00"` //nolint: lll
}
InfoResponse is the object returned by the info API
type OFREPBulkEvaluateSuccessResponse ¶
type OFREPBulkEvaluateSuccessResponse struct {
Flags []OFREPFlagBulkEvaluateSuccessResponse `json:"flags"`
}
type OFREPCommonResponseError ¶
type OFREPCommonResponseError struct {
ErrorCode flag.ErrorCode `json:"errorCode"`
ErrorDetails string `json:"errorDetails"`
}
func (*OFREPCommonResponseError) Error ¶
func (o *OFREPCommonResponseError) 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 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 OFREPEvaluateResponseError ¶
type OFREPEvaluateResponseError struct {
OFREPCommonResponseError ` json:",inline" yaml:",inline" toml:",inline"`
Key string `json:"key"`
}
type OFREPFlagBulkEvaluateSuccessResponse ¶
type OFREPFlagBulkEvaluateSuccessResponse struct {
OFREPEvaluateSuccessResponse `json:",inline"`
ErrorCode string `json:"errorCode,omitempty"`
ErrorDetails string `json:"errorDetails,omitempty"`
}
type UserRequest
deprecated
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]any `` // nolint: lll
/* 177-byte string literal not displayed */
}
Deprecated: UserRequest The representation of a user for your feature flag system.
Click to show internal directories.
Click to hide internal directories.