api

Documentation

Index

• Variables
• type Constraint
• type Feature
  • func (f Feature) GetVariant(ctx *context.Context) *Variant
• type FeatureResponse
  • func (fr FeatureResponse) FeatureMap() map[string]interface{}
• type Operator
• type Override
• type ParameterDescription
• type ParameterMap
• type Payload
• type Response
• type Strategy
• type StrategyDescription
• type StrategyResponse
• type Variant
  • func GetDefaultVariant() *Variant
• type VariantInternal

Variables

var DISABLED_VARIANT = &Variant{
	Name:    "disabled",
	Enabled: false,
}

Types

type Constraint

type Constraint struct {
	// ContextName is the context name of the constraint.
	ContextName string `json:"contextName"`

	// Operator is the operator of the constraint.
	Operator Operator `json:"operator"`

	// Values is the values of the constraint.
	Values []string `json:"values"`
}

Constraint represents a constraint on a particular context value.

type Feature

type Feature struct {
	// Name is the name of the feature toggle.
	Name string `json:"name"`

	// Description is a description of the feature toggle.
	Description string `json:"description"`

	// Enabled indicates whether the feature was enabled or not.
	Enabled bool `json:"enabled"`

	// Strategies is a list of names of the strategies supported by the client.
	Strategies []Strategy `json:"strategies"`

	// CreatedAt is the creation time of the feature toggle.
	CreatedAt time.Time `json:"createdAt"`

	// Strategy is the strategy of the feature toggle.
	Strategy string `json:"strategy"`

	// Parameters is the parameters of the feature toggle.
	Parameters ParameterMap `json:"parameters"`

	// Variants is a list of variants of the feature toggle.
	Variants []VariantInternal `json:"variants"`
}

func (Feature) GetVariant

func (f Feature) GetVariant(ctx *context.Context) *Variant

Get variant for a given feature which is considered as enabled

type FeatureResponse

type FeatureResponse struct {
	Response
	Features []Feature `json:"features"`
}

func (FeatureResponse) FeatureMap

func (fr FeatureResponse) FeatureMap() map[string]interface{}

type Operator

type Operator string

Operator is a type representing a constraint operator

const (
	// OperatorIn indicates that the context values must be
	// contained within those specified in the constraint.
	OperatorIn Operator = "IN"

	// OperatorNotIn indicates that the context values must
	// NOT be contained within those specified in the constraint.
	OperatorNotIn Operator = "NOT_IN"
)

type Override

type Override struct {
	// ContextName is the value of attribute context name
	ContextName string `json:"contextName"`
	// Values is the value of attribute values
	Values []string `json:"values"`
}

type ParameterDescription

type ParameterDescription struct {
	Name        string `json:"name"`
	Type        string `json:"type"`
	Description string `json:"description"`
	Required    bool   `json:"required"`
}

type ParameterMap

type ParameterMap map[string]interface{}

type Payload

type Payload struct {
	// Type is the type of the payload
	Type string `json:"type"`
	// Value is the value of the payload type
	Value string `json:"value"`
}

type Response

type Response struct {
	Version int `json:"version"`
}

type Strategy

type Strategy struct {
	// Id is the name of the strategy.
	Id int `json:"id"`

	// Name is the name of the strategy.
	Name string `json:"name"`

	// Constraints is the constraints of the strategy.
	Constraints []Constraint `json:"constraints"`

	// Parameters is the parameters of the strategy.
	Parameters ParameterMap `json:"parameters"`
}

type StrategyDescription

type StrategyDescription struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Parameters  []ParameterDescription `json:"parameters"`
}

type StrategyResponse

type StrategyResponse struct {
	Response
	Strategies []StrategyDescription `json:"strategies"`
}

type Variant

type Variant struct {
	// Name is the value of the variant name.
	Name string `json:"name"`
	// Payload is the value of the variant payload
	Payload Payload `json:"payload"`
	// Enabled indicates whether the feature which is extend by this variant was enabled or not.
	Enabled bool `json:"enabled"`
}

func GetDefaultVariant

func GetDefaultVariant() *Variant

Get default variant if no variant is found

type VariantInternal

type VariantInternal struct {
	Variant
	// Weight is the traffic ratio for the request
	Weight int `json:"weight"`
	// WeightType can be fixed or variable
	WeightType string `json:"weightType"`
	// Override is used to get a variant accoording to the Unleash context field
	Overrides []Override `json:"overrides"`
}