api

type Auth struct {
	// Type is `bearer`.
	Type string `yaml:"type"`

	// KeysFrom names the ENVIRONMENT VARIABLE holding the key list -- one
	// `<sha256 of the key, hex>=<tenant>` per line. The file is in git, and
	// the variable holds no key either: a hash is what lets an environment
	// dump, a CI log or a `kubectl describe` show this variable without
	// handing anybody a way in.
	KeysFrom string `yaml:"keys_from"`
}

type ByteSize int64

type CacheConfig struct {
	Type     string        `yaml:"type"`
	AddrFrom string        `yaml:"addr_from"`
	TTL      time.Duration `yaml:"ttl"`
	MaxEntry ByteSize      `yaml:"max_entry"`
}

type Config struct {
	Name       string `yaml:"name"`
	Connection string `yaml:"connection"`

	// ConnectionID is where the connection reaches, from the registry: part
	// of every cache key, so two deployments' answers never meet.
	ConnectionID string `yaml:"-"`

	// Timezone is the IANA zone `period` resolves in. UTC when absent.
	Timezone  string      `yaml:"timezone"`
	Listen    Listen      `yaml:"listen"`
	Endpoints []*Endpoint `yaml:"endpoints"`

	// Params are definitions an endpoint's parameter can name with `ref`.
	Params map[string]Param `yaml:"params"`

	// Limits bound every request; see Limits.
	Limits Limits `yaml:"limits"`

	// Cache keeps answers until a model they read is rebuilt. Absent, every
	// request reads the warehouse.
	Cache *CacheConfig `yaml:"cache"`

	// CacheKV is where the cache is kept; nil opens Cache.AddrFrom.
	CacheKV cache.KV `yaml:"-"`

	// Dialect and Open are the connection's, resolved from the registry at
	// load: a file naming a connection nobody declared is refused there,
	// not at the first request.
	Dialect dialect.Dialect                             `yaml:"-"`
	Open    func(context.Context) (dialect.Conn, error) `yaml:"-"`

	// MaxRows is the file-wide row ceiling.
	MaxRows int `yaml:"-"`

	// Metrics is where the Prometheus exposition listens.
	Metrics struct {
		Addr string `yaml:"addr"`
	} `yaml:"metrics"`

	// Audit receives one JSON line per request. Nil writes none.
	Audit io.Writer `yaml:"-"`

	// Env is BREVIS_ENV, read by the binary and never from the file: a file
	// that could declare itself local would be a file that turns off
	// authentication.
	Env string `yaml:"-"`
}

type Endpoint struct {
	Name    string           `yaml:"name"`
	Path    string           `yaml:"path"`
	Params  map[string]Param `yaml:"params"`
	SQL     string           `yaml:"sql"`
	SQLFile string           `yaml:"sql_file"`

	// Limits are this endpoint's, each at most the file's.
	Limits *Limits `yaml:"limits"`

	// Tenant is `none` for an endpoint whose data is the same for every
	// tenant. Absent, the SQL must use `{{ tenant }}`.
	Tenant string `yaml:"tenant"`

	// MaxRows is this endpoint's ceiling; zero takes the file's.
	MaxRows int `yaml:"-"`

	Template *render.Template `yaml:"-"`
	// contains filtered or unexported fields
}

type Limits struct {
	Timeout        time.Duration `yaml:"timeout"`
	MaxRows        int           `yaml:"max_rows"`
	MaxBytesBilled ByteSize      `yaml:"max_bytes_billed"`

	// MaxResponseBytes bounds one answer's JSON. max_rows bounds how many
	// rows; this bounds how wide they are, which nothing did.
	MaxResponseBytes ByteSize `yaml:"max_response_bytes"`

	// MaxInFlight is how many requests the whole API may have waiting on
	// the warehouse at once -- each holds a connection. File-wide only.
	MaxInFlight int `yaml:"max_in_flight"`
}

type Listen struct {
	Addr string `yaml:"addr"`
	Auth *Auth  `yaml:"auth"`
}

type Manifest struct {
	Version    int                `json:"version"`
	Kind       string             `json:"kind"`
	Name       string             `json:"name"`
	Connection string             `json:"connection"`
	Dialect    string             `json:"dialect"`
	Cache      *ManifestCache     `json:"cache,omitempty"`
	Endpoints  []ManifestEndpoint `json:"endpoints"`
	Notes      map[string]string  `json:"notes,omitempty"`
}

type ManifestCache struct {
	Type     string `json:"type"`
	AddrFrom string `json:"addr_from"`
	TTL      string `json:"ttl"`
	MaxEntry int64  `json:"max_entry"`
}

type ManifestEndpoint struct {
	Name   string            `json:"name"`
	Path   string            `json:"path"`
	Tenant string            `json:"tenant"`
	Params []ManifestParam   `json:"params"`
	Limits ManifestLimits    `json:"limits"`
	Reads  []string          `json:"reads"`
	Notes  map[string]string `json:"notes,omitempty"`
}

type ManifestLimits struct {
	Timeout        string `json:"timeout"`
	MaxRows        int    `json:"max_rows"`
	MaxBytesBilled int64  `json:"max_bytes_billed"`
}

type ManifestParam struct {
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Default  *string  `json:"default,omitempty"`
	Required bool     `json:"required,omitempty"`
	Values   []string `json:"values,omitempty"`
	Min      *int64   `json:"min,omitempty"`
	Max      *int64   `json:"max,omitempty"`
	MaxLen   int      `json:"max_len,omitempty"`
}

type Param struct {
	Type string `yaml:"type"`

	// MaxLen bounds a string, in characters. Required for one.
	MaxLen int `yaml:"max_len"`

	// Min and Max bound an int.
	Min *int64 `yaml:"min"`
	Max *int64 `yaml:"max"`

	// Values are an enum's, each an identifier: an enum is the one value
	// written into the SQL text, and an identifier is what makes that safe.
	Values []string `yaml:"values"`

	// Default stands in for an omitted value, and is parsed exactly as a
	// sent one is -- so a default its own type cannot hold is refused at
	// load.
	Default *string `yaml:"default"`

	// Required refuses a request that omits the parameter.
	Required bool `yaml:"required"`

	// Ref names a definition in the file's `params:`, and takes nothing
	// else.
	Ref string `yaml:"ref"`
}

type Server struct {
	// contains filtered or unexported fields
}