api

package

v0.9.0 Latest Latest Go to latest Published: Jul 4, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/burrow-cloud/burrow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api is the control plane's HTTP front end: it exposes the deploy engine's operations over JSON and authenticates its callers with a bearer token (ADR-0005). It is a thin transport adapter — it decodes requests, calls the engine, and maps the engine's typed outcomes to HTTP status codes; the orchestration and guardrails live in the engine (ADR-0006). The MCP server and the CLI are both clients of this API.

It lives under controlplane/ (not controlplane/internal) so cmd/burrowd and the managed module can wire it; it is licensed Apache-2.0.

Index ¶

func New(cfg Config) (http.Handler, error)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(cfg Config) (http.Handler, error)

New builds the control-plane HTTP handler. The /v1 routes require the bearer token; /healthz is unauthenticated for liveness probes.

Types ¶

type Config ¶

type Config struct {
	// Engine is the deploy engine the API fronts. Required.
	Engine *controlplane.Engine
	// Token is the bearer token clients must present on every /v1 request
	// (ADR-0005). Required — the control plane authenticates its callers.
	Token string
}

Config configures the API handler.

Source Files ¶

View all Source files

api.go

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