Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIProvider ¶
type APIProvider interface {
// RegisterRoutes allows the extension to register its own HTTP handlers on the provided ServeMux.
// The extension should use a unique path prefix to avoid conflicts with other extensions.
RegisterRoutes(
mux *http.ServeMux,
middleware ...strictnethttp.StrictHTTPMiddlewareFunc,
) error
}
APIProvider is implemented by any extension that wants to expose additional admin API endpoints.
type DummyOASBackend ¶
type DummyOASBackend struct{}
DummyOASBackend is a no-op OAS backend that always returns not found. This is used by default when admin is instantiated without an OAS backend, to avoid nil checks.
type FlowFetcher ¶
type FlowFetcher interface {
// GetFlow returns metadata about the current FlowComponent chain. This is used for flow inspection in the admin API.
GetFlow() []adminapi.FlowMeta
}
FlowFetcher implementors provide a way for the admin API to fetch the FlowComponent chain.
type OASBackend ¶
type OASBackend interface {
// GetOAS returns the OpenAPI Specification for the specified backend.
GetOAS(backendName string) ([]byte, error)
}
OASBackend implementors provide a way for the admin API to fetch an OAS per backend name.
Click to show internal directories.
Click to hide internal directories.