adminext

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2026 License: BSD-3-Clause Imports: 4 Imported by: 0

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.

func (*DummyOASBackend) GetOAS

func (d *DummyOASBackend) GetOAS(_ string) ([]byte, error)

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL