Documentation ¶
Index ¶
- type Controller
- func NewAPIFlagChange(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
- func NewAllFlags(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
- func NewCollectEvalData(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
- func NewFlagEval(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
- func NewForceFlagsRefresh(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
- func NewHealth(monitoring service.Monitoring) Controller
- func NewInfo(monitoring service.Monitoring) Controller
- func NewWsFlagChange(websocketService service.WebsocketService, logger *zap.Logger) Controller
- type FlagChangeAPICtrl
- type FlagChangeResponse
- type OFREPController
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Controller ¶
type Controller interface {
Handler(c echo.Context) error
}
Controller is the interface used by all controller struct
func NewAPIFlagChange ¶ added in v1.30.0
func NewAPIFlagChange(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
func NewAllFlags ¶
func NewAllFlags(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
func NewCollectEvalData ¶ added in v1.7.0
func NewCollectEvalData(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
NewCollectEvalData initialize the controller for the /data/collector endpoint
func NewFlagEval ¶
func NewFlagEval(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
func NewForceFlagsRefresh ¶ added in v1.28.0
func NewForceFlagsRefresh(goFF *ffclient.GoFeatureFlag, metrics metric.Metrics) Controller
NewForceFlagsRefresh initialize the controller for the /data/collector endpoint
func NewHealth ¶
func NewHealth(monitoring service.Monitoring) Controller
NewHealth is a constructor to create a new controller for the health method
func NewInfo ¶
func NewInfo(monitoring service.Monitoring) Controller
func NewWsFlagChange ¶ added in v1.12.0
func NewWsFlagChange(websocketService service.WebsocketService, logger *zap.Logger) Controller
NewWsFlagChange is the constructor to create a new controller to handle websocket request to be notified about flag changes.
type FlagChangeAPICtrl ¶ added in v1.30.0
type FlagChangeAPICtrl struct {
// contains filtered or unexported fields
}
func (*FlagChangeAPICtrl) Handler ¶ added in v1.30.0
func (h *FlagChangeAPICtrl) Handler(c echo.Context) error
Handler is the endpoint to poll if you want to know if there is a configuration change in the flags @Summary Endpoint to poll if you want to know if there is a configuration change in the flags @Tags GO Feature Flag Evaluation API @Description Making a **GET** request to the URL `/v1/flag/change` will give you the hash of the current @Description configuration, you can use this hash to know if the configuration has changed. @Security ApiKeyAuth @Produce json @Accept json @Param If-None-Match header string false "The request will be processed only if ETag doesn't match." @Success 200 {object} FlagChangeResponse "Success" @Success 304 {string} string "Etag: \"117-0193435c612c50d93b798619d9464856263dbf9f\"" @Failure 500 {object} modeldocs.HTTPErrorDoc "Internal server error" @Router /v1/flag/change [get]
type FlagChangeResponse ¶ added in v1.30.0
type FlagChangeResponse struct {
Hash uint32 `json:"hash"`
}