busbar

package module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Jul 19, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

README

busbar-go (Go SDK)

A typed Go client for the Busbar Admin API (/api/v1/admin).

Generated from the typed OpenAPI 3.1 schema in openapi.json with oapi-codegen v2, so every response is a real struct (InfoView, TopologyInfo, ...) — not interface{}/json.RawMessage.

import busbar "github.com/GetBusbar/busbar-go"

Versioning

The SDK carries its own semantic version, independent of the busbar server / OpenAPI info.version (currently 1.4.0). This first cut is tagged v0.1.0. It targets the frozen, additive-only /api/v1/admin surface.

Go modules publish via git tags — there is no registry token. go get fetches straight from this repo:

go get github.com/GetBusbar/busbar-go@v0.1.0

Usage

The admin API authenticates with an x-admin-token header. Attach it with a request editor, then call GET /info (see examples/info):

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"

	busbar "github.com/GetBusbar/busbar-go"
)

func main() {
	client, err := busbar.NewClientWithResponses(
		"http://localhost:8081",
		busbar.WithRequestEditorFn(func(_ context.Context, req *http.Request) error {
			req.Header.Set("x-admin-token", "YOUR_ADMIN_TOKEN")
			return nil
		}),
	)
	if err != nil {
		log.Fatal(err)
	}

	resp, err := client.GetApiV1AdminInfoWithResponse(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	if resp.JSON200 == nil {
		log.Fatalf("status %d: %s", resp.StatusCode(), resp.Body)
	}

	// resp.JSON200 is *InfoView — TYPED. .Version is string, .Topology is a struct.
	info := resp.JSON200
	fmt.Println("busbar version:", info.Version)        // -> "1.4.0"
	fmt.Println("pools:", info.Topology.Pools)
	fmt.Println("config version:", info.ConfigVersion)
}

Prefer Authorization: Bearer? Set req.Header.Set("Authorization", "Bearer YOUR_ADMIN_TOKEN") instead — the admin API accepts either.

Regenerating the client

The committed client (client.gen.go) is generated from openapi.json. To re-derive it:

make generate     # runs the pinned oapi-codegen via go run

The generator version is pinned in go.mod (via tools.go). CI regenerates on every PR/push and fails if the committed client drifts (git diff --exit-code).

License

Apache-2.0 © Busbar, Inc.

Documentation

Overview

Package busbar provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package busbar is the Go SDK for the Busbar admin API, generated from the typed OpenAPI 3.1 schema in openapi.json.

Regenerate the client with: make generate

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDeleteApiV1AdminHooksNameRequest

func NewDeleteApiV1AdminHooksNameRequest(server string, name string, params *DeleteApiV1AdminHooksNameParams) (*http.Request, error)

NewDeleteApiV1AdminHooksNameRequest constructs an http.Request for the DeleteApiV1AdminHooksName method

func NewDeleteApiV1AdminKeysIdRequest

func NewDeleteApiV1AdminKeysIdRequest(server string, id string, params *DeleteApiV1AdminKeysIdParams) (*http.Request, error)

NewDeleteApiV1AdminKeysIdRequest constructs an http.Request for the DeleteApiV1AdminKeysId method

func NewGetApiV1AdminAdminAuthRequest

func NewGetApiV1AdminAdminAuthRequest(server string) (*http.Request, error)

NewGetApiV1AdminAdminAuthRequest constructs an http.Request for the GetApiV1AdminAdminAuth method

func NewGetApiV1AdminAuditRequest

func NewGetApiV1AdminAuditRequest(server string, params *GetApiV1AdminAuditParams) (*http.Request, error)

NewGetApiV1AdminAuditRequest constructs an http.Request for the GetApiV1AdminAudit method

func NewGetApiV1AdminAuthRequest

func NewGetApiV1AdminAuthRequest(server string) (*http.Request, error)

NewGetApiV1AdminAuthRequest constructs an http.Request for the GetApiV1AdminAuth method

func NewGetApiV1AdminConfigDiffRequest

func NewGetApiV1AdminConfigDiffRequest(server string, params *GetApiV1AdminConfigDiffParams) (*http.Request, error)

NewGetApiV1AdminConfigDiffRequest constructs an http.Request for the GetApiV1AdminConfigDiff method

func NewGetApiV1AdminConfigRequest

func NewGetApiV1AdminConfigRequest(server string) (*http.Request, error)

NewGetApiV1AdminConfigRequest constructs an http.Request for the GetApiV1AdminConfig method

func NewGetApiV1AdminConfigVersionsRequest

func NewGetApiV1AdminConfigVersionsRequest(server string, params *GetApiV1AdminConfigVersionsParams) (*http.Request, error)

NewGetApiV1AdminConfigVersionsRequest constructs an http.Request for the GetApiV1AdminConfigVersions method

func NewGetApiV1AdminConfigVersionsVRequest

func NewGetApiV1AdminConfigVersionsVRequest(server string, v int) (*http.Request, error)

NewGetApiV1AdminConfigVersionsVRequest constructs an http.Request for the GetApiV1AdminConfigVersionsV method

func NewGetApiV1AdminHooksNameHealthRequest

func NewGetApiV1AdminHooksNameHealthRequest(server string, name string) (*http.Request, error)

NewGetApiV1AdminHooksNameHealthRequest constructs an http.Request for the GetApiV1AdminHooksNameHealth method

func NewGetApiV1AdminHooksNameRequest

func NewGetApiV1AdminHooksNameRequest(server string, name string) (*http.Request, error)

NewGetApiV1AdminHooksNameRequest constructs an http.Request for the GetApiV1AdminHooksName method

func NewGetApiV1AdminHooksNameSchemaRequest

func NewGetApiV1AdminHooksNameSchemaRequest(server string, name string) (*http.Request, error)

NewGetApiV1AdminHooksNameSchemaRequest constructs an http.Request for the GetApiV1AdminHooksNameSchema method

func NewGetApiV1AdminHooksNameStatusRequest

func NewGetApiV1AdminHooksNameStatusRequest(server string, name string) (*http.Request, error)

NewGetApiV1AdminHooksNameStatusRequest constructs an http.Request for the GetApiV1AdminHooksNameStatus method

func NewGetApiV1AdminHooksRequest

func NewGetApiV1AdminHooksRequest(server string) (*http.Request, error)

NewGetApiV1AdminHooksRequest constructs an http.Request for the GetApiV1AdminHooks method

func NewGetApiV1AdminInfoRequest

func NewGetApiV1AdminInfoRequest(server string) (*http.Request, error)

NewGetApiV1AdminInfoRequest constructs an http.Request for the GetApiV1AdminInfo method

func NewGetApiV1AdminKeysIdRequest

func NewGetApiV1AdminKeysIdRequest(server string, id string) (*http.Request, error)

NewGetApiV1AdminKeysIdRequest constructs an http.Request for the GetApiV1AdminKeysId method

func NewGetApiV1AdminKeysIdUsageRequest

func NewGetApiV1AdminKeysIdUsageRequest(server string, id string) (*http.Request, error)

NewGetApiV1AdminKeysIdUsageRequest constructs an http.Request for the GetApiV1AdminKeysIdUsage method

func NewGetApiV1AdminKeysRequest

func NewGetApiV1AdminKeysRequest(server string, params *GetApiV1AdminKeysParams) (*http.Request, error)

NewGetApiV1AdminKeysRequest constructs an http.Request for the GetApiV1AdminKeys method

func NewGetApiV1AdminModelsRequest

func NewGetApiV1AdminModelsRequest(server string) (*http.Request, error)

NewGetApiV1AdminModelsRequest constructs an http.Request for the GetApiV1AdminModels method

func NewGetApiV1AdminOpenapiJsonRequest

func NewGetApiV1AdminOpenapiJsonRequest(server string) (*http.Request, error)

NewGetApiV1AdminOpenapiJsonRequest constructs an http.Request for the GetApiV1AdminOpenapiJson method

func NewGetApiV1AdminPluginsRequest

func NewGetApiV1AdminPluginsRequest(server string, params *GetApiV1AdminPluginsParams) (*http.Request, error)

NewGetApiV1AdminPluginsRequest constructs an http.Request for the GetApiV1AdminPlugins method

func NewGetApiV1AdminPoolsNameRequest

func NewGetApiV1AdminPoolsNameRequest(server string, name string) (*http.Request, error)

NewGetApiV1AdminPoolsNameRequest constructs an http.Request for the GetApiV1AdminPoolsName method

func NewGetApiV1AdminPoolsRequest

func NewGetApiV1AdminPoolsRequest(server string, params *GetApiV1AdminPoolsParams) (*http.Request, error)

NewGetApiV1AdminPoolsRequest constructs an http.Request for the GetApiV1AdminPools method

func NewGetApiV1AdminProvidersRequest

func NewGetApiV1AdminProvidersRequest(server string) (*http.Request, error)

NewGetApiV1AdminProvidersRequest constructs an http.Request for the GetApiV1AdminProviders method

func NewGetApiV1AdminUsageRequest

func NewGetApiV1AdminUsageRequest(server string, params *GetApiV1AdminUsageParams) (*http.Request, error)

NewGetApiV1AdminUsageRequest constructs an http.Request for the GetApiV1AdminUsage method

func NewPatchApiV1AdminHooksNameSettingsRequest

func NewPatchApiV1AdminHooksNameSettingsRequest(server string, name string, params *PatchApiV1AdminHooksNameSettingsParams) (*http.Request, error)

NewPatchApiV1AdminHooksNameSettingsRequest constructs an http.Request for the PatchApiV1AdminHooksNameSettings method

func NewPatchApiV1AdminKeysIdRequest

func NewPatchApiV1AdminKeysIdRequest(server string, id string, params *PatchApiV1AdminKeysIdParams) (*http.Request, error)

NewPatchApiV1AdminKeysIdRequest constructs an http.Request for the PatchApiV1AdminKeysId method

func NewPostApiV1AdminAuthCacheFlushRequest

func NewPostApiV1AdminAuthCacheFlushRequest(server string) (*http.Request, error)

NewPostApiV1AdminAuthCacheFlushRequest constructs an http.Request for the PostApiV1AdminAuthCacheFlush method

func NewPostApiV1AdminConfigApplyRequest

func NewPostApiV1AdminConfigApplyRequest(server string, params *PostApiV1AdminConfigApplyParams) (*http.Request, error)

NewPostApiV1AdminConfigApplyRequest constructs an http.Request for the PostApiV1AdminConfigApply method

func NewPostApiV1AdminConfigReloadRequest

func NewPostApiV1AdminConfigReloadRequest(server string) (*http.Request, error)

NewPostApiV1AdminConfigReloadRequest constructs an http.Request for the PostApiV1AdminConfigReload method

func NewPostApiV1AdminConfigRollbackRequest

func NewPostApiV1AdminConfigRollbackRequest(server string, params *PostApiV1AdminConfigRollbackParams) (*http.Request, error)

NewPostApiV1AdminConfigRollbackRequest constructs an http.Request for the PostApiV1AdminConfigRollback method

func NewPostApiV1AdminConfigValidateRequest

func NewPostApiV1AdminConfigValidateRequest(server string) (*http.Request, error)

NewPostApiV1AdminConfigValidateRequest constructs an http.Request for the PostApiV1AdminConfigValidate method

func NewPostApiV1AdminHooksRequest

func NewPostApiV1AdminHooksRequest(server string, params *PostApiV1AdminHooksParams) (*http.Request, error)

NewPostApiV1AdminHooksRequest constructs an http.Request for the PostApiV1AdminHooks method

func NewPostApiV1AdminKeysIdRotateRequest

func NewPostApiV1AdminKeysIdRotateRequest(server string, id string) (*http.Request, error)

NewPostApiV1AdminKeysIdRotateRequest constructs an http.Request for the PostApiV1AdminKeysIdRotate method

func NewPostApiV1AdminKeysRequest

func NewPostApiV1AdminKeysRequest(server string) (*http.Request, error)

NewPostApiV1AdminKeysRequest constructs an http.Request for the PostApiV1AdminKeys method

func NewPutApiV1AdminAdminAuthRequest

func NewPutApiV1AdminAdminAuthRequest(server string, params *PutApiV1AdminAdminAuthParams) (*http.Request, error)

NewPutApiV1AdminAdminAuthRequest constructs an http.Request for the PutApiV1AdminAdminAuth method

func NewPutApiV1AdminHooksNameRequest

func NewPutApiV1AdminHooksNameRequest(server string, name string, params *PutApiV1AdminHooksNameParams) (*http.Request, error)

NewPutApiV1AdminHooksNameRequest constructs an http.Request for the PutApiV1AdminHooksName method

Types

type AdminAuthPutView

type AdminAuthPutView struct {
	Applied       bool     `json:"applied"`
	ConfigVersion uint64   `json:"config_version"`
	Configured    bool     `json:"configured"`
	Modules       []string `json:"modules"`
	Note          string   `json:"note"`
}

AdminAuthPutView `PUT /admin-auth` — the resource post-state (`{configured, modules}`, the same shape `GET /admin-auth` returns) plus apply metadata, so a client uses the PUT response as post-state.

type AdminAuthView

type AdminAuthView struct {
	// Configured Whether an admin credential chain is configured. `false` = the empty chain = open dev posture.
	Configured bool `json:"configured"`

	// Modules The active admin-plane guard module names — the `admin_auth` chain verbatim (e.g.
	// `["admin-tokens"]`), reported in order. Empty when the admin plane is open.
	Modules []string `json:"modules"`
}

AdminAuthView The admin-plane auth read (`GET /api/v1/admin/admin-auth`) — which modules guard the ADMIN surface (distinct from the ingress `auth` chain). `modules` is the live `admin_auth` chain (the SAME resource `PUT /api/v1/admin/admin-auth` writes), so a read-after-write is coherent. An empty chain is the open (anonymous, full-authority) dev posture — `configured: false`. Never a secret.

type AuditEntry

type AuditEntry struct {
	// Action The action, `noun.verb` (e.g. `hook.register`, `hook.delete`).
	Action string `json:"action"`

	// Hash `sha256(prev_hash | seq | ts | action | resource | outcome | principal)` — the tamper-evidence digest.
	Hash string `json:"hash"`

	// Outcome Stable outcome token: `applied` (mutation committed) | `rejected` (validation/conflict, nothing
	// changed).
	Outcome string `json:"outcome"`

	// PrevHash The preceding entry's `hash` (empty for the first entry of the process, or the oldest retained
	// entry whose predecessor was pruned).
	PrevHash string `json:"prev_hash"`

	// Principal WHO — the authenticated principal id that attempted the mutation (`admin` for the operator
	// token; a virtual-key id or an external module's principal id otherwise; `anonymous` for the
	// explicit open admin posture). Attribution, never a credential.
	Principal string `json:"principal"`

	// Resource The resource acted on (e.g. `hook:compress`). Never a secret.
	Resource string `json:"resource"`

	// Seq Monotonic sequence number (1-based), unique within a process lifetime.
	Seq uint64 `json:"seq"`

	// Ts Unix seconds when the mutation was attempted.
	Ts uint64 `json:"ts"`
}

AuditEntry One admin audit record. `outcome` is a stable token tooling can branch on. The record is HASH-CHAINED for tamper-EVIDENCE (§6.7): `hash = sha256(prev_hash | seq | ts | action | resource | outcome | principal)`, and `prev_hash` is the preceding entry's `hash`. Recomputing the chain detects any altered/reordered/deleted entry (detection, not prevention — a compromised host can still rewrite the whole chain; prevention is shipping the log off-box to a SIEM).

type AuditPageView

type AuditPageView struct {
	Items      []AuditEntry `json:"items"`
	NextCursor *string      `json:"next_cursor"`
}

AuditPageView `GET /audit` — the cursor-paginated audit-log envelope (`{items, next_cursor}`, hand-rolled in the audit handler).

type AuthView

type AuthView struct {
	// Chain Ordered auth-chain module names (`[]` = open front door).
	Chain []string `json:"chain"`

	// Open Whether the front door is open (empty chain admits unconditionally).
	Open bool `json:"open"`

	// UpstreamCredentials `"own"` (busbar signs egress with its configured key) or `"passthrough"` (forward the caller's
	// credential upstream).
	UpstreamCredentials string `json:"upstream_credentials"`
}

AuthView The ingress auth chain read (`GET /api/v1/admin/auth`): the ordered module names that authenticate callers + the upstream-credential mode. Never a secret — module names and the mode are config identifiers, not credentials. An empty `chain` is the open front door (admits every request).

type BuildInfo

type BuildInfo struct {
	// AuthModules Auth modules baked into this binary (e.g. `["tokens"]`; empty under `--no-default-features`).
	AuthModules []string `json:"auth_modules"`

	// HookPlugins Hook plugins baked into this binary (e.g. `["ranking"]`).
	HookPlugins []string `json:"hook_plugins"`

	// WeightedFloor The inline SWRR floor — ALWAYS `true` (compiled in unconditionally, non-removable).
	WeightedFloor bool `json:"weighted_floor"`
}

BuildInfo The compiled-in feature proof (`InfoView.build`).

type CacheFlushView

type CacheFlushView struct {
	Flushed uint `json:"flushed"`
}

CacheFlushView `POST /auth/cache/flush` — number of cached credential-decision entries dropped.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) DeleteApiV1AdminHooksName

func (c *Client) DeleteApiV1AdminHooksName(ctx context.Context, name string, params *DeleteApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteApiV1AdminHooksName Remove a hook at runtime — live immediately

Corresponds with DELETE /api/v1/admin/hooks/{name} (the `DeleteApiV1AdminHooksName` operationId).

func (*Client) DeleteApiV1AdminKeysId

func (c *Client) DeleteApiV1AdminKeysId(ctx context.Context, id string, params *DeleteApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteApiV1AdminKeysId Revoke a key — it stops resolving immediately. Optional `If-Match` (the key's ETag)

Corresponds with DELETE /api/v1/admin/keys/{id} (the `DeleteApiV1AdminKeysId` operationId).

func (*Client) GetApiV1AdminAdminAuth

func (c *Client) GetApiV1AdminAdminAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminAdminAuth Admin-plane auth config (the admin surface guard)

Corresponds with GET /api/v1/admin/admin-auth (the `GetApiV1AdminAdminAuth` operationId).

func (*Client) GetApiV1AdminAudit

func (c *Client) GetApiV1AdminAudit(ctx context.Context, params *GetApiV1AdminAuditParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminAudit Admin audit log — every mutation with its outcome (newest first). Page: ?limit=, ?cursor=; returns {items, next_cursor}

Corresponds with GET /api/v1/admin/audit (the `GetApiV1AdminAudit` operationId).

func (*Client) GetApiV1AdminAuth

func (c *Client) GetApiV1AdminAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminAuth Ingress auth chain + upstream-credential mode

Corresponds with GET /api/v1/admin/auth (the `GetApiV1AdminAuth` operationId).

func (*Client) GetApiV1AdminConfig

func (c *Client) GetApiV1AdminConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminConfig Effective running config snapshot (redacted)

Corresponds with GET /api/v1/admin/config (the `GetApiV1AdminConfig` operationId).

func (*Client) GetApiV1AdminConfigDiff

func (c *Client) GetApiV1AdminConfigDiff(ctx context.Context, params *GetApiV1AdminConfigDiffParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminConfigDiff Structured hook-surface diff between two retained versions

Corresponds with GET /api/v1/admin/config/diff (the `GetApiV1AdminConfigDiff` operationId).

func (*Client) GetApiV1AdminConfigVersions

func (c *Client) GetApiV1AdminConfigVersions(ctx context.Context, params *GetApiV1AdminConfigVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminConfigVersions Config version history (newest first; id/ts/principal/summary). Page: ?limit=, ?cursor=; returns {items, next_cursor}

Corresponds with GET /api/v1/admin/config/versions (the `GetApiV1AdminConfigVersions` operationId).

func (*Client) GetApiV1AdminConfigVersionsV

func (c *Client) GetApiV1AdminConfigVersionsV(ctx context.Context, v int, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminConfigVersionsV One retained config version, with its hook-surface snapshot

Corresponds with GET /api/v1/admin/config/versions/{v} (the `GetApiV1AdminConfigVersionsV` operationId).

func (*Client) GetApiV1AdminHooks

func (c *Client) GetApiV1AdminHooks(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminHooks Hook registry (definitions)

Corresponds with GET /api/v1/admin/hooks (the `GetApiV1AdminHooks` operationId).

func (*Client) GetApiV1AdminHooksName

func (c *Client) GetApiV1AdminHooksName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminHooksName One hook definition

Corresponds with GET /api/v1/admin/hooks/{name} (the `GetApiV1AdminHooksName` operationId).

func (*Client) GetApiV1AdminHooksNameHealth

func (c *Client) GetApiV1AdminHooksNameHealth(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminHooksNameHealth Best-effort hook transport reachability

Corresponds with GET /api/v1/admin/hooks/{name}/health (the `GetApiV1AdminHooksNameHealth` operationId).

func (*Client) GetApiV1AdminHooksNameSchema

func (c *Client) GetApiV1AdminHooksNameSchema(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminHooksNameSchema The hook's self-described settings JSON Schema (describe proxy)

Corresponds with GET /api/v1/admin/hooks/{name}/schema (the `GetApiV1AdminHooksNameSchema` operationId).

func (*Client) GetApiV1AdminHooksNameStatus

func (c *Client) GetApiV1AdminHooksNameStatus(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminHooksNameStatus The hook's OBSERVED state, live-queried: running settings + version (vs busbar's desired copy, with a drift verdict) and self-reported metrics. reported=null when the hook doesn't answer (fail-open)

Corresponds with GET /api/v1/admin/hooks/{name}/status (the `GetApiV1AdminHooksNameStatus` operationId).

func (*Client) GetApiV1AdminInfo

func (c *Client) GetApiV1AdminInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminInfo Version, compiled-in plugin proof, uptime, topology

Corresponds with GET /api/v1/admin/info (the `GetApiV1AdminInfo` operationId).

func (*Client) GetApiV1AdminKeys

func (c *Client) GetApiV1AdminKeys(ctx context.Context, params *GetApiV1AdminKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminKeys List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=. Paginate: ?limit=, ?cursor= (opaque)

Corresponds with GET /api/v1/admin/keys (the `GetApiV1AdminKeys` operationId).

func (*Client) GetApiV1AdminKeysId

func (c *Client) GetApiV1AdminKeysId(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminKeysId One key's metadata + `ETag` (never the secret/hash)

Corresponds with GET /api/v1/admin/keys/{id} (the `GetApiV1AdminKeysId` operationId).

func (*Client) GetApiV1AdminKeysIdUsage

func (c *Client) GetApiV1AdminKeysIdUsage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminKeysIdUsage Current-window usage for one key (spend / tokens / requests)

Corresponds with GET /api/v1/admin/keys/{id}/usage (the `GetApiV1AdminKeysIdUsage` operationId).

func (*Client) GetApiV1AdminModels

func (c *Client) GetApiV1AdminModels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminModels Model lanes + upstream providers

Corresponds with GET /api/v1/admin/models (the `GetApiV1AdminModels` operationId).

func (*Client) GetApiV1AdminOpenapiJson

func (c *Client) GetApiV1AdminOpenapiJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminOpenapiJson This OpenAPI 3.1 document

Corresponds with GET /api/v1/admin/openapi.json (the `GetApiV1AdminOpenapiJson` operationId).

func (*Client) GetApiV1AdminPlugins

func (c *Client) GetApiV1AdminPlugins(ctx context.Context, params *GetApiV1AdminPluginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminPlugins Plugin catalog by type (compiled-in + external)

Corresponds with GET /api/v1/admin/plugins (the `GetApiV1AdminPlugins` operationId).

func (*Client) GetApiV1AdminPools

func (c *Client) GetApiV1AdminPools(ctx context.Context, params *GetApiV1AdminPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminPools Pool topology (members + weights). ?detail=true inlines live member status (one call, no N+1)

Corresponds with GET /api/v1/admin/pools (the `GetApiV1AdminPools` operationId).

func (*Client) GetApiV1AdminPoolsName

func (c *Client) GetApiV1AdminPoolsName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminPoolsName Live per-member status of one pool (breaker/concurrency/latency)

Corresponds with GET /api/v1/admin/pools/{name} (the `GetApiV1AdminPoolsName` operationId).

func (*Client) GetApiV1AdminProviders

func (c *Client) GetApiV1AdminProviders(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminProviders Distinct providers + lane counts

Corresponds with GET /api/v1/admin/providers (the `GetApiV1AdminProviders` operationId).

func (*Client) GetApiV1AdminUsage

func (c *Client) GetApiV1AdminUsage(ctx context.Context, params *GetApiV1AdminUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetApiV1AdminUsage Metering: current UTC-day bucket — {window, as_of, currency, total, by_model, by_key}, raw token split + derived spend_micros

Corresponds with GET /api/v1/admin/usage (the `GetApiV1AdminUsage` operationId).

func (*Client) PatchApiV1AdminHooksNameSettings

func (c *Client) PatchApiV1AdminHooksNameSettings(ctx context.Context, name string, params *PatchApiV1AdminHooksNameSettingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchApiV1AdminHooksNameSettings Push an opaque settings map to the running hook; COMMIT ON ACK

Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchApiV1AdminHooksNameSettings` operationId).

func (*Client) PatchApiV1AdminKeysId

func (c *Client) PatchApiV1AdminKeysId(ctx context.Context, id string, params *PatchApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchApiV1AdminKeysId Update budget / rate / enabled. Optional `If-Match` for optimistic concurrency

Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchApiV1AdminKeysId` operationId).

func (*Client) PostApiV1AdminAuthCacheFlush

func (c *Client) PostApiV1AdminAuthCacheFlush(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminAuthCacheFlush Flush the credential cache — one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window

Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostApiV1AdminAuthCacheFlush` operationId).

func (*Client) PostApiV1AdminConfigApply

func (c *Client) PostApiV1AdminConfigApply(ctx context.Context, params *PostApiV1AdminConfigApplyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminConfigApply Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)

Corresponds with POST /api/v1/admin/config/apply (the `PostApiV1AdminConfigApply` operationId).

func (*Client) PostApiV1AdminConfigReload

func (c *Client) PostApiV1AdminConfigReload(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminConfigReload Re-read config.yaml/providers.yaml from disk and apply atomically (health state preserved by lane identity)

Corresponds with POST /api/v1/admin/config/reload (the `PostApiV1AdminConfigReload` operationId).

func (*Client) PostApiV1AdminConfigRollback

func (c *Client) PostApiV1AdminConfigRollback(ctx context.Context, params *PostApiV1AdminConfigRollbackParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminConfigRollback Restore a retained version's hook surface (re-validated; a NEW version)

Corresponds with POST /api/v1/admin/config/rollback (the `PostApiV1AdminConfigRollback` operationId).

func (*Client) PostApiV1AdminConfigValidate

func (c *Client) PostApiV1AdminConfigValidate(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminConfigValidate Dry-run validate a proposed config

Corresponds with POST /api/v1/admin/config/validate (the `PostApiV1AdminConfigValidate` operationId).

func (*Client) PostApiV1AdminHooks

func (c *Client) PostApiV1AdminHooks(ctx context.Context, params *PostApiV1AdminHooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminHooks Register (or replace) a hook at runtime — live immediately

Corresponds with POST /api/v1/admin/hooks (the `PostApiV1AdminHooks` operationId).

func (*Client) PostApiV1AdminKeys

func (c *Client) PostApiV1AdminKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminKeys Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)

Corresponds with POST /api/v1/admin/keys (the `PostApiV1AdminKeys` operationId).

func (*Client) PostApiV1AdminKeysIdRotate

func (c *Client) PostApiV1AdminKeysIdRotate(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

PostApiV1AdminKeysIdRotate Mint a fresh secret in place (same id, budgets, usage). The new secret is shown once; the old stops resolving. Honors an `Idempotency-Key` header (per-principal, op+id-scoped, ~10min replay)

Corresponds with POST /api/v1/admin/keys/{id}/rotate (the `PostApiV1AdminKeysIdRotate` operationId).

func (*Client) PutApiV1AdminAdminAuth

func (c *Client) PutApiV1AdminAdminAuth(ctx context.Context, params *PutApiV1AdminAdminAuthParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PutApiV1AdminAdminAuth Replace the admin_auth chain at runtime — dry-run guarded (the calling credentials must hold full scope under the NEW chain, else 409). Live until the next reload/restart

Corresponds with PUT /api/v1/admin/admin-auth (the `PutApiV1AdminAdminAuth` operationId).

func (*Client) PutApiV1AdminHooksName

func (c *Client) PutApiV1AdminHooksName(ctx context.Context, name string, params *PutApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

PutApiV1AdminHooksName Replace an overlay hook definition — live immediately (grants immutable)

Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutApiV1AdminHooksName` operationId).

type ClientInterface

type ClientInterface interface {

	// GetApiV1AdminAdminAuth Admin-plane auth config (the admin surface guard)
	//
	// Corresponds with GET /api/v1/admin/admin-auth (the `GetApiV1AdminAdminAuth` operationId).
	GetApiV1AdminAdminAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiV1AdminAdminAuth Replace the admin_auth chain at runtime — dry-run guarded (the calling credentials must hold full scope under the NEW chain, else 409). Live until the next reload/restart
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutApiV1AdminAdminAuth` operationId).
	PutApiV1AdminAdminAuth(ctx context.Context, params *PutApiV1AdminAdminAuthParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminAudit Admin audit log — every mutation with its outcome (newest first). Page: ?limit=, ?cursor=; returns {items, next_cursor}
	//
	// Corresponds with GET /api/v1/admin/audit (the `GetApiV1AdminAudit` operationId).
	GetApiV1AdminAudit(ctx context.Context, params *GetApiV1AdminAuditParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminAuth Ingress auth chain + upstream-credential mode
	//
	// Corresponds with GET /api/v1/admin/auth (the `GetApiV1AdminAuth` operationId).
	GetApiV1AdminAuth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminAuthCacheFlush Flush the credential cache — one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window
	//
	// Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostApiV1AdminAuthCacheFlush` operationId).
	PostApiV1AdminAuthCacheFlush(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminConfig Effective running config snapshot (redacted)
	//
	// Corresponds with GET /api/v1/admin/config (the `GetApiV1AdminConfig` operationId).
	GetApiV1AdminConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminConfigApply Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)
	//
	// Corresponds with POST /api/v1/admin/config/apply (the `PostApiV1AdminConfigApply` operationId).
	PostApiV1AdminConfigApply(ctx context.Context, params *PostApiV1AdminConfigApplyParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminConfigDiff Structured hook-surface diff between two retained versions
	//
	// Corresponds with GET /api/v1/admin/config/diff (the `GetApiV1AdminConfigDiff` operationId).
	GetApiV1AdminConfigDiff(ctx context.Context, params *GetApiV1AdminConfigDiffParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminConfigReload Re-read config.yaml/providers.yaml from disk and apply atomically (health state preserved by lane identity)
	//
	// Corresponds with POST /api/v1/admin/config/reload (the `PostApiV1AdminConfigReload` operationId).
	PostApiV1AdminConfigReload(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminConfigRollback Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostApiV1AdminConfigRollback` operationId).
	PostApiV1AdminConfigRollback(ctx context.Context, params *PostApiV1AdminConfigRollbackParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminConfigValidate Dry-run validate a proposed config
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostApiV1AdminConfigValidate` operationId).
	PostApiV1AdminConfigValidate(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminConfigVersions Config version history (newest first; id/ts/principal/summary). Page: ?limit=, ?cursor=; returns {items, next_cursor}
	//
	// Corresponds with GET /api/v1/admin/config/versions (the `GetApiV1AdminConfigVersions` operationId).
	GetApiV1AdminConfigVersions(ctx context.Context, params *GetApiV1AdminConfigVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminConfigVersionsV One retained config version, with its hook-surface snapshot
	//
	// Corresponds with GET /api/v1/admin/config/versions/{v} (the `GetApiV1AdminConfigVersionsV` operationId).
	GetApiV1AdminConfigVersionsV(ctx context.Context, v int, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminHooks Hook registry (definitions)
	//
	// Corresponds with GET /api/v1/admin/hooks (the `GetApiV1AdminHooks` operationId).
	GetApiV1AdminHooks(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminHooks Register (or replace) a hook at runtime — live immediately
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostApiV1AdminHooks` operationId).
	PostApiV1AdminHooks(ctx context.Context, params *PostApiV1AdminHooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiV1AdminHooksName Remove a hook at runtime — live immediately
	//
	// Corresponds with DELETE /api/v1/admin/hooks/{name} (the `DeleteApiV1AdminHooksName` operationId).
	DeleteApiV1AdminHooksName(ctx context.Context, name string, params *DeleteApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminHooksName One hook definition
	//
	// Corresponds with GET /api/v1/admin/hooks/{name} (the `GetApiV1AdminHooksName` operationId).
	GetApiV1AdminHooksName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiV1AdminHooksName Replace an overlay hook definition — live immediately (grants immutable)
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutApiV1AdminHooksName` operationId).
	PutApiV1AdminHooksName(ctx context.Context, name string, params *PutApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminHooksNameHealth Best-effort hook transport reachability
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/health (the `GetApiV1AdminHooksNameHealth` operationId).
	GetApiV1AdminHooksNameHealth(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminHooksNameSchema The hook's self-described settings JSON Schema (describe proxy)
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/schema (the `GetApiV1AdminHooksNameSchema` operationId).
	GetApiV1AdminHooksNameSchema(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchApiV1AdminHooksNameSettings Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchApiV1AdminHooksNameSettings` operationId).
	PatchApiV1AdminHooksNameSettings(ctx context.Context, name string, params *PatchApiV1AdminHooksNameSettingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminHooksNameStatus The hook's OBSERVED state, live-queried: running settings + version (vs busbar's desired copy, with a drift verdict) and self-reported metrics. reported=null when the hook doesn't answer (fail-open)
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/status (the `GetApiV1AdminHooksNameStatus` operationId).
	GetApiV1AdminHooksNameStatus(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminInfo Version, compiled-in plugin proof, uptime, topology
	//
	// Corresponds with GET /api/v1/admin/info (the `GetApiV1AdminInfo` operationId).
	GetApiV1AdminInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminKeys List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=. Paginate: ?limit=, ?cursor= (opaque)
	//
	// Corresponds with GET /api/v1/admin/keys (the `GetApiV1AdminKeys` operationId).
	GetApiV1AdminKeys(ctx context.Context, params *GetApiV1AdminKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminKeys Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)
	//
	// Corresponds with POST /api/v1/admin/keys (the `PostApiV1AdminKeys` operationId).
	PostApiV1AdminKeys(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiV1AdminKeysId Revoke a key — it stops resolving immediately. Optional `If-Match` (the key's ETag)
	//
	// Corresponds with DELETE /api/v1/admin/keys/{id} (the `DeleteApiV1AdminKeysId` operationId).
	DeleteApiV1AdminKeysId(ctx context.Context, id string, params *DeleteApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminKeysId One key's metadata + `ETag` (never the secret/hash)
	//
	// Corresponds with GET /api/v1/admin/keys/{id} (the `GetApiV1AdminKeysId` operationId).
	GetApiV1AdminKeysId(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchApiV1AdminKeysId Update budget / rate / enabled. Optional `If-Match` for optimistic concurrency
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchApiV1AdminKeysId` operationId).
	PatchApiV1AdminKeysId(ctx context.Context, id string, params *PatchApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiV1AdminKeysIdRotate Mint a fresh secret in place (same id, budgets, usage). The new secret is shown once; the old stops resolving. Honors an `Idempotency-Key` header (per-principal, op+id-scoped, ~10min replay)
	//
	// Corresponds with POST /api/v1/admin/keys/{id}/rotate (the `PostApiV1AdminKeysIdRotate` operationId).
	PostApiV1AdminKeysIdRotate(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminKeysIdUsage Current-window usage for one key (spend / tokens / requests)
	//
	// Corresponds with GET /api/v1/admin/keys/{id}/usage (the `GetApiV1AdminKeysIdUsage` operationId).
	GetApiV1AdminKeysIdUsage(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminModels Model lanes + upstream providers
	//
	// Corresponds with GET /api/v1/admin/models (the `GetApiV1AdminModels` operationId).
	GetApiV1AdminModels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminOpenapiJson This OpenAPI 3.1 document
	//
	// Corresponds with GET /api/v1/admin/openapi.json (the `GetApiV1AdminOpenapiJson` operationId).
	GetApiV1AdminOpenapiJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminPlugins Plugin catalog by type (compiled-in + external)
	//
	// Corresponds with GET /api/v1/admin/plugins (the `GetApiV1AdminPlugins` operationId).
	GetApiV1AdminPlugins(ctx context.Context, params *GetApiV1AdminPluginsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminPools Pool topology (members + weights). ?detail=true inlines live member status (one call, no N+1)
	//
	// Corresponds with GET /api/v1/admin/pools (the `GetApiV1AdminPools` operationId).
	GetApiV1AdminPools(ctx context.Context, params *GetApiV1AdminPoolsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminPoolsName Live per-member status of one pool (breaker/concurrency/latency)
	//
	// Corresponds with GET /api/v1/admin/pools/{name} (the `GetApiV1AdminPoolsName` operationId).
	GetApiV1AdminPoolsName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminProviders Distinct providers + lane counts
	//
	// Corresponds with GET /api/v1/admin/providers (the `GetApiV1AdminProviders` operationId).
	GetApiV1AdminProviders(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AdminUsage Metering: current UTC-day bucket — {window, as_of, currency, total, by_model, by_key}, raw token split + derived spend_micros
	//
	// Corresponds with GET /api/v1/admin/usage (the `GetApiV1AdminUsage` operationId).
	GetApiV1AdminUsage(ctx context.Context, params *GetApiV1AdminUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteApiV1AdminHooksNameWithResponse

func (c *ClientWithResponses) DeleteApiV1AdminHooksNameWithResponse(ctx context.Context, name string, params *DeleteApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*DeleteApiV1AdminHooksNameResponse, error)

DeleteApiV1AdminHooksNameWithResponse Remove a hook at runtime — live immediately

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/v1/admin/hooks/{name} (the `DeleteApiV1AdminHooksName` operationId).

func (*ClientWithResponses) DeleteApiV1AdminKeysIdWithResponse

func (c *ClientWithResponses) DeleteApiV1AdminKeysIdWithResponse(ctx context.Context, id string, params *DeleteApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*DeleteApiV1AdminKeysIdResponse, error)

DeleteApiV1AdminKeysIdWithResponse Revoke a key — it stops resolving immediately. Optional `If-Match` (the key's ETag)

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/v1/admin/keys/{id} (the `DeleteApiV1AdminKeysId` operationId).

func (*ClientWithResponses) GetApiV1AdminAdminAuthWithResponse

func (c *ClientWithResponses) GetApiV1AdminAdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminAdminAuthResponse, error)

GetApiV1AdminAdminAuthWithResponse Admin-plane auth config (the admin surface guard)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/admin-auth (the `GetApiV1AdminAdminAuth` operationId).

func (*ClientWithResponses) GetApiV1AdminAuditWithResponse

func (c *ClientWithResponses) GetApiV1AdminAuditWithResponse(ctx context.Context, params *GetApiV1AdminAuditParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminAuditResponse, error)

GetApiV1AdminAuditWithResponse Admin audit log — every mutation with its outcome (newest first). Page: ?limit=, ?cursor=; returns {items, next_cursor}

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/audit (the `GetApiV1AdminAudit` operationId).

func (*ClientWithResponses) GetApiV1AdminAuthWithResponse

func (c *ClientWithResponses) GetApiV1AdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminAuthResponse, error)

GetApiV1AdminAuthWithResponse Ingress auth chain + upstream-credential mode

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/auth (the `GetApiV1AdminAuth` operationId).

func (*ClientWithResponses) GetApiV1AdminConfigDiffWithResponse

func (c *ClientWithResponses) GetApiV1AdminConfigDiffWithResponse(ctx context.Context, params *GetApiV1AdminConfigDiffParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigDiffResponse, error)

GetApiV1AdminConfigDiffWithResponse Structured hook-surface diff between two retained versions

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/config/diff (the `GetApiV1AdminConfigDiff` operationId).

func (*ClientWithResponses) GetApiV1AdminConfigVersionsVWithResponse

func (c *ClientWithResponses) GetApiV1AdminConfigVersionsVWithResponse(ctx context.Context, v int, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigVersionsVResponse, error)

GetApiV1AdminConfigVersionsVWithResponse One retained config version, with its hook-surface snapshot

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/config/versions/{v} (the `GetApiV1AdminConfigVersionsV` operationId).

func (*ClientWithResponses) GetApiV1AdminConfigVersionsWithResponse

func (c *ClientWithResponses) GetApiV1AdminConfigVersionsWithResponse(ctx context.Context, params *GetApiV1AdminConfigVersionsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigVersionsResponse, error)

GetApiV1AdminConfigVersionsWithResponse Config version history (newest first; id/ts/principal/summary). Page: ?limit=, ?cursor=; returns {items, next_cursor}

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/config/versions (the `GetApiV1AdminConfigVersions` operationId).

func (*ClientWithResponses) GetApiV1AdminConfigWithResponse

func (c *ClientWithResponses) GetApiV1AdminConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigResponse, error)

GetApiV1AdminConfigWithResponse Effective running config snapshot (redacted)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/config (the `GetApiV1AdminConfig` operationId).

func (*ClientWithResponses) GetApiV1AdminHooksNameHealthWithResponse

func (c *ClientWithResponses) GetApiV1AdminHooksNameHealthWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameHealthResponse, error)

GetApiV1AdminHooksNameHealthWithResponse Best-effort hook transport reachability

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/hooks/{name}/health (the `GetApiV1AdminHooksNameHealth` operationId).

func (*ClientWithResponses) GetApiV1AdminHooksNameSchemaWithResponse

func (c *ClientWithResponses) GetApiV1AdminHooksNameSchemaWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameSchemaResponse, error)

GetApiV1AdminHooksNameSchemaWithResponse The hook's self-described settings JSON Schema (describe proxy)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/hooks/{name}/schema (the `GetApiV1AdminHooksNameSchema` operationId).

func (*ClientWithResponses) GetApiV1AdminHooksNameStatusWithResponse

func (c *ClientWithResponses) GetApiV1AdminHooksNameStatusWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameStatusResponse, error)

GetApiV1AdminHooksNameStatusWithResponse The hook's OBSERVED state, live-queried: running settings + version (vs busbar's desired copy, with a drift verdict) and self-reported metrics. reported=null when the hook doesn't answer (fail-open)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/hooks/{name}/status (the `GetApiV1AdminHooksNameStatus` operationId).

func (*ClientWithResponses) GetApiV1AdminHooksNameWithResponse

func (c *ClientWithResponses) GetApiV1AdminHooksNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameResponse, error)

GetApiV1AdminHooksNameWithResponse One hook definition

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/hooks/{name} (the `GetApiV1AdminHooksName` operationId).

func (*ClientWithResponses) GetApiV1AdminHooksWithResponse

func (c *ClientWithResponses) GetApiV1AdminHooksWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksResponse, error)

GetApiV1AdminHooksWithResponse Hook registry (definitions)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/hooks (the `GetApiV1AdminHooks` operationId).

func (*ClientWithResponses) GetApiV1AdminInfoWithResponse

func (c *ClientWithResponses) GetApiV1AdminInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminInfoResponse, error)

GetApiV1AdminInfoWithResponse Version, compiled-in plugin proof, uptime, topology

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/info (the `GetApiV1AdminInfo` operationId).

func (*ClientWithResponses) GetApiV1AdminKeysIdUsageWithResponse

func (c *ClientWithResponses) GetApiV1AdminKeysIdUsageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysIdUsageResponse, error)

GetApiV1AdminKeysIdUsageWithResponse Current-window usage for one key (spend / tokens / requests)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/keys/{id}/usage (the `GetApiV1AdminKeysIdUsage` operationId).

func (*ClientWithResponses) GetApiV1AdminKeysIdWithResponse

func (c *ClientWithResponses) GetApiV1AdminKeysIdWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysIdResponse, error)

GetApiV1AdminKeysIdWithResponse One key's metadata + `ETag` (never the secret/hash)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/keys/{id} (the `GetApiV1AdminKeysId` operationId).

func (*ClientWithResponses) GetApiV1AdminKeysWithResponse

func (c *ClientWithResponses) GetApiV1AdminKeysWithResponse(ctx context.Context, params *GetApiV1AdminKeysParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysResponse, error)

GetApiV1AdminKeysWithResponse List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=. Paginate: ?limit=, ?cursor= (opaque)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/keys (the `GetApiV1AdminKeys` operationId).

func (*ClientWithResponses) GetApiV1AdminModelsWithResponse

func (c *ClientWithResponses) GetApiV1AdminModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminModelsResponse, error)

GetApiV1AdminModelsWithResponse Model lanes + upstream providers

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/models (the `GetApiV1AdminModels` operationId).

func (*ClientWithResponses) GetApiV1AdminOpenapiJsonWithResponse

func (c *ClientWithResponses) GetApiV1AdminOpenapiJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminOpenapiJsonResponse, error)

GetApiV1AdminOpenapiJsonWithResponse This OpenAPI 3.1 document

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/openapi.json (the `GetApiV1AdminOpenapiJson` operationId).

func (*ClientWithResponses) GetApiV1AdminPluginsWithResponse

func (c *ClientWithResponses) GetApiV1AdminPluginsWithResponse(ctx context.Context, params *GetApiV1AdminPluginsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminPluginsResponse, error)

GetApiV1AdminPluginsWithResponse Plugin catalog by type (compiled-in + external)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/plugins (the `GetApiV1AdminPlugins` operationId).

func (*ClientWithResponses) GetApiV1AdminPoolsNameWithResponse

func (c *ClientWithResponses) GetApiV1AdminPoolsNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminPoolsNameResponse, error)

GetApiV1AdminPoolsNameWithResponse Live per-member status of one pool (breaker/concurrency/latency)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/pools/{name} (the `GetApiV1AdminPoolsName` operationId).

func (*ClientWithResponses) GetApiV1AdminPoolsWithResponse

func (c *ClientWithResponses) GetApiV1AdminPoolsWithResponse(ctx context.Context, params *GetApiV1AdminPoolsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminPoolsResponse, error)

GetApiV1AdminPoolsWithResponse Pool topology (members + weights). ?detail=true inlines live member status (one call, no N+1)

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/pools (the `GetApiV1AdminPools` operationId).

func (*ClientWithResponses) GetApiV1AdminProvidersWithResponse

func (c *ClientWithResponses) GetApiV1AdminProvidersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminProvidersResponse, error)

GetApiV1AdminProvidersWithResponse Distinct providers + lane counts

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/providers (the `GetApiV1AdminProviders` operationId).

func (*ClientWithResponses) GetApiV1AdminUsageWithResponse

func (c *ClientWithResponses) GetApiV1AdminUsageWithResponse(ctx context.Context, params *GetApiV1AdminUsageParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminUsageResponse, error)

GetApiV1AdminUsageWithResponse Metering: current UTC-day bucket — {window, as_of, currency, total, by_model, by_key}, raw token split + derived spend_micros

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/admin/usage (the `GetApiV1AdminUsage` operationId).

func (*ClientWithResponses) PatchApiV1AdminHooksNameSettingsWithResponse

func (c *ClientWithResponses) PatchApiV1AdminHooksNameSettingsWithResponse(ctx context.Context, name string, params *PatchApiV1AdminHooksNameSettingsParams, reqEditors ...RequestEditorFn) (*PatchApiV1AdminHooksNameSettingsResponse, error)

PatchApiV1AdminHooksNameSettingsWithResponse Push an opaque settings map to the running hook; COMMIT ON ACK

Returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchApiV1AdminHooksNameSettings` operationId).

func (*ClientWithResponses) PatchApiV1AdminKeysIdWithResponse

func (c *ClientWithResponses) PatchApiV1AdminKeysIdWithResponse(ctx context.Context, id string, params *PatchApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*PatchApiV1AdminKeysIdResponse, error)

PatchApiV1AdminKeysIdWithResponse Update budget / rate / enabled. Optional `If-Match` for optimistic concurrency

Returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchApiV1AdminKeysId` operationId).

func (*ClientWithResponses) PostApiV1AdminAuthCacheFlushWithResponse

func (c *ClientWithResponses) PostApiV1AdminAuthCacheFlushWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminAuthCacheFlushResponse, error)

PostApiV1AdminAuthCacheFlushWithResponse Flush the credential cache — one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostApiV1AdminAuthCacheFlush` operationId).

func (*ClientWithResponses) PostApiV1AdminConfigApplyWithResponse

func (c *ClientWithResponses) PostApiV1AdminConfigApplyWithResponse(ctx context.Context, params *PostApiV1AdminConfigApplyParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigApplyResponse, error)

PostApiV1AdminConfigApplyWithResponse Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/config/apply (the `PostApiV1AdminConfigApply` operationId).

func (*ClientWithResponses) PostApiV1AdminConfigReloadWithResponse

func (c *ClientWithResponses) PostApiV1AdminConfigReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigReloadResponse, error)

PostApiV1AdminConfigReloadWithResponse Re-read config.yaml/providers.yaml from disk and apply atomically (health state preserved by lane identity)

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/config/reload (the `PostApiV1AdminConfigReload` operationId).

func (*ClientWithResponses) PostApiV1AdminConfigRollbackWithResponse

func (c *ClientWithResponses) PostApiV1AdminConfigRollbackWithResponse(ctx context.Context, params *PostApiV1AdminConfigRollbackParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigRollbackResponse, error)

PostApiV1AdminConfigRollbackWithResponse Restore a retained version's hook surface (re-validated; a NEW version)

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/config/rollback (the `PostApiV1AdminConfigRollback` operationId).

func (*ClientWithResponses) PostApiV1AdminConfigValidateWithResponse

func (c *ClientWithResponses) PostApiV1AdminConfigValidateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigValidateResponse, error)

PostApiV1AdminConfigValidateWithResponse Dry-run validate a proposed config

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/config/validate (the `PostApiV1AdminConfigValidate` operationId).

func (*ClientWithResponses) PostApiV1AdminHooksWithResponse

func (c *ClientWithResponses) PostApiV1AdminHooksWithResponse(ctx context.Context, params *PostApiV1AdminHooksParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminHooksResponse, error)

PostApiV1AdminHooksWithResponse Register (or replace) a hook at runtime — live immediately

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/hooks (the `PostApiV1AdminHooks` operationId).

func (*ClientWithResponses) PostApiV1AdminKeysIdRotateWithResponse

func (c *ClientWithResponses) PostApiV1AdminKeysIdRotateWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PostApiV1AdminKeysIdRotateResponse, error)

PostApiV1AdminKeysIdRotateWithResponse Mint a fresh secret in place (same id, budgets, usage). The new secret is shown once; the old stops resolving. Honors an `Idempotency-Key` header (per-principal, op+id-scoped, ~10min replay)

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/keys/{id}/rotate (the `PostApiV1AdminKeysIdRotate` operationId).

func (*ClientWithResponses) PostApiV1AdminKeysWithResponse

func (c *ClientWithResponses) PostApiV1AdminKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminKeysResponse, error)

PostApiV1AdminKeysWithResponse Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/keys (the `PostApiV1AdminKeys` operationId).

func (*ClientWithResponses) PutApiV1AdminAdminAuthWithResponse

func (c *ClientWithResponses) PutApiV1AdminAdminAuthWithResponse(ctx context.Context, params *PutApiV1AdminAdminAuthParams, reqEditors ...RequestEditorFn) (*PutApiV1AdminAdminAuthResponse, error)

PutApiV1AdminAdminAuthWithResponse Replace the admin_auth chain at runtime — dry-run guarded (the calling credentials must hold full scope under the NEW chain, else 409). Live until the next reload/restart

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/admin-auth (the `PutApiV1AdminAdminAuth` operationId).

func (*ClientWithResponses) PutApiV1AdminHooksNameWithResponse

func (c *ClientWithResponses) PutApiV1AdminHooksNameWithResponse(ctx context.Context, name string, params *PutApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*PutApiV1AdminHooksNameResponse, error)

PutApiV1AdminHooksNameWithResponse Replace an overlay hook definition — live immediately (grants immutable)

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutApiV1AdminHooksName` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// GetApiV1AdminAdminAuthWithResponse Admin-plane auth config (the admin surface guard)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/admin-auth (the `GetApiV1AdminAdminAuth` operationId).
	GetApiV1AdminAdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminAdminAuthResponse, error)

	// PutApiV1AdminAdminAuthWithResponse Replace the admin_auth chain at runtime — dry-run guarded (the calling credentials must hold full scope under the NEW chain, else 409). Live until the next reload/restart
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutApiV1AdminAdminAuth` operationId).
	PutApiV1AdminAdminAuthWithResponse(ctx context.Context, params *PutApiV1AdminAdminAuthParams, reqEditors ...RequestEditorFn) (*PutApiV1AdminAdminAuthResponse, error)

	// GetApiV1AdminAuditWithResponse Admin audit log — every mutation with its outcome (newest first). Page: ?limit=, ?cursor=; returns {items, next_cursor}
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/audit (the `GetApiV1AdminAudit` operationId).
	GetApiV1AdminAuditWithResponse(ctx context.Context, params *GetApiV1AdminAuditParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminAuditResponse, error)

	// GetApiV1AdminAuthWithResponse Ingress auth chain + upstream-credential mode
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/auth (the `GetApiV1AdminAuth` operationId).
	GetApiV1AdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminAuthResponse, error)

	// PostApiV1AdminAuthCacheFlushWithResponse Flush the credential cache — one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostApiV1AdminAuthCacheFlush` operationId).
	PostApiV1AdminAuthCacheFlushWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminAuthCacheFlushResponse, error)

	// GetApiV1AdminConfigWithResponse Effective running config snapshot (redacted)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/config (the `GetApiV1AdminConfig` operationId).
	GetApiV1AdminConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigResponse, error)

	// PostApiV1AdminConfigApplyWithResponse Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/apply (the `PostApiV1AdminConfigApply` operationId).
	PostApiV1AdminConfigApplyWithResponse(ctx context.Context, params *PostApiV1AdminConfigApplyParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigApplyResponse, error)

	// GetApiV1AdminConfigDiffWithResponse Structured hook-surface diff between two retained versions
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/config/diff (the `GetApiV1AdminConfigDiff` operationId).
	GetApiV1AdminConfigDiffWithResponse(ctx context.Context, params *GetApiV1AdminConfigDiffParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigDiffResponse, error)

	// PostApiV1AdminConfigReloadWithResponse Re-read config.yaml/providers.yaml from disk and apply atomically (health state preserved by lane identity)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/reload (the `PostApiV1AdminConfigReload` operationId).
	PostApiV1AdminConfigReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigReloadResponse, error)

	// PostApiV1AdminConfigRollbackWithResponse Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostApiV1AdminConfigRollback` operationId).
	PostApiV1AdminConfigRollbackWithResponse(ctx context.Context, params *PostApiV1AdminConfigRollbackParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigRollbackResponse, error)

	// PostApiV1AdminConfigValidateWithResponse Dry-run validate a proposed config
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostApiV1AdminConfigValidate` operationId).
	PostApiV1AdminConfigValidateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminConfigValidateResponse, error)

	// GetApiV1AdminConfigVersionsWithResponse Config version history (newest first; id/ts/principal/summary). Page: ?limit=, ?cursor=; returns {items, next_cursor}
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/config/versions (the `GetApiV1AdminConfigVersions` operationId).
	GetApiV1AdminConfigVersionsWithResponse(ctx context.Context, params *GetApiV1AdminConfigVersionsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigVersionsResponse, error)

	// GetApiV1AdminConfigVersionsVWithResponse One retained config version, with its hook-surface snapshot
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/config/versions/{v} (the `GetApiV1AdminConfigVersionsV` operationId).
	GetApiV1AdminConfigVersionsVWithResponse(ctx context.Context, v int, reqEditors ...RequestEditorFn) (*GetApiV1AdminConfigVersionsVResponse, error)

	// GetApiV1AdminHooksWithResponse Hook registry (definitions)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/hooks (the `GetApiV1AdminHooks` operationId).
	GetApiV1AdminHooksWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksResponse, error)

	// PostApiV1AdminHooksWithResponse Register (or replace) a hook at runtime — live immediately
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostApiV1AdminHooks` operationId).
	PostApiV1AdminHooksWithResponse(ctx context.Context, params *PostApiV1AdminHooksParams, reqEditors ...RequestEditorFn) (*PostApiV1AdminHooksResponse, error)

	// DeleteApiV1AdminHooksNameWithResponse Remove a hook at runtime — live immediately
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/hooks/{name} (the `DeleteApiV1AdminHooksName` operationId).
	DeleteApiV1AdminHooksNameWithResponse(ctx context.Context, name string, params *DeleteApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*DeleteApiV1AdminHooksNameResponse, error)

	// GetApiV1AdminHooksNameWithResponse One hook definition
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/hooks/{name} (the `GetApiV1AdminHooksName` operationId).
	GetApiV1AdminHooksNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameResponse, error)

	// PutApiV1AdminHooksNameWithResponse Replace an overlay hook definition — live immediately (grants immutable)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutApiV1AdminHooksName` operationId).
	PutApiV1AdminHooksNameWithResponse(ctx context.Context, name string, params *PutApiV1AdminHooksNameParams, reqEditors ...RequestEditorFn) (*PutApiV1AdminHooksNameResponse, error)

	// GetApiV1AdminHooksNameHealthWithResponse Best-effort hook transport reachability
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/health (the `GetApiV1AdminHooksNameHealth` operationId).
	GetApiV1AdminHooksNameHealthWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameHealthResponse, error)

	// GetApiV1AdminHooksNameSchemaWithResponse The hook's self-described settings JSON Schema (describe proxy)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/schema (the `GetApiV1AdminHooksNameSchema` operationId).
	GetApiV1AdminHooksNameSchemaWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameSchemaResponse, error)

	// PatchApiV1AdminHooksNameSettingsWithResponse Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchApiV1AdminHooksNameSettings` operationId).
	PatchApiV1AdminHooksNameSettingsWithResponse(ctx context.Context, name string, params *PatchApiV1AdminHooksNameSettingsParams, reqEditors ...RequestEditorFn) (*PatchApiV1AdminHooksNameSettingsResponse, error)

	// GetApiV1AdminHooksNameStatusWithResponse The hook's OBSERVED state, live-queried: running settings + version (vs busbar's desired copy, with a drift verdict) and self-reported metrics. reported=null when the hook doesn't answer (fail-open)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/hooks/{name}/status (the `GetApiV1AdminHooksNameStatus` operationId).
	GetApiV1AdminHooksNameStatusWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminHooksNameStatusResponse, error)

	// GetApiV1AdminInfoWithResponse Version, compiled-in plugin proof, uptime, topology
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/info (the `GetApiV1AdminInfo` operationId).
	GetApiV1AdminInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminInfoResponse, error)

	// GetApiV1AdminKeysWithResponse List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=. Paginate: ?limit=, ?cursor= (opaque)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/keys (the `GetApiV1AdminKeys` operationId).
	GetApiV1AdminKeysWithResponse(ctx context.Context, params *GetApiV1AdminKeysParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysResponse, error)

	// PostApiV1AdminKeysWithResponse Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/keys (the `PostApiV1AdminKeys` operationId).
	PostApiV1AdminKeysWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostApiV1AdminKeysResponse, error)

	// DeleteApiV1AdminKeysIdWithResponse Revoke a key — it stops resolving immediately. Optional `If-Match` (the key's ETag)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/keys/{id} (the `DeleteApiV1AdminKeysId` operationId).
	DeleteApiV1AdminKeysIdWithResponse(ctx context.Context, id string, params *DeleteApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*DeleteApiV1AdminKeysIdResponse, error)

	// GetApiV1AdminKeysIdWithResponse One key's metadata + `ETag` (never the secret/hash)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/keys/{id} (the `GetApiV1AdminKeysId` operationId).
	GetApiV1AdminKeysIdWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysIdResponse, error)

	// PatchApiV1AdminKeysIdWithResponse Update budget / rate / enabled. Optional `If-Match` for optimistic concurrency
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchApiV1AdminKeysId` operationId).
	PatchApiV1AdminKeysIdWithResponse(ctx context.Context, id string, params *PatchApiV1AdminKeysIdParams, reqEditors ...RequestEditorFn) (*PatchApiV1AdminKeysIdResponse, error)

	// PostApiV1AdminKeysIdRotateWithResponse Mint a fresh secret in place (same id, budgets, usage). The new secret is shown once; the old stops resolving. Honors an `Idempotency-Key` header (per-principal, op+id-scoped, ~10min replay)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/keys/{id}/rotate (the `PostApiV1AdminKeysIdRotate` operationId).
	PostApiV1AdminKeysIdRotateWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PostApiV1AdminKeysIdRotateResponse, error)

	// GetApiV1AdminKeysIdUsageWithResponse Current-window usage for one key (spend / tokens / requests)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/keys/{id}/usage (the `GetApiV1AdminKeysIdUsage` operationId).
	GetApiV1AdminKeysIdUsageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetApiV1AdminKeysIdUsageResponse, error)

	// GetApiV1AdminModelsWithResponse Model lanes + upstream providers
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/models (the `GetApiV1AdminModels` operationId).
	GetApiV1AdminModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminModelsResponse, error)

	// GetApiV1AdminOpenapiJsonWithResponse This OpenAPI 3.1 document
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/openapi.json (the `GetApiV1AdminOpenapiJson` operationId).
	GetApiV1AdminOpenapiJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminOpenapiJsonResponse, error)

	// GetApiV1AdminPluginsWithResponse Plugin catalog by type (compiled-in + external)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/plugins (the `GetApiV1AdminPlugins` operationId).
	GetApiV1AdminPluginsWithResponse(ctx context.Context, params *GetApiV1AdminPluginsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminPluginsResponse, error)

	// GetApiV1AdminPoolsWithResponse Pool topology (members + weights). ?detail=true inlines live member status (one call, no N+1)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/pools (the `GetApiV1AdminPools` operationId).
	GetApiV1AdminPoolsWithResponse(ctx context.Context, params *GetApiV1AdminPoolsParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminPoolsResponse, error)

	// GetApiV1AdminPoolsNameWithResponse Live per-member status of one pool (breaker/concurrency/latency)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/pools/{name} (the `GetApiV1AdminPoolsName` operationId).
	GetApiV1AdminPoolsNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetApiV1AdminPoolsNameResponse, error)

	// GetApiV1AdminProvidersWithResponse Distinct providers + lane counts
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/providers (the `GetApiV1AdminProviders` operationId).
	GetApiV1AdminProvidersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AdminProvidersResponse, error)

	// GetApiV1AdminUsageWithResponse Metering: current UTC-day bucket — {window, as_of, currency, total, by_model, by_key}, raw token split + derived spend_micros
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/usage (the `GetApiV1AdminUsage` operationId).
	GetApiV1AdminUsageWithResponse(ctx context.Context, params *GetApiV1AdminUsageParams, reqEditors ...RequestEditorFn) (*GetApiV1AdminUsageResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ConfigApplyView

type ConfigApplyView struct {
	Applied       bool   `json:"applied"`
	ConfigVersion uint64 `json:"config_version"`
	Note          string `json:"note"`
}

ConfigApplyView `POST /config/apply` — apply-a-full-config result. The change is live but not written to disk.

type ConfigDiffGlobalHooks

type ConfigDiffGlobalHooks struct {
	From []string `json:"from"`
	To   []string `json:"to"`
}

ConfigDiffGlobalHooks The `global_hooks` delta of a `GET /config/diff` — present only when the global wiring changed.

type ConfigDiffHooks

type ConfigDiffHooks struct {
	Added   []string `json:"added"`
	Changed []string `json:"changed"`
	Removed []string `json:"removed"`
}

ConfigDiffHooks The `hooks` object of a `GET /config/diff` — hook names added / removed / changed between the two versions.

type ConfigDiffView

type ConfigDiffView struct {
	From        uint64                 `json:"from"`
	GlobalHooks *ConfigDiffGlobalHooks `json:"global_hooks,omitempty"`

	// Hooks The `hooks` object of a `GET /config/diff` — hook names added / removed / changed between the two
	// versions.
	Hooks ConfigDiffHooks `json:"hooks"`
	To    uint64          `json:"to"`
}

ConfigDiffView `GET /config/diff` — structured hook-surface diff between two retained versions. `global_hooks` is present only when the global wiring differed between the two sides.

type ConfigReloadView

type ConfigReloadView struct {
	ConfigVersion uint64 `json:"config_version"`
	Reloaded      bool   `json:"reloaded"`
}

ConfigReloadView `POST /config/reload` — reload-from-disk result.

type ConfigRollbackView

type ConfigRollbackView struct {
	ConfigVersion   uint64 `json:"config_version"`
	RestoredVersion uint64 `json:"restored_version"`
}

ConfigRollbackView `POST /config/rollback` — restore-a-retained-version result (the restored version + the NEW config version the rollback produced).

type ConfigValidateView

type ConfigValidateView struct {
	Errors []string `json:"errors"`
	Ok     bool     `json:"ok"`
}

ConfigValidateView The result of `POST /api/v1/admin/config/validate` — a DRY-RUN: does a proposed config resolve + validate, WITHOUT applying anything. `ok` is the verdict; `errors` lists every structural/resolution failure at once (empty when `ok`). A well-formed request always returns 200 with this view (a valid request that describes an INVALID config is `ok: false`, not an HTTP error); only a MALFORMED request body is an `invalid_request`. Env-var interpolation is out of scope — this checks structure and cross-reference resolution, not runtime secret presence.

type ConfigVersion

type ConfigVersion struct {
	// Principal The acting principal (audit attribution, same handle as the audit log).
	Principal string `json:"principal"`

	// Summary Human summary of the mutation that produced this version (e.g. `hook.register hook:x`).
	Summary string `json:"summary"`

	// Ts Unix seconds when the mutation committed.
	Ts uint64 `json:"ts"`

	// Version The `App.config_version` this snapshot corresponds to (monotonic per process).
	Version uint64 `json:"version"`
}

ConfigVersion One recorded config version: the metadata the versions LIST shows, plus the full hook-surface snapshot rollback restores. Never contains a secret (hook definitions are operator config — transports, grants, deadlines).

type ConfigVersionDetailView

type ConfigVersionDetailView struct {
	GlobalHooks []string            `json:"global_hooks"`
	Hooks       map[string]HookView `json:"hooks"`
	Principal   string              `json:"principal"`
	Summary     string              `json:"summary"`
	Ts          uint64              `json:"ts"`
	Version     uint64              `json:"version"`
}

ConfigVersionDetailView `GET /config/versions/{v}` — one retained config version WITH its full hook-surface snapshot (projected through the wire `HookView`, keyed by hook name) and the global wiring at that version.

type ConfigVersionPageView

type ConfigVersionPageView struct {
	Items      []ConfigVersion `json:"items"`
	NextCursor *string         `json:"next_cursor"`
}

ConfigVersionPageView `GET /config/versions` — the cursor-paginated version-history envelope (`{items, next_cursor}`).

type CreatedKeyView

type CreatedKeyView struct {
	AllowedPools []string `json:"allowed_pools"`

	// AwsAccessKeyId AWS AccessKeyId (present only when `issue_aws_credential` was set). Not secret.
	AwsAccessKeyId *string `json:"aws_access_key_id,omitempty"`

	// AwsSecretAccessKey AWS SigV4 secret access key — shown once (present only with an AWS credential).
	AwsSecretAccessKey *string `json:"aws_secret_access_key,omitempty"`
	BudgetPeriod       string  `json:"budget_period"`
	CreatedAt          uint64  `json:"created_at"`
	Enabled            bool    `json:"enabled"`
	Id                 string  `json:"id"`
	MaxBudgetCents     *int64  `json:"max_budget_cents"`
	Name               string  `json:"name"`
	RpmLimit           *uint32 `json:"rpm_limit"`

	// Secret The bearer secret — shown EXACTLY once, never returned by any read.
	Secret   string  `json:"secret"`
	TpmLimit *uint32 `json:"tpm_limit"`
}

CreatedKeyView `POST /keys` (mint) — the key metadata plus the ONCE-shown secret, and (when an AWS SigV4 credential was requested) the AccessKeyId + secret access key. The AWS fields are absent on a bearer-only mint.

type DeleteApiV1AdminHooksNameParams

type DeleteApiV1AdminHooksNameParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

DeleteApiV1AdminHooksNameParams defines parameters for DeleteApiV1AdminHooksName.

type DeleteApiV1AdminHooksNameResponse

type DeleteApiV1AdminHooksNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParseDeleteApiV1AdminHooksNameResponse

func ParseDeleteApiV1AdminHooksNameResponse(rsp *http.Response) (*DeleteApiV1AdminHooksNameResponse, error)

ParseDeleteApiV1AdminHooksNameResponse parses an HTTP response from a DeleteApiV1AdminHooksNameWithResponse call

func (DeleteApiV1AdminHooksNameResponse) ContentType

func (r DeleteApiV1AdminHooksNameResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteApiV1AdminHooksNameResponse) GetBody

GetBody returns the raw response body bytes

func (DeleteApiV1AdminHooksNameResponse) GetJSON401

func (r DeleteApiV1AdminHooksNameResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteApiV1AdminHooksNameResponse) GetJSON403

func (r DeleteApiV1AdminHooksNameResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteApiV1AdminHooksNameResponse) GetJSON404

func (r DeleteApiV1AdminHooksNameResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteApiV1AdminHooksNameResponse) GetJSON409

func (r DeleteApiV1AdminHooksNameResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DeleteApiV1AdminHooksNameResponse) GetJSON429

func (r DeleteApiV1AdminHooksNameResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (DeleteApiV1AdminHooksNameResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiV1AdminHooksNameResponse) StatusCode

func (r DeleteApiV1AdminHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiV1AdminKeysIdParams

type DeleteApiV1AdminKeysIdParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

DeleteApiV1AdminKeysIdParams defines parameters for DeleteApiV1AdminKeysId.

type DeleteApiV1AdminKeysIdResponse

type DeleteApiV1AdminKeysIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParseDeleteApiV1AdminKeysIdResponse

func ParseDeleteApiV1AdminKeysIdResponse(rsp *http.Response) (*DeleteApiV1AdminKeysIdResponse, error)

ParseDeleteApiV1AdminKeysIdResponse parses an HTTP response from a DeleteApiV1AdminKeysIdWithResponse call

func (DeleteApiV1AdminKeysIdResponse) ContentType

func (r DeleteApiV1AdminKeysIdResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteApiV1AdminKeysIdResponse) GetBody

func (r DeleteApiV1AdminKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteApiV1AdminKeysIdResponse) GetJSON400

func (r DeleteApiV1AdminKeysIdResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) GetJSON401

func (r DeleteApiV1AdminKeysIdResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) GetJSON403

func (r DeleteApiV1AdminKeysIdResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) GetJSON404

func (r DeleteApiV1AdminKeysIdResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) GetJSON409

func (r DeleteApiV1AdminKeysIdResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) GetJSON429

func (r DeleteApiV1AdminKeysIdResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (DeleteApiV1AdminKeysIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiV1AdminKeysIdResponse) StatusCode

func (r DeleteApiV1AdminKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EffectiveConfigView

type EffectiveConfigView struct {
	// Auth The ingress auth chain read (`GET /api/v1/admin/auth`): the ordered module names that authenticate
	// callers + the upstream-credential mode. Never a secret — module names and the mode are config
	// identifiers, not credentials. An empty `chain` is the open front door (admits every request).
	Auth AuthView `json:"auth"`

	// GlobalHooks Names fired on every request (`global_hooks:` + any inline `global: true`).
	GlobalHooks []string       `json:"global_hooks"`
	Hooks       []HookView     `json:"hooks"`
	Models      []ModelView    `json:"models"`
	Pools       []PoolView     `json:"pools"`
	Providers   []ProviderView `json:"providers"`

	// Version The monotonic config version at the time of this read (see `InfoView.config_version`) — so a
	// drift-detection read gets the config AND its version in one call.
	Version uint64 `json:"version"`
}

EffectiveConfigView The EFFECTIVE config snapshot (`GET /api/v1/admin/config`) — the running configuration as busbar resolved it, for drift detection (compare against your desired config) and one-shot inspection. Composed from the same REDACTED reads as the individual endpoints (auth chain names, pool/model/ provider topology, hook definitions, global-hook wiring) — so it carries NO secret: no client tokens, no provider keys, no hook payloads. Additive-only; the source-layer annotation (base vs overlay) lands with the config overlay substrate.

type Error

type Error struct {
	Error struct {
		Code    ErrorErrorCode `json:"code"`
		Message string         `json:"message"`
	} `json:"error"`
}

Error defines model for Error.

type ErrorErrorCode

type ErrorErrorCode string

ErrorErrorCode defines model for Error.Error.Code.

const (
	Conflict         ErrorErrorCode = "conflict"
	Forbidden        ErrorErrorCode = "forbidden"
	Internal         ErrorErrorCode = "internal"
	InvalidRequest   ErrorErrorCode = "invalid_request"
	MethodNotAllowed ErrorErrorCode = "method_not_allowed"
	NotFound         ErrorErrorCode = "not_found"
	RateLimited      ErrorErrorCode = "rate_limited"
	Unauthorized     ErrorErrorCode = "unauthorized"
	VersionConflict  ErrorErrorCode = "version_conflict"
)

Defines values for ErrorErrorCode.

func (ErrorErrorCode) Valid

func (e ErrorErrorCode) Valid() bool

Valid indicates whether the value is a known member of the ErrorErrorCode enum.

type GetApiV1AdminAdminAuthResponse

type GetApiV1AdminAdminAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AdminAuthView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminAdminAuthResponse

func ParseGetApiV1AdminAdminAuthResponse(rsp *http.Response) (*GetApiV1AdminAdminAuthResponse, error)

ParseGetApiV1AdminAdminAuthResponse parses an HTTP response from a GetApiV1AdminAdminAuthWithResponse call

func (GetApiV1AdminAdminAuthResponse) ContentType

func (r GetApiV1AdminAdminAuthResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminAdminAuthResponse) GetBody

func (r GetApiV1AdminAdminAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminAdminAuthResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminAdminAuthResponse) GetJSON401

func (r GetApiV1AdminAdminAuthResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminAdminAuthResponse) GetJSON403

func (r GetApiV1AdminAdminAuthResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminAdminAuthResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminAdminAuthResponse) StatusCode

func (r GetApiV1AdminAdminAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminAuditParams

type GetApiV1AdminAuditParams struct {
	// Action Filter by exact action (e.g. `hook.register`)
	Action *string `form:"action,omitempty" json:"action,omitempty"`

	// Resource Filter by exact resource (e.g. `hook:x`)
	Resource *string `form:"resource,omitempty" json:"resource,omitempty"`

	// Limit Page size (default 200, max 1000)
	Limit *string `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque continuation cursor from `next_cursor`
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetApiV1AdminAuditParams defines parameters for GetApiV1AdminAudit.

type GetApiV1AdminAuditResponse

type GetApiV1AdminAuditResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AuditPageView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminAuditResponse

func ParseGetApiV1AdminAuditResponse(rsp *http.Response) (*GetApiV1AdminAuditResponse, error)

ParseGetApiV1AdminAuditResponse parses an HTTP response from a GetApiV1AdminAuditWithResponse call

func (GetApiV1AdminAuditResponse) ContentType

func (r GetApiV1AdminAuditResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminAuditResponse) GetBody

func (r GetApiV1AdminAuditResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminAuditResponse) GetJSON200

func (r GetApiV1AdminAuditResponse) GetJSON200() *AuditPageView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminAuditResponse) GetJSON401

func (r GetApiV1AdminAuditResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminAuditResponse) GetJSON403

func (r GetApiV1AdminAuditResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminAuditResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminAuditResponse) StatusCode

func (r GetApiV1AdminAuditResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminAuthResponse

type GetApiV1AdminAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AuthView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminAuthResponse

func ParseGetApiV1AdminAuthResponse(rsp *http.Response) (*GetApiV1AdminAuthResponse, error)

ParseGetApiV1AdminAuthResponse parses an HTTP response from a GetApiV1AdminAuthWithResponse call

func (GetApiV1AdminAuthResponse) ContentType

func (r GetApiV1AdminAuthResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminAuthResponse) GetBody

func (r GetApiV1AdminAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminAuthResponse) GetJSON200

func (r GetApiV1AdminAuthResponse) GetJSON200() *AuthView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminAuthResponse) GetJSON401

func (r GetApiV1AdminAuthResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminAuthResponse) GetJSON403

func (r GetApiV1AdminAuthResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminAuthResponse) Status

func (r GetApiV1AdminAuthResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1AdminAuthResponse) StatusCode

func (r GetApiV1AdminAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminConfigDiffParams

type GetApiV1AdminConfigDiffParams struct {
	From int `form:"from" json:"from"`
	To   int `form:"to" json:"to"`
}

GetApiV1AdminConfigDiffParams defines parameters for GetApiV1AdminConfigDiff.

type GetApiV1AdminConfigDiffResponse

type GetApiV1AdminConfigDiffResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigDiffView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminConfigDiffResponse

func ParseGetApiV1AdminConfigDiffResponse(rsp *http.Response) (*GetApiV1AdminConfigDiffResponse, error)

ParseGetApiV1AdminConfigDiffResponse parses an HTTP response from a GetApiV1AdminConfigDiffWithResponse call

func (GetApiV1AdminConfigDiffResponse) ContentType

func (r GetApiV1AdminConfigDiffResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminConfigDiffResponse) GetBody

func (r GetApiV1AdminConfigDiffResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminConfigDiffResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminConfigDiffResponse) GetJSON400

func (r GetApiV1AdminConfigDiffResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetApiV1AdminConfigDiffResponse) GetJSON401

func (r GetApiV1AdminConfigDiffResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminConfigDiffResponse) GetJSON403

func (r GetApiV1AdminConfigDiffResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminConfigDiffResponse) GetJSON404

func (r GetApiV1AdminConfigDiffResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminConfigDiffResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminConfigDiffResponse) StatusCode

func (r GetApiV1AdminConfigDiffResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminConfigResponse

type GetApiV1AdminConfigResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EffectiveConfigView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminConfigResponse

func ParseGetApiV1AdminConfigResponse(rsp *http.Response) (*GetApiV1AdminConfigResponse, error)

ParseGetApiV1AdminConfigResponse parses an HTTP response from a GetApiV1AdminConfigWithResponse call

func (GetApiV1AdminConfigResponse) ContentType

func (r GetApiV1AdminConfigResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminConfigResponse) GetBody

func (r GetApiV1AdminConfigResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminConfigResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminConfigResponse) GetJSON401

func (r GetApiV1AdminConfigResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminConfigResponse) GetJSON403

func (r GetApiV1AdminConfigResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminConfigResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminConfigResponse) StatusCode

func (r GetApiV1AdminConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminConfigVersionsParams

type GetApiV1AdminConfigVersionsParams struct {
	// Limit Page size (default 100, max 1000)
	Limit *string `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque continuation cursor from `next_cursor`
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetApiV1AdminConfigVersionsParams defines parameters for GetApiV1AdminConfigVersions.

type GetApiV1AdminConfigVersionsResponse

type GetApiV1AdminConfigVersionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigVersionPageView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminConfigVersionsResponse

func ParseGetApiV1AdminConfigVersionsResponse(rsp *http.Response) (*GetApiV1AdminConfigVersionsResponse, error)

ParseGetApiV1AdminConfigVersionsResponse parses an HTTP response from a GetApiV1AdminConfigVersionsWithResponse call

func (GetApiV1AdminConfigVersionsResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminConfigVersionsResponse) GetBody

GetBody returns the raw response body bytes

func (GetApiV1AdminConfigVersionsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminConfigVersionsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminConfigVersionsResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminConfigVersionsResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminConfigVersionsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminConfigVersionsVResponse

type GetApiV1AdminConfigVersionsVResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigVersionDetailView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminConfigVersionsVResponse

func ParseGetApiV1AdminConfigVersionsVResponse(rsp *http.Response) (*GetApiV1AdminConfigVersionsVResponse, error)

ParseGetApiV1AdminConfigVersionsVResponse parses an HTTP response from a GetApiV1AdminConfigVersionsVWithResponse call

func (GetApiV1AdminConfigVersionsVResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminConfigVersionsVResponse) GetBody

GetBody returns the raw response body bytes

func (GetApiV1AdminConfigVersionsVResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminConfigVersionsVResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminConfigVersionsVResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminConfigVersionsVResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminConfigVersionsVResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminConfigVersionsVResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminHooksNameHealthResponse

type GetApiV1AdminHooksNameHealthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookHealthView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminHooksNameHealthResponse

func ParseGetApiV1AdminHooksNameHealthResponse(rsp *http.Response) (*GetApiV1AdminHooksNameHealthResponse, error)

ParseGetApiV1AdminHooksNameHealthResponse parses an HTTP response from a GetApiV1AdminHooksNameHealthWithResponse call

func (GetApiV1AdminHooksNameHealthResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminHooksNameHealthResponse) GetBody

GetBody returns the raw response body bytes

func (GetApiV1AdminHooksNameHealthResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminHooksNameHealthResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminHooksNameHealthResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminHooksNameHealthResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminHooksNameHealthResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminHooksNameHealthResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminHooksNameResponse

type GetApiV1AdminHooksNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminHooksNameResponse

func ParseGetApiV1AdminHooksNameResponse(rsp *http.Response) (*GetApiV1AdminHooksNameResponse, error)

ParseGetApiV1AdminHooksNameResponse parses an HTTP response from a GetApiV1AdminHooksNameWithResponse call

func (GetApiV1AdminHooksNameResponse) ContentType

func (r GetApiV1AdminHooksNameResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminHooksNameResponse) GetBody

func (r GetApiV1AdminHooksNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminHooksNameResponse) GetJSON200

func (r GetApiV1AdminHooksNameResponse) GetJSON200() *HookView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminHooksNameResponse) GetJSON401

func (r GetApiV1AdminHooksNameResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminHooksNameResponse) GetJSON403

func (r GetApiV1AdminHooksNameResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminHooksNameResponse) GetJSON404

func (r GetApiV1AdminHooksNameResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminHooksNameResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminHooksNameResponse) StatusCode

func (r GetApiV1AdminHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminHooksNameSchemaResponse

type GetApiV1AdminHooksNameSchemaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookSchemaView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminHooksNameSchemaResponse

func ParseGetApiV1AdminHooksNameSchemaResponse(rsp *http.Response) (*GetApiV1AdminHooksNameSchemaResponse, error)

ParseGetApiV1AdminHooksNameSchemaResponse parses an HTTP response from a GetApiV1AdminHooksNameSchemaWithResponse call

func (GetApiV1AdminHooksNameSchemaResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminHooksNameSchemaResponse) GetBody

GetBody returns the raw response body bytes

func (GetApiV1AdminHooksNameSchemaResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminHooksNameSchemaResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminHooksNameSchemaResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminHooksNameSchemaResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminHooksNameSchemaResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminHooksNameSchemaResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminHooksNameStatusResponse

type GetApiV1AdminHooksNameStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookStatusView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminHooksNameStatusResponse

func ParseGetApiV1AdminHooksNameStatusResponse(rsp *http.Response) (*GetApiV1AdminHooksNameStatusResponse, error)

ParseGetApiV1AdminHooksNameStatusResponse parses an HTTP response from a GetApiV1AdminHooksNameStatusWithResponse call

func (GetApiV1AdminHooksNameStatusResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminHooksNameStatusResponse) GetBody

GetBody returns the raw response body bytes

func (GetApiV1AdminHooksNameStatusResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminHooksNameStatusResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminHooksNameStatusResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminHooksNameStatusResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminHooksNameStatusResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminHooksNameStatusResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminHooksResponse

type GetApiV1AdminHooksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PageHookView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminHooksResponse

func ParseGetApiV1AdminHooksResponse(rsp *http.Response) (*GetApiV1AdminHooksResponse, error)

ParseGetApiV1AdminHooksResponse parses an HTTP response from a GetApiV1AdminHooksWithResponse call

func (GetApiV1AdminHooksResponse) ContentType

func (r GetApiV1AdminHooksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminHooksResponse) GetBody

func (r GetApiV1AdminHooksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminHooksResponse) GetJSON200

func (r GetApiV1AdminHooksResponse) GetJSON200() *PageHookView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminHooksResponse) GetJSON401

func (r GetApiV1AdminHooksResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminHooksResponse) GetJSON403

func (r GetApiV1AdminHooksResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminHooksResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminHooksResponse) StatusCode

func (r GetApiV1AdminHooksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminInfoResponse

type GetApiV1AdminInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InfoView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminInfoResponse

func ParseGetApiV1AdminInfoResponse(rsp *http.Response) (*GetApiV1AdminInfoResponse, error)

ParseGetApiV1AdminInfoResponse parses an HTTP response from a GetApiV1AdminInfoWithResponse call

func (GetApiV1AdminInfoResponse) ContentType

func (r GetApiV1AdminInfoResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminInfoResponse) GetBody

func (r GetApiV1AdminInfoResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminInfoResponse) GetJSON200

func (r GetApiV1AdminInfoResponse) GetJSON200() *InfoView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminInfoResponse) GetJSON401

func (r GetApiV1AdminInfoResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminInfoResponse) GetJSON403

func (r GetApiV1AdminInfoResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminInfoResponse) Status

func (r GetApiV1AdminInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1AdminInfoResponse) StatusCode

func (r GetApiV1AdminInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminKeysIdResponse

type GetApiV1AdminKeysIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *KeyView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminKeysIdResponse

func ParseGetApiV1AdminKeysIdResponse(rsp *http.Response) (*GetApiV1AdminKeysIdResponse, error)

ParseGetApiV1AdminKeysIdResponse parses an HTTP response from a GetApiV1AdminKeysIdWithResponse call

func (GetApiV1AdminKeysIdResponse) ContentType

func (r GetApiV1AdminKeysIdResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminKeysIdResponse) GetBody

func (r GetApiV1AdminKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminKeysIdResponse) GetJSON200

func (r GetApiV1AdminKeysIdResponse) GetJSON200() *KeyView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminKeysIdResponse) GetJSON401

func (r GetApiV1AdminKeysIdResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminKeysIdResponse) GetJSON403

func (r GetApiV1AdminKeysIdResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminKeysIdResponse) GetJSON404

func (r GetApiV1AdminKeysIdResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminKeysIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminKeysIdResponse) StatusCode

func (r GetApiV1AdminKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminKeysIdUsageResponse

type GetApiV1AdminKeysIdUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *KeyMeteringView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminKeysIdUsageResponse

func ParseGetApiV1AdminKeysIdUsageResponse(rsp *http.Response) (*GetApiV1AdminKeysIdUsageResponse, error)

ParseGetApiV1AdminKeysIdUsageResponse parses an HTTP response from a GetApiV1AdminKeysIdUsageWithResponse call

func (GetApiV1AdminKeysIdUsageResponse) ContentType

func (r GetApiV1AdminKeysIdUsageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminKeysIdUsageResponse) GetBody

func (r GetApiV1AdminKeysIdUsageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminKeysIdUsageResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminKeysIdUsageResponse) GetJSON401

func (r GetApiV1AdminKeysIdUsageResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminKeysIdUsageResponse) GetJSON403

func (r GetApiV1AdminKeysIdUsageResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminKeysIdUsageResponse) GetJSON404

func (r GetApiV1AdminKeysIdUsageResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminKeysIdUsageResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminKeysIdUsageResponse) StatusCode

func (r GetApiV1AdminKeysIdUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminKeysParams

type GetApiV1AdminKeysParams struct {
	// Enabled Filter by enabled state (`true`|`false`)
	Enabled *string `form:"enabled,omitempty" json:"enabled,omitempty"`

	// Prefix Filter by key-id prefix
	Prefix *string `form:"prefix,omitempty" json:"prefix,omitempty"`

	// Limit Page size (default 200, max 1000)
	Limit *string `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque continuation cursor from `next_cursor`
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetApiV1AdminKeysParams defines parameters for GetApiV1AdminKeys.

type GetApiV1AdminKeysResponse

type GetApiV1AdminKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *KeyPageView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminKeysResponse

func ParseGetApiV1AdminKeysResponse(rsp *http.Response) (*GetApiV1AdminKeysResponse, error)

ParseGetApiV1AdminKeysResponse parses an HTTP response from a GetApiV1AdminKeysWithResponse call

func (GetApiV1AdminKeysResponse) ContentType

func (r GetApiV1AdminKeysResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminKeysResponse) GetBody

func (r GetApiV1AdminKeysResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminKeysResponse) GetJSON200

func (r GetApiV1AdminKeysResponse) GetJSON200() *KeyPageView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminKeysResponse) GetJSON400

func (r GetApiV1AdminKeysResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetApiV1AdminKeysResponse) GetJSON401

func (r GetApiV1AdminKeysResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminKeysResponse) GetJSON403

func (r GetApiV1AdminKeysResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminKeysResponse) Status

func (r GetApiV1AdminKeysResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1AdminKeysResponse) StatusCode

func (r GetApiV1AdminKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminModelsResponse

type GetApiV1AdminModelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PageModelView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminModelsResponse

func ParseGetApiV1AdminModelsResponse(rsp *http.Response) (*GetApiV1AdminModelsResponse, error)

ParseGetApiV1AdminModelsResponse parses an HTTP response from a GetApiV1AdminModelsWithResponse call

func (GetApiV1AdminModelsResponse) ContentType

func (r GetApiV1AdminModelsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminModelsResponse) GetBody

func (r GetApiV1AdminModelsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminModelsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminModelsResponse) GetJSON401

func (r GetApiV1AdminModelsResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminModelsResponse) GetJSON403

func (r GetApiV1AdminModelsResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminModelsResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminModelsResponse) StatusCode

func (r GetApiV1AdminModelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminOpenapiJsonResponse

type GetApiV1AdminOpenapiJsonResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *map[string]interface{}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminOpenapiJsonResponse

func ParseGetApiV1AdminOpenapiJsonResponse(rsp *http.Response) (*GetApiV1AdminOpenapiJsonResponse, error)

ParseGetApiV1AdminOpenapiJsonResponse parses an HTTP response from a GetApiV1AdminOpenapiJsonWithResponse call

func (GetApiV1AdminOpenapiJsonResponse) ContentType

func (r GetApiV1AdminOpenapiJsonResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminOpenapiJsonResponse) GetBody

func (r GetApiV1AdminOpenapiJsonResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminOpenapiJsonResponse) GetJSON200

func (r GetApiV1AdminOpenapiJsonResponse) GetJSON200() *map[string]interface{}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminOpenapiJsonResponse) GetJSON401

func (r GetApiV1AdminOpenapiJsonResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminOpenapiJsonResponse) GetJSON403

func (r GetApiV1AdminOpenapiJsonResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminOpenapiJsonResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminOpenapiJsonResponse) StatusCode

func (r GetApiV1AdminOpenapiJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminPluginsParams

type GetApiV1AdminPluginsParams struct {
	// Type Plugin type: `auth` | `hooks` (required)
	Type string `form:"type" json:"type"`
}

GetApiV1AdminPluginsParams defines parameters for GetApiV1AdminPlugins.

type GetApiV1AdminPluginsResponse

type GetApiV1AdminPluginsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PagePluginView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminPluginsResponse

func ParseGetApiV1AdminPluginsResponse(rsp *http.Response) (*GetApiV1AdminPluginsResponse, error)

ParseGetApiV1AdminPluginsResponse parses an HTTP response from a GetApiV1AdminPluginsWithResponse call

func (GetApiV1AdminPluginsResponse) ContentType

func (r GetApiV1AdminPluginsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminPluginsResponse) GetBody

func (r GetApiV1AdminPluginsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminPluginsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminPluginsResponse) GetJSON401

func (r GetApiV1AdminPluginsResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminPluginsResponse) GetJSON403

func (r GetApiV1AdminPluginsResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminPluginsResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminPluginsResponse) StatusCode

func (r GetApiV1AdminPluginsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminPoolsNameResponse

type GetApiV1AdminPoolsNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PoolDetailView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
}

func ParseGetApiV1AdminPoolsNameResponse

func ParseGetApiV1AdminPoolsNameResponse(rsp *http.Response) (*GetApiV1AdminPoolsNameResponse, error)

ParseGetApiV1AdminPoolsNameResponse parses an HTTP response from a GetApiV1AdminPoolsNameWithResponse call

func (GetApiV1AdminPoolsNameResponse) ContentType

func (r GetApiV1AdminPoolsNameResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminPoolsNameResponse) GetBody

func (r GetApiV1AdminPoolsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminPoolsNameResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminPoolsNameResponse) GetJSON401

func (r GetApiV1AdminPoolsNameResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminPoolsNameResponse) GetJSON403

func (r GetApiV1AdminPoolsNameResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminPoolsNameResponse) GetJSON404

func (r GetApiV1AdminPoolsNameResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetApiV1AdminPoolsNameResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminPoolsNameResponse) StatusCode

func (r GetApiV1AdminPoolsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminPoolsParams

type GetApiV1AdminPoolsParams struct {
	// Detail `true` inlines each member's live status (same row shape as /pools/{name})
	Detail *string `form:"detail,omitempty" json:"detail,omitempty"`
}

GetApiV1AdminPoolsParams defines parameters for GetApiV1AdminPools.

type GetApiV1AdminPoolsResponse

type GetApiV1AdminPoolsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PagePoolView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminPoolsResponse

func ParseGetApiV1AdminPoolsResponse(rsp *http.Response) (*GetApiV1AdminPoolsResponse, error)

ParseGetApiV1AdminPoolsResponse parses an HTTP response from a GetApiV1AdminPoolsWithResponse call

func (GetApiV1AdminPoolsResponse) ContentType

func (r GetApiV1AdminPoolsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminPoolsResponse) GetBody

func (r GetApiV1AdminPoolsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminPoolsResponse) GetJSON200

func (r GetApiV1AdminPoolsResponse) GetJSON200() *PagePoolView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminPoolsResponse) GetJSON401

func (r GetApiV1AdminPoolsResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminPoolsResponse) GetJSON403

func (r GetApiV1AdminPoolsResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminPoolsResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminPoolsResponse) StatusCode

func (r GetApiV1AdminPoolsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminProvidersResponse

type GetApiV1AdminProvidersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PageProviderView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminProvidersResponse

func ParseGetApiV1AdminProvidersResponse(rsp *http.Response) (*GetApiV1AdminProvidersResponse, error)

ParseGetApiV1AdminProvidersResponse parses an HTTP response from a GetApiV1AdminProvidersWithResponse call

func (GetApiV1AdminProvidersResponse) ContentType

func (r GetApiV1AdminProvidersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminProvidersResponse) GetBody

func (r GetApiV1AdminProvidersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminProvidersResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminProvidersResponse) GetJSON401

func (r GetApiV1AdminProvidersResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminProvidersResponse) GetJSON403

func (r GetApiV1AdminProvidersResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminProvidersResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminProvidersResponse) StatusCode

func (r GetApiV1AdminProvidersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AdminUsageParams

type GetApiV1AdminUsageParams struct {
	// Window A PAST UTC-day bucket start epoch (default: current bucket). The response is always ONE bucket; spend_micros is a read-time estimate — bill from the raw token split, never store spend_micros as a ledger charge
	Window *string `form:"window,omitempty" json:"window,omitempty"`
}

GetApiV1AdminUsageParams defines parameters for GetApiV1AdminUsage.

type GetApiV1AdminUsageResponse

type GetApiV1AdminUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UsageView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
}

func ParseGetApiV1AdminUsageResponse

func ParseGetApiV1AdminUsageResponse(rsp *http.Response) (*GetApiV1AdminUsageResponse, error)

ParseGetApiV1AdminUsageResponse parses an HTTP response from a GetApiV1AdminUsageWithResponse call

func (GetApiV1AdminUsageResponse) ContentType

func (r GetApiV1AdminUsageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetApiV1AdminUsageResponse) GetBody

func (r GetApiV1AdminUsageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetApiV1AdminUsageResponse) GetJSON200

func (r GetApiV1AdminUsageResponse) GetJSON200() *UsageView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetApiV1AdminUsageResponse) GetJSON401

func (r GetApiV1AdminUsageResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetApiV1AdminUsageResponse) GetJSON403

func (r GetApiV1AdminUsageResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetApiV1AdminUsageResponse) Status

Status returns HTTPResponse.Status

func (GetApiV1AdminUsageResponse) StatusCode

func (r GetApiV1AdminUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HookDesiredStatus

type HookDesiredStatus struct {
	Settings        map[string]interface{} `json:"settings"`
	SettingsVersion uint64                 `json:"settings_version"`
}

HookDesiredStatus The DESIRED settings side of `hooks/{name}/status`: busbar's registry copy of the hook's settings and their version.

type HookHealthView

type HookHealthView struct {
	// Detail A short human note on the probe (why `None`, or the connect error class). Never a secret.
	Detail *string `json:"detail"`
	Name   string  `json:"name"`

	// Reachable `Some(true)` = the transport accepted a connection; `Some(false)` = it did not; `None` = not
	// probed here (webhook / non-unix).
	Reachable *bool `json:"reachable"`

	// Transport The transport half of a `HookView`: which wire the hook speaks and its target (socket path or
	// webhook URL — operator config, not a secret). Exactly one of `socket`/`webhook` is set.
	Transport HookTransportView `json:"transport"`
}

HookHealthView The live health of one hook's transport (`GET /api/v1/admin/hooks/{name}/health`). BEST-EFFORT: for a socket transport `reachable` is `Some(true/false)` from a short-timeout connect probe; for a webhook (or on a non-unix host) it is `None` (probed on demand, not here) with a `detail` note. Never fires the hook — just checks whether the endpoint accepts a connection. Additive-only.

type HookReportedStatus

type HookReportedStatus struct {
	Settings        *map[string]interface{} `json:"settings"`
	SettingsVersion *uint64                 `json:"settings_version"`
}

HookReportedStatus The REPORTED settings side of `hooks/{name}/status`: what the hook says it is actually running (present only when the hook answered `status`).

type HookSchemaView

type HookSchemaView struct {
	Name string `json:"name"`

	// Schema The hook's settings JSON Schema verbatim (an arbitrary JSON object), or `null`.
	Schema interface{} `json:"schema"`
}

HookSchemaView `GET /hooks/{name}/schema` — the hook's self-described settings JSON Schema (proxied over the `describe` wire message), or `null` when the hook/transport does not answer.

type HookStatusView

type HookStatusView struct {
	AsOf uint64 `json:"as_of"`

	// Desired The DESIRED settings side of `hooks/{name}/status`: busbar's registry copy of the hook's settings
	// and their version.
	Desired HookDesiredStatus `json:"desired"`
	Drift   *bool             `json:"drift"`

	// Metrics Validated + bounded self-reported metrics; each entry carries `{name, type, value}` and, when
	// the hook sent them, optional `labels`/`quantiles`/`estimated`/`ci_low`/`ci_high`/`help`/
	// `label`/`unit`/`viz`/`max` members.
	Metrics []interface{} `json:"metrics"`
	Name    string        `json:"name"`

	// Note A short human note present only on the fail-open (no-answer) branch.
	Note     *string             `json:"note,omitempty"`
	Reported *HookReportedStatus `json:"reported"`

	// Source Always `"live"` (the read is a live transport query).
	Source string `json:"source"`
}

HookStatusView `GET /hooks/{name}/status` — the hook's OBSERVED state: desired vs reported settings with a `drift` verdict, plus the hook's self-reported metrics. `reported`/`drift` are `null` and `note` is present when the hook did not answer (fail-open); `metrics` is invariantly an array.

type HookTransportView

type HookTransportView struct {
	// Kind `"socket"` or `"webhook"` (or `"none"` for a misconfigured entry with neither).
	Kind string `json:"kind"`

	// Target The socket path or webhook URL. `None` only if the definition set neither transport.
	Target *string `json:"target"`
}

HookTransportView The transport half of a `HookView`: which wire the hook speaks and its target (socket path or webhook URL — operator config, not a secret). Exactly one of `socket`/`webhook` is set.

type HookView

type HookView struct {
	// At TAP observation stage (`"request"`/`"route"`/`"attempt"`/`"completion"`), or `None` for a gate.
	At *string `json:"at"`

	// Global Whether this hook fires on every request (globally wired).
	Global bool `json:"global"`

	// Kind `"tap"` (fire-and-forget) or `"gate"` (fire-and-wait).
	Kind string `json:"kind"`
	Name string `json:"name"`

	// OnError Gate fallback on timeout/error — a CLOSED, unambiguous string union (audit #8): one of the
	// reserved terminals (`"weighted"` | `"reject"` | `"first"` | `"nothing"`) or the NAME of the
	// fallback hook the chain continues through. Unambiguous by construction: the terminal words
	// are ILLEGAL hook names on every write path (`config::RESERVED_HOOK_NAMES`), so a value in
	// the terminal set is always a terminal and anything else is always a hook reference.
	OnError string `json:"on_error"`

	// Priority Rewrite/reject ordering key (transform-chain order + reject tie-break).
	Priority uint16 `json:"priority"`

	// Prompt Prompt access grant: `"no"` | `"ro"` | `"rw"`.
	Prompt string `json:"prompt"`

	// Settings The hook's opaque settings map (operator/API-owned; pushed via the configure wire). Never
	// interpreted by busbar; never a secret by contract (hook settings are operator config).
	Settings map[string]interface{} `json:"settings"`

	// TimeoutMs Gate decision deadline in milliseconds.
	TimeoutMs uint64 `json:"timeout_ms"`

	// Transport The transport half of a `HookView`: which wire the hook speaks and its target (socket path or
	// webhook URL — operator config, not a secret). Exactly one of `socket`/`webhook` is set.
	Transport HookTransportView `json:"transport"`

	// User Caller-identity access grant: `"no"` | `"ro"`.
	User string `json:"user"`
}

HookView A hook definition in the registry read (`GET /api/v1/admin/hooks`, `GET /api/v1/admin/hooks/{name}`) — the plugin catalog read. Projects the DEFINITION (kind, transport, grants, ordering, stage), never a secret. `global` reports whether the hook fires on every request (named in `global_hooks:` or declared `global: true`). Live connection status (`health`) is a separate endpoint. Additive-only.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InfoView

type InfoView struct {
	// Build The compiled-in feature proof (`InfoView.build`).
	Build BuildInfo `json:"build"`

	// ConfigPersistence Whether config-overlay persistence is enabled (`BUSBAR_CONFIG_OVERLAY` set): `true` = API-applied
	// config changes are durable across restarts; `false` = live-only (lost on restart). Lets tooling
	// tell an operator whether their runtime changes will survive a restart.
	ConfigPersistence bool `json:"config_persistence"`

	// ConfigVersion Monotonic config version — `0` at boot, +1 per API config apply. Drift-detection: re-read and
	// compare to tell whether the running config changed. Process-local (resets on restart).
	ConfigVersion uint64 `json:"config_version"`

	// StartedAt Epoch seconds of process start — the BOOT EPOCH marker: `config_version` (and any
	// process-local counter) resets on restart, so a consumer that sees `started_at` change knows
	// to read a counter reset as "new epoch", never as "reverted" (audit minor #2 / #4).
	StartedAt *uint64 `json:"started_at"`

	// Topology Pool/model/provider counts (`InfoView.topology`).
	Topology TopologyInfo `json:"topology"`

	// UptimeSeconds Seconds since process start, or `None` if the start instant was never stamped.
	UptimeSeconds *uint64 `json:"uptime_seconds"`

	// Version busbar semantic version (`CARGO_PKG_VERSION`).
	Version string `json:"version"`
}

InfoView The compiled-in plugin catalog + topology + uptime returned by `GET /api/v1/admin/info`. Powers version negotiation for tooling AND the compliance-by-compilation proof: `auth_modules`/`hook_plugins` reflect the ACTUAL binary (feature-gated at compile time), not config, so `--no-default-features` shows a provably smaller surface. No LLM content, ever.

type KeyMeteringView

type KeyMeteringView struct {
	AsOf         uint64   `json:"as_of"`
	BudgetPeriod *string  `json:"budget_period"`
	Id           string   `json:"id"`
	RateHeadroom *float64 `json:"rate_headroom"`
	Requests     uint64   `json:"requests"`
	SpendCents   int64    `json:"spend_cents"`
	Tokens       uint64   `json:"tokens"`
	WindowStart  *uint64  `json:"window_start"`
}

KeyMeteringView `GET /keys/{id}/usage` — the current budget-window counters for one key, plus the fraction of the tightest RPM/TPM cap remaining (`null` = uncapped). `budget_period`/`window_start` are `null` when the key record could not be read.

type KeyPageView

type KeyPageView struct {
	Items      []KeyView `json:"items"`
	NextCursor *string   `json:"next_cursor"`
}

KeyPageView `GET /keys` — the cursor-paginated key list envelope (`{items, next_cursor}`, hand-rolled in the keys handler rather than via `Page<T>`).

type KeyUsageView

type KeyUsageView struct {
	Id string `json:"id"`

	// Name The key's display name; `None` when the key was deleted after metering accumulated (history
	// outlives the key — the id still attributes it).
	Name     *string `json:"name"`
	Requests uint64  `json:"requests"`

	// SpendMicros Busbar's derived cost estimate in MICRO-units of `currency` (1e-6 USD — integer math,
	// sub-cent precise, no float drift), from the operator's configured global prices. A consumer
	// with its own per-model catalog recomputes from the raw token split instead.
	SpendMicros         int64  `json:"spend_micros"`
	TokensCacheCreation uint64 `json:"tokens_cache_creation"`
	TokensCacheRead     uint64 `json:"tokens_cache_read"`

	// TokensInput Uncached input tokens (normalized additive-cache convention).
	TokensInput  uint64 `json:"tokens_input"`
	TokensOutput uint64 `json:"tokens_output"`
}

KeyUsageView One key's row of the per-key aggregation: the key id/name (never the secret) + its counts.

type KeyView

type KeyView struct {
	AllowedPools   []string `json:"allowed_pools"`
	BudgetPeriod   string   `json:"budget_period"`
	CreatedAt      uint64   `json:"created_at"`
	Enabled        bool     `json:"enabled"`
	Id             string   `json:"id"`
	MaxBudgetCents *int64   `json:"max_budget_cents"`
	Name           string   `json:"name"`
	RpmLimit       *uint32  `json:"rpm_limit"`
	TpmLimit       *uint32  `json:"tpm_limit"`
}

KeyView Virtual-key metadata — the `key_meta()` shape returned by `GET /keys/{id}`, `PATCH /keys/{id}`, and as each item of `GET /keys`. Never the secret or its hash.

type ModelUsageView

type ModelUsageView struct {
	Model    string `json:"model"`
	Provider string `json:"provider"`
	Requests uint64 `json:"requests"`

	// SpendMicros Busbar's derived cost estimate in MICRO-units of `currency` (1e-6 USD — integer math,
	// sub-cent precise, no float drift), from the operator's configured global prices. A consumer
	// with its own per-model catalog recomputes from the raw token split instead.
	SpendMicros         int64  `json:"spend_micros"`
	TokensCacheCreation uint64 `json:"tokens_cache_creation"`
	TokensCacheRead     uint64 `json:"tokens_cache_read"`

	// TokensInput Uncached input tokens (normalized additive-cache convention).
	TokensInput  uint64 `json:"tokens_input"`
	TokensOutput uint64 `json:"tokens_output"`
}

ModelUsageView One (model, provider) row of the per-model aggregation.

type ModelView

type ModelView struct {
	Model    string `json:"model"`
	Provider string `json:"provider"`
}

ModelView A model lane in the topology read (`GET /api/v1/admin/models`): the config key + its upstream provider. No credentials, ever.

type PageHookView

type PageHookView struct {
	Items      []HookView `json:"items"`
	NextCursor *string    `json:"next_cursor"`
}

PageHookView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain (design-admin-api-v1 §0.4). Generic over the item view so every list endpoint shares one shape.

type PageModelView

type PageModelView struct {
	Items      []ModelView `json:"items"`
	NextCursor *string     `json:"next_cursor"`
}

PageModelView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain (design-admin-api-v1 §0.4). Generic over the item view so every list endpoint shares one shape.

type PagePluginView

type PagePluginView struct {
	Items      []PluginView `json:"items"`
	NextCursor *string      `json:"next_cursor"`
}

PagePluginView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain (design-admin-api-v1 §0.4). Generic over the item view so every list endpoint shares one shape.

type PagePoolView

type PagePoolView struct {
	Items      []PoolView `json:"items"`
	NextCursor *string    `json:"next_cursor"`
}

PagePoolView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain (design-admin-api-v1 §0.4). Generic over the item view so every list endpoint shares one shape.

type PageProviderView

type PageProviderView struct {
	Items      []ProviderView `json:"items"`
	NextCursor *string        `json:"next_cursor"`
}

PageProviderView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain (design-admin-api-v1 §0.4). Generic over the item view so every list endpoint shares one shape.

type PatchApiV1AdminHooksNameSettingsParams

type PatchApiV1AdminHooksNameSettingsParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PatchApiV1AdminHooksNameSettingsParams defines parameters for PatchApiV1AdminHooksNameSettings.

type PatchApiV1AdminHooksNameSettingsResponse

type PatchApiV1AdminHooksNameSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePatchApiV1AdminHooksNameSettingsResponse

func ParsePatchApiV1AdminHooksNameSettingsResponse(rsp *http.Response) (*PatchApiV1AdminHooksNameSettingsResponse, error)

ParsePatchApiV1AdminHooksNameSettingsResponse parses an HTTP response from a PatchApiV1AdminHooksNameSettingsWithResponse call

func (PatchApiV1AdminHooksNameSettingsResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchApiV1AdminHooksNameSettingsResponse) GetBody

GetBody returns the raw response body bytes

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON409

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PatchApiV1AdminHooksNameSettingsResponse) Status

Status returns HTTPResponse.Status

func (PatchApiV1AdminHooksNameSettingsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PatchApiV1AdminKeysIdParams

type PatchApiV1AdminKeysIdParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PatchApiV1AdminKeysIdParams defines parameters for PatchApiV1AdminKeysId.

type PatchApiV1AdminKeysIdResponse

type PatchApiV1AdminKeysIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *KeyView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePatchApiV1AdminKeysIdResponse

func ParsePatchApiV1AdminKeysIdResponse(rsp *http.Response) (*PatchApiV1AdminKeysIdResponse, error)

ParsePatchApiV1AdminKeysIdResponse parses an HTTP response from a PatchApiV1AdminKeysIdWithResponse call

func (PatchApiV1AdminKeysIdResponse) ContentType

func (r PatchApiV1AdminKeysIdResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchApiV1AdminKeysIdResponse) GetBody

func (r PatchApiV1AdminKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchApiV1AdminKeysIdResponse) GetJSON200

func (r PatchApiV1AdminKeysIdResponse) GetJSON200() *KeyView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON400

func (r PatchApiV1AdminKeysIdResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON401

func (r PatchApiV1AdminKeysIdResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON403

func (r PatchApiV1AdminKeysIdResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON404

func (r PatchApiV1AdminKeysIdResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON409

func (r PatchApiV1AdminKeysIdResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PatchApiV1AdminKeysIdResponse) GetJSON429

func (r PatchApiV1AdminKeysIdResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PatchApiV1AdminKeysIdResponse) Status

Status returns HTTPResponse.Status

func (PatchApiV1AdminKeysIdResponse) StatusCode

func (r PatchApiV1AdminKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PluginView

type PluginView struct {
	// Active Whether the plugin is currently active, where tracked; `None` when activation is not summarized
	// at this level.
	Active *bool `json:"active"`

	// Loader `"compiled-in"` or `"external"`.
	Loader string `json:"loader"`
	Name   string `json:"name"`

	// Target For an external plugin, its transport target (socket path / webhook URL). `None` for compiled-in.
	Target *string `json:"target"`

	// Type `"auth"` or `"hooks"` — the plugin TYPE (each a distinct engine contract).
	Type string `json:"type"`
}

PluginView One plugin in the plugin catalog (`GET /api/v1/admin/plugins?type=`). A plugin is either COMPILED-IN (baked into the binary, feature-gated — provably removable via `--no-default-features`) or EXTERNAL (registered at runtime over socket/webhook). `active` is `Some(true/false)` where activation is tracked (auth modules: in the chain?; external hooks: configured = true) and `None` where it is a per-pool concern not summarized here (compiled-in ranking policies). Additive-only.

type PoolDetailView

type PoolDetailView struct {
	Members []PoolMemberStatusView `json:"members"`
	Name    string                 `json:"name"`
}

PoolDetailView The LIVE per-pool detail read (`GET /api/v1/admin/pools/{name}`) — the reliability/capacity dashboard data (design-admin-api-v1 §6.9): each member's breaker state, concurrency headroom, in-flight count, latency EWMA, and success/error tallies, read from the SAME store signals the routing seam ranks on. No LLM content, no credentials.

type PoolMemberStatusView

type PoolMemberStatusView struct {
	// AvailableConcurrency Free concurrency slots on this lane right now (lane-global; permits are shared across pools).
	AvailableConcurrency uint `json:"available_concurrency"`

	// CooldownRemainingSeconds Seconds until a tripped breaker's cooldown elapses; `0` when not cooling down. (`_seconds`
	// suffix — the one unit-suffix spelling across the surface, like `uptime_seconds`.)
	CooldownRemainingSeconds uint64 `json:"cooldown_remaining_seconds"`

	// Dead Whether the lane is hard-down/dead (distinct from a transiently-tripped breaker).
	Dead bool   `json:"dead"`
	Err  uint64 `json:"err"`

	// Inflight In-flight requests on this lane right now.
	Inflight int64 `json:"inflight"`

	// LastTripAt Epoch seconds of the most recent trip; `None` = never tripped.
	LastTripAt *uint64 `json:"last_trip_at"`

	// LatencyMs Latency EWMA in milliseconds, or `None` if no sample yet.
	LatencyMs *float64 `json:"latency_ms"`
	Model     string   `json:"model"`

	// Ok Successful and errored request tallies for this lane.
	Ok uint64 `json:"ok"`

	// TripCount MONOTONIC count of Closed→Open breaker trips on this lane. Breaker episodes are transient
	// and can open+close entirely between two polls — a consumer alerting on trips diffs this
	// count instead of trying to catch the live edge (audit #5). Carried across config apply and
	// restart with the rest of the learned health.
	TripCount uint64 `json:"trip_count"`

	// Usable Whether the lane can currently take dispatch (breaker closed / recovered). `false` while a
	// tripped breaker cools down or the lane is dead.
	Usable bool   `json:"usable"`
	Weight uint32 `json:"weight"`
}

PoolMemberStatusView One member's live status within a pool. The breaker signal is the release-exposed `usable`/`cooldown_remaining_seconds` pair (a lane in breaker cooldown reports `usable: false` with the seconds remaining) — the same summary `/stats` surfaces.

type PoolMemberView

type PoolMemberView struct {
	Model  string `json:"model"`
	Weight uint32 `json:"weight"`
}

PoolMemberView One member of a pool: the model it targets and its SWRR weight.

type PoolView

type PoolView struct {
	Members []PoolMemberView `json:"members"`
	Name    string           `json:"name"`
}

PoolView A pool in the topology read (`GET /api/v1/admin/pools`). Summary shape today: name + the member models and their weights. LIVE per-member status (breaker state, available concurrency, latency EWMA, budget/rate headroom — design-admin-api-v1 §6.9) is an additive follow-up; the field set only grows.

type PostApiV1AdminAuthCacheFlushResponse

type PostApiV1AdminAuthCacheFlushResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CacheFlushView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminAuthCacheFlushResponse

func ParsePostApiV1AdminAuthCacheFlushResponse(rsp *http.Response) (*PostApiV1AdminAuthCacheFlushResponse, error)

ParsePostApiV1AdminAuthCacheFlushResponse parses an HTTP response from a PostApiV1AdminAuthCacheFlushWithResponse call

func (PostApiV1AdminAuthCacheFlushResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminAuthCacheFlushResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminAuthCacheFlushResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminAuthCacheFlushResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminAuthCacheFlushResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminAuthCacheFlushResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminAuthCacheFlushResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminAuthCacheFlushResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminAuthCacheFlushResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminConfigApplyParams

type PostApiV1AdminConfigApplyParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PostApiV1AdminConfigApplyParams defines parameters for PostApiV1AdminConfigApply.

type PostApiV1AdminConfigApplyResponse

type PostApiV1AdminConfigApplyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigApplyView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminConfigApplyResponse

func ParsePostApiV1AdminConfigApplyResponse(rsp *http.Response) (*PostApiV1AdminConfigApplyResponse, error)

ParsePostApiV1AdminConfigApplyResponse parses an HTTP response from a PostApiV1AdminConfigApplyWithResponse call

func (PostApiV1AdminConfigApplyResponse) ContentType

func (r PostApiV1AdminConfigApplyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminConfigApplyResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminConfigApplyResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminConfigApplyResponse) GetJSON400

func (r PostApiV1AdminConfigApplyResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminConfigApplyResponse) GetJSON401

func (r PostApiV1AdminConfigApplyResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminConfigApplyResponse) GetJSON403

func (r PostApiV1AdminConfigApplyResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminConfigApplyResponse) GetJSON409

func (r PostApiV1AdminConfigApplyResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PostApiV1AdminConfigApplyResponse) GetJSON429

func (r PostApiV1AdminConfigApplyResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminConfigApplyResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminConfigApplyResponse) StatusCode

func (r PostApiV1AdminConfigApplyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminConfigReloadResponse

type PostApiV1AdminConfigReloadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigReloadView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminConfigReloadResponse

func ParsePostApiV1AdminConfigReloadResponse(rsp *http.Response) (*PostApiV1AdminConfigReloadResponse, error)

ParsePostApiV1AdminConfigReloadResponse parses an HTTP response from a PostApiV1AdminConfigReloadWithResponse call

func (PostApiV1AdminConfigReloadResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminConfigReloadResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminConfigReloadResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminConfigReloadResponse) GetJSON400

func (r PostApiV1AdminConfigReloadResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminConfigReloadResponse) GetJSON401

func (r PostApiV1AdminConfigReloadResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminConfigReloadResponse) GetJSON403

func (r PostApiV1AdminConfigReloadResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminConfigReloadResponse) GetJSON429

func (r PostApiV1AdminConfigReloadResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminConfigReloadResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminConfigReloadResponse) StatusCode

func (r PostApiV1AdminConfigReloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminConfigRollbackParams

type PostApiV1AdminConfigRollbackParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PostApiV1AdminConfigRollbackParams defines parameters for PostApiV1AdminConfigRollback.

type PostApiV1AdminConfigRollbackResponse

type PostApiV1AdminConfigRollbackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigRollbackView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminConfigRollbackResponse

func ParsePostApiV1AdminConfigRollbackResponse(rsp *http.Response) (*PostApiV1AdminConfigRollbackResponse, error)

ParsePostApiV1AdminConfigRollbackResponse parses an HTTP response from a PostApiV1AdminConfigRollbackWithResponse call

func (PostApiV1AdminConfigRollbackResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminConfigRollbackResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminConfigRollbackResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON409

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminConfigRollbackResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminConfigRollbackResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminConfigValidateResponse

type PostApiV1AdminConfigValidateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigValidateView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminConfigValidateResponse

func ParsePostApiV1AdminConfigValidateResponse(rsp *http.Response) (*PostApiV1AdminConfigValidateResponse, error)

ParsePostApiV1AdminConfigValidateResponse parses an HTTP response from a PostApiV1AdminConfigValidateWithResponse call

func (PostApiV1AdminConfigValidateResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminConfigValidateResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminConfigValidateResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminConfigValidateResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminConfigValidateResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminConfigValidateResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminConfigValidateResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminConfigValidateResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminConfigValidateResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminHooksParams

type PostApiV1AdminHooksParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PostApiV1AdminHooksParams defines parameters for PostApiV1AdminHooks.

type PostApiV1AdminHooksResponse

type PostApiV1AdminHooksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookView
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *HookView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminHooksResponse

func ParsePostApiV1AdminHooksResponse(rsp *http.Response) (*PostApiV1AdminHooksResponse, error)

ParsePostApiV1AdminHooksResponse parses an HTTP response from a PostApiV1AdminHooksWithResponse call

func (PostApiV1AdminHooksResponse) ContentType

func (r PostApiV1AdminHooksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminHooksResponse) GetBody

func (r PostApiV1AdminHooksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostApiV1AdminHooksResponse) GetJSON200

func (r PostApiV1AdminHooksResponse) GetJSON200() *HookView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON201

func (r PostApiV1AdminHooksResponse) GetJSON201() *HookView

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON400

func (r PostApiV1AdminHooksResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON401

func (r PostApiV1AdminHooksResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON403

func (r PostApiV1AdminHooksResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON409

func (r PostApiV1AdminHooksResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PostApiV1AdminHooksResponse) GetJSON429

func (r PostApiV1AdminHooksResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminHooksResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminHooksResponse) StatusCode

func (r PostApiV1AdminHooksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminKeysIdRotateResponse

type PostApiV1AdminKeysIdRotateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RotatedKeyView
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminKeysIdRotateResponse

func ParsePostApiV1AdminKeysIdRotateResponse(rsp *http.Response) (*PostApiV1AdminKeysIdRotateResponse, error)

ParsePostApiV1AdminKeysIdRotateResponse parses an HTTP response from a PostApiV1AdminKeysIdRotateWithResponse call

func (PostApiV1AdminKeysIdRotateResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminKeysIdRotateResponse) GetBody

GetBody returns the raw response body bytes

func (PostApiV1AdminKeysIdRotateResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) GetJSON401

func (r PostApiV1AdminKeysIdRotateResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) GetJSON403

func (r PostApiV1AdminKeysIdRotateResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) GetJSON404

func (r PostApiV1AdminKeysIdRotateResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) GetJSON409

func (r PostApiV1AdminKeysIdRotateResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) GetJSON429

func (r PostApiV1AdminKeysIdRotateResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminKeysIdRotateResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminKeysIdRotateResponse) StatusCode

func (r PostApiV1AdminKeysIdRotateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiV1AdminKeysResponse

type PostApiV1AdminKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *CreatedKeyView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePostApiV1AdminKeysResponse

func ParsePostApiV1AdminKeysResponse(rsp *http.Response) (*PostApiV1AdminKeysResponse, error)

ParsePostApiV1AdminKeysResponse parses an HTTP response from a PostApiV1AdminKeysWithResponse call

func (PostApiV1AdminKeysResponse) ContentType

func (r PostApiV1AdminKeysResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PostApiV1AdminKeysResponse) GetBody

func (r PostApiV1AdminKeysResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostApiV1AdminKeysResponse) GetJSON201

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (PostApiV1AdminKeysResponse) GetJSON400

func (r PostApiV1AdminKeysResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PostApiV1AdminKeysResponse) GetJSON401

func (r PostApiV1AdminKeysResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PostApiV1AdminKeysResponse) GetJSON403

func (r PostApiV1AdminKeysResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PostApiV1AdminKeysResponse) GetJSON409

func (r PostApiV1AdminKeysResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PostApiV1AdminKeysResponse) GetJSON429

func (r PostApiV1AdminKeysResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PostApiV1AdminKeysResponse) Status

Status returns HTTPResponse.Status

func (PostApiV1AdminKeysResponse) StatusCode

func (r PostApiV1AdminKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProviderView

type ProviderView struct {
	ModelCount uint   `json:"model_count"`
	Provider   string `json:"provider"`
}

ProviderView A provider in the topology read (`GET /api/v1/admin/providers`): the provider name + how many model lanes route through it.

type PutApiV1AdminAdminAuthParams

type PutApiV1AdminAdminAuthParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PutApiV1AdminAdminAuthParams defines parameters for PutApiV1AdminAdminAuth.

type PutApiV1AdminAdminAuthResponse

type PutApiV1AdminAdminAuthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AdminAuthPutView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePutApiV1AdminAdminAuthResponse

func ParsePutApiV1AdminAdminAuthResponse(rsp *http.Response) (*PutApiV1AdminAdminAuthResponse, error)

ParsePutApiV1AdminAdminAuthResponse parses an HTTP response from a PutApiV1AdminAdminAuthWithResponse call

func (PutApiV1AdminAdminAuthResponse) ContentType

func (r PutApiV1AdminAdminAuthResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutApiV1AdminAdminAuthResponse) GetBody

func (r PutApiV1AdminAdminAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutApiV1AdminAdminAuthResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutApiV1AdminAdminAuthResponse) GetJSON400

func (r PutApiV1AdminAdminAuthResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutApiV1AdminAdminAuthResponse) GetJSON401

func (r PutApiV1AdminAdminAuthResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutApiV1AdminAdminAuthResponse) GetJSON403

func (r PutApiV1AdminAdminAuthResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutApiV1AdminAdminAuthResponse) GetJSON409

func (r PutApiV1AdminAdminAuthResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutApiV1AdminAdminAuthResponse) GetJSON429

func (r PutApiV1AdminAdminAuthResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PutApiV1AdminAdminAuthResponse) Status

Status returns HTTPResponse.Status

func (PutApiV1AdminAdminAuthResponse) StatusCode

func (r PutApiV1AdminAdminAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutApiV1AdminHooksNameParams

type PutApiV1AdminHooksNameParams struct {
	// IfMatch Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 `version_conflict` (re-read and retry), nothing changes; absent or `*` = unconditional.
	IfMatch *string `json:"If-Match,omitempty"`
}

PutApiV1AdminHooksNameParams defines parameters for PutApiV1AdminHooksName.

type PutApiV1AdminHooksNameResponse

type PutApiV1AdminHooksNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HookView
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *Error
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *Error
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

func ParsePutApiV1AdminHooksNameResponse

func ParsePutApiV1AdminHooksNameResponse(rsp *http.Response) (*PutApiV1AdminHooksNameResponse, error)

ParsePutApiV1AdminHooksNameResponse parses an HTTP response from a PutApiV1AdminHooksNameWithResponse call

func (PutApiV1AdminHooksNameResponse) ContentType

func (r PutApiV1AdminHooksNameResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PutApiV1AdminHooksNameResponse) GetBody

func (r PutApiV1AdminHooksNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutApiV1AdminHooksNameResponse) GetJSON200

func (r PutApiV1AdminHooksNameResponse) GetJSON200() *HookView

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON400

func (r PutApiV1AdminHooksNameResponse) GetJSON400() *Error

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON401

func (r PutApiV1AdminHooksNameResponse) GetJSON401() *Error

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON403

func (r PutApiV1AdminHooksNameResponse) GetJSON403() *Error

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON404

func (r PutApiV1AdminHooksNameResponse) GetJSON404() *Error

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON409

func (r PutApiV1AdminHooksNameResponse) GetJSON409() *Error

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (PutApiV1AdminHooksNameResponse) GetJSON429

func (r PutApiV1AdminHooksNameResponse) GetJSON429() *Error

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (PutApiV1AdminHooksNameResponse) Status

Status returns HTTPResponse.Status

func (PutApiV1AdminHooksNameResponse) StatusCode

func (r PutApiV1AdminHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RotatedKeyView

type RotatedKeyView struct {
	AllowedPools   []string `json:"allowed_pools"`
	BudgetPeriod   string   `json:"budget_period"`
	CreatedAt      uint64   `json:"created_at"`
	Enabled        bool     `json:"enabled"`
	Id             string   `json:"id"`
	MaxBudgetCents *int64   `json:"max_budget_cents"`
	Name           string   `json:"name"`
	RpmLimit       *uint32  `json:"rpm_limit"`

	// Secret The fresh bearer secret — shown EXACTLY once.
	Secret   string  `json:"secret"`
	TpmLimit *uint32 `json:"tpm_limit"`
}

RotatedKeyView `POST /keys/{id}/rotate` — the key metadata plus the ONCE-shown fresh bearer secret.

type TopologyInfo

type TopologyInfo struct {
	Models    uint `json:"models"`
	Pools     uint `json:"pools"`
	Providers uint `json:"providers"`
}

TopologyInfo Pool/model/provider counts (`InfoView.topology`).

type UsageBreakdown

type UsageBreakdown struct {
	Requests uint64 `json:"requests"`

	// SpendMicros Busbar's derived cost estimate in MICRO-units of `currency` (1e-6 USD — integer math,
	// sub-cent precise, no float drift), from the operator's configured global prices. A consumer
	// with its own per-model catalog recomputes from the raw token split instead.
	SpendMicros         int64  `json:"spend_micros"`
	TokensCacheCreation uint64 `json:"tokens_cache_creation"`
	TokensCacheRead     uint64 `json:"tokens_cache_read"`

	// TokensInput Uncached input tokens (normalized additive-cache convention).
	TokensInput  uint64 `json:"tokens_input"`
	TokensOutput uint64 `json:"tokens_output"`
}

UsageBreakdown The raw consumption counts + the derived spend estimate — the one shape shared by `total`, `by_model` rows, and `by_key` rows, so a consumer writes ONE aggregation reader.

type UsageView

type UsageView struct {
	// AsOf Freshness marker: the epoch this read was computed at (counters accumulate live).
	AsOf uint64 `json:"as_of"`

	// ByKey Per-key aggregation (same raw-split shape). CAPPED at the top 1000 rows by spend (the
	// FinOps-relevant ordering); `by_key_truncated` says the cap fired — never a silent cut.
	ByKey []KeyUsageView `json:"by_key"`

	// ByKeyTruncated True when `by_key` was truncated to the cap (a deployment with more active keys than the
	// cap). `by_model` is never capped (bounded by the configured model fleet).
	ByKeyTruncated bool `json:"by_key_truncated"`

	// ByModel Per-(model, provider) aggregation — cost attribution by model (the FinOps unit).
	ByModel []ModelUsageView `json:"by_model"`

	// Currency The denomination of every `spend_micros` in this response (`USAGE_CURRENCY`).
	Currency string `json:"currency"`

	// Others The summed remainder BEYOND the `by_key` cap — present exactly when `by_key_truncated`, so
	// every unit of consumption is attributable at least to "others" (FinOps completeness:
	// `total == sum(by_key) + others`).
	Others *UsageBreakdown `json:"others,omitempty"`

	// Total The raw consumption counts + the derived spend estimate — the one shape shared by `total`,
	// `by_model` rows, and `by_key` rows, so a consumer writes ONE aggregation reader.
	Total UsageBreakdown `json:"total"`

	// Window The UTC-day metering bucket this response aggregates: `[start, end)` epoch seconds.
	Window UsageWindow `json:"window"`
}

UsageView Fleet METERING read (`GET /api/v1/admin/usage`) — the FinOps surface. Design principle: busbar exposes the RAW INPUTS of cost, not just its own number. Every row carries the full token SPLIT (input / output / cache-read / cache-creation — each prices differently), so a consumer with its own (special/negotiated) price catalog reconstructs cost independently; `spend_micros` is busbar's DERIVED estimate from the operator's configured global prices, computed at read time (raw counts are what's stored — a price change re-prices history consistently).

Time base — THE PINNED SHAPE RULING (external review R3 #1): a usage response is ALWAYS exactly ONE fixed UTC-day metering bucket (`window`). `?window=<bucket-start-epoch>` selects a PAST bucket (default: the current one); a multi-window series is the CLIENT fetching N buckets — or a future additive `?from=&to=` returning an ARRAY OF THIS SAME PER-BUCKET SHAPE, never a differently-shaped merged view. Billing periods aggregate client-side from day buckets (raw counts are stored, so the math is exact). Deliberately decoupled from per-key budget windows so per-model aggregation across keys is well-defined; budget ENFORCEMENT state lives on `GET /keys/{id}/usage`, not here. Empty aggregations when governance is disabled. No secrets — key ids/names only, never a token.

LEDGER RULE (one loud contract sentence): `spend_micros` is a MUTABLE ESTIMATE — derived at read time from the operator's CURRENT prices, so a price change re-prices history. Never store it as a ledger charge; bill from the raw token split.

type UsageWindow

type UsageWindow struct {
	End   uint64 `json:"end"`
	Start uint64 `json:"start"`
}

UsageWindow A metering window: `[start, end)` epoch seconds.

Directories

Path Synopsis
examples
info command
Command info calls GET /api/v1/admin/info and prints the TYPED version.
Command info calls GET /api/v1/admin/info and prints the TYPED version.

Jump to

Keyboard shortcuts

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