api

package

v0.9.6 Latest Latest Go to latest Published: Apr 21, 2026 License: MIT Imports: 15 Imported by: 0

Details

This section is empty.

This section is empty.

func APIAuthMiddleware(apiKey string, allowedRoles []string) func(http.Handler) http.Handler

APIAuthMiddleware authorizes requests when either the bearer token matches apiKey or when X-User-Roles contains any role listed in allowedRoles.

func APIKeyMiddleware(apiKey string) func(http.Handler) http.Handler

APIKeyMiddleware checks the Authorization header for a matching API key. Deprecated: use APIAuthMiddleware for role support.

func MiddlewareChain() []func(http.Handler) http.Handler

func OpenAPIHandler() http.HandlerFunc

OpenAPIHandler serves the generated OpenAPI schema.

func SwaggerHandler() http.HandlerFunc

SwaggerHandler serves a minimal Swagger UI.

type API struct {
	Timeout  time.Duration
	Health   HealthChecker
	StateReg *serverstate.Registry
	generated.Unimplemented
}

func (a *API) GetApiState(w http.ResponseWriter, r *http.Request)

func (a *API) GetApiStateStream(w http.ResponseWriter, r *http.Request)

func (a *API) GetHealthz(w http.ResponseWriter, r *http.Request)

type HealthChecker interface {
	Healthy() bool
}

type PluginsEnvelope struct {
	Plugins map[string]any `json:"plugins"`
}

PluginsEnvelope is the generic, plugin-agnostic state payload.

type StateHandler struct {
	// Aggregated plugin state from serverstate.Registry
	State *serverstate.Registry
}

StateHandler serves state snapshots and streams.

func (h *StateHandler) GetState(w http.ResponseWriter, r *http.Request)

GetState returns a JSON snapshot of metrics.

func (h *StateHandler) GetStateStream(w http.ResponseWriter, r *http.Request)

GetStateStream streams state snapshots as Server-Sent Events.