api

Documentation

Overview

Package api exposes read-only JSON endpoints for dashboards and automation.

Index

• func NewHandler(store Store, m *metrics.Metrics, logger *slog.Logger, defaults Config) http.Handler
• type Config
• type Store

Functions

func NewHandler

func NewHandler(store Store, m *metrics.Metrics, logger *slog.Logger, defaults Config) http.Handler

NewHandler returns the API routes. HTTP server timeouts are the caller's responsibility.

Types

type Config

type Config struct {
	DefaultTenantID    string
	DefaultAccountID   string
	DefaultWindowDays  int
	MinObservationDays int
	AuthToken          string
}

Config supplies query defaults when request parameters are omitted.

type Store

type Store interface {
	Ping(context.Context) error
	QueryPermissionUsage(context.Context, storage.UsageQuery) ([]storage.PermissionUsage, error)
	GetCollectorCoverage(context.Context, time.Time) (storage.CollectorCoverage, error)
	LatestIAMSnapshot(context.Context, string) (storage.IAMSnapshot, bool, error)
}

Store is the storage surface used by the query API.