README
¶
HTTP Interface Module
HTTP exposes DeltaScope audit and metadata-aware review capabilities as a JSON service.
Files
| File | Responsibility |
|---|---|
| audit_metadata.go | Executes one HTTP audit request through offline or direct metadata-aware flows and adds adapter context to the JSON response |
| audit_metadata_test.go | Verifies HTTP metadata-aware execution wiring, additive context, and direct metadata client lifecycle handling |
| handler.go | Binds Gin HTTP requests to the public audit API, auth checks, JSON responses, structured access logging, and health/readiness endpoints |
| handler_test.go | Verifies HTTP request binding, error mapping, and JSON response shape |
| server.go | Assembles the HTTP handler and long-running server wiring |
Exports
NewHandler(configPath, version, opts ...HandlerOption) (http.Handler, error)WithAuthConfig(AuthConfig) HandlerOptionWithMiddlewareConfig(MiddlewareConfig) HandlerOptionWithAuditFunc(func(context.Context, deltascope.Request) (deltascope.Result, error)) HandlerOptionNewServer(addr, configPath, version, opts ...HandlerOption)
Notes
- The HTTP layer is adapter-only: it reuses the shared public audit API and metadata-preparation helpers instead of reimplementing dialect or schema logic.
- Routing uses Gin while keeping the public JSON API contract unchanged.
- API-key auth is optional and configured through adapter options.
- Rate limiting is optional and supports
api-keyoripbucketing. /metricsis exposed in Prometheus format by default and can be disabled via middleware config.- Default middleware chain is request-id -> recovery -> timeout -> metrics -> auth -> rate-limit -> access log.
- Config hot-reload is achieved by re-reading the configured policy path on each audit request, so file updates take effect without restarting the server.
- Current scope supports offline HTTP audit and metadata-aware audit through direct request-scoped
connectioninputs. - Responses preserve the public DeltaScope result body and add a
contextblock describing mode, dialect/schema provenance, and metadata source.
Dependencies
- Upstream:
cmd/deltascope-server - Downstream:
pkg/deltascope,internal/application/policy
Update Rule
- If members/interfaces/dependencies change, update this file in same change.
Documentation
¶
Overview ¶
Package httpapi exposes the HTTP adapter for DeltaScope. input: parsed HTTP audit requests, shared metadata-preparation helpers, and public audit execution functions output: additive HTTP audit context plus offline or metadata-aware audit execution results pos: HTTP adapter glue between request-scoped metadata inputs and the public DeltaScope audit API note: if this file changes, update this header and module README.md.
Package httpapi exposes the HTTP adapter for DeltaScope. input: HTTP requests carrying SQL audit payloads plus service-level config/version wiring output: JSON audit, health, readiness, version, structured error responses, and structured access log lines pos: interface adapter between net/http and the public DeltaScope audit API note: if this file changes, update this header and module README.md.
Package httpapi exposes the HTTP adapter for DeltaScope. input: listen addresses plus service-level config/version wiring output: ready-to-run HTTP server instances for the JSON audit service pos: long-running net/http server assembly for the HTTP interface milestone note: if this file changes, update this header and module README.md.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHandler ¶
func NewHandler(configPath, version string, opts ...HandlerOption) (http.Handler, error)
NewHandler returns the JSON HTTP adapter for DeltaScope.
Types ¶
type AuthConfig ¶ added in v0.10.0
AuthConfig controls API-key authentication on the HTTP adapter.
type HandlerOption ¶ added in v0.10.0
type HandlerOption func(*handlerOptions)
HandlerOption configures NewHandler behavior.
func WithAuditFunc ¶ added in v0.10.0
func WithAuditFunc(fn func(context.Context, deltascope.Request) (deltascope.Result, error)) HandlerOption
WithAuditFunc overrides the audit execution function (primarily for tests).
func WithAuthConfig ¶ added in v0.10.0
func WithAuthConfig(cfg AuthConfig) HandlerOption
WithAuthConfig enables API-key authentication on selected routes.
func WithMiddlewareConfig ¶ added in v0.10.0
func WithMiddlewareConfig(cfg MiddlewareConfig) HandlerOption
WithMiddlewareConfig overrides default middleware settings.
type MiddlewareConfig ¶ added in v0.10.0
type MiddlewareConfig struct {
RequestTimeout time.Duration
Logger *log.Logger
RateLimit RateLimitConfig
MetricsEnabled *bool
TrustedProxies []string
}
MiddlewareConfig controls default middleware behavior.
Source Files