busbar

package module
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 8, 2026 License: Apache-2.0 Imports: 9 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.5.0). The current release is tagged v0.2.0, generated from the busbar 1.5.0 spec (which added operationIds, renaming every generated symbol — a breaking change from v0.1.0). dev is kept continuously synced with busbarAI's dev branch spec (see RELEASING.md). 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.2.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.GetInfoWithResponse(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.5.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).

main is additionally kept auto-synced with busbarAI's dev branch spec by .github/workflows/regen-from-upstream.yml — see RELEASING.md for how that works and how version tags get cut (separately, by hand).

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 NewDeleteExportNameRequest added in v0.4.0

func NewDeleteExportNameRequest(server string, name string, params *DeleteExportNameParams) (*http.Request, error)

NewDeleteExportNameRequest constructs an http.Request for the DeleteExportName method

func NewDeleteGroupsNameRequest added in v0.2.0

func NewDeleteGroupsNameRequest(server string, name string, params *DeleteGroupsNameParams) (*http.Request, error)

NewDeleteGroupsNameRequest constructs an http.Request for the DeleteGroupsName method

func NewDeleteHooksNameRequest added in v0.2.0

func NewDeleteHooksNameRequest(server string, name string, params *DeleteHooksNameParams) (*http.Request, error)

NewDeleteHooksNameRequest constructs an http.Request for the DeleteHooksName method

func NewDeleteIdentityProvidersNameRequest added in v0.4.0

func NewDeleteIdentityProvidersNameRequest(server string, name string, params *DeleteIdentityProvidersNameParams) (*http.Request, error)

NewDeleteIdentityProvidersNameRequest constructs an http.Request for the DeleteIdentityProvidersName method

func NewDeleteKeysIdRequest added in v0.2.0

func NewDeleteKeysIdRequest(server string, id string, params *DeleteKeysIdParams) (*http.Request, error)

NewDeleteKeysIdRequest constructs an http.Request for the DeleteKeysId method

func NewDeleteOverlaySectionRequest added in v0.2.0

func NewDeleteOverlaySectionRequest(server string, section DeleteOverlaySectionParamsSection, params *DeleteOverlaySectionParams) (*http.Request, error)

NewDeleteOverlaySectionRequest constructs an http.Request for the DeleteOverlaySection method

func NewDeletePluginsFileRequest added in v0.2.0

func NewDeletePluginsFileRequest(server string, file string) (*http.Request, error)

NewDeletePluginsFileRequest constructs an http.Request for the DeletePluginsFile method

func NewGetAdminAuthRequest added in v0.2.0

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

NewGetAdminAuthRequest constructs an http.Request for the GetAdminAuth method

func NewGetAuditRequest added in v0.2.0

func NewGetAuditRequest(server string, params *GetAuditParams) (*http.Request, error)

NewGetAuditRequest constructs an http.Request for the GetAudit method

func NewGetAuthRequest added in v0.2.0

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

NewGetAuthRequest constructs an http.Request for the GetAuth method

func NewGetConfigDiffRequest added in v0.2.0

func NewGetConfigDiffRequest(server string, params *GetConfigDiffParams) (*http.Request, error)

NewGetConfigDiffRequest constructs an http.Request for the GetConfigDiff method

func NewGetConfigRequest added in v0.2.0

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

NewGetConfigRequest constructs an http.Request for the GetConfig method

func NewGetConfigSettingsRequest added in v0.2.0

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

NewGetConfigSettingsRequest constructs an http.Request for the GetConfigSettings method

func NewGetConfigVersionsRequest added in v0.2.0

func NewGetConfigVersionsRequest(server string, params *GetConfigVersionsParams) (*http.Request, error)

NewGetConfigVersionsRequest constructs an http.Request for the GetConfigVersions method

func NewGetConfigVersionsVRequest added in v0.2.0

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

NewGetConfigVersionsVRequest constructs an http.Request for the GetConfigVersionsV method

func NewGetExportNameRequest added in v0.4.0

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

NewGetExportNameRequest constructs an http.Request for the GetExportName method

func NewGetExportRequest added in v0.4.0

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

NewGetExportRequest constructs an http.Request for the GetExport method

func NewGetGroupsNameRequest added in v0.2.0

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

NewGetGroupsNameRequest constructs an http.Request for the GetGroupsName method

func NewGetGroupsNameUsageRequest added in v0.2.0

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

NewGetGroupsNameUsageRequest constructs an http.Request for the GetGroupsNameUsage method

func NewGetGroupsRequest added in v0.2.0

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

NewGetGroupsRequest constructs an http.Request for the GetGroups method

func NewGetHooksNameHealthRequest added in v0.2.0

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

NewGetHooksNameHealthRequest constructs an http.Request for the GetHooksNameHealth method

func NewGetHooksNameRequest added in v0.2.0

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

NewGetHooksNameRequest constructs an http.Request for the GetHooksName method

func NewGetHooksNameSchemaRequest added in v0.2.0

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

NewGetHooksNameSchemaRequest constructs an http.Request for the GetHooksNameSchema method

func NewGetHooksNameStatusRequest added in v0.2.0

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

NewGetHooksNameStatusRequest constructs an http.Request for the GetHooksNameStatus method

func NewGetHooksRequest added in v0.2.0

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

NewGetHooksRequest constructs an http.Request for the GetHooks method

func NewGetIdentityProvidersNameRequest added in v0.4.0

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

NewGetIdentityProvidersNameRequest constructs an http.Request for the GetIdentityProvidersName method

func NewGetIdentityProvidersRequest added in v0.4.0

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

NewGetIdentityProvidersRequest constructs an http.Request for the GetIdentityProviders method

func NewGetInfoRequest added in v0.2.0

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

NewGetInfoRequest constructs an http.Request for the GetInfo method

func NewGetKeysIdRequest added in v0.2.0

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

NewGetKeysIdRequest constructs an http.Request for the GetKeysId method

func NewGetKeysIdUsageRequest added in v0.2.0

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

NewGetKeysIdUsageRequest constructs an http.Request for the GetKeysIdUsage method

func NewGetKeysRequest added in v0.2.0

func NewGetKeysRequest(server string, params *GetKeysParams) (*http.Request, error)

NewGetKeysRequest constructs an http.Request for the GetKeys method

func NewGetModelsRequest added in v0.2.0

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

NewGetModelsRequest constructs an http.Request for the GetModels method

func NewGetOpenapiJsonRequest added in v0.2.0

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

NewGetOpenapiJsonRequest constructs an http.Request for the GetOpenapiJson method

func NewGetPluginsFileSchemaRequest added in v0.2.0

func NewGetPluginsFileSchemaRequest(server string, file string) (*http.Request, error)

NewGetPluginsFileSchemaRequest constructs an http.Request for the GetPluginsFileSchema method

func NewGetPluginsRequest added in v0.2.0

func NewGetPluginsRequest(server string, params *GetPluginsParams) (*http.Request, error)

NewGetPluginsRequest constructs an http.Request for the GetPlugins method

func NewGetPoolsNameRequest added in v0.2.0

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

NewGetPoolsNameRequest constructs an http.Request for the GetPoolsName method

func NewGetPoolsRequest added in v0.2.0

func NewGetPoolsRequest(server string, params *GetPoolsParams) (*http.Request, error)

NewGetPoolsRequest constructs an http.Request for the GetPools method

func NewGetProvidersRequest added in v0.2.0

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

NewGetProvidersRequest constructs an http.Request for the GetProviders method

func NewGetUsageRequest added in v0.2.0

func NewGetUsageRequest(server string, params *GetUsageParams) (*http.Request, error)

NewGetUsageRequest constructs an http.Request for the GetUsage method

func NewPatchExportNameSettingsRequest added in v0.4.0

func NewPatchExportNameSettingsRequest(server string, name string, params *PatchExportNameSettingsParams, body PatchExportNameSettingsJSONRequestBody) (*http.Request, error)

NewPatchExportNameSettingsRequest calls the generic PatchExportNameSettings builder with application/json body

func NewPatchExportNameSettingsRequestWithBody added in v0.4.0

func NewPatchExportNameSettingsRequestWithBody(server string, name string, params *PatchExportNameSettingsParams, contentType string, body io.Reader) (*http.Request, error)

NewPatchExportNameSettingsRequestWithBody constructs an http.Request for the PatchExportNameSettings method, with any body, and a specified content type

func NewPatchGroupsNameRequest added in v0.2.0

func NewPatchGroupsNameRequest(server string, name string, params *PatchGroupsNameParams, body PatchGroupsNameJSONRequestBody) (*http.Request, error)

NewPatchGroupsNameRequest calls the generic PatchGroupsName builder with application/json body

func NewPatchGroupsNameRequestWithBody added in v0.2.0

func NewPatchGroupsNameRequestWithBody(server string, name string, params *PatchGroupsNameParams, contentType string, body io.Reader) (*http.Request, error)

NewPatchGroupsNameRequestWithBody constructs an http.Request for the PatchGroupsName method, with any body, and a specified content type

func NewPatchHooksNameSettingsRequest added in v0.2.0

func NewPatchHooksNameSettingsRequest(server string, name string, params *PatchHooksNameSettingsParams, body PatchHooksNameSettingsJSONRequestBody) (*http.Request, error)

NewPatchHooksNameSettingsRequest calls the generic PatchHooksNameSettings builder with application/json body

func NewPatchHooksNameSettingsRequestWithBody added in v0.2.0

func NewPatchHooksNameSettingsRequestWithBody(server string, name string, params *PatchHooksNameSettingsParams, contentType string, body io.Reader) (*http.Request, error)

NewPatchHooksNameSettingsRequestWithBody constructs an http.Request for the PatchHooksNameSettings method, with any body, and a specified content type

func NewPatchIdentityProvidersNameSettingsRequest added in v0.4.0

func NewPatchIdentityProvidersNameSettingsRequest(server string, name string, params *PatchIdentityProvidersNameSettingsParams, body PatchIdentityProvidersNameSettingsJSONRequestBody) (*http.Request, error)

NewPatchIdentityProvidersNameSettingsRequest calls the generic PatchIdentityProvidersNameSettings builder with application/json body

func NewPatchIdentityProvidersNameSettingsRequestWithBody added in v0.4.0

func NewPatchIdentityProvidersNameSettingsRequestWithBody(server string, name string, params *PatchIdentityProvidersNameSettingsParams, contentType string, body io.Reader) (*http.Request, error)

NewPatchIdentityProvidersNameSettingsRequestWithBody constructs an http.Request for the PatchIdentityProvidersNameSettings method, with any body, and a specified content type

func NewPatchKeysIdRequest added in v0.2.0

func NewPatchKeysIdRequest(server string, id string, params *PatchKeysIdParams, body PatchKeysIdJSONRequestBody) (*http.Request, error)

NewPatchKeysIdRequest calls the generic PatchKeysId builder with application/json body

func NewPatchKeysIdRequestWithBody added in v0.2.0

func NewPatchKeysIdRequestWithBody(server string, id string, params *PatchKeysIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPatchKeysIdRequestWithBody constructs an http.Request for the PatchKeysId method, with any body, and a specified content type

func NewPostAuthCacheFlushRequest added in v0.2.0

func NewPostAuthCacheFlushRequest(server string, body PostAuthCacheFlushJSONRequestBody) (*http.Request, error)

NewPostAuthCacheFlushRequest calls the generic PostAuthCacheFlush builder with application/json body

func NewPostAuthCacheFlushRequestWithBody added in v0.2.0

func NewPostAuthCacheFlushRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostAuthCacheFlushRequestWithBody constructs an http.Request for the PostAuthCacheFlush method, with any body, and a specified content type

func NewPostConfigApplyRequest added in v0.2.0

func NewPostConfigApplyRequest(server string, params *PostConfigApplyParams, body PostConfigApplyJSONRequestBody) (*http.Request, error)

NewPostConfigApplyRequest calls the generic PostConfigApply builder with application/json body

func NewPostConfigApplyRequestWithBody added in v0.2.0

func NewPostConfigApplyRequestWithBody(server string, params *PostConfigApplyParams, contentType string, body io.Reader) (*http.Request, error)

NewPostConfigApplyRequestWithBody constructs an http.Request for the PostConfigApply method, with any body, and a specified content type

func NewPostConfigReloadRequest added in v0.2.0

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

NewPostConfigReloadRequest constructs an http.Request for the PostConfigReload method

func NewPostConfigRollbackRequest added in v0.2.0

func NewPostConfigRollbackRequest(server string, params *PostConfigRollbackParams, body PostConfigRollbackJSONRequestBody) (*http.Request, error)

NewPostConfigRollbackRequest calls the generic PostConfigRollback builder with application/json body

func NewPostConfigRollbackRequestWithBody added in v0.2.0

func NewPostConfigRollbackRequestWithBody(server string, params *PostConfigRollbackParams, contentType string, body io.Reader) (*http.Request, error)

NewPostConfigRollbackRequestWithBody constructs an http.Request for the PostConfigRollback method, with any body, and a specified content type

func NewPostConfigValidateRequest added in v0.2.0

func NewPostConfigValidateRequest(server string, body PostConfigValidateJSONRequestBody) (*http.Request, error)

NewPostConfigValidateRequest calls the generic PostConfigValidate builder with application/json body

func NewPostConfigValidateRequestWithBody added in v0.2.0

func NewPostConfigValidateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostConfigValidateRequestWithBody constructs an http.Request for the PostConfigValidate method, with any body, and a specified content type

func NewPostGroupsRequest added in v0.2.0

func NewPostGroupsRequest(server string, params *PostGroupsParams, body PostGroupsJSONRequestBody) (*http.Request, error)

NewPostGroupsRequest calls the generic PostGroups builder with application/json body

func NewPostGroupsRequestWithBody added in v0.2.0

func NewPostGroupsRequestWithBody(server string, params *PostGroupsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostGroupsRequestWithBody constructs an http.Request for the PostGroups method, with any body, and a specified content type

func NewPostHooksRequest added in v0.2.0

func NewPostHooksRequest(server string, params *PostHooksParams, body PostHooksJSONRequestBody) (*http.Request, error)

NewPostHooksRequest calls the generic PostHooks builder with application/json body

func NewPostHooksRequestWithBody added in v0.2.0

func NewPostHooksRequestWithBody(server string, params *PostHooksParams, contentType string, body io.Reader) (*http.Request, error)

NewPostHooksRequestWithBody constructs an http.Request for the PostHooks method, with any body, and a specified content type

func NewPostKeysIdRevokeRequest added in v0.2.0

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

NewPostKeysIdRevokeRequest constructs an http.Request for the PostKeysIdRevoke method

func NewPostKeysIdRotateRequest added in v0.2.0

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

NewPostKeysIdRotateRequest constructs an http.Request for the PostKeysIdRotate method

func NewPostKeysRequest added in v0.2.0

func NewPostKeysRequest(server string, body PostKeysJSONRequestBody) (*http.Request, error)

NewPostKeysRequest calls the generic PostKeys builder with application/json body

func NewPostKeysRequestWithBody added in v0.2.0

func NewPostKeysRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostKeysRequestWithBody constructs an http.Request for the PostKeys method, with any body, and a specified content type

func NewPostPluginsInspectRequest added in v0.3.0

func NewPostPluginsInspectRequest(server string, body PostPluginsInspectJSONRequestBody) (*http.Request, error)

NewPostPluginsInspectRequest calls the generic PostPluginsInspect builder with application/json body

func NewPostPluginsInspectRequestWithBody added in v0.3.0

func NewPostPluginsInspectRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostPluginsInspectRequestWithBody constructs an http.Request for the PostPluginsInspect method, with any body, and a specified content type

func NewPostPluginsReloadRequest added in v0.2.0

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

NewPostPluginsReloadRequest constructs an http.Request for the PostPluginsReload method

func NewPostPluginsRequest added in v0.2.0

func NewPostPluginsRequest(server string, body PostPluginsJSONRequestBody) (*http.Request, error)

NewPostPluginsRequest calls the generic PostPlugins builder with application/json body

func NewPostPluginsRequestWithBody added in v0.2.0

func NewPostPluginsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostPluginsRequestWithBody constructs an http.Request for the PostPlugins method, with any body, and a specified content type

func NewPostPluginsRollbackRequest added in v0.2.0

func NewPostPluginsRollbackRequest(server string, params *PostPluginsRollbackParams, body PostPluginsRollbackJSONRequestBody) (*http.Request, error)

NewPostPluginsRollbackRequest calls the generic PostPluginsRollback builder with application/json body

func NewPostPluginsRollbackRequestWithBody added in v0.2.0

func NewPostPluginsRollbackRequestWithBody(server string, params *PostPluginsRollbackParams, contentType string, body io.Reader) (*http.Request, error)

NewPostPluginsRollbackRequestWithBody constructs an http.Request for the PostPluginsRollback method, with any body, and a specified content type

func NewPostRestartRequest added in v0.2.0

func NewPostRestartRequest(server string, body PostRestartJSONRequestBody) (*http.Request, error)

NewPostRestartRequest calls the generic PostRestart builder with application/json body

func NewPostRestartRequestWithBody added in v0.2.0

func NewPostRestartRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostRestartRequestWithBody constructs an http.Request for the PostRestart method, with any body, and a specified content type

func NewPostSigningKeyRotateRequest added in v0.2.0

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

NewPostSigningKeyRotateRequest constructs an http.Request for the PostSigningKeyRotate method

func NewPutAdminAuthRequest added in v0.2.0

func NewPutAdminAuthRequest(server string, params *PutAdminAuthParams, body PutAdminAuthJSONRequestBody) (*http.Request, error)

NewPutAdminAuthRequest calls the generic PutAdminAuth builder with application/json body

func NewPutAdminAuthRequestWithBody added in v0.2.0

func NewPutAdminAuthRequestWithBody(server string, params *PutAdminAuthParams, contentType string, body io.Reader) (*http.Request, error)

NewPutAdminAuthRequestWithBody constructs an http.Request for the PutAdminAuth method, with any body, and a specified content type

func NewPutConfigSettingsRequest added in v0.2.0

func NewPutConfigSettingsRequest(server string, params *PutConfigSettingsParams, body PutConfigSettingsJSONRequestBody) (*http.Request, error)

NewPutConfigSettingsRequest calls the generic PutConfigSettings builder with application/json body

func NewPutConfigSettingsRequestWithBody added in v0.2.0

func NewPutConfigSettingsRequestWithBody(server string, params *PutConfigSettingsParams, contentType string, body io.Reader) (*http.Request, error)

NewPutConfigSettingsRequestWithBody constructs an http.Request for the PutConfigSettings method, with any body, and a specified content type

func NewPutExportNameRequest added in v0.4.0

func NewPutExportNameRequest(server string, name string, params *PutExportNameParams, body PutExportNameJSONRequestBody) (*http.Request, error)

NewPutExportNameRequest calls the generic PutExportName builder with application/json body

func NewPutExportNameRequestWithBody added in v0.4.0

func NewPutExportNameRequestWithBody(server string, name string, params *PutExportNameParams, contentType string, body io.Reader) (*http.Request, error)

NewPutExportNameRequestWithBody constructs an http.Request for the PutExportName method, with any body, and a specified content type

func NewPutGroupsNameRequest added in v0.2.0

func NewPutGroupsNameRequest(server string, name string, params *PutGroupsNameParams, body PutGroupsNameJSONRequestBody) (*http.Request, error)

NewPutGroupsNameRequest calls the generic PutGroupsName builder with application/json body

func NewPutGroupsNameRequestWithBody added in v0.2.0

func NewPutGroupsNameRequestWithBody(server string, name string, params *PutGroupsNameParams, contentType string, body io.Reader) (*http.Request, error)

NewPutGroupsNameRequestWithBody constructs an http.Request for the PutGroupsName method, with any body, and a specified content type

func NewPutHooksNameRequest added in v0.2.0

func NewPutHooksNameRequest(server string, name string, params *PutHooksNameParams, body PutHooksNameJSONRequestBody) (*http.Request, error)

NewPutHooksNameRequest calls the generic PutHooksName builder with application/json body

func NewPutHooksNameRequestWithBody added in v0.2.0

func NewPutHooksNameRequestWithBody(server string, name string, params *PutHooksNameParams, contentType string, body io.Reader) (*http.Request, error)

NewPutHooksNameRequestWithBody constructs an http.Request for the PutHooksName method, with any body, and a specified content type

func NewPutIdentityProvidersNameRequest added in v0.4.0

func NewPutIdentityProvidersNameRequest(server string, name string, params *PutIdentityProvidersNameParams, body PutIdentityProvidersNameJSONRequestBody) (*http.Request, error)

NewPutIdentityProvidersNameRequest calls the generic PutIdentityProvidersName builder with application/json body

func NewPutIdentityProvidersNameRequestWithBody added in v0.4.0

func NewPutIdentityProvidersNameRequestWithBody(server string, name string, params *PutIdentityProvidersNameParams, contentType string, body io.Reader) (*http.Request, error)

NewPutIdentityProvidersNameRequestWithBody constructs an http.Request for the PutIdentityProvidersName method, with any body, and a specified content type

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: `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) DeleteExportName added in v0.4.0

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

DeleteExportName Remove one `export:` definition, refused while another config section still references it by bare name

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

func (*Client) DeleteGroupsName added in v0.2.0

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

DeleteGroupsName Remove an overlay group at runtime, live immediately

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

func (*Client) DeleteHooksName added in v0.2.0

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

DeleteHooksName Remove a hook at runtime, live immediately

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

func (*Client) DeleteIdentityProvidersName added in v0.4.0

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

DeleteIdentityProvidersName Remove one `identity-providers:` definition, refused while another config section still references it by bare name

Corresponds with DELETE /api/v1/admin/identity-providers/{name} (the `DeleteIdentityProvidersName` operationId).

func (*Client) DeleteKeysId added in v0.2.0

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

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

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

func (*Client) DeleteOverlaySection added in v0.2.0

func (c *Client) DeleteOverlaySection(ctx context.Context, section DeleteOverlaySectionParamsSection, params *DeleteOverlaySectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteOverlaySection DISCARD a section's overlay mutations and revert it to base config.yaml (section ∈ groups|hooks|root|plugin_versions). Per-section reset: the OTHER sections' overlay survives. A NEW config version; an already-empty section is an idempotent no-op (changed:false)

Corresponds with DELETE /api/v1/admin/overlay/{section} (the `DeleteOverlaySection` operationId).

func (*Client) DeletePluginsFile added in v0.2.0

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

DeletePluginsFile Remove a dynamic-library plugin (library + manifest sidecar) from the plugins directory. A loaded store keeps running until the next store (re)load

Corresponds with DELETE /api/v1/admin/plugins/{file} (the `DeletePluginsFile` operationId).

func (*Client) GetAdminAuth added in v0.2.0

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

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

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

func (*Client) GetAudit added in v0.2.0

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

GetAudit 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 `GetAudit` operationId).

func (*Client) GetAuth added in v0.2.0

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

GetAuth Ingress auth chain + upstream-credential mode

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

func (*Client) GetConfig added in v0.2.0

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

GetConfig Effective running config snapshot (redacted)

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

func (*Client) GetConfigDiff added in v0.2.0

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

GetConfigDiff Structured hook-surface diff between two retained versions

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

func (*Client) GetConfigSettings added in v0.2.0

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

GetConfigSettings Read the API-set single-value config overlay (root section: listen/tls/rate_card/store/security/limits/…), only the operator's overrides; base config.yaml stands for the rest

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

func (*Client) GetConfigVersions added in v0.2.0

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

GetConfigVersions 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 `GetConfigVersions` operationId).

func (*Client) GetConfigVersionsV added in v0.2.0

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

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

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

func (*Client) GetExport added in v0.4.0

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

GetExport Every `export:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected

Corresponds with GET /api/v1/admin/export (the `GetExport` operationId).

func (*Client) GetExportName added in v0.4.0

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

GetExportName One `export:` definition

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

func (*Client) GetGroups added in v0.2.0

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

GetGroups Group registry: the limit tree (parent chain, limits, child_default budget template)

Corresponds with GET /api/v1/admin/groups (the `GetGroups` operationId).

func (*Client) GetGroupsName added in v0.2.0

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

GetGroupsName One group definition (parent, enabled, limits, child_default)

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

func (*Client) GetGroupsNameUsage added in v0.2.0

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

GetGroupsNameUsage The group's derived current-window usage per (window, pool) enforcement bucket vs its caps: the self-service dashboard read (spend derives from the token ledger x the CURRENT rate card at read time)

Corresponds with GET /api/v1/admin/groups/{name}/usage (the `GetGroupsNameUsage` operationId).

func (*Client) GetHooks added in v0.2.0

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

GetHooks Hook registry (definitions)

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

func (*Client) GetHooksName added in v0.2.0

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

GetHooksName One hook definition

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

func (*Client) GetHooksNameHealth added in v0.2.0

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

GetHooksNameHealth Best-effort hook transport reachability

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

func (*Client) GetHooksNameSchema added in v0.2.0

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

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

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

func (*Client) GetHooksNameStatus added in v0.2.0

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

GetHooksNameStatus 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 `GetHooksNameStatus` operationId).

func (*Client) GetIdentityProviders added in v0.4.0

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

GetIdentityProviders Every `identity-providers:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected

Corresponds with GET /api/v1/admin/identity-providers (the `GetIdentityProviders` operationId).

func (*Client) GetIdentityProvidersName added in v0.4.0

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

GetIdentityProvidersName One `identity-providers:` definition

Corresponds with GET /api/v1/admin/identity-providers/{name} (the `GetIdentityProvidersName` operationId).

func (*Client) GetInfo added in v0.2.0

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

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

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

func (*Client) GetKeys added in v0.2.0

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

GetKeys List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=, ?group= (keys bound to a group; a `user:<sub>` leaf's keys are one person's). Paginate: ?limit=, ?cursor= (opaque)

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

func (*Client) GetKeysId added in v0.2.0

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

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

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

func (*Client) GetKeysIdUsage added in v0.2.0

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

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

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

func (*Client) GetModels added in v0.2.0

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

GetModels Model lanes + upstream providers

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

func (*Client) GetOpenapiJson added in v0.2.0

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

GetOpenapiJson This OpenAPI 3.1 document

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

func (*Client) GetPlugins added in v0.2.0

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

GetPlugins Plugin catalog by type (compiled-in + external + dynamic-library)

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

func (*Client) GetPluginsFileSchema added in v0.2.0

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

GetPluginsFileSchema The plugin's self-described settings JSON Schema, read from the SIGNED manifest's `settings_schema` field, which works for every plugin kind (store/secret/auth/hook), not just hooks. `hook` plugins keep the live describe-proxy behavior when describe answers (source: describe); a loaded hook whose describe answers null falls back server-side to the manifest baseline (source: manifest)

Corresponds with GET /api/v1/admin/plugins/{file}/schema (the `GetPluginsFileSchema` operationId).

func (*Client) GetPools added in v0.2.0

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

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

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

func (*Client) GetPoolsName added in v0.2.0

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

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

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

func (*Client) GetProviders added in v0.2.0

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

GetProviders Distinct providers + lane counts

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

func (*Client) GetUsage added in v0.2.0

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

GetUsage 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 `GetUsage` operationId).

func (*Client) PatchExportNameSettings added in v0.4.0

func (c *Client) PatchExportNameSettings(ctx context.Context, name string, params *PatchExportNameSettingsParams, body PatchExportNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchExportNameSettings Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical

Takes a body of the `application/json` content type.

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

func (*Client) PatchExportNameSettingsWithBody added in v0.4.0

func (c *Client) PatchExportNameSettingsWithBody(ctx context.Context, name string, params *PatchExportNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchExportNameSettingsWithBody Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical

Takes any type of body and a specified content type.

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

func (*Client) PatchGroupsName added in v0.2.0

func (c *Client) PatchGroupsName(ctx context.Context, name string, params *PatchGroupsNameParams, body PatchGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchGroupsName Partial update: change only the fields present (e.g. raise a budget, freeze a group)

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).

func (*Client) PatchGroupsNameWithBody added in v0.2.0

func (c *Client) PatchGroupsNameWithBody(ctx context.Context, name string, params *PatchGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchGroupsNameWithBody Partial update: change only the fields present (e.g. raise a budget, freeze a group)

Takes any type of body and a specified content type.

Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).

func (*Client) PatchHooksNameSettings added in v0.2.0

func (c *Client) PatchHooksNameSettings(ctx context.Context, name string, params *PatchHooksNameSettingsParams, body PatchHooksNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes a body of the `application/json` content type.

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

func (*Client) PatchHooksNameSettingsWithBody added in v0.2.0

func (c *Client) PatchHooksNameSettingsWithBody(ctx context.Context, name string, params *PatchHooksNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes any type of body and a specified content type.

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

func (*Client) PatchIdentityProvidersNameSettings added in v0.4.0

func (c *Client) PatchIdentityProvidersNameSettings(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, body PatchIdentityProvidersNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchIdentityProvidersNameSettings Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).

func (*Client) PatchIdentityProvidersNameSettingsWithBody added in v0.4.0

func (c *Client) PatchIdentityProvidersNameSettingsWithBody(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchIdentityProvidersNameSettingsWithBody Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical

Takes any type of body and a specified content type.

Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).

func (*Client) PatchKeysId added in v0.2.0

func (c *Client) PatchKeysId(ctx context.Context, id string, params *PatchKeysIdParams, body PatchKeysIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchKeysId Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency

Takes a body of the `application/json` content type.

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

func (*Client) PatchKeysIdWithBody added in v0.2.0

func (c *Client) PatchKeysIdWithBody(ctx context.Context, id string, params *PatchKeysIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchKeysIdWithBody Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency

Takes any type of body and a specified content type.

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

func (*Client) PostAuthCacheFlush added in v0.2.0

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

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

Takes a body of the `application/json` content type.

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

func (*Client) PostAuthCacheFlushWithBody added in v0.2.0

func (c *Client) PostAuthCacheFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes any type of body and a specified content type.

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

func (*Client) PostConfigApply added in v0.2.0

func (c *Client) PostConfigApply(ctx context.Context, params *PostConfigApplyParams, body PostConfigApplyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes a body of the `application/json` content type.

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

func (*Client) PostConfigApplyWithBody added in v0.2.0

func (c *Client) PostConfigApplyWithBody(ctx context.Context, params *PostConfigApplyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes any type of body and a specified content type.

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

func (*Client) PostConfigReload added in v0.2.0

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

PostConfigReload 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 `PostConfigReload` operationId).

func (*Client) PostConfigRollback added in v0.2.0

func (c *Client) PostConfigRollback(ctx context.Context, params *PostConfigRollbackParams, body PostConfigRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes a body of the `application/json` content type.

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

func (*Client) PostConfigRollbackWithBody added in v0.2.0

func (c *Client) PostConfigRollbackWithBody(ctx context.Context, params *PostConfigRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes any type of body and a specified content type.

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

func (*Client) PostConfigValidate added in v0.2.0

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

PostConfigValidate Dry-run validate a proposed config

Takes a body of the `application/json` content type.

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

func (*Client) PostConfigValidateWithBody added in v0.2.0

func (c *Client) PostConfigValidateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostConfigValidateWithBody Dry-run validate a proposed config

Takes any type of body and a specified content type.

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

func (*Client) PostGroups added in v0.2.0

func (c *Client) PostGroups(ctx context.Context, params *PostGroupsParams, body PostGroupsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostGroups Create (or replace) a group at runtime, live immediately (upsert)

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).

func (*Client) PostGroupsWithBody added in v0.2.0

func (c *Client) PostGroupsWithBody(ctx context.Context, params *PostGroupsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostGroupsWithBody Create (or replace) a group at runtime, live immediately (upsert)

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).

func (*Client) PostHooks added in v0.2.0

func (c *Client) PostHooks(ctx context.Context, params *PostHooksParams, body PostHooksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostHooks Register (or replace) a hook at runtime, live immediately

Takes a body of the `application/json` content type.

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

func (*Client) PostHooksWithBody added in v0.2.0

func (c *Client) PostHooksWithBody(ctx context.Context, params *PostHooksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostHooksWithBody Register (or replace) a hook at runtime, live immediately

Takes any type of body and a specified content type.

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

func (*Client) PostKeys added in v0.2.0

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

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

Takes a body of the `application/json` content type.

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

func (*Client) PostKeysIdRevoke added in v0.2.0

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

PostKeysIdRevoke REVOKE a signed-token key: denylist it durably WITHOUT deleting the binding (GET /keys/{id} still shows the record; verify now fails). Idempotent: revoking an already-revoked key is 200. DELETE /keys/{id} is the revoke-AND-forget variant (1.5.0)

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

func (*Client) PostKeysIdRotate added in v0.2.0

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

PostKeysIdRotate 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 `PostKeysIdRotate` operationId).

func (*Client) PostKeysWithBody added in v0.2.0

func (c *Client) PostKeysWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

Takes any type of body and a specified content type.

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

func (*Client) PostPlugins added in v0.2.0

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

PostPlugins Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).

func (*Client) PostPluginsInspect added in v0.3.0

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

PostPluginsInspect Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).

func (*Client) PostPluginsInspectWithBody added in v0.3.0

func (c *Client) PostPluginsInspectWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostPluginsInspectWithBody Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).

func (*Client) PostPluginsReload added in v0.2.0

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

PostPluginsReload Re-scan the plugins directory and report the reconciled dynamic-library inventory (the sibling of config/reload). A store change takes effect on the next store (re)load

Corresponds with POST /api/v1/admin/plugins/reload (the `PostPluginsReload` operationId).

func (*Client) PostPluginsRollback added in v0.2.0

func (c *Client) PostPluginsRollback(ctx context.Context, params *PostPluginsRollbackParams, body PostPluginsRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PostPluginsRollback EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).

func (*Client) PostPluginsRollbackWithBody added in v0.2.0

func (c *Client) PostPluginsRollbackWithBody(ctx context.Context, params *PostPluginsRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostPluginsRollbackWithBody EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).

func (*Client) PostPluginsWithBody added in v0.2.0

func (c *Client) PostPluginsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostPluginsWithBody Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).

func (*Client) PostRestart added in v0.2.0

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

PostRestart Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).

func (*Client) PostRestartWithBody added in v0.2.0

func (c *Client) PostRestartWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostRestartWithBody Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).

func (*Client) PostSigningKeyRotate added in v0.2.0

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

PostSigningKeyRotate ROTATE the busbar key-signing key. Rotation is REVOKE-ALL by design: a new signing key means every token minted under the OLD key stops verifying, so every outstanding key must be re-minted. 1.5.0 is single-key, so this reports the intent + current kid; the actual swap is an operator action (replace auth.signing_key / the persisted key file and restart/reload every node in lockstep) (1.5.0)

Corresponds with POST /api/v1/admin/signing-key/rotate (the `PostSigningKeyRotate` operationId).

func (*Client) PutAdminAuth added in v0.2.0

func (c *Client) PutAdminAuth(ctx context.Context, params *PutAdminAuthParams, body PutAdminAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutAdminAuth 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

Takes a body of the `application/json` content type.

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

func (*Client) PutAdminAuthWithBody added in v0.2.0

func (c *Client) PutAdminAuthWithBody(ctx context.Context, params *PutAdminAuthParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutAdminAuthWithBody 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

Takes any type of body and a specified content type.

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

func (*Client) PutConfigSettings added in v0.2.0

func (c *Client) PutConfigSettings(ctx context.Context, params *PutConfigSettingsParams, body PutConfigSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutConfigSettings SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).

func (*Client) PutConfigSettingsWithBody added in v0.2.0

func (c *Client) PutConfigSettingsWithBody(ctx context.Context, params *PutConfigSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutConfigSettingsWithBody SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).

func (*Client) PutExportName added in v0.4.0

func (c *Client) PutExportName(ctx context.Context, name string, params *PutExportNameParams, body PutExportNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutExportName Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)

Takes a body of the `application/json` content type.

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

func (*Client) PutExportNameWithBody added in v0.4.0

func (c *Client) PutExportNameWithBody(ctx context.Context, name string, params *PutExportNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutExportNameWithBody Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)

Takes any type of body and a specified content type.

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

func (*Client) PutGroupsName added in v0.2.0

func (c *Client) PutGroupsName(ctx context.Context, name string, params *PutGroupsNameParams, body PutGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutGroupsName Replace an overlay group definition, live immediately (limits rebuilt)

Takes a body of the `application/json` content type.

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

func (*Client) PutGroupsNameWithBody added in v0.2.0

func (c *Client) PutGroupsNameWithBody(ctx context.Context, name string, params *PutGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutGroupsNameWithBody Replace an overlay group definition, live immediately (limits rebuilt)

Takes any type of body and a specified content type.

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

func (*Client) PutHooksName added in v0.2.0

func (c *Client) PutHooksName(ctx context.Context, name string, params *PutHooksNameParams, body PutHooksNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutHooksName Replace an overlay hook definition, live immediately (grants immutable)

Takes a body of the `application/json` content type.

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

func (*Client) PutHooksNameWithBody added in v0.2.0

func (c *Client) PutHooksNameWithBody(ctx context.Context, name string, params *PutHooksNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutHooksNameWithBody Replace an overlay hook definition, live immediately (grants immutable)

Takes any type of body and a specified content type.

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

func (*Client) PutIdentityProvidersName added in v0.4.0

func (c *Client) PutIdentityProvidersName(ctx context.Context, name string, params *PutIdentityProvidersNameParams, body PutIdentityProvidersNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PutIdentityProvidersName Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)

Takes a body of the `application/json` content type.

Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).

func (*Client) PutIdentityProvidersNameWithBody added in v0.4.0

func (c *Client) PutIdentityProvidersNameWithBody(ctx context.Context, name string, params *PutIdentityProvidersNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PutIdentityProvidersNameWithBody Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)

Takes any type of body and a specified content type.

Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).

type ClientInterface

type ClientInterface interface {

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

	// PutAdminAuthWithBody 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
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutAdminAuth` operationId).
	PutAdminAuthWithBody(ctx context.Context, params *PutAdminAuthParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutAdminAuth 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
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutAdminAuth` operationId).
	PutAdminAuth(ctx context.Context, params *PutAdminAuthParams, body PutAdminAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAudit 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 `GetAudit` operationId).
	GetAudit(ctx context.Context, params *GetAuditParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// PostAuthCacheFlushWithBody Flush the credential cache: one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostAuthCacheFlush` operationId).
	PostAuthCacheFlushWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// PostConfigApplyWithBody Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/config/apply (the `PostConfigApply` operationId).
	PostConfigApplyWithBody(ctx context.Context, params *PostConfigApplyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// PostConfigReload 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 `PostConfigReload` operationId).
	PostConfigReload(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostConfigRollbackWithBody Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostConfigRollback` operationId).
	PostConfigRollbackWithBody(ctx context.Context, params *PostConfigRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostConfigRollback Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostConfigRollback` operationId).
	PostConfigRollback(ctx context.Context, params *PostConfigRollbackParams, body PostConfigRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetConfigSettings Read the API-set single-value config overlay (root section: listen/tls/rate_card/store/security/limits/…), only the operator's overrides; base config.yaml stands for the rest
	//
	// Corresponds with GET /api/v1/admin/config/settings (the `GetConfigSettings` operationId).
	GetConfigSettings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutConfigSettingsWithBody SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).
	PutConfigSettingsWithBody(ctx context.Context, params *PutConfigSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutConfigSettings SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).
	PutConfigSettings(ctx context.Context, params *PutConfigSettingsParams, body PutConfigSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostConfigValidateWithBody Dry-run validate a proposed config
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostConfigValidate` operationId).
	PostConfigValidateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostConfigValidate Dry-run validate a proposed config
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostConfigValidate` operationId).
	PostConfigValidate(ctx context.Context, body PostConfigValidateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetConfigVersions 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 `GetConfigVersions` operationId).
	GetConfigVersions(ctx context.Context, params *GetConfigVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// GetExport Every `export:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected
	//
	// Corresponds with GET /api/v1/admin/export (the `GetExport` operationId).
	GetExport(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteExportName Remove one `export:` definition, refused while another config section still references it by bare name
	//
	// Corresponds with DELETE /api/v1/admin/export/{name} (the `DeleteExportName` operationId).
	DeleteExportName(ctx context.Context, name string, params *DeleteExportNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// PutExportNameWithBody Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/export/{name} (the `PutExportName` operationId).
	PutExportNameWithBody(ctx context.Context, name string, params *PutExportNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutExportName Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/export/{name} (the `PutExportName` operationId).
	PutExportName(ctx context.Context, name string, params *PutExportNameParams, body PutExportNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchExportNameSettingsWithBody Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/admin/export/{name}/settings (the `PatchExportNameSettings` operationId).
	PatchExportNameSettingsWithBody(ctx context.Context, name string, params *PatchExportNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchExportNameSettings Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/admin/export/{name}/settings (the `PatchExportNameSettings` operationId).
	PatchExportNameSettings(ctx context.Context, name string, params *PatchExportNameSettingsParams, body PatchExportNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetGroups Group registry: the limit tree (parent chain, limits, child_default budget template)
	//
	// Corresponds with GET /api/v1/admin/groups (the `GetGroups` operationId).
	GetGroups(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostGroupsWithBody Create (or replace) a group at runtime, live immediately (upsert)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).
	PostGroupsWithBody(ctx context.Context, params *PostGroupsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostGroups Create (or replace) a group at runtime, live immediately (upsert)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).
	PostGroups(ctx context.Context, params *PostGroupsParams, body PostGroupsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteGroupsName Remove an overlay group at runtime, live immediately
	//
	// Corresponds with DELETE /api/v1/admin/groups/{name} (the `DeleteGroupsName` operationId).
	DeleteGroupsName(ctx context.Context, name string, params *DeleteGroupsNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetGroupsName One group definition (parent, enabled, limits, child_default)
	//
	// Corresponds with GET /api/v1/admin/groups/{name} (the `GetGroupsName` operationId).
	GetGroupsName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchGroupsNameWithBody Partial update: change only the fields present (e.g. raise a budget, freeze a group)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).
	PatchGroupsNameWithBody(ctx context.Context, name string, params *PatchGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchGroupsName Partial update: change only the fields present (e.g. raise a budget, freeze a group)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).
	PatchGroupsName(ctx context.Context, name string, params *PatchGroupsNameParams, body PatchGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutGroupsNameWithBody Replace an overlay group definition, live immediately (limits rebuilt)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/groups/{name} (the `PutGroupsName` operationId).
	PutGroupsNameWithBody(ctx context.Context, name string, params *PutGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutGroupsName Replace an overlay group definition, live immediately (limits rebuilt)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/groups/{name} (the `PutGroupsName` operationId).
	PutGroupsName(ctx context.Context, name string, params *PutGroupsNameParams, body PutGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetGroupsNameUsage The group's derived current-window usage per (window, pool) enforcement bucket vs its caps: the self-service dashboard read (spend derives from the token ledger x the CURRENT rate card at read time)
	//
	// Corresponds with GET /api/v1/admin/groups/{name}/usage (the `GetGroupsNameUsage` operationId).
	GetGroupsNameUsage(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// PostHooksWithBody Register (or replace) a hook at runtime, live immediately
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostHooks` operationId).
	PostHooksWithBody(ctx context.Context, params *PostHooksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostHooks Register (or replace) a hook at runtime, live immediately
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostHooks` operationId).
	PostHooks(ctx context.Context, params *PostHooksParams, body PostHooksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// PutHooksNameWithBody Replace an overlay hook definition, live immediately (grants immutable)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutHooksName` operationId).
	PutHooksNameWithBody(ctx context.Context, name string, params *PutHooksNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutHooksName Replace an overlay hook definition, live immediately (grants immutable)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutHooksName` operationId).
	PutHooksName(ctx context.Context, name string, params *PutHooksNameParams, body PutHooksNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	// PatchHooksNameSettingsWithBody Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchHooksNameSettings` operationId).
	PatchHooksNameSettingsWithBody(ctx context.Context, name string, params *PatchHooksNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchHooksNameSettings Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchHooksNameSettings` operationId).
	PatchHooksNameSettings(ctx context.Context, name string, params *PatchHooksNameSettingsParams, body PatchHooksNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHooksNameStatus 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 `GetHooksNameStatus` operationId).
	GetHooksNameStatus(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIdentityProviders Every `identity-providers:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected
	//
	// Corresponds with GET /api/v1/admin/identity-providers (the `GetIdentityProviders` operationId).
	GetIdentityProviders(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteIdentityProvidersName Remove one `identity-providers:` definition, refused while another config section still references it by bare name
	//
	// Corresponds with DELETE /api/v1/admin/identity-providers/{name} (the `DeleteIdentityProvidersName` operationId).
	DeleteIdentityProvidersName(ctx context.Context, name string, params *DeleteIdentityProvidersNameParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIdentityProvidersName One `identity-providers:` definition
	//
	// Corresponds with GET /api/v1/admin/identity-providers/{name} (the `GetIdentityProvidersName` operationId).
	GetIdentityProvidersName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutIdentityProvidersNameWithBody Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).
	PutIdentityProvidersNameWithBody(ctx context.Context, name string, params *PutIdentityProvidersNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutIdentityProvidersName Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).
	PutIdentityProvidersName(ctx context.Context, name string, params *PutIdentityProvidersNameParams, body PutIdentityProvidersNameJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchIdentityProvidersNameSettingsWithBody Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).
	PatchIdentityProvidersNameSettingsWithBody(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchIdentityProvidersNameSettings Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).
	PatchIdentityProvidersNameSettings(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, body PatchIdentityProvidersNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// GetKeys List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=, ?group= (keys bound to a group; a `user:<sub>` leaf's keys are one person's). Paginate: ?limit=, ?cursor= (opaque)
	//
	// Corresponds with GET /api/v1/admin/keys (the `GetKeys` operationId).
	GetKeys(ctx context.Context, params *GetKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostKeysWithBody Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/keys (the `PostKeys` operationId).
	PostKeysWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	// PatchKeysIdWithBody Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchKeysId` operationId).
	PatchKeysIdWithBody(ctx context.Context, id string, params *PatchKeysIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchKeysId Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchKeysId` operationId).
	PatchKeysId(ctx context.Context, id string, params *PatchKeysIdParams, body PatchKeysIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostKeysIdRevoke REVOKE a signed-token key: denylist it durably WITHOUT deleting the binding (GET /keys/{id} still shows the record; verify now fails). Idempotent: revoking an already-revoked key is 200. DELETE /keys/{id} is the revoke-AND-forget variant (1.5.0)
	//
	// Corresponds with POST /api/v1/admin/keys/{id}/revoke (the `PostKeysIdRevoke` operationId).
	PostKeysIdRevoke(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostKeysIdRotate 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 `PostKeysIdRotate` operationId).
	PostKeysIdRotate(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	// DeleteOverlaySection DISCARD a section's overlay mutations and revert it to base config.yaml (section ∈ groups|hooks|root|plugin_versions). Per-section reset: the OTHER sections' overlay survives. A NEW config version; an already-empty section is an idempotent no-op (changed:false)
	//
	// Corresponds with DELETE /api/v1/admin/overlay/{section} (the `DeleteOverlaySection` operationId).
	DeleteOverlaySection(ctx context.Context, section DeleteOverlaySectionParamsSection, params *DeleteOverlaySectionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// PostPluginsWithBody Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).
	PostPluginsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPlugins Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).
	PostPlugins(ctx context.Context, body PostPluginsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPluginsInspectWithBody Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).
	PostPluginsInspectWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPluginsInspect Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).
	PostPluginsInspect(ctx context.Context, body PostPluginsInspectJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPluginsReload Re-scan the plugins directory and report the reconciled dynamic-library inventory (the sibling of config/reload). A store change takes effect on the next store (re)load
	//
	// Corresponds with POST /api/v1/admin/plugins/reload (the `PostPluginsReload` operationId).
	PostPluginsReload(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPluginsRollbackWithBody EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).
	PostPluginsRollbackWithBody(ctx context.Context, params *PostPluginsRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPluginsRollback EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).
	PostPluginsRollback(ctx context.Context, params *PostPluginsRollbackParams, body PostPluginsRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePluginsFile Remove a dynamic-library plugin (library + manifest sidecar) from the plugins directory. A loaded store keeps running until the next store (re)load
	//
	// Corresponds with DELETE /api/v1/admin/plugins/{file} (the `DeletePluginsFile` operationId).
	DeletePluginsFile(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPluginsFileSchema The plugin's self-described settings JSON Schema, read from the SIGNED manifest's `settings_schema` field, which works for every plugin kind (store/secret/auth/hook), not just hooks. `hook` plugins keep the live describe-proxy behavior when describe answers (source: describe); a loaded hook whose describe answers null falls back server-side to the manifest baseline (source: manifest)
	//
	// Corresponds with GET /api/v1/admin/plugins/{file}/schema (the `GetPluginsFileSchema` operationId).
	GetPluginsFileSchema(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

	// PostRestartWithBody Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).
	PostRestartWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRestart Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).
	PostRestart(ctx context.Context, body PostRestartJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostSigningKeyRotate ROTATE the busbar key-signing key. Rotation is REVOKE-ALL by design: a new signing key means every token minted under the OLD key stops verifying, so every outstanding key must be re-minted. 1.5.0 is single-key, so this reports the intent + current kid; the actual swap is an operator action (replace auth.signing_key / the persisted key file and restart/reload every node in lockstep) (1.5.0)
	//
	// Corresponds with POST /api/v1/admin/signing-key/rotate (the `PostSigningKeyRotate` operationId).
	PostSigningKeyRotate(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUsage 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 `GetUsage` operationId).
	GetUsage(ctx context.Context, params *GetUsageParams, 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) DeleteExportNameWithResponse added in v0.4.0

func (c *ClientWithResponses) DeleteExportNameWithResponse(ctx context.Context, name string, params *DeleteExportNameParams, reqEditors ...RequestEditorFn) (*DeleteExportNameResponse, error)

DeleteExportNameWithResponse Remove one `export:` definition, refused while another config section still references it by bare name

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

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

func (*ClientWithResponses) DeleteGroupsNameWithResponse added in v0.2.0

func (c *ClientWithResponses) DeleteGroupsNameWithResponse(ctx context.Context, name string, params *DeleteGroupsNameParams, reqEditors ...RequestEditorFn) (*DeleteGroupsNameResponse, error)

DeleteGroupsNameWithResponse Remove an overlay group at runtime, live immediately

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

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

func (*ClientWithResponses) DeleteHooksNameWithResponse added in v0.2.0

func (c *ClientWithResponses) DeleteHooksNameWithResponse(ctx context.Context, name string, params *DeleteHooksNameParams, reqEditors ...RequestEditorFn) (*DeleteHooksNameResponse, error)

DeleteHooksNameWithResponse 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 `DeleteHooksName` operationId).

func (*ClientWithResponses) DeleteIdentityProvidersNameWithResponse added in v0.4.0

func (c *ClientWithResponses) DeleteIdentityProvidersNameWithResponse(ctx context.Context, name string, params *DeleteIdentityProvidersNameParams, reqEditors ...RequestEditorFn) (*DeleteIdentityProvidersNameResponse, error)

DeleteIdentityProvidersNameWithResponse Remove one `identity-providers:` definition, refused while another config section still references it by bare name

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

Corresponds with DELETE /api/v1/admin/identity-providers/{name} (the `DeleteIdentityProvidersName` operationId).

func (*ClientWithResponses) DeleteKeysIdWithResponse added in v0.2.0

func (c *ClientWithResponses) DeleteKeysIdWithResponse(ctx context.Context, id string, params *DeleteKeysIdParams, reqEditors ...RequestEditorFn) (*DeleteKeysIdResponse, error)

DeleteKeysIdWithResponse 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 `DeleteKeysId` operationId).

func (*ClientWithResponses) DeleteOverlaySectionWithResponse added in v0.2.0

func (c *ClientWithResponses) DeleteOverlaySectionWithResponse(ctx context.Context, section DeleteOverlaySectionParamsSection, params *DeleteOverlaySectionParams, reqEditors ...RequestEditorFn) (*DeleteOverlaySectionResponse, error)

DeleteOverlaySectionWithResponse DISCARD a section's overlay mutations and revert it to base config.yaml (section ∈ groups|hooks|root|plugin_versions). Per-section reset: the OTHER sections' overlay survives. A NEW config version; an already-empty section is an idempotent no-op (changed:false)

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

Corresponds with DELETE /api/v1/admin/overlay/{section} (the `DeleteOverlaySection` operationId).

func (*ClientWithResponses) DeletePluginsFileWithResponse added in v0.2.0

func (c *ClientWithResponses) DeletePluginsFileWithResponse(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*DeletePluginsFileResponse, error)

DeletePluginsFileWithResponse Remove a dynamic-library plugin (library + manifest sidecar) from the plugins directory. A loaded store keeps running until the next store (re)load

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

Corresponds with DELETE /api/v1/admin/plugins/{file} (the `DeletePluginsFile` operationId).

func (*ClientWithResponses) GetAdminAuthWithResponse added in v0.2.0

func (c *ClientWithResponses) GetAdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAdminAuthResponse, error)

GetAdminAuthWithResponse 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 `GetAdminAuth` operationId).

func (*ClientWithResponses) GetAuditWithResponse added in v0.2.0

func (c *ClientWithResponses) GetAuditWithResponse(ctx context.Context, params *GetAuditParams, reqEditors ...RequestEditorFn) (*GetAuditResponse, error)

GetAuditWithResponse 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 `GetAudit` operationId).

func (*ClientWithResponses) GetAuthWithResponse added in v0.2.0

func (c *ClientWithResponses) GetAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAuthResponse, error)

GetAuthWithResponse 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 `GetAuth` operationId).

func (*ClientWithResponses) GetConfigDiffWithResponse added in v0.2.0

func (c *ClientWithResponses) GetConfigDiffWithResponse(ctx context.Context, params *GetConfigDiffParams, reqEditors ...RequestEditorFn) (*GetConfigDiffResponse, error)

GetConfigDiffWithResponse 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 `GetConfigDiff` operationId).

func (*ClientWithResponses) GetConfigSettingsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetConfigSettingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigSettingsResponse, error)

GetConfigSettingsWithResponse Read the API-set single-value config overlay (root section: listen/tls/rate_card/store/security/limits/…), only the operator's overrides; base config.yaml stands for the rest

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

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

func (*ClientWithResponses) GetConfigVersionsVWithResponse added in v0.2.0

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

GetConfigVersionsVWithResponse 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 `GetConfigVersionsV` operationId).

func (*ClientWithResponses) GetConfigVersionsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetConfigVersionsWithResponse(ctx context.Context, params *GetConfigVersionsParams, reqEditors ...RequestEditorFn) (*GetConfigVersionsResponse, error)

GetConfigVersionsWithResponse 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 `GetConfigVersions` operationId).

func (*ClientWithResponses) GetConfigWithResponse added in v0.2.0

func (c *ClientWithResponses) GetConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

GetConfigWithResponse Effective running config snapshot (redacted)

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

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

func (*ClientWithResponses) GetExportNameWithResponse added in v0.4.0

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

GetExportNameWithResponse One `export:` definition

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

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

func (*ClientWithResponses) GetExportWithResponse added in v0.4.0

func (c *ClientWithResponses) GetExportWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExportResponse, error)

GetExportWithResponse Every `export:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected

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

Corresponds with GET /api/v1/admin/export (the `GetExport` operationId).

func (*ClientWithResponses) GetGroupsNameUsageWithResponse added in v0.2.0

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

GetGroupsNameUsageWithResponse The group's derived current-window usage per (window, pool) enforcement bucket vs its caps: the self-service dashboard read (spend derives from the token ledger x the CURRENT rate card at read time)

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

Corresponds with GET /api/v1/admin/groups/{name}/usage (the `GetGroupsNameUsage` operationId).

func (*ClientWithResponses) GetGroupsNameWithResponse added in v0.2.0

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

GetGroupsNameWithResponse One group definition (parent, enabled, limits, child_default)

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

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

func (*ClientWithResponses) GetGroupsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetGroupsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetGroupsResponse, error)

GetGroupsWithResponse Group registry: the limit tree (parent chain, limits, child_default budget template)

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

Corresponds with GET /api/v1/admin/groups (the `GetGroups` operationId).

func (*ClientWithResponses) GetHooksNameHealthWithResponse added in v0.2.0

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

GetHooksNameHealthWithResponse 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 `GetHooksNameHealth` operationId).

func (*ClientWithResponses) GetHooksNameSchemaWithResponse added in v0.2.0

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

GetHooksNameSchemaWithResponse 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 `GetHooksNameSchema` operationId).

func (*ClientWithResponses) GetHooksNameStatusWithResponse added in v0.2.0

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

GetHooksNameStatusWithResponse 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 `GetHooksNameStatus` operationId).

func (*ClientWithResponses) GetHooksNameWithResponse added in v0.2.0

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

GetHooksNameWithResponse One hook definition

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

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

func (*ClientWithResponses) GetHooksWithResponse added in v0.2.0

func (c *ClientWithResponses) GetHooksWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHooksResponse, error)

GetHooksWithResponse Hook registry (definitions)

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

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

func (*ClientWithResponses) GetIdentityProvidersNameWithResponse added in v0.4.0

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

GetIdentityProvidersNameWithResponse One `identity-providers:` definition

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

Corresponds with GET /api/v1/admin/identity-providers/{name} (the `GetIdentityProvidersName` operationId).

func (*ClientWithResponses) GetIdentityProvidersWithResponse added in v0.4.0

func (c *ClientWithResponses) GetIdentityProvidersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIdentityProvidersResponse, error)

GetIdentityProvidersWithResponse Every `identity-providers:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected

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

Corresponds with GET /api/v1/admin/identity-providers (the `GetIdentityProviders` operationId).

func (*ClientWithResponses) GetInfoWithResponse added in v0.2.0

func (c *ClientWithResponses) GetInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetInfoResponse, error)

GetInfoWithResponse 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 `GetInfo` operationId).

func (*ClientWithResponses) GetKeysIdUsageWithResponse added in v0.2.0

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

GetKeysIdUsageWithResponse 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 `GetKeysIdUsage` operationId).

func (*ClientWithResponses) GetKeysIdWithResponse added in v0.2.0

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

GetKeysIdWithResponse 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 `GetKeysId` operationId).

func (*ClientWithResponses) GetKeysWithResponse added in v0.2.0

func (c *ClientWithResponses) GetKeysWithResponse(ctx context.Context, params *GetKeysParams, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)

GetKeysWithResponse List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=, ?group= (keys bound to a group; a `user:<sub>` leaf's keys are one person's). Paginate: ?limit=, ?cursor= (opaque)

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

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

func (*ClientWithResponses) GetModelsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetModelsResponse, error)

GetModelsWithResponse Model lanes + upstream providers

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

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

func (*ClientWithResponses) GetOpenapiJsonWithResponse added in v0.2.0

func (c *ClientWithResponses) GetOpenapiJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenapiJsonResponse, error)

GetOpenapiJsonWithResponse 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 `GetOpenapiJson` operationId).

func (*ClientWithResponses) GetPluginsFileSchemaWithResponse added in v0.2.0

func (c *ClientWithResponses) GetPluginsFileSchemaWithResponse(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*GetPluginsFileSchemaResponse, error)

GetPluginsFileSchemaWithResponse The plugin's self-described settings JSON Schema, read from the SIGNED manifest's `settings_schema` field, which works for every plugin kind (store/secret/auth/hook), not just hooks. `hook` plugins keep the live describe-proxy behavior when describe answers (source: describe); a loaded hook whose describe answers null falls back server-side to the manifest baseline (source: manifest)

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

Corresponds with GET /api/v1/admin/plugins/{file}/schema (the `GetPluginsFileSchema` operationId).

func (*ClientWithResponses) GetPluginsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetPluginsWithResponse(ctx context.Context, params *GetPluginsParams, reqEditors ...RequestEditorFn) (*GetPluginsResponse, error)

GetPluginsWithResponse Plugin catalog by type (compiled-in + external + dynamic-library)

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

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

func (*ClientWithResponses) GetPoolsNameWithResponse added in v0.2.0

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

GetPoolsNameWithResponse 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 `GetPoolsName` operationId).

func (*ClientWithResponses) GetPoolsWithResponse added in v0.2.0

func (c *ClientWithResponses) GetPoolsWithResponse(ctx context.Context, params *GetPoolsParams, reqEditors ...RequestEditorFn) (*GetPoolsResponse, error)

GetPoolsWithResponse 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 `GetPools` operationId).

func (*ClientWithResponses) GetProvidersWithResponse added in v0.2.0

func (c *ClientWithResponses) GetProvidersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProvidersResponse, error)

GetProvidersWithResponse Distinct providers + lane counts

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

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

func (*ClientWithResponses) GetUsageWithResponse added in v0.2.0

func (c *ClientWithResponses) GetUsageWithResponse(ctx context.Context, params *GetUsageParams, reqEditors ...RequestEditorFn) (*GetUsageResponse, error)

GetUsageWithResponse 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 `GetUsage` operationId).

func (*ClientWithResponses) PatchExportNameSettingsWithBodyWithResponse added in v0.4.0

func (c *ClientWithResponses) PatchExportNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchExportNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchExportNameSettingsResponse, error)

PatchExportNameSettingsWithBodyWithResponse Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PatchExportNameSettingsWithResponse added in v0.4.0

PatchExportNameSettingsWithResponse Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PatchGroupsNameWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PatchGroupsNameWithBodyWithResponse(ctx context.Context, name string, params *PatchGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchGroupsNameResponse, error)

PatchGroupsNameWithBodyWithResponse Partial update: change only the fields present (e.g. raise a budget, freeze a group)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).

func (*ClientWithResponses) PatchGroupsNameWithResponse added in v0.2.0

func (c *ClientWithResponses) PatchGroupsNameWithResponse(ctx context.Context, name string, params *PatchGroupsNameParams, body PatchGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchGroupsNameResponse, error)

PatchGroupsNameWithResponse Partial update: change only the fields present (e.g. raise a budget, freeze a group)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).

func (*ClientWithResponses) PatchHooksNameSettingsWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PatchHooksNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchHooksNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchHooksNameSettingsResponse, error)

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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PatchHooksNameSettingsWithResponse added in v0.2.0

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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PatchIdentityProvidersNameSettingsWithBodyWithResponse added in v0.4.0

func (c *ClientWithResponses) PatchIdentityProvidersNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchIdentityProvidersNameSettingsResponse, error)

PatchIdentityProvidersNameSettingsWithBodyWithResponse Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).

func (*ClientWithResponses) PatchIdentityProvidersNameSettingsWithResponse added in v0.4.0

PatchIdentityProvidersNameSettingsWithResponse Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).

func (*ClientWithResponses) PatchKeysIdWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PatchKeysIdWithBodyWithResponse(ctx context.Context, id string, params *PatchKeysIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchKeysIdResponse, error)

PatchKeysIdWithBodyWithResponse Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PatchKeysIdWithResponse added in v0.2.0

func (c *ClientWithResponses) PatchKeysIdWithResponse(ctx context.Context, id string, params *PatchKeysIdParams, body PatchKeysIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchKeysIdResponse, error)

PatchKeysIdWithResponse Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostAuthCacheFlushWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostAuthCacheFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAuthCacheFlushResponse, error)

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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostAuthCacheFlushWithResponse added in v0.2.0

func (c *ClientWithResponses) PostAuthCacheFlushWithResponse(ctx context.Context, body PostAuthCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAuthCacheFlushResponse, error)

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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigApplyWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigApplyWithBodyWithResponse(ctx context.Context, params *PostConfigApplyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigApplyResponse, error)

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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigApplyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigApplyWithResponse(ctx context.Context, params *PostConfigApplyParams, body PostConfigApplyJSONRequestBody, reqEditors ...RequestEditorFn) (*PostConfigApplyResponse, error)

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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigReloadWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostConfigReloadResponse, error)

PostConfigReloadWithResponse 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 `PostConfigReload` operationId).

func (*ClientWithResponses) PostConfigRollbackWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigRollbackWithBodyWithResponse(ctx context.Context, params *PostConfigRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigRollbackResponse, error)

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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigRollbackWithResponse added in v0.2.0

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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigValidateWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigValidateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigValidateResponse, error)

PostConfigValidateWithBodyWithResponse Dry-run validate a proposed config

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostConfigValidateWithResponse added in v0.2.0

func (c *ClientWithResponses) PostConfigValidateWithResponse(ctx context.Context, body PostConfigValidateJSONRequestBody, reqEditors ...RequestEditorFn) (*PostConfigValidateResponse, error)

PostConfigValidateWithResponse Dry-run validate a proposed config

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostGroupsWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostGroupsWithBodyWithResponse(ctx context.Context, params *PostGroupsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostGroupsResponse, error)

PostGroupsWithBodyWithResponse Create (or replace) a group at runtime, live immediately (upsert)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).

func (*ClientWithResponses) PostGroupsWithResponse added in v0.2.0

func (c *ClientWithResponses) PostGroupsWithResponse(ctx context.Context, params *PostGroupsParams, body PostGroupsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostGroupsResponse, error)

PostGroupsWithResponse Create (or replace) a group at runtime, live immediately (upsert)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).

func (*ClientWithResponses) PostHooksWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostHooksWithBodyWithResponse(ctx context.Context, params *PostHooksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostHooksResponse, error)

PostHooksWithBodyWithResponse Register (or replace) a hook at runtime, live immediately

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostHooksWithResponse added in v0.2.0

func (c *ClientWithResponses) PostHooksWithResponse(ctx context.Context, params *PostHooksParams, body PostHooksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostHooksResponse, error)

PostHooksWithResponse Register (or replace) a hook at runtime, live immediately

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostKeysIdRevokeWithResponse added in v0.2.0

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

PostKeysIdRevokeWithResponse REVOKE a signed-token key: denylist it durably WITHOUT deleting the binding (GET /keys/{id} still shows the record; verify now fails). Idempotent: revoking an already-revoked key is 200. DELETE /keys/{id} is the revoke-AND-forget variant (1.5.0)

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

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

func (*ClientWithResponses) PostKeysIdRotateWithResponse added in v0.2.0

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

PostKeysIdRotateWithResponse 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 `PostKeysIdRotate` operationId).

func (*ClientWithResponses) PostKeysWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostKeysWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostKeysResponse, error)

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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostKeysWithResponse added in v0.2.0

func (c *ClientWithResponses) PostKeysWithResponse(ctx context.Context, body PostKeysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostKeysResponse, error)

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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PostPluginsInspectWithBodyWithResponse added in v0.3.0

func (c *ClientWithResponses) PostPluginsInspectWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsInspectResponse, error)

PostPluginsInspectWithBodyWithResponse Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).

func (*ClientWithResponses) PostPluginsInspectWithResponse added in v0.3.0

func (c *ClientWithResponses) PostPluginsInspectWithResponse(ctx context.Context, body PostPluginsInspectJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPluginsInspectResponse, error)

PostPluginsInspectWithResponse Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).

func (*ClientWithResponses) PostPluginsReloadWithResponse added in v0.2.0

func (c *ClientWithResponses) PostPluginsReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostPluginsReloadResponse, error)

PostPluginsReloadWithResponse Re-scan the plugins directory and report the reconciled dynamic-library inventory (the sibling of config/reload). A store change takes effect on the next store (re)load

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

Corresponds with POST /api/v1/admin/plugins/reload (the `PostPluginsReload` operationId).

func (*ClientWithResponses) PostPluginsRollbackWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostPluginsRollbackWithBodyWithResponse(ctx context.Context, params *PostPluginsRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsRollbackResponse, error)

PostPluginsRollbackWithBodyWithResponse EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).

func (*ClientWithResponses) PostPluginsRollbackWithResponse added in v0.2.0

PostPluginsRollbackWithResponse EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).

func (*ClientWithResponses) PostPluginsWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostPluginsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsResponse, error)

PostPluginsWithBodyWithResponse Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).

func (*ClientWithResponses) PostPluginsWithResponse added in v0.2.0

func (c *ClientWithResponses) PostPluginsWithResponse(ctx context.Context, body PostPluginsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPluginsResponse, error)

PostPluginsWithResponse Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).

func (*ClientWithResponses) PostRestartWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PostRestartWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRestartResponse, error)

PostRestartWithBodyWithResponse Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).

func (*ClientWithResponses) PostRestartWithResponse added in v0.2.0

func (c *ClientWithResponses) PostRestartWithResponse(ctx context.Context, body PostRestartJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRestartResponse, error)

PostRestartWithResponse Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).

func (*ClientWithResponses) PostSigningKeyRotateWithResponse added in v0.2.0

func (c *ClientWithResponses) PostSigningKeyRotateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostSigningKeyRotateResponse, error)

PostSigningKeyRotateWithResponse ROTATE the busbar key-signing key. Rotation is REVOKE-ALL by design: a new signing key means every token minted under the OLD key stops verifying, so every outstanding key must be re-minted. 1.5.0 is single-key, so this reports the intent + current kid; the actual swap is an operator action (replace auth.signing_key / the persisted key file and restart/reload every node in lockstep) (1.5.0)

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

Corresponds with POST /api/v1/admin/signing-key/rotate (the `PostSigningKeyRotate` operationId).

func (*ClientWithResponses) PutAdminAuthWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PutAdminAuthWithBodyWithResponse(ctx context.Context, params *PutAdminAuthParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutAdminAuthResponse, error)

PutAdminAuthWithBodyWithResponse 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

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutAdminAuthWithResponse added in v0.2.0

func (c *ClientWithResponses) PutAdminAuthWithResponse(ctx context.Context, params *PutAdminAuthParams, body PutAdminAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*PutAdminAuthResponse, error)

PutAdminAuthWithResponse 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

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutConfigSettingsWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PutConfigSettingsWithBodyWithResponse(ctx context.Context, params *PutConfigSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutConfigSettingsResponse, error)

PutConfigSettingsWithBodyWithResponse SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).

func (*ClientWithResponses) PutConfigSettingsWithResponse added in v0.2.0

PutConfigSettingsWithResponse SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).

func (*ClientWithResponses) PutExportNameWithBodyWithResponse added in v0.4.0

func (c *ClientWithResponses) PutExportNameWithBodyWithResponse(ctx context.Context, name string, params *PutExportNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutExportNameResponse, error)

PutExportNameWithBodyWithResponse Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutExportNameWithResponse added in v0.4.0

func (c *ClientWithResponses) PutExportNameWithResponse(ctx context.Context, name string, params *PutExportNameParams, body PutExportNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutExportNameResponse, error)

PutExportNameWithResponse Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutGroupsNameWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PutGroupsNameWithBodyWithResponse(ctx context.Context, name string, params *PutGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutGroupsNameResponse, error)

PutGroupsNameWithBodyWithResponse Replace an overlay group definition, live immediately (limits rebuilt)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutGroupsNameWithResponse added in v0.2.0

func (c *ClientWithResponses) PutGroupsNameWithResponse(ctx context.Context, name string, params *PutGroupsNameParams, body PutGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutGroupsNameResponse, error)

PutGroupsNameWithResponse Replace an overlay group definition, live immediately (limits rebuilt)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutHooksNameWithBodyWithResponse added in v0.2.0

func (c *ClientWithResponses) PutHooksNameWithBodyWithResponse(ctx context.Context, name string, params *PutHooksNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutHooksNameResponse, error)

PutHooksNameWithBodyWithResponse Replace an overlay hook definition, live immediately (grants immutable)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutHooksNameWithResponse added in v0.2.0

func (c *ClientWithResponses) PutHooksNameWithResponse(ctx context.Context, name string, params *PutHooksNameParams, body PutHooksNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutHooksNameResponse, error)

PutHooksNameWithResponse Replace an overlay hook definition, live immediately (grants immutable)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

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

func (*ClientWithResponses) PutIdentityProvidersNameWithBodyWithResponse added in v0.4.0

func (c *ClientWithResponses) PutIdentityProvidersNameWithBodyWithResponse(ctx context.Context, name string, params *PutIdentityProvidersNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutIdentityProvidersNameResponse, error)

PutIdentityProvidersNameWithBodyWithResponse Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).

func (*ClientWithResponses) PutIdentityProvidersNameWithResponse added in v0.4.0

PutIdentityProvidersNameWithResponse Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// GetAdminAuthWithResponse 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 `GetAdminAuth` operationId).
	GetAdminAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAdminAuthResponse, error)

	// PutAdminAuthWithBodyWithResponse 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
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutAdminAuth` operationId).
	PutAdminAuthWithBodyWithResponse(ctx context.Context, params *PutAdminAuthParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutAdminAuthResponse, error)

	// PutAdminAuthWithResponse 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
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/admin-auth (the `PutAdminAuth` operationId).
	PutAdminAuthWithResponse(ctx context.Context, params *PutAdminAuthParams, body PutAdminAuthJSONRequestBody, reqEditors ...RequestEditorFn) (*PutAdminAuthResponse, error)

	// GetAuditWithResponse 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 `GetAudit` operationId).
	GetAuditWithResponse(ctx context.Context, params *GetAuditParams, reqEditors ...RequestEditorFn) (*GetAuditResponse, error)

	// GetAuthWithResponse 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 `GetAuth` operationId).
	GetAuthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAuthResponse, error)

	// PostAuthCacheFlushWithBodyWithResponse Flush the credential cache: one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostAuthCacheFlush` operationId).
	PostAuthCacheFlushWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAuthCacheFlushResponse, error)

	// PostAuthCacheFlushWithResponse Flush the credential cache: one module's partition (`{module}`) or everything (empty body). Instant revocation of the cached-allow window
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/auth/cache/flush (the `PostAuthCacheFlush` operationId).
	PostAuthCacheFlushWithResponse(ctx context.Context, body PostAuthCacheFlushJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAuthCacheFlushResponse, error)

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

	// PostConfigApplyWithBodyWithResponse Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/apply (the `PostConfigApply` operationId).
	PostConfigApplyWithBodyWithResponse(ctx context.Context, params *PostConfigApplyParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigApplyResponse, error)

	// PostConfigApplyWithResponse Apply a full config from the request body, atomically (live until next reload/restart; health preserved by lane identity)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/apply (the `PostConfigApply` operationId).
	PostConfigApplyWithResponse(ctx context.Context, params *PostConfigApplyParams, body PostConfigApplyJSONRequestBody, reqEditors ...RequestEditorFn) (*PostConfigApplyResponse, error)

	// GetConfigDiffWithResponse 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 `GetConfigDiff` operationId).
	GetConfigDiffWithResponse(ctx context.Context, params *GetConfigDiffParams, reqEditors ...RequestEditorFn) (*GetConfigDiffResponse, error)

	// PostConfigReloadWithResponse 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 `PostConfigReload` operationId).
	PostConfigReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostConfigReloadResponse, error)

	// PostConfigRollbackWithBodyWithResponse Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostConfigRollback` operationId).
	PostConfigRollbackWithBodyWithResponse(ctx context.Context, params *PostConfigRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigRollbackResponse, error)

	// PostConfigRollbackWithResponse Restore a retained version's hook surface (re-validated; a NEW version)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/rollback (the `PostConfigRollback` operationId).
	PostConfigRollbackWithResponse(ctx context.Context, params *PostConfigRollbackParams, body PostConfigRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*PostConfigRollbackResponse, error)

	// GetConfigSettingsWithResponse Read the API-set single-value config overlay (root section: listen/tls/rate_card/store/security/limits/…), only the operator's overrides; base config.yaml stands for the rest
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/config/settings (the `GetConfigSettings` operationId).
	GetConfigSettingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigSettingsResponse, error)

	// PutConfigSettingsWithBodyWithResponse SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).
	PutConfigSettingsWithBodyWithResponse(ctx context.Context, params *PutConfigSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutConfigSettingsResponse, error)

	// PutConfigSettingsWithResponse SET any single-value config section durably (1.5.0 full-config coverage): partial RootSettings merged onto the overlay, re-resolved + validated, swapped in. rate_card/per_request_fee/security/limits/… go live; listen/tls/admin_listen/admin_tls/admin_require_mtls/store are stored + flagged restart-to-apply (bound once at start / store reused across a hot reload). NEVER writes config.yaml
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/config/settings (the `PutConfigSettings` operationId).
	PutConfigSettingsWithResponse(ctx context.Context, params *PutConfigSettingsParams, body PutConfigSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PutConfigSettingsResponse, error)

	// PostConfigValidateWithBodyWithResponse Dry-run validate a proposed config
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostConfigValidate` operationId).
	PostConfigValidateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostConfigValidateResponse, error)

	// PostConfigValidateWithResponse Dry-run validate a proposed config
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/config/validate (the `PostConfigValidate` operationId).
	PostConfigValidateWithResponse(ctx context.Context, body PostConfigValidateJSONRequestBody, reqEditors ...RequestEditorFn) (*PostConfigValidateResponse, error)

	// GetConfigVersionsWithResponse 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 `GetConfigVersions` operationId).
	GetConfigVersionsWithResponse(ctx context.Context, params *GetConfigVersionsParams, reqEditors ...RequestEditorFn) (*GetConfigVersionsResponse, error)

	// GetConfigVersionsVWithResponse 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 `GetConfigVersionsV` operationId).
	GetConfigVersionsVWithResponse(ctx context.Context, v int, reqEditors ...RequestEditorFn) (*GetConfigVersionsVResponse, error)

	// GetExportWithResponse Every `export:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/export (the `GetExport` operationId).
	GetExportWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetExportResponse, error)

	// DeleteExportNameWithResponse Remove one `export:` definition, refused while another config section still references it by bare name
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/export/{name} (the `DeleteExportName` operationId).
	DeleteExportNameWithResponse(ctx context.Context, name string, params *DeleteExportNameParams, reqEditors ...RequestEditorFn) (*DeleteExportNameResponse, error)

	// GetExportNameWithResponse One `export:` definition
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/export/{name} (the `GetExportName` operationId).
	GetExportNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetExportNameResponse, error)

	// PutExportNameWithBodyWithResponse Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/export/{name} (the `PutExportName` operationId).
	PutExportNameWithBodyWithResponse(ctx context.Context, name string, params *PutExportNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutExportNameResponse, error)

	// PutExportNameWithResponse Create or REPLACE one `export:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/export/{name} (the `PutExportName` operationId).
	PutExportNameWithResponse(ctx context.Context, name string, params *PutExportNameParams, body PutExportNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutExportNameResponse, error)

	// PatchExportNameSettingsWithBodyWithResponse Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/export/{name}/settings (the `PatchExportNameSettings` operationId).
	PatchExportNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchExportNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchExportNameSettingsResponse, error)

	// PatchExportNameSettingsWithResponse Replace ONLY the opaque `settings:` bag of one `export:` definition; every other field is left byte-identical
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/export/{name}/settings (the `PatchExportNameSettings` operationId).
	PatchExportNameSettingsWithResponse(ctx context.Context, name string, params *PatchExportNameSettingsParams, body PatchExportNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchExportNameSettingsResponse, error)

	// GetGroupsWithResponse Group registry: the limit tree (parent chain, limits, child_default budget template)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/groups (the `GetGroups` operationId).
	GetGroupsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetGroupsResponse, error)

	// PostGroupsWithBodyWithResponse Create (or replace) a group at runtime, live immediately (upsert)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).
	PostGroupsWithBodyWithResponse(ctx context.Context, params *PostGroupsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostGroupsResponse, error)

	// PostGroupsWithResponse Create (or replace) a group at runtime, live immediately (upsert)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/groups (the `PostGroups` operationId).
	PostGroupsWithResponse(ctx context.Context, params *PostGroupsParams, body PostGroupsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostGroupsResponse, error)

	// DeleteGroupsNameWithResponse Remove an overlay group at runtime, live immediately
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/groups/{name} (the `DeleteGroupsName` operationId).
	DeleteGroupsNameWithResponse(ctx context.Context, name string, params *DeleteGroupsNameParams, reqEditors ...RequestEditorFn) (*DeleteGroupsNameResponse, error)

	// GetGroupsNameWithResponse One group definition (parent, enabled, limits, child_default)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/groups/{name} (the `GetGroupsName` operationId).
	GetGroupsNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetGroupsNameResponse, error)

	// PatchGroupsNameWithBodyWithResponse Partial update: change only the fields present (e.g. raise a budget, freeze a group)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).
	PatchGroupsNameWithBodyWithResponse(ctx context.Context, name string, params *PatchGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchGroupsNameResponse, error)

	// PatchGroupsNameWithResponse Partial update: change only the fields present (e.g. raise a budget, freeze a group)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/groups/{name} (the `PatchGroupsName` operationId).
	PatchGroupsNameWithResponse(ctx context.Context, name string, params *PatchGroupsNameParams, body PatchGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchGroupsNameResponse, error)

	// PutGroupsNameWithBodyWithResponse Replace an overlay group definition, live immediately (limits rebuilt)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/groups/{name} (the `PutGroupsName` operationId).
	PutGroupsNameWithBodyWithResponse(ctx context.Context, name string, params *PutGroupsNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutGroupsNameResponse, error)

	// PutGroupsNameWithResponse Replace an overlay group definition, live immediately (limits rebuilt)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/groups/{name} (the `PutGroupsName` operationId).
	PutGroupsNameWithResponse(ctx context.Context, name string, params *PutGroupsNameParams, body PutGroupsNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutGroupsNameResponse, error)

	// GetGroupsNameUsageWithResponse The group's derived current-window usage per (window, pool) enforcement bucket vs its caps: the self-service dashboard read (spend derives from the token ledger x the CURRENT rate card at read time)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/groups/{name}/usage (the `GetGroupsNameUsage` operationId).
	GetGroupsNameUsageWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetGroupsNameUsageResponse, error)

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

	// PostHooksWithBodyWithResponse Register (or replace) a hook at runtime, live immediately
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostHooks` operationId).
	PostHooksWithBodyWithResponse(ctx context.Context, params *PostHooksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostHooksResponse, error)

	// PostHooksWithResponse Register (or replace) a hook at runtime, live immediately
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/hooks (the `PostHooks` operationId).
	PostHooksWithResponse(ctx context.Context, params *PostHooksParams, body PostHooksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostHooksResponse, error)

	// DeleteHooksNameWithResponse 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 `DeleteHooksName` operationId).
	DeleteHooksNameWithResponse(ctx context.Context, name string, params *DeleteHooksNameParams, reqEditors ...RequestEditorFn) (*DeleteHooksNameResponse, error)

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

	// PutHooksNameWithBodyWithResponse Replace an overlay hook definition, live immediately (grants immutable)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutHooksName` operationId).
	PutHooksNameWithBodyWithResponse(ctx context.Context, name string, params *PutHooksNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutHooksNameResponse, error)

	// PutHooksNameWithResponse Replace an overlay hook definition, live immediately (grants immutable)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/hooks/{name} (the `PutHooksName` operationId).
	PutHooksNameWithResponse(ctx context.Context, name string, params *PutHooksNameParams, body PutHooksNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutHooksNameResponse, error)

	// GetHooksNameHealthWithResponse 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 `GetHooksNameHealth` operationId).
	GetHooksNameHealthWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetHooksNameHealthResponse, error)

	// GetHooksNameSchemaWithResponse 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 `GetHooksNameSchema` operationId).
	GetHooksNameSchemaWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetHooksNameSchemaResponse, error)

	// PatchHooksNameSettingsWithBodyWithResponse Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchHooksNameSettings` operationId).
	PatchHooksNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchHooksNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchHooksNameSettingsResponse, error)

	// PatchHooksNameSettingsWithResponse Push an opaque settings map to the running hook; COMMIT ON ACK
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/hooks/{name}/settings (the `PatchHooksNameSettings` operationId).
	PatchHooksNameSettingsWithResponse(ctx context.Context, name string, params *PatchHooksNameSettingsParams, body PatchHooksNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchHooksNameSettingsResponse, error)

	// GetHooksNameStatusWithResponse 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 `GetHooksNameStatus` operationId).
	GetHooksNameStatusWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetHooksNameStatusResponse, error)

	// GetIdentityProvidersWithResponse Every `identity-providers:` DEFINITION (the 1.5.3 named-definition map: name -> {module, settings, ...}, referenced by bare name). Secrets are never projected
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/identity-providers (the `GetIdentityProviders` operationId).
	GetIdentityProvidersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIdentityProvidersResponse, error)

	// DeleteIdentityProvidersNameWithResponse Remove one `identity-providers:` definition, refused while another config section still references it by bare name
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/identity-providers/{name} (the `DeleteIdentityProvidersName` operationId).
	DeleteIdentityProvidersNameWithResponse(ctx context.Context, name string, params *DeleteIdentityProvidersNameParams, reqEditors ...RequestEditorFn) (*DeleteIdentityProvidersNameResponse, error)

	// GetIdentityProvidersNameWithResponse One `identity-providers:` definition
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/identity-providers/{name} (the `GetIdentityProvidersName` operationId).
	GetIdentityProvidersNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetIdentityProvidersNameResponse, error)

	// PutIdentityProvidersNameWithBodyWithResponse Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).
	PutIdentityProvidersNameWithBodyWithResponse(ctx context.Context, name string, params *PutIdentityProvidersNameParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutIdentityProvidersNameResponse, error)

	// PutIdentityProvidersNameWithResponse Create or REPLACE one `identity-providers:` definition (upsert), persisted to the config overlay and live after an atomic rebuild-and-swap. A base-config-defined entry is 409 (edit config.yaml); RAISING `max_admin_scope` is refused outright (the trust ceiling is operator file policy)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /api/v1/admin/identity-providers/{name} (the `PutIdentityProvidersName` operationId).
	PutIdentityProvidersNameWithResponse(ctx context.Context, name string, params *PutIdentityProvidersNameParams, body PutIdentityProvidersNameJSONRequestBody, reqEditors ...RequestEditorFn) (*PutIdentityProvidersNameResponse, error)

	// PatchIdentityProvidersNameSettingsWithBodyWithResponse Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).
	PatchIdentityProvidersNameSettingsWithBodyWithResponse(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchIdentityProvidersNameSettingsResponse, error)

	// PatchIdentityProvidersNameSettingsWithResponse Replace ONLY the opaque `settings:` bag of one `identity-providers:` definition; every other field is left byte-identical
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/identity-providers/{name}/settings (the `PatchIdentityProvidersNameSettings` operationId).
	PatchIdentityProvidersNameSettingsWithResponse(ctx context.Context, name string, params *PatchIdentityProvidersNameSettingsParams, body PatchIdentityProvidersNameSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchIdentityProvidersNameSettingsResponse, error)

	// GetInfoWithResponse 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 `GetInfo` operationId).
	GetInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetInfoResponse, error)

	// GetKeysWithResponse List virtual keys (metadata only; never secrets). Filters: ?enabled=, ?prefix=, ?group= (keys bound to a group; a `user:<sub>` leaf's keys are one person's). Paginate: ?limit=, ?cursor= (opaque)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/keys (the `GetKeys` operationId).
	GetKeysWithResponse(ctx context.Context, params *GetKeysParams, reqEditors ...RequestEditorFn) (*GetKeysResponse, error)

	// PostKeysWithBodyWithResponse Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/keys (the `PostKeys` operationId).
	PostKeysWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostKeysResponse, error)

	// PostKeysWithResponse Mint a virtual key. The secret is returned EXACTLY once. Honors an `Idempotency-Key` header (per-principal ~10min replay)
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/keys (the `PostKeys` operationId).
	PostKeysWithResponse(ctx context.Context, body PostKeysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostKeysResponse, error)

	// DeleteKeysIdWithResponse 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 `DeleteKeysId` operationId).
	DeleteKeysIdWithResponse(ctx context.Context, id string, params *DeleteKeysIdParams, reqEditors ...RequestEditorFn) (*DeleteKeysIdResponse, error)

	// GetKeysIdWithResponse 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 `GetKeysId` operationId).
	GetKeysIdWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetKeysIdResponse, error)

	// PatchKeysIdWithBodyWithResponse Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchKeysId` operationId).
	PatchKeysIdWithBodyWithResponse(ctx context.Context, id string, params *PatchKeysIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchKeysIdResponse, error)

	// PatchKeysIdWithResponse Enable/disable a key or rebind its group. Optional `If-Match` for optimistic concurrency
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/admin/keys/{id} (the `PatchKeysId` operationId).
	PatchKeysIdWithResponse(ctx context.Context, id string, params *PatchKeysIdParams, body PatchKeysIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchKeysIdResponse, error)

	// PostKeysIdRevokeWithResponse REVOKE a signed-token key: denylist it durably WITHOUT deleting the binding (GET /keys/{id} still shows the record; verify now fails). Idempotent: revoking an already-revoked key is 200. DELETE /keys/{id} is the revoke-AND-forget variant (1.5.0)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/keys/{id}/revoke (the `PostKeysIdRevoke` operationId).
	PostKeysIdRevokeWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PostKeysIdRevokeResponse, error)

	// PostKeysIdRotateWithResponse 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 `PostKeysIdRotate` operationId).
	PostKeysIdRotateWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*PostKeysIdRotateResponse, error)

	// GetKeysIdUsageWithResponse 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 `GetKeysIdUsage` operationId).
	GetKeysIdUsageWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetKeysIdUsageResponse, error)

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

	// GetOpenapiJsonWithResponse 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 `GetOpenapiJson` operationId).
	GetOpenapiJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenapiJsonResponse, error)

	// DeleteOverlaySectionWithResponse DISCARD a section's overlay mutations and revert it to base config.yaml (section ∈ groups|hooks|root|plugin_versions). Per-section reset: the OTHER sections' overlay survives. A NEW config version; an already-empty section is an idempotent no-op (changed:false)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/overlay/{section} (the `DeleteOverlaySection` operationId).
	DeleteOverlaySectionWithResponse(ctx context.Context, section DeleteOverlaySectionParamsSection, params *DeleteOverlaySectionParams, reqEditors ...RequestEditorFn) (*DeleteOverlaySectionResponse, error)

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

	// PostPluginsWithBodyWithResponse Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).
	PostPluginsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsResponse, error)

	// PostPluginsWithResponse Install a dynamic-library store plugin: upload the library (base64) + optional signed manifest; the engine RE-VERIFIES against the running trust posture, validates the store ABI, and writes it atomically into the plugins directory. Takes effect on the next store (re)load
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins (the `PostPlugins` operationId).
	PostPluginsWithResponse(ctx context.Context, body PostPluginsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPluginsResponse, error)

	// PostPluginsInspectWithBodyWithResponse Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).
	PostPluginsInspectWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsInspectResponse, error)

	// PostPluginsInspectWithResponse Stateless read-only preview of a candidate plugin tarball: verify its signature, parse its manifest, and report its settings schema WITHOUT installing anything
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins/inspect (the `PostPluginsInspect` operationId).
	PostPluginsInspectWithResponse(ctx context.Context, body PostPluginsInspectJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPluginsInspectResponse, error)

	// PostPluginsReloadWithResponse Re-scan the plugins directory and report the reconciled dynamic-library inventory (the sibling of config/reload). A store change takes effect on the next store (re)load
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins/reload (the `PostPluginsReload` operationId).
	PostPluginsReloadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostPluginsReloadResponse, error)

	// PostPluginsRollbackWithBodyWithResponse EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).
	PostPluginsRollbackWithBodyWithResponse(ctx context.Context, params *PostPluginsRollbackParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPluginsRollbackResponse, error)

	// PostPluginsRollbackWithResponse EXPLICIT, authenticated, audited rollback of a plugin to a PRIOR version (1.5.0). Validates the target artifact (structure + trust) with the anti-downgrade floor lowered to EXACTLY the target's own version; a lower or untrusted artifact still fails (a rollback authenticates the OPERATOR, never the bytes). Persists the version pin to the overlay (survives restart) and hot-swaps via the same rebuild-and-swap path as plugins/reload
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/plugins/rollback (the `PostPluginsRollback` operationId).
	PostPluginsRollbackWithResponse(ctx context.Context, params *PostPluginsRollbackParams, body PostPluginsRollbackJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPluginsRollbackResponse, error)

	// DeletePluginsFileWithResponse Remove a dynamic-library plugin (library + manifest sidecar) from the plugins directory. A loaded store keeps running until the next store (re)load
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/admin/plugins/{file} (the `DeletePluginsFile` operationId).
	DeletePluginsFileWithResponse(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*DeletePluginsFileResponse, error)

	// GetPluginsFileSchemaWithResponse The plugin's self-described settings JSON Schema, read from the SIGNED manifest's `settings_schema` field, which works for every plugin kind (store/secret/auth/hook), not just hooks. `hook` plugins keep the live describe-proxy behavior when describe answers (source: describe); a loaded hook whose describe answers null falls back server-side to the manifest baseline (source: manifest)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/admin/plugins/{file}/schema (the `GetPluginsFileSchema` operationId).
	GetPluginsFileSchemaWithResponse(ctx context.Context, file string, reqEditors ...RequestEditorFn) (*GetPluginsFileSchemaResponse, error)

	// GetPoolsWithResponse 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 `GetPools` operationId).
	GetPoolsWithResponse(ctx context.Context, params *GetPoolsParams, reqEditors ...RequestEditorFn) (*GetPoolsResponse, error)

	// GetPoolsNameWithResponse 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 `GetPoolsName` operationId).
	GetPoolsNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*GetPoolsNameResponse, error)

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

	// PostRestartWithBodyWithResponse Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).
	PostRestartWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRestartResponse, error)

	// PostRestartWithResponse Restart busbar to apply the restart-scoped settings (listen, admin_listen, tls, admin_tls, admin_require_mtls, store). Drains first; the supervisor brings it back
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/restart (the `PostRestart` operationId).
	PostRestartWithResponse(ctx context.Context, body PostRestartJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRestartResponse, error)

	// PostSigningKeyRotateWithResponse ROTATE the busbar key-signing key. Rotation is REVOKE-ALL by design: a new signing key means every token minted under the OLD key stops verifying, so every outstanding key must be re-minted. 1.5.0 is single-key, so this reports the intent + current kid; the actual swap is an operator action (replace auth.signing_key / the persisted key file and restart/reload every node in lockstep) (1.5.0)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/admin/signing-key/rotate (the `PostSigningKeyRotate` operationId).
	PostSigningKeyRotateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*PostSigningKeyRotateResponse, error)

	// GetUsageWithResponse 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 `GetUsage` operationId).
	GetUsageWithResponse(ctx context.Context, params *GetUsageParams, reqEditors ...RequestEditorFn) (*GetUsageResponse, 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 ConfigSettingsView added in v0.2.0

type ConfigSettingsView struct {
	// Applied `true` on a PUT that stored + swapped; `false` on a GET (a pure read).
	Applied       bool   `json:"applied"`
	ConfigVersion uint64 `json:"config_version"`

	// Note A human note describing the live-vs-reload split (absent on a GET).
	Note *string `json:"note,omitempty"`

	// ReloadToApply Fields that were stored durably but are RESTART-TO-APPLY: a socket rebind, a TLS acceptor
	// build and a store open all happen once at process start, so a `POST /config/reload` does NOT
	// make them live; `POST /restart` (or a supervisor restart) does. Empty when the PUT touched
	// only live-swappable fields (or on a GET). The field NAME is frozen wire; only this description
	// changed.
	ReloadToApply *[]string `json:"reload_to_apply,omitempty"`

	// Settings The current effective root-section overlay (only the fields the operator has set; base
	// `config.yaml` stands for the rest). An arbitrary JSON object (the `RootSettings` projection),
	// REDACTED by `service::redact_settings_bags`: every opaque `settings:` bag inside it (today
	// `store.settings`, whose `url` is a credential in busbar's own docs) appears as
	// `settings_keys`: sorted key names, no values. Same on the GET and on the PUT echo.
	//
	// This field NAME is frozen wire and is the response ENVELOPE member, not a plugin settings
	// bag; the redaction applies to the bags nested INSIDE it.
	Settings interface{} `json:"settings"`
}

ConfigSettingsView `GET`/`PUT /config/settings` (1.5.0 full-config coverage): the API-settable single-value config overlay (`root` section) and, on a PUT, the apply metadata. `settings` is the CURRENT effective root override (the merge of prior overlay + this request). It is overlay-persisted so it survives a restart. 1.5.3: a MUTABLE config always has a writable `config.overlay` backend (the boot invariant), so a successful PUT is ALWAYS durable; a LOCKED config (`config.locked: true`) refuses the PUT (`400`) instead of applying it in memory only; the silent-loss outcome is gone. `reload_to_apply` names the fields whose new value is DURABLY STORED but not yet LIVE: the process-level binds (`listen`/`admin_listen` socket, `tls`/`admin_tls` bind, and the `admin_require_mtls` boot-guard) are read once at process start, and the durable `store` backend is reused across a hot reload; none can hot-swap, so they take effect on the next RESTART (or a supervisor restart), NEVER on a `POST /config/reload`: a reload re-reads disk and rebuilds the `App` but does not rebind sockets, rebuild the TLS acceptor, or re-open the store. It is always EMPTY when nothing was durably stored (no overlay); `note` names the affected fields instead. Everything else (`rate_card`/`per_request_fee`/`security`/`health`/`routing`) is LIVE on the swap; `limits` is live EXCEPT four boot-scoped fields (see `reload_to_apply_fields`): `upstream_request_timeout_secs`/`pool_max_idle_per_host`/`pool_idle_timeout_secs`, which the reused `UpstreamClients` only reads once at boot, and `max_inbound_concurrent`, which is baked once into the data router's `GlobalConcurrencyLimitLayer` at process start (a config apply swaps only `Arc<App>`, never the router): two independent freezing mechanisms. There is NO `observability` section here, and no `metrics` one either: 1.5.3 DELETED both from the config grammar, and `RootSettings` (what this endpoint projects) carries neither field: a PUT naming `observability` is a loud `400` (`deny_unknown_fields`), never a silent no-op. All telemetry egress is now `export:`, a NAMED MAP of exporter instances that this endpoint does not reach at all: it is edited in `config.yaml` and made live by a plugin reload, not by `PUT /config/settings`. Each `export:` entry is keyed by an operator-chosen instance name and carries a `module:` naming the exporter plus a `settings:` bag that module validates, and MAY carry a `streams:` subscription list. The built-in modules are `prometheus` (carries the `metrics` stream), `otlp` (`traces`), and `request-log-webhook` + `request-log-file` (`logs`); subscribing an instance to a stream its module does not carry is rejected rather than silently delivering nothing. An entry MAY also carry a `fields:` projection, but do NOT plan on it in 1.5.3: it is parsed and enforced yet unreachable with every built-in module, because each stream they carry has a pinned field that has no producer yet, so any `fields:` on them is rejected. Omit it and receive the stream's produced default set. `advanced` is live EXCEPT `response_headers`: `response_headers.server_timing` is baked into router middleware state at boot (same "config apply swaps `Arc<App>`, never the router" freezing as `max_inbound_concurrent`) and `response_headers.route_policy` seeds a process-global `OnceLock`; neither is rebuilt by an apply.

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 CreateKeyReq added in v0.2.0

type CreateKeyReq struct {
	// AllowedPools Pools this key may target. OMITTED = ALL pools; an explicit `[]` = NO pools.
	AllowedPools *[]string `json:"allowed_pools,omitempty"`

	// ExpiresAt Token expiry as an absolute Unix-seconds timestamp. Mutually exclusive with `expires_in`.
	ExpiresAt *uint64 `json:"expires_at,omitempty"`

	// ExpiresIn Token lifetime as a duration string (`7d`, `24h`, `30m`, `3600s`) - the token's `exp` is
	// `now + expires_in`. Mutually exclusive with `expires_at`. Absent (and no `expires_at`) => a
	// sane long default (see `DEFAULT_KEY_TTL_SECS`).
	ExpiresIn *string `json:"expires_in,omitempty"`

	// Group The `groups:` bucket this key binds to (at most one). A key with NO group is authed +
	// unlimited (access only). If the named group EXISTS, the key binds to it. If it does NOT
	// exist, the mint 400s UNLESS `parent` is given, in which case it is AUTO-PROVISIONED as a leaf under
	// `parent` (self-service; see `parent`).
	Group *string `json:"group,omitempty"`

	// IssueAwsCredential When true, ALSO issue an AWS-style access-key-id + secret access key (the MinIO/S3-compatible
	// model) so a Bedrock-SDK client can authenticate via inbound SigV4. Both are returned ONCE.
	IssueAwsCredential *bool `json:"issue_aws_credential,omitempty"`

	// Labels Optional mint-time labels echoed onto this key's metric series; never interpreted by
	// enforcement.
	Labels *map[string]string `json:"labels,omitempty"`
	Name   string             `json:"name"`

	// Parent AUTO-PROVISION target: the EXISTING parent group under which to create
	// `group` as a leaf when `group` does not yet exist: the first-self-mint materialization of a
	// `user:<sub>` personal budget bucket. The new leaf's limits come from the nearest-ancestor
	// `child_default` template (inherit-only when none up the chain), created through the same
	// validate-at-the-door path as `POST /groups`. If `group` ALREADY exists, `parent` must equal
	// its actual parent (else 409); a mint never re-homes an existing group. Ignored when `group`
	// is absent (a key with no group has nothing to provision).
	Parent *string `json:"parent,omitempty"`
}

CreateKeyReq `POST /keys` body (1.5.0 signed-token keys): PURE AUTH + a signed expiring token. A minted key is a busbar-signed `{sub, exp, kid}` token, returned ONCE. No rpm/tpm/budget on a key - all enforcement flows through the bound `group`. `#[serde(deny_unknown_fields)]` so the removed 1.4.x fields (max_budget_cents/rpm_limit/tpm_limit/budget_period) fail loudly.

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"`
	CreatedAt          uint64  `json:"created_at"`
	Enabled            bool    `json:"enabled"`

	// ExpiresAt Unix-seconds expiry of the signed token.
	ExpiresAt uint64  `json:"expires_at"`
	Group     *string `json:"group"`

	// GroupProvisioned Whether this mint AUTO-PROVISIONED its bound group leaf (self-service); lets a portal
	// distinguish "bound to an existing bucket" from "created your personal bucket + bound".
	GroupProvisioned bool              `json:"group_provisioned"`
	Id               string            `json:"id"`
	Labels           map[string]string `json:"labels"`
	Name             string            `json:"name"`

	// State Same field as `KeyView.state`; a fresh mint is always `"active"` (enabled, not
	// revoked, not deleted).
	State string `json:"state"`

	// Token The busbar-SIGNED token: the key credential (1.5.0), shown EXACTLY once and never
	// returned by any read. (This is the field a client must capture to authenticate.)
	Token string `json:"token"`
}

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

type DeleteExportNameParams added in v0.4.0

type DeleteExportNameParams 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"`
}

DeleteExportNameParams defines parameters for DeleteExportName.

type DeleteExportNameResponse added in v0.4.0

type DeleteExportNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteExportNameResponse added in v0.4.0

func ParseDeleteExportNameResponse(rsp *http.Response) (*DeleteExportNameResponse, error)

ParseDeleteExportNameResponse parses an HTTP response from a DeleteExportNameWithResponse call

func (DeleteExportNameResponse) ContentType added in v0.4.0

func (r DeleteExportNameResponse) ContentType() string

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

func (DeleteExportNameResponse) GetBody added in v0.4.0

func (r DeleteExportNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteExportNameResponse) GetJSON400 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON400() *Error

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

func (DeleteExportNameResponse) GetJSON401 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON401() *Error

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

func (DeleteExportNameResponse) GetJSON403 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON403() *Error

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

func (DeleteExportNameResponse) GetJSON404 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON404() *Error

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

func (DeleteExportNameResponse) GetJSON409 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON409() *Error

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

func (DeleteExportNameResponse) GetJSON429 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON429() *Error

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

func (DeleteExportNameResponse) GetJSON500 added in v0.4.0

func (r DeleteExportNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteExportNameResponse) Status added in v0.4.0

func (r DeleteExportNameResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteExportNameResponse) StatusCode added in v0.4.0

func (r DeleteExportNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteGroupsNameParams added in v0.2.0

type DeleteGroupsNameParams 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"`
}

DeleteGroupsNameParams defines parameters for DeleteGroupsName.

type DeleteGroupsNameResponse added in v0.2.0

type DeleteGroupsNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteGroupsNameResponse added in v0.2.0

func ParseDeleteGroupsNameResponse(rsp *http.Response) (*DeleteGroupsNameResponse, error)

ParseDeleteGroupsNameResponse parses an HTTP response from a DeleteGroupsNameWithResponse call

func (DeleteGroupsNameResponse) ContentType added in v0.2.0

func (r DeleteGroupsNameResponse) ContentType() string

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

func (DeleteGroupsNameResponse) GetBody added in v0.2.0

func (r DeleteGroupsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteGroupsNameResponse) GetJSON400 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON400() *Error

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

func (DeleteGroupsNameResponse) GetJSON401 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON401() *Error

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

func (DeleteGroupsNameResponse) GetJSON403 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON403() *Error

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

func (DeleteGroupsNameResponse) GetJSON404 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON404() *Error

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

func (DeleteGroupsNameResponse) GetJSON409 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON409() *Error

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

func (DeleteGroupsNameResponse) GetJSON429 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON429() *Error

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

func (DeleteGroupsNameResponse) GetJSON500 added in v0.2.0

func (r DeleteGroupsNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteGroupsNameResponse) Status added in v0.2.0

func (r DeleteGroupsNameResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteGroupsNameResponse) StatusCode added in v0.2.0

func (r DeleteGroupsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteHooksNameParams added in v0.2.0

type DeleteHooksNameParams 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"`
}

DeleteHooksNameParams defines parameters for DeleteHooksName.

type DeleteHooksNameResponse added in v0.2.0

type DeleteHooksNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteHooksNameResponse added in v0.2.0

func ParseDeleteHooksNameResponse(rsp *http.Response) (*DeleteHooksNameResponse, error)

ParseDeleteHooksNameResponse parses an HTTP response from a DeleteHooksNameWithResponse call

func (DeleteHooksNameResponse) ContentType added in v0.2.0

func (r DeleteHooksNameResponse) ContentType() string

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

func (DeleteHooksNameResponse) GetBody added in v0.2.0

func (r DeleteHooksNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteHooksNameResponse) GetJSON400 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON400() *Error

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

func (DeleteHooksNameResponse) GetJSON401 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON401() *Error

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

func (DeleteHooksNameResponse) GetJSON403 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON403() *Error

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

func (DeleteHooksNameResponse) GetJSON404 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON404() *Error

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

func (DeleteHooksNameResponse) GetJSON409 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON409() *Error

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

func (DeleteHooksNameResponse) GetJSON429 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON429() *Error

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

func (DeleteHooksNameResponse) GetJSON500 added in v0.2.0

func (r DeleteHooksNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteHooksNameResponse) Status added in v0.2.0

func (r DeleteHooksNameResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteHooksNameResponse) StatusCode added in v0.2.0

func (r DeleteHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteIdentityProvidersNameParams added in v0.4.0

type DeleteIdentityProvidersNameParams 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"`
}

DeleteIdentityProvidersNameParams defines parameters for DeleteIdentityProvidersName.

type DeleteIdentityProvidersNameResponse added in v0.4.0

type DeleteIdentityProvidersNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteIdentityProvidersNameResponse added in v0.4.0

func ParseDeleteIdentityProvidersNameResponse(rsp *http.Response) (*DeleteIdentityProvidersNameResponse, error)

ParseDeleteIdentityProvidersNameResponse parses an HTTP response from a DeleteIdentityProvidersNameWithResponse call

func (DeleteIdentityProvidersNameResponse) ContentType added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetBody added in v0.4.0

GetBody returns the raw response body bytes

func (DeleteIdentityProvidersNameResponse) GetJSON400 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON401 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON403 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON404 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON409 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON429 added in v0.4.0

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

func (DeleteIdentityProvidersNameResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteIdentityProvidersNameResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (DeleteIdentityProvidersNameResponse) StatusCode added in v0.4.0

StatusCode returns HTTPResponse.StatusCode

type DeleteKeysIdParams added in v0.2.0

type DeleteKeysIdParams 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"`
}

DeleteKeysIdParams defines parameters for DeleteKeysId.

type DeleteKeysIdResponse added in v0.2.0

type DeleteKeysIdResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteKeysIdResponse added in v0.2.0

func ParseDeleteKeysIdResponse(rsp *http.Response) (*DeleteKeysIdResponse, error)

ParseDeleteKeysIdResponse parses an HTTP response from a DeleteKeysIdWithResponse call

func (DeleteKeysIdResponse) ContentType added in v0.2.0

func (r DeleteKeysIdResponse) ContentType() string

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

func (DeleteKeysIdResponse) GetBody added in v0.2.0

func (r DeleteKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteKeysIdResponse) GetJSON400 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON400() *Error

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

func (DeleteKeysIdResponse) GetJSON401 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON401() *Error

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

func (DeleteKeysIdResponse) GetJSON403 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON403() *Error

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

func (DeleteKeysIdResponse) GetJSON404 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON404() *Error

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

func (DeleteKeysIdResponse) GetJSON409 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON409() *Error

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

func (DeleteKeysIdResponse) GetJSON429 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON429() *Error

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

func (DeleteKeysIdResponse) GetJSON500 added in v0.2.0

func (r DeleteKeysIdResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteKeysIdResponse) Status added in v0.2.0

func (r DeleteKeysIdResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteKeysIdResponse) StatusCode added in v0.2.0

func (r DeleteKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteOverlaySectionParams added in v0.2.0

type DeleteOverlaySectionParams 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"`
}

DeleteOverlaySectionParams defines parameters for DeleteOverlaySection.

type DeleteOverlaySectionParamsSection added in v0.2.0

type DeleteOverlaySectionParamsSection string

DeleteOverlaySectionParamsSection defines parameters for DeleteOverlaySection.

const (
	Groups         DeleteOverlaySectionParamsSection = "groups"
	Hooks          DeleteOverlaySectionParamsSection = "hooks"
	PluginVersions DeleteOverlaySectionParamsSection = "plugin_versions"
	Root           DeleteOverlaySectionParamsSection = "root"
)

Defines values for DeleteOverlaySectionParamsSection.

func (DeleteOverlaySectionParamsSection) Valid added in v0.2.0

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

type DeleteOverlaySectionResponse added in v0.2.0

type DeleteOverlaySectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OverlayResetView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeleteOverlaySectionResponse added in v0.2.0

func ParseDeleteOverlaySectionResponse(rsp *http.Response) (*DeleteOverlaySectionResponse, error)

ParseDeleteOverlaySectionResponse parses an HTTP response from a DeleteOverlaySectionWithResponse call

func (DeleteOverlaySectionResponse) ContentType added in v0.2.0

func (r DeleteOverlaySectionResponse) ContentType() string

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

func (DeleteOverlaySectionResponse) GetBody added in v0.2.0

func (r DeleteOverlaySectionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteOverlaySectionResponse) GetJSON200 added in v0.2.0

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

func (DeleteOverlaySectionResponse) GetJSON400 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON400() *Error

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

func (DeleteOverlaySectionResponse) GetJSON401 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON401() *Error

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

func (DeleteOverlaySectionResponse) GetJSON403 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON403() *Error

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

func (DeleteOverlaySectionResponse) GetJSON409 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON409() *Error

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

func (DeleteOverlaySectionResponse) GetJSON429 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON429() *Error

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

func (DeleteOverlaySectionResponse) GetJSON500 added in v0.2.0

func (r DeleteOverlaySectionResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteOverlaySectionResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (DeleteOverlaySectionResponse) StatusCode added in v0.2.0

func (r DeleteOverlaySectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeletePluginsFileResponse added in v0.2.0

type DeletePluginsFileResponse 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
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseDeletePluginsFileResponse added in v0.2.0

func ParseDeletePluginsFileResponse(rsp *http.Response) (*DeletePluginsFileResponse, error)

ParseDeletePluginsFileResponse parses an HTTP response from a DeletePluginsFileWithResponse call

func (DeletePluginsFileResponse) ContentType added in v0.2.0

func (r DeletePluginsFileResponse) ContentType() string

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

func (DeletePluginsFileResponse) GetBody added in v0.2.0

func (r DeletePluginsFileResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeletePluginsFileResponse) GetJSON400 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON400() *Error

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

func (DeletePluginsFileResponse) GetJSON401 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON401() *Error

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

func (DeletePluginsFileResponse) GetJSON403 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON403() *Error

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

func (DeletePluginsFileResponse) GetJSON404 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON404() *Error

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

func (DeletePluginsFileResponse) GetJSON429 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON429() *Error

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

func (DeletePluginsFileResponse) GetJSON500 added in v0.2.0

func (r DeletePluginsFileResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeletePluginsFileResponse) Status added in v0.2.0

func (r DeletePluginsFileResponse) Status() string

Status returns HTTPResponse.Status

func (DeletePluginsFileResponse) StatusCode added in v0.2.0

func (r DeletePluginsFileResponse) 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: the hooks attached at the reserved all-pools key `pools.hooks:`
	// in `config.yaml` (the 1.5.3 replacement for the DELETED `global_hooks:` key; that key no
	// longer parses), plus any hook this API declares with `global: true`. The response FIELD name
	// stays `global_hooks`; only the config-file spelling changed.
	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 FlushCacheReq added in v0.2.0

type FlushCacheReq struct {
	// Module The auth module whose cache partition to flush. Omitted = flush all.
	Module *string `json:"module,omitempty"`
}

FlushCacheReq The `POST /api/v1/admin/auth/cache/flush` body. An absent body (or an absent `module`) flushes every partition. Deliberately NOT `deny_unknown_fields`: the endpoint has always ignored extra members, and tightening that would reject a call that works today.

type GetAdminAuthResponse added in v0.2.0

type GetAdminAuthResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetAdminAuthResponse added in v0.2.0

func ParseGetAdminAuthResponse(rsp *http.Response) (*GetAdminAuthResponse, error)

ParseGetAdminAuthResponse parses an HTTP response from a GetAdminAuthWithResponse call

func (GetAdminAuthResponse) ContentType added in v0.2.0

func (r GetAdminAuthResponse) ContentType() string

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

func (GetAdminAuthResponse) GetBody added in v0.2.0

func (r GetAdminAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAdminAuthResponse) GetJSON200 added in v0.2.0

func (r GetAdminAuthResponse) GetJSON200() *AdminAuthView

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

func (GetAdminAuthResponse) GetJSON401 added in v0.2.0

func (r GetAdminAuthResponse) GetJSON401() *Error

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

func (GetAdminAuthResponse) GetJSON403 added in v0.2.0

func (r GetAdminAuthResponse) GetJSON403() *Error

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

func (GetAdminAuthResponse) GetJSON500 added in v0.2.0

func (r GetAdminAuthResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetAdminAuthResponse) Status added in v0.2.0

func (r GetAdminAuthResponse) Status() string

Status returns HTTPResponse.Status

func (GetAdminAuthResponse) StatusCode added in v0.2.0

func (r GetAdminAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAuditParams added in v0.2.0

type GetAuditParams 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"`
}

GetAuditParams defines parameters for GetAudit.

type GetAuditResponse added in v0.2.0

type GetAuditResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AuditPageView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetAuditResponse added in v0.2.0

func ParseGetAuditResponse(rsp *http.Response) (*GetAuditResponse, error)

ParseGetAuditResponse parses an HTTP response from a GetAuditWithResponse call

func (GetAuditResponse) ContentType added in v0.2.0

func (r GetAuditResponse) ContentType() string

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

func (GetAuditResponse) GetBody added in v0.2.0

func (r GetAuditResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAuditResponse) GetJSON200 added in v0.2.0

func (r GetAuditResponse) GetJSON200() *AuditPageView

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

func (GetAuditResponse) GetJSON400 added in v0.2.0

func (r GetAuditResponse) GetJSON400() *Error

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

func (GetAuditResponse) GetJSON401 added in v0.2.0

func (r GetAuditResponse) GetJSON401() *Error

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

func (GetAuditResponse) GetJSON403 added in v0.2.0

func (r GetAuditResponse) GetJSON403() *Error

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

func (GetAuditResponse) GetJSON500 added in v0.2.0

func (r GetAuditResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetAuditResponse) Status added in v0.2.0

func (r GetAuditResponse) Status() string

Status returns HTTPResponse.Status

func (GetAuditResponse) StatusCode added in v0.2.0

func (r GetAuditResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAuthResponse added in v0.2.0

type GetAuthResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetAuthResponse added in v0.2.0

func ParseGetAuthResponse(rsp *http.Response) (*GetAuthResponse, error)

ParseGetAuthResponse parses an HTTP response from a GetAuthWithResponse call

func (GetAuthResponse) ContentType added in v0.2.0

func (r GetAuthResponse) ContentType() string

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

func (GetAuthResponse) GetBody added in v0.2.0

func (r GetAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAuthResponse) GetJSON200 added in v0.2.0

func (r GetAuthResponse) GetJSON200() *AuthView

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

func (GetAuthResponse) GetJSON401 added in v0.2.0

func (r GetAuthResponse) GetJSON401() *Error

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

func (GetAuthResponse) GetJSON403 added in v0.2.0

func (r GetAuthResponse) GetJSON403() *Error

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

func (GetAuthResponse) GetJSON500 added in v0.2.0

func (r GetAuthResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetAuthResponse) Status added in v0.2.0

func (r GetAuthResponse) Status() string

Status returns HTTPResponse.Status

func (GetAuthResponse) StatusCode added in v0.2.0

func (r GetAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetConfigDiffParams added in v0.2.0

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

GetConfigDiffParams defines parameters for GetConfigDiff.

type GetConfigDiffResponse added in v0.2.0

type GetConfigDiffResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetConfigDiffResponse added in v0.2.0

func ParseGetConfigDiffResponse(rsp *http.Response) (*GetConfigDiffResponse, error)

ParseGetConfigDiffResponse parses an HTTP response from a GetConfigDiffWithResponse call

func (GetConfigDiffResponse) ContentType added in v0.2.0

func (r GetConfigDiffResponse) ContentType() string

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

func (GetConfigDiffResponse) GetBody added in v0.2.0

func (r GetConfigDiffResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetConfigDiffResponse) GetJSON200 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON200() *ConfigDiffView

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

func (GetConfigDiffResponse) GetJSON400 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON400() *Error

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

func (GetConfigDiffResponse) GetJSON401 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON401() *Error

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

func (GetConfigDiffResponse) GetJSON403 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON403() *Error

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

func (GetConfigDiffResponse) GetJSON404 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON404() *Error

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

func (GetConfigDiffResponse) GetJSON500 added in v0.2.0

func (r GetConfigDiffResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetConfigDiffResponse) Status added in v0.2.0

func (r GetConfigDiffResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigDiffResponse) StatusCode added in v0.2.0

func (r GetConfigDiffResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetConfigResponse added in v0.2.0

type GetConfigResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetConfigResponse added in v0.2.0

func ParseGetConfigResponse(rsp *http.Response) (*GetConfigResponse, error)

ParseGetConfigResponse parses an HTTP response from a GetConfigWithResponse call

func (GetConfigResponse) ContentType added in v0.2.0

func (r GetConfigResponse) ContentType() string

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

func (GetConfigResponse) GetBody added in v0.2.0

func (r GetConfigResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetConfigResponse) GetJSON200 added in v0.2.0

func (r GetConfigResponse) GetJSON200() *EffectiveConfigView

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

func (GetConfigResponse) GetJSON401 added in v0.2.0

func (r GetConfigResponse) GetJSON401() *Error

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

func (GetConfigResponse) GetJSON403 added in v0.2.0

func (r GetConfigResponse) GetJSON403() *Error

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

func (GetConfigResponse) GetJSON500 added in v0.2.0

func (r GetConfigResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetConfigResponse) Status added in v0.2.0

func (r GetConfigResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigResponse) StatusCode added in v0.2.0

func (r GetConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetConfigSettingsResponse added in v0.2.0

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

func ParseGetConfigSettingsResponse added in v0.2.0

func ParseGetConfigSettingsResponse(rsp *http.Response) (*GetConfigSettingsResponse, error)

ParseGetConfigSettingsResponse parses an HTTP response from a GetConfigSettingsWithResponse call

func (GetConfigSettingsResponse) ContentType added in v0.2.0

func (r GetConfigSettingsResponse) ContentType() string

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

func (GetConfigSettingsResponse) GetBody added in v0.2.0

func (r GetConfigSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetConfigSettingsResponse) GetJSON200 added in v0.2.0

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

func (GetConfigSettingsResponse) GetJSON401 added in v0.2.0

func (r GetConfigSettingsResponse) GetJSON401() *Error

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

func (GetConfigSettingsResponse) GetJSON403 added in v0.2.0

func (r GetConfigSettingsResponse) GetJSON403() *Error

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

func (GetConfigSettingsResponse) GetJSON500 added in v0.2.0

func (r GetConfigSettingsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetConfigSettingsResponse) Status added in v0.2.0

func (r GetConfigSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigSettingsResponse) StatusCode added in v0.2.0

func (r GetConfigSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetConfigVersionsParams added in v0.2.0

type GetConfigVersionsParams 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"`
}

GetConfigVersionsParams defines parameters for GetConfigVersions.

type GetConfigVersionsResponse added in v0.2.0

type GetConfigVersionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigVersionPageView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetConfigVersionsResponse added in v0.2.0

func ParseGetConfigVersionsResponse(rsp *http.Response) (*GetConfigVersionsResponse, error)

ParseGetConfigVersionsResponse parses an HTTP response from a GetConfigVersionsWithResponse call

func (GetConfigVersionsResponse) ContentType added in v0.2.0

func (r GetConfigVersionsResponse) ContentType() string

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

func (GetConfigVersionsResponse) GetBody added in v0.2.0

func (r GetConfigVersionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetConfigVersionsResponse) GetJSON200 added in v0.2.0

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

func (GetConfigVersionsResponse) GetJSON400 added in v0.2.0

func (r GetConfigVersionsResponse) GetJSON400() *Error

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

func (GetConfigVersionsResponse) GetJSON401 added in v0.2.0

func (r GetConfigVersionsResponse) GetJSON401() *Error

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

func (GetConfigVersionsResponse) GetJSON403 added in v0.2.0

func (r GetConfigVersionsResponse) GetJSON403() *Error

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

func (GetConfigVersionsResponse) GetJSON500 added in v0.2.0

func (r GetConfigVersionsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetConfigVersionsResponse) Status added in v0.2.0

func (r GetConfigVersionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigVersionsResponse) StatusCode added in v0.2.0

func (r GetConfigVersionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetConfigVersionsVResponse added in v0.2.0

type GetConfigVersionsVResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigVersionDetailView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetConfigVersionsVResponse added in v0.2.0

func ParseGetConfigVersionsVResponse(rsp *http.Response) (*GetConfigVersionsVResponse, error)

ParseGetConfigVersionsVResponse parses an HTTP response from a GetConfigVersionsVWithResponse call

func (GetConfigVersionsVResponse) ContentType added in v0.2.0

func (r GetConfigVersionsVResponse) ContentType() string

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

func (GetConfigVersionsVResponse) GetBody added in v0.2.0

func (r GetConfigVersionsVResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetConfigVersionsVResponse) GetJSON200 added in v0.2.0

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

func (GetConfigVersionsVResponse) GetJSON400 added in v0.2.0

func (r GetConfigVersionsVResponse) GetJSON400() *Error

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

func (GetConfigVersionsVResponse) GetJSON401 added in v0.2.0

func (r GetConfigVersionsVResponse) GetJSON401() *Error

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

func (GetConfigVersionsVResponse) GetJSON403 added in v0.2.0

func (r GetConfigVersionsVResponse) GetJSON403() *Error

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

func (GetConfigVersionsVResponse) GetJSON404 added in v0.2.0

func (r GetConfigVersionsVResponse) GetJSON404() *Error

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

func (GetConfigVersionsVResponse) GetJSON500 added in v0.2.0

func (r GetConfigVersionsVResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetConfigVersionsVResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetConfigVersionsVResponse) StatusCode added in v0.2.0

func (r GetConfigVersionsVResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExportNameResponse added in v0.4.0

type GetExportNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetExportNameResponse added in v0.4.0

func ParseGetExportNameResponse(rsp *http.Response) (*GetExportNameResponse, error)

ParseGetExportNameResponse parses an HTTP response from a GetExportNameWithResponse call

func (GetExportNameResponse) ContentType added in v0.4.0

func (r GetExportNameResponse) ContentType() string

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

func (GetExportNameResponse) GetBody added in v0.4.0

func (r GetExportNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetExportNameResponse) GetJSON200 added in v0.4.0

func (r GetExportNameResponse) GetJSON200() *NamedDefView

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

func (GetExportNameResponse) GetJSON401 added in v0.4.0

func (r GetExportNameResponse) GetJSON401() *Error

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

func (GetExportNameResponse) GetJSON403 added in v0.4.0

func (r GetExportNameResponse) GetJSON403() *Error

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

func (GetExportNameResponse) GetJSON404 added in v0.4.0

func (r GetExportNameResponse) GetJSON404() *Error

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

func (GetExportNameResponse) GetJSON500 added in v0.4.0

func (r GetExportNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetExportNameResponse) Status added in v0.4.0

func (r GetExportNameResponse) Status() string

Status returns HTTPResponse.Status

func (GetExportNameResponse) StatusCode added in v0.4.0

func (r GetExportNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetExportResponse added in v0.4.0

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

func ParseGetExportResponse added in v0.4.0

func ParseGetExportResponse(rsp *http.Response) (*GetExportResponse, error)

ParseGetExportResponse parses an HTTP response from a GetExportWithResponse call

func (GetExportResponse) ContentType added in v0.4.0

func (r GetExportResponse) ContentType() string

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

func (GetExportResponse) GetBody added in v0.4.0

func (r GetExportResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetExportResponse) GetJSON200 added in v0.4.0

func (r GetExportResponse) GetJSON200() *PageNamedDefView

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

func (GetExportResponse) GetJSON401 added in v0.4.0

func (r GetExportResponse) GetJSON401() *Error

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

func (GetExportResponse) GetJSON403 added in v0.4.0

func (r GetExportResponse) GetJSON403() *Error

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

func (GetExportResponse) GetJSON500 added in v0.4.0

func (r GetExportResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetExportResponse) Status added in v0.4.0

func (r GetExportResponse) Status() string

Status returns HTTPResponse.Status

func (GetExportResponse) StatusCode added in v0.4.0

func (r GetExportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetGroupsNameResponse added in v0.2.0

type GetGroupsNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GroupView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetGroupsNameResponse added in v0.2.0

func ParseGetGroupsNameResponse(rsp *http.Response) (*GetGroupsNameResponse, error)

ParseGetGroupsNameResponse parses an HTTP response from a GetGroupsNameWithResponse call

func (GetGroupsNameResponse) ContentType added in v0.2.0

func (r GetGroupsNameResponse) ContentType() string

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

func (GetGroupsNameResponse) GetBody added in v0.2.0

func (r GetGroupsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetGroupsNameResponse) GetJSON200 added in v0.2.0

func (r GetGroupsNameResponse) GetJSON200() *GroupView

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

func (GetGroupsNameResponse) GetJSON401 added in v0.2.0

func (r GetGroupsNameResponse) GetJSON401() *Error

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

func (GetGroupsNameResponse) GetJSON403 added in v0.2.0

func (r GetGroupsNameResponse) GetJSON403() *Error

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

func (GetGroupsNameResponse) GetJSON404 added in v0.2.0

func (r GetGroupsNameResponse) GetJSON404() *Error

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

func (GetGroupsNameResponse) GetJSON500 added in v0.2.0

func (r GetGroupsNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetGroupsNameResponse) Status added in v0.2.0

func (r GetGroupsNameResponse) Status() string

Status returns HTTPResponse.Status

func (GetGroupsNameResponse) StatusCode added in v0.2.0

func (r GetGroupsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetGroupsNameUsageResponse added in v0.2.0

type GetGroupsNameUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GroupUsageView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetGroupsNameUsageResponse added in v0.2.0

func ParseGetGroupsNameUsageResponse(rsp *http.Response) (*GetGroupsNameUsageResponse, error)

ParseGetGroupsNameUsageResponse parses an HTTP response from a GetGroupsNameUsageWithResponse call

func (GetGroupsNameUsageResponse) ContentType added in v0.2.0

func (r GetGroupsNameUsageResponse) ContentType() string

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

func (GetGroupsNameUsageResponse) GetBody added in v0.2.0

func (r GetGroupsNameUsageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetGroupsNameUsageResponse) GetJSON200 added in v0.2.0

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

func (GetGroupsNameUsageResponse) GetJSON401 added in v0.2.0

func (r GetGroupsNameUsageResponse) GetJSON401() *Error

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

func (GetGroupsNameUsageResponse) GetJSON403 added in v0.2.0

func (r GetGroupsNameUsageResponse) GetJSON403() *Error

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

func (GetGroupsNameUsageResponse) GetJSON404 added in v0.2.0

func (r GetGroupsNameUsageResponse) GetJSON404() *Error

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

func (GetGroupsNameUsageResponse) GetJSON500 added in v0.2.0

func (r GetGroupsNameUsageResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetGroupsNameUsageResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetGroupsNameUsageResponse) StatusCode added in v0.2.0

func (r GetGroupsNameUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetGroupsResponse added in v0.2.0

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

func ParseGetGroupsResponse added in v0.2.0

func ParseGetGroupsResponse(rsp *http.Response) (*GetGroupsResponse, error)

ParseGetGroupsResponse parses an HTTP response from a GetGroupsWithResponse call

func (GetGroupsResponse) ContentType added in v0.2.0

func (r GetGroupsResponse) ContentType() string

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

func (GetGroupsResponse) GetBody added in v0.2.0

func (r GetGroupsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetGroupsResponse) GetJSON200 added in v0.2.0

func (r GetGroupsResponse) GetJSON200() *PageGroupView

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

func (GetGroupsResponse) GetJSON401 added in v0.2.0

func (r GetGroupsResponse) GetJSON401() *Error

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

func (GetGroupsResponse) GetJSON403 added in v0.2.0

func (r GetGroupsResponse) GetJSON403() *Error

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

func (GetGroupsResponse) GetJSON500 added in v0.2.0

func (r GetGroupsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetGroupsResponse) Status added in v0.2.0

func (r GetGroupsResponse) Status() string

Status returns HTTPResponse.Status

func (GetGroupsResponse) StatusCode added in v0.2.0

func (r GetGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHooksNameHealthResponse added in v0.2.0

type GetHooksNameHealthResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetHooksNameHealthResponse added in v0.2.0

func ParseGetHooksNameHealthResponse(rsp *http.Response) (*GetHooksNameHealthResponse, error)

ParseGetHooksNameHealthResponse parses an HTTP response from a GetHooksNameHealthWithResponse call

func (GetHooksNameHealthResponse) ContentType added in v0.2.0

func (r GetHooksNameHealthResponse) ContentType() string

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

func (GetHooksNameHealthResponse) GetBody added in v0.2.0

func (r GetHooksNameHealthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHooksNameHealthResponse) GetJSON200 added in v0.2.0

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

func (GetHooksNameHealthResponse) GetJSON401 added in v0.2.0

func (r GetHooksNameHealthResponse) GetJSON401() *Error

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

func (GetHooksNameHealthResponse) GetJSON403 added in v0.2.0

func (r GetHooksNameHealthResponse) GetJSON403() *Error

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

func (GetHooksNameHealthResponse) GetJSON404 added in v0.2.0

func (r GetHooksNameHealthResponse) GetJSON404() *Error

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

func (GetHooksNameHealthResponse) GetJSON500 added in v0.2.0

func (r GetHooksNameHealthResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHooksNameHealthResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetHooksNameHealthResponse) StatusCode added in v0.2.0

func (r GetHooksNameHealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHooksNameResponse added in v0.2.0

type GetHooksNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetHooksNameResponse added in v0.2.0

func ParseGetHooksNameResponse(rsp *http.Response) (*GetHooksNameResponse, error)

ParseGetHooksNameResponse parses an HTTP response from a GetHooksNameWithResponse call

func (GetHooksNameResponse) ContentType added in v0.2.0

func (r GetHooksNameResponse) ContentType() string

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

func (GetHooksNameResponse) GetBody added in v0.2.0

func (r GetHooksNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHooksNameResponse) GetJSON200 added in v0.2.0

func (r GetHooksNameResponse) GetJSON200() *HookView

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

func (GetHooksNameResponse) GetJSON401 added in v0.2.0

func (r GetHooksNameResponse) GetJSON401() *Error

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

func (GetHooksNameResponse) GetJSON403 added in v0.2.0

func (r GetHooksNameResponse) GetJSON403() *Error

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

func (GetHooksNameResponse) GetJSON404 added in v0.2.0

func (r GetHooksNameResponse) GetJSON404() *Error

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

func (GetHooksNameResponse) GetJSON500 added in v0.2.0

func (r GetHooksNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHooksNameResponse) Status added in v0.2.0

func (r GetHooksNameResponse) Status() string

Status returns HTTPResponse.Status

func (GetHooksNameResponse) StatusCode added in v0.2.0

func (r GetHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHooksNameSchemaResponse added in v0.2.0

type GetHooksNameSchemaResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetHooksNameSchemaResponse added in v0.2.0

func ParseGetHooksNameSchemaResponse(rsp *http.Response) (*GetHooksNameSchemaResponse, error)

ParseGetHooksNameSchemaResponse parses an HTTP response from a GetHooksNameSchemaWithResponse call

func (GetHooksNameSchemaResponse) ContentType added in v0.2.0

func (r GetHooksNameSchemaResponse) ContentType() string

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

func (GetHooksNameSchemaResponse) GetBody added in v0.2.0

func (r GetHooksNameSchemaResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHooksNameSchemaResponse) GetJSON200 added in v0.2.0

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

func (GetHooksNameSchemaResponse) GetJSON401 added in v0.2.0

func (r GetHooksNameSchemaResponse) GetJSON401() *Error

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

func (GetHooksNameSchemaResponse) GetJSON403 added in v0.2.0

func (r GetHooksNameSchemaResponse) GetJSON403() *Error

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

func (GetHooksNameSchemaResponse) GetJSON404 added in v0.2.0

func (r GetHooksNameSchemaResponse) GetJSON404() *Error

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

func (GetHooksNameSchemaResponse) GetJSON500 added in v0.2.0

func (r GetHooksNameSchemaResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHooksNameSchemaResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetHooksNameSchemaResponse) StatusCode added in v0.2.0

func (r GetHooksNameSchemaResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHooksNameStatusResponse added in v0.2.0

type GetHooksNameStatusResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetHooksNameStatusResponse added in v0.2.0

func ParseGetHooksNameStatusResponse(rsp *http.Response) (*GetHooksNameStatusResponse, error)

ParseGetHooksNameStatusResponse parses an HTTP response from a GetHooksNameStatusWithResponse call

func (GetHooksNameStatusResponse) ContentType added in v0.2.0

func (r GetHooksNameStatusResponse) ContentType() string

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

func (GetHooksNameStatusResponse) GetBody added in v0.2.0

func (r GetHooksNameStatusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHooksNameStatusResponse) GetJSON200 added in v0.2.0

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

func (GetHooksNameStatusResponse) GetJSON401 added in v0.2.0

func (r GetHooksNameStatusResponse) GetJSON401() *Error

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

func (GetHooksNameStatusResponse) GetJSON403 added in v0.2.0

func (r GetHooksNameStatusResponse) GetJSON403() *Error

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

func (GetHooksNameStatusResponse) GetJSON404 added in v0.2.0

func (r GetHooksNameStatusResponse) GetJSON404() *Error

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

func (GetHooksNameStatusResponse) GetJSON500 added in v0.2.0

func (r GetHooksNameStatusResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHooksNameStatusResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetHooksNameStatusResponse) StatusCode added in v0.2.0

func (r GetHooksNameStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHooksResponse added in v0.2.0

type GetHooksResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetHooksResponse added in v0.2.0

func ParseGetHooksResponse(rsp *http.Response) (*GetHooksResponse, error)

ParseGetHooksResponse parses an HTTP response from a GetHooksWithResponse call

func (GetHooksResponse) ContentType added in v0.2.0

func (r GetHooksResponse) ContentType() string

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

func (GetHooksResponse) GetBody added in v0.2.0

func (r GetHooksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHooksResponse) GetJSON200 added in v0.2.0

func (r GetHooksResponse) GetJSON200() *PageHookView

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

func (GetHooksResponse) GetJSON401 added in v0.2.0

func (r GetHooksResponse) GetJSON401() *Error

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

func (GetHooksResponse) GetJSON403 added in v0.2.0

func (r GetHooksResponse) GetJSON403() *Error

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

func (GetHooksResponse) GetJSON500 added in v0.2.0

func (r GetHooksResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetHooksResponse) Status added in v0.2.0

func (r GetHooksResponse) Status() string

Status returns HTTPResponse.Status

func (GetHooksResponse) StatusCode added in v0.2.0

func (r GetHooksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIdentityProvidersNameResponse added in v0.4.0

type GetIdentityProvidersNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetIdentityProvidersNameResponse added in v0.4.0

func ParseGetIdentityProvidersNameResponse(rsp *http.Response) (*GetIdentityProvidersNameResponse, error)

ParseGetIdentityProvidersNameResponse parses an HTTP response from a GetIdentityProvidersNameWithResponse call

func (GetIdentityProvidersNameResponse) ContentType added in v0.4.0

func (r GetIdentityProvidersNameResponse) ContentType() string

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

func (GetIdentityProvidersNameResponse) GetBody added in v0.4.0

func (r GetIdentityProvidersNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIdentityProvidersNameResponse) GetJSON200 added in v0.4.0

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

func (GetIdentityProvidersNameResponse) GetJSON401 added in v0.4.0

func (r GetIdentityProvidersNameResponse) GetJSON401() *Error

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

func (GetIdentityProvidersNameResponse) GetJSON403 added in v0.4.0

func (r GetIdentityProvidersNameResponse) GetJSON403() *Error

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

func (GetIdentityProvidersNameResponse) GetJSON404 added in v0.4.0

func (r GetIdentityProvidersNameResponse) GetJSON404() *Error

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

func (GetIdentityProvidersNameResponse) GetJSON500 added in v0.4.0

func (r GetIdentityProvidersNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetIdentityProvidersNameResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetIdentityProvidersNameResponse) StatusCode added in v0.4.0

func (r GetIdentityProvidersNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIdentityProvidersResponse added in v0.4.0

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

func ParseGetIdentityProvidersResponse added in v0.4.0

func ParseGetIdentityProvidersResponse(rsp *http.Response) (*GetIdentityProvidersResponse, error)

ParseGetIdentityProvidersResponse parses an HTTP response from a GetIdentityProvidersWithResponse call

func (GetIdentityProvidersResponse) ContentType added in v0.4.0

func (r GetIdentityProvidersResponse) ContentType() string

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

func (GetIdentityProvidersResponse) GetBody added in v0.4.0

func (r GetIdentityProvidersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIdentityProvidersResponse) GetJSON200 added in v0.4.0

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

func (GetIdentityProvidersResponse) GetJSON401 added in v0.4.0

func (r GetIdentityProvidersResponse) GetJSON401() *Error

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

func (GetIdentityProvidersResponse) GetJSON403 added in v0.4.0

func (r GetIdentityProvidersResponse) GetJSON403() *Error

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

func (GetIdentityProvidersResponse) GetJSON500 added in v0.4.0

func (r GetIdentityProvidersResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetIdentityProvidersResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetIdentityProvidersResponse) StatusCode added in v0.4.0

func (r GetIdentityProvidersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInfoResponse added in v0.2.0

type GetInfoResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetInfoResponse added in v0.2.0

func ParseGetInfoResponse(rsp *http.Response) (*GetInfoResponse, error)

ParseGetInfoResponse parses an HTTP response from a GetInfoWithResponse call

func (GetInfoResponse) ContentType added in v0.2.0

func (r GetInfoResponse) ContentType() string

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

func (GetInfoResponse) GetBody added in v0.2.0

func (r GetInfoResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetInfoResponse) GetJSON200 added in v0.2.0

func (r GetInfoResponse) GetJSON200() *InfoView

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

func (GetInfoResponse) GetJSON401 added in v0.2.0

func (r GetInfoResponse) GetJSON401() *Error

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

func (GetInfoResponse) GetJSON403 added in v0.2.0

func (r GetInfoResponse) GetJSON403() *Error

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

func (GetInfoResponse) GetJSON500 added in v0.2.0

func (r GetInfoResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetInfoResponse) Status added in v0.2.0

func (r GetInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetInfoResponse) StatusCode added in v0.2.0

func (r GetInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetKeysIdResponse added in v0.2.0

type GetKeysIdResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetKeysIdResponse added in v0.2.0

func ParseGetKeysIdResponse(rsp *http.Response) (*GetKeysIdResponse, error)

ParseGetKeysIdResponse parses an HTTP response from a GetKeysIdWithResponse call

func (GetKeysIdResponse) ContentType added in v0.2.0

func (r GetKeysIdResponse) ContentType() string

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

func (GetKeysIdResponse) GetBody added in v0.2.0

func (r GetKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetKeysIdResponse) GetJSON200 added in v0.2.0

func (r GetKeysIdResponse) GetJSON200() *KeyView

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

func (GetKeysIdResponse) GetJSON400 added in v0.2.0

func (r GetKeysIdResponse) GetJSON400() *Error

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

func (GetKeysIdResponse) GetJSON401 added in v0.2.0

func (r GetKeysIdResponse) GetJSON401() *Error

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

func (GetKeysIdResponse) GetJSON403 added in v0.2.0

func (r GetKeysIdResponse) GetJSON403() *Error

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

func (GetKeysIdResponse) GetJSON404 added in v0.2.0

func (r GetKeysIdResponse) GetJSON404() *Error

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

func (GetKeysIdResponse) GetJSON500 added in v0.2.0

func (r GetKeysIdResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetKeysIdResponse) Status added in v0.2.0

func (r GetKeysIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetKeysIdResponse) StatusCode added in v0.2.0

func (r GetKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetKeysIdUsageResponse added in v0.2.0

type GetKeysIdUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *KeyMeteringView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetKeysIdUsageResponse added in v0.2.0

func ParseGetKeysIdUsageResponse(rsp *http.Response) (*GetKeysIdUsageResponse, error)

ParseGetKeysIdUsageResponse parses an HTTP response from a GetKeysIdUsageWithResponse call

func (GetKeysIdUsageResponse) ContentType added in v0.2.0

func (r GetKeysIdUsageResponse) ContentType() string

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

func (GetKeysIdUsageResponse) GetBody added in v0.2.0

func (r GetKeysIdUsageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetKeysIdUsageResponse) GetJSON200 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON200() *KeyMeteringView

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

func (GetKeysIdUsageResponse) GetJSON400 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON400() *Error

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

func (GetKeysIdUsageResponse) GetJSON401 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON401() *Error

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

func (GetKeysIdUsageResponse) GetJSON403 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON403() *Error

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

func (GetKeysIdUsageResponse) GetJSON404 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON404() *Error

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

func (GetKeysIdUsageResponse) GetJSON500 added in v0.2.0

func (r GetKeysIdUsageResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetKeysIdUsageResponse) Status added in v0.2.0

func (r GetKeysIdUsageResponse) Status() string

Status returns HTTPResponse.Status

func (GetKeysIdUsageResponse) StatusCode added in v0.2.0

func (r GetKeysIdUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetKeysParams added in v0.2.0

type GetKeysParams 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"`

	// Group Filter by bound group (a `user:<sub>` leaf's keys are one person's)
	Group *string `form:"group,omitempty" json:"group,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"`

	// Include Set to `tombstoned` to include hard-deleted keys, which are otherwise omitted (each row's `state` reads `"tombstoned"`)
	Include *string `form:"include,omitempty" json:"include,omitempty"`
}

GetKeysParams defines parameters for GetKeys.

type GetKeysResponse added in v0.2.0

type GetKeysResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetKeysResponse added in v0.2.0

func ParseGetKeysResponse(rsp *http.Response) (*GetKeysResponse, error)

ParseGetKeysResponse parses an HTTP response from a GetKeysWithResponse call

func (GetKeysResponse) ContentType added in v0.2.0

func (r GetKeysResponse) ContentType() string

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

func (GetKeysResponse) GetBody added in v0.2.0

func (r GetKeysResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetKeysResponse) GetJSON200 added in v0.2.0

func (r GetKeysResponse) GetJSON200() *KeyPageView

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

func (GetKeysResponse) GetJSON400 added in v0.2.0

func (r GetKeysResponse) GetJSON400() *Error

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

func (GetKeysResponse) GetJSON401 added in v0.2.0

func (r GetKeysResponse) GetJSON401() *Error

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

func (GetKeysResponse) GetJSON403 added in v0.2.0

func (r GetKeysResponse) GetJSON403() *Error

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

func (GetKeysResponse) GetJSON500 added in v0.2.0

func (r GetKeysResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetKeysResponse) Status added in v0.2.0

func (r GetKeysResponse) Status() string

Status returns HTTPResponse.Status

func (GetKeysResponse) StatusCode added in v0.2.0

func (r GetKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetModelsResponse added in v0.2.0

type GetModelsResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetModelsResponse added in v0.2.0

func ParseGetModelsResponse(rsp *http.Response) (*GetModelsResponse, error)

ParseGetModelsResponse parses an HTTP response from a GetModelsWithResponse call

func (GetModelsResponse) ContentType added in v0.2.0

func (r GetModelsResponse) ContentType() string

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

func (GetModelsResponse) GetBody added in v0.2.0

func (r GetModelsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetModelsResponse) GetJSON200 added in v0.2.0

func (r GetModelsResponse) GetJSON200() *PageModelView

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

func (GetModelsResponse) GetJSON401 added in v0.2.0

func (r GetModelsResponse) GetJSON401() *Error

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

func (GetModelsResponse) GetJSON403 added in v0.2.0

func (r GetModelsResponse) GetJSON403() *Error

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

func (GetModelsResponse) GetJSON500 added in v0.2.0

func (r GetModelsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetModelsResponse) Status added in v0.2.0

func (r GetModelsResponse) Status() string

Status returns HTTPResponse.Status

func (GetModelsResponse) StatusCode added in v0.2.0

func (r GetModelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOpenapiJsonResponse added in v0.2.0

type GetOpenapiJsonResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetOpenapiJsonResponse added in v0.2.0

func ParseGetOpenapiJsonResponse(rsp *http.Response) (*GetOpenapiJsonResponse, error)

ParseGetOpenapiJsonResponse parses an HTTP response from a GetOpenapiJsonWithResponse call

func (GetOpenapiJsonResponse) ContentType added in v0.2.0

func (r GetOpenapiJsonResponse) ContentType() string

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

func (GetOpenapiJsonResponse) GetBody added in v0.2.0

func (r GetOpenapiJsonResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOpenapiJsonResponse) GetJSON200 added in v0.2.0

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

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

func (GetOpenapiJsonResponse) GetJSON401 added in v0.2.0

func (r GetOpenapiJsonResponse) GetJSON401() *Error

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

func (GetOpenapiJsonResponse) GetJSON403 added in v0.2.0

func (r GetOpenapiJsonResponse) GetJSON403() *Error

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

func (GetOpenapiJsonResponse) GetJSON500 added in v0.2.0

func (r GetOpenapiJsonResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetOpenapiJsonResponse) Status added in v0.2.0

func (r GetOpenapiJsonResponse) Status() string

Status returns HTTPResponse.Status

func (GetOpenapiJsonResponse) StatusCode added in v0.2.0

func (r GetOpenapiJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPluginsFileSchemaResponse added in v0.2.0

type GetPluginsFileSchemaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PluginSchemaView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetPluginsFileSchemaResponse added in v0.2.0

func ParseGetPluginsFileSchemaResponse(rsp *http.Response) (*GetPluginsFileSchemaResponse, error)

ParseGetPluginsFileSchemaResponse parses an HTTP response from a GetPluginsFileSchemaWithResponse call

func (GetPluginsFileSchemaResponse) ContentType added in v0.2.0

func (r GetPluginsFileSchemaResponse) ContentType() string

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

func (GetPluginsFileSchemaResponse) GetBody added in v0.2.0

func (r GetPluginsFileSchemaResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPluginsFileSchemaResponse) GetJSON200 added in v0.2.0

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

func (GetPluginsFileSchemaResponse) GetJSON401 added in v0.2.0

func (r GetPluginsFileSchemaResponse) GetJSON401() *Error

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

func (GetPluginsFileSchemaResponse) GetJSON403 added in v0.2.0

func (r GetPluginsFileSchemaResponse) GetJSON403() *Error

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

func (GetPluginsFileSchemaResponse) GetJSON404 added in v0.2.0

func (r GetPluginsFileSchemaResponse) GetJSON404() *Error

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

func (GetPluginsFileSchemaResponse) GetJSON500 added in v0.2.0

func (r GetPluginsFileSchemaResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPluginsFileSchemaResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (GetPluginsFileSchemaResponse) StatusCode added in v0.2.0

func (r GetPluginsFileSchemaResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPluginsParams added in v0.2.0

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

GetPluginsParams defines parameters for GetPlugins.

type GetPluginsResponse added in v0.2.0

type GetPluginsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PagePluginView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetPluginsResponse added in v0.2.0

func ParseGetPluginsResponse(rsp *http.Response) (*GetPluginsResponse, error)

ParseGetPluginsResponse parses an HTTP response from a GetPluginsWithResponse call

func (GetPluginsResponse) ContentType added in v0.2.0

func (r GetPluginsResponse) ContentType() string

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

func (GetPluginsResponse) GetBody added in v0.2.0

func (r GetPluginsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPluginsResponse) GetJSON200 added in v0.2.0

func (r GetPluginsResponse) GetJSON200() *PagePluginView

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

func (GetPluginsResponse) GetJSON400 added in v0.2.0

func (r GetPluginsResponse) GetJSON400() *Error

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

func (GetPluginsResponse) GetJSON401 added in v0.2.0

func (r GetPluginsResponse) GetJSON401() *Error

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

func (GetPluginsResponse) GetJSON403 added in v0.2.0

func (r GetPluginsResponse) GetJSON403() *Error

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

func (GetPluginsResponse) GetJSON500 added in v0.2.0

func (r GetPluginsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPluginsResponse) Status added in v0.2.0

func (r GetPluginsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPluginsResponse) StatusCode added in v0.2.0

func (r GetPluginsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPoolsNameResponse added in v0.2.0

type GetPoolsNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetPoolsNameResponse added in v0.2.0

func ParseGetPoolsNameResponse(rsp *http.Response) (*GetPoolsNameResponse, error)

ParseGetPoolsNameResponse parses an HTTP response from a GetPoolsNameWithResponse call

func (GetPoolsNameResponse) ContentType added in v0.2.0

func (r GetPoolsNameResponse) ContentType() string

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

func (GetPoolsNameResponse) GetBody added in v0.2.0

func (r GetPoolsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPoolsNameResponse) GetJSON200 added in v0.2.0

func (r GetPoolsNameResponse) GetJSON200() *PoolDetailView

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

func (GetPoolsNameResponse) GetJSON401 added in v0.2.0

func (r GetPoolsNameResponse) GetJSON401() *Error

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

func (GetPoolsNameResponse) GetJSON403 added in v0.2.0

func (r GetPoolsNameResponse) GetJSON403() *Error

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

func (GetPoolsNameResponse) GetJSON404 added in v0.2.0

func (r GetPoolsNameResponse) GetJSON404() *Error

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

func (GetPoolsNameResponse) GetJSON500 added in v0.2.0

func (r GetPoolsNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPoolsNameResponse) Status added in v0.2.0

func (r GetPoolsNameResponse) Status() string

Status returns HTTPResponse.Status

func (GetPoolsNameResponse) StatusCode added in v0.2.0

func (r GetPoolsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPoolsParams added in v0.2.0

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

GetPoolsParams defines parameters for GetPools.

type GetPoolsResponse added in v0.2.0

type GetPoolsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PagePoolView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetPoolsResponse added in v0.2.0

func ParseGetPoolsResponse(rsp *http.Response) (*GetPoolsResponse, error)

ParseGetPoolsResponse parses an HTTP response from a GetPoolsWithResponse call

func (GetPoolsResponse) ContentType added in v0.2.0

func (r GetPoolsResponse) ContentType() string

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

func (GetPoolsResponse) GetBody added in v0.2.0

func (r GetPoolsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPoolsResponse) GetJSON200 added in v0.2.0

func (r GetPoolsResponse) GetJSON200() *PagePoolView

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

func (GetPoolsResponse) GetJSON400 added in v0.2.0

func (r GetPoolsResponse) GetJSON400() *Error

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

func (GetPoolsResponse) GetJSON401 added in v0.2.0

func (r GetPoolsResponse) GetJSON401() *Error

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

func (GetPoolsResponse) GetJSON403 added in v0.2.0

func (r GetPoolsResponse) GetJSON403() *Error

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

func (GetPoolsResponse) GetJSON500 added in v0.2.0

func (r GetPoolsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPoolsResponse) Status added in v0.2.0

func (r GetPoolsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPoolsResponse) StatusCode added in v0.2.0

func (r GetPoolsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProvidersResponse added in v0.2.0

type GetProvidersResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetProvidersResponse added in v0.2.0

func ParseGetProvidersResponse(rsp *http.Response) (*GetProvidersResponse, error)

ParseGetProvidersResponse parses an HTTP response from a GetProvidersWithResponse call

func (GetProvidersResponse) ContentType added in v0.2.0

func (r GetProvidersResponse) ContentType() string

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

func (GetProvidersResponse) GetBody added in v0.2.0

func (r GetProvidersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetProvidersResponse) GetJSON200 added in v0.2.0

func (r GetProvidersResponse) GetJSON200() *PageProviderView

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

func (GetProvidersResponse) GetJSON401 added in v0.2.0

func (r GetProvidersResponse) GetJSON401() *Error

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

func (GetProvidersResponse) GetJSON403 added in v0.2.0

func (r GetProvidersResponse) GetJSON403() *Error

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

func (GetProvidersResponse) GetJSON500 added in v0.2.0

func (r GetProvidersResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetProvidersResponse) Status added in v0.2.0

func (r GetProvidersResponse) Status() string

Status returns HTTPResponse.Status

func (GetProvidersResponse) StatusCode added in v0.2.0

func (r GetProvidersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUsageParams added in v0.2.0

type GetUsageParams 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"`
}

GetUsageParams defines parameters for GetUsage.

type GetUsageResponse added in v0.2.0

type GetUsageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UsageView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParseGetUsageResponse added in v0.2.0

func ParseGetUsageResponse(rsp *http.Response) (*GetUsageResponse, error)

ParseGetUsageResponse parses an HTTP response from a GetUsageWithResponse call

func (GetUsageResponse) ContentType added in v0.2.0

func (r GetUsageResponse) ContentType() string

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

func (GetUsageResponse) GetBody added in v0.2.0

func (r GetUsageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetUsageResponse) GetJSON200 added in v0.2.0

func (r GetUsageResponse) GetJSON200() *UsageView

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

func (GetUsageResponse) GetJSON400 added in v0.2.0

func (r GetUsageResponse) GetJSON400() *Error

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

func (GetUsageResponse) GetJSON401 added in v0.2.0

func (r GetUsageResponse) GetJSON401() *Error

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

func (GetUsageResponse) GetJSON403 added in v0.2.0

func (r GetUsageResponse) GetJSON403() *Error

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

func (GetUsageResponse) GetJSON500 added in v0.2.0

func (r GetUsageResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetUsageResponse) Status added in v0.2.0

func (r GetUsageResponse) Status() string

Status returns HTTPResponse.Status

func (GetUsageResponse) StatusCode added in v0.2.0

func (r GetUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GroupBucketUsageView added in v0.2.0

type GroupBucketUsageView struct {
	BudgetCap *int64 `json:"budget_cap,omitempty"`

	// BudgetRemainingCents Cents left under `budget_cap` (floored at 0); absent when no budget cap is set.
	BudgetRemainingCents *int64 `json:"budget_remaining_cents,omitempty"`

	// Pool The pool scope for a pool-qualified bucket; absent for a group-wide bucket.
	Pool *string `json:"pool,omitempty"`

	// Requests Requests admitted this window (the requests-limit truth: failures are not refunded).
	Requests uint64 `json:"requests"`

	// RequestsCap The bucket's caps, when configured (absent = uncapped on that metric).
	RequestsCap *uint64 `json:"requests_cap,omitempty"`

	// SpendCents Spend derived at read time (tokens x current rate card), abstract cents.
	SpendCents int64 `json:"spend_cents"`

	// Tokens Total tokens ledgered this window (all tiers).
	Tokens    uint64  `json:"tokens"`
	TokensCap *uint64 `json:"tokens_cap,omitempty"`

	// Window The accounting window: `minute` | `hour` | `day` | `month` | `total`.
	Window string `json:"window"`
}

GroupBucketUsageView One `(window, pool?)` enforcement bucket's usage vs caps inside a [`GroupUsageView`].

type GroupUsageView added in v0.2.0

type GroupUsageView struct {
	// AsOf Epoch seconds the read was taken at (the windows below are current AS OF this instant).
	AsOf uint64 `json:"as_of"`

	// Buckets One row per enforcement bucket, in the group's resolved bucket order. Empty for a group
	// with only a `concurrent` limit (or none); there is no windowed ledger to read.
	Buckets []GroupBucketUsageView `json:"buckets"`

	// Enabled `false` = the group is FROZEN (`enabled: false`): every request through it rejects.
	Enabled bool `json:"enabled"`

	// Group The group name (echoed from the path).
	Group string `json:"group"`
}

GroupUsageView `GET /groups/{name}/usage`: one group's DERIVED current-window usage, one row per enforcement bucket (each `(window, pool?)` its limits materialise), against that bucket's caps. The dashboard read: spend/tokens/requests per tier vs the budgets, straight off the ledger x the CURRENT rate card (reprice-on-read, nothing stored). The customer's self-service tool consumes this per group (`user:<sub>` leaf = one person's view) and re-scopes it.

type GroupView added in v0.2.0

type GroupView struct {
	// ChildDefault The limit template stamped onto children auto-provisioned under this group (e.g. a
	// `user:<sub>` leaf on first self-mint). Skipped from the body when the group sets none.
	ChildDefault *[]LimitView `json:"child_default,omitempty"`

	// Enabled `false` FREEZES the group (every request charging through it is rejected; history kept).
	Enabled bool `json:"enabled"`

	// Limits The group's own limits, enforced together (AND). Order preserved from config.
	Limits []LimitView `json:"limits"`
	Name   string      `json:"name"`

	// Parent The parent group whose limits this one is ANDed under (the enforcement chain). `None` = a
	// root group. Skipped from the body when absent.
	Parent *string `json:"parent,omitempty"`
}

GroupView A group definition in the registry read (`GET /api/v1/admin/groups`, `GET /api/v1/admin/groups/{name}`): the limit-tree read surface. Projects the `groups:` config entry faithfully (parent chain, enabled freeze flag, the ordered limits, the `child_default` budget template for auto-provisioned children), never a secret. This is the READ shape; the WRITE verbs accept a `GroupCfg` verbatim (paste a config.yaml group block). Additive-only.

type HookDesiredStatus

type HookDesiredStatus struct {
	// SettingsKeys Sorted KEY NAMES of the desired settings bag, never its values.
	SettingsKeys    []string `json:"settings_keys"`
	SettingsVersion uint64   `json:"settings_version"`
}

HookDesiredStatus The DESIRED settings side of `hooks/{name}/status`: busbar's registry copy of the hook's settings (KEY NAMES only, see [`super::HookView::settings_keys`]) and their version.

type HookHealthView

type HookHealthView struct {
	// Detail A short human note on the resolution (why `false`, or the resolved plugin's kind). Never a
	// secret.
	Detail *string `json:"detail"`
	Name   string  `json:"name"`

	// Reachable `Some(true)` = resolves to a loaded `kind: hook` plugin; `Some(false)` = it does not
	// (wrong kind, or not installed/loaded), always `Some`, never `None`, as of 1.5.0's
	// in-process plugin model.
	Reachable *bool `json:"reachable"`

	// Transport The transport half of a `HookView`. As of 1.5.0 a hook is EITHER a compiled-in kind (no
	// transport at all) or a signed `kind: hook` dlopen'd plugin (`target` = the plugin NAME, not a
	// socket path or URL); the retired 1.4.x socket/webhook sidecar transports are gone.
	Transport HookTransportView `json:"transport"`
}

HookHealthView The live health of one hook's transport (`GET /api/v1/admin/hooks/{name}/health`). Checks whether the hook resolves to a LOADED `kind: hook` plugin in the process's plugin registry; this is a plugin-LOAD status check, not a network reachability probe: it never opens a connection, and it cannot tell you whether a `kind: hook` plugin's own configured external endpoint (e.g. `busbar-webrequest-hook`'s `settings.url`) is actually reachable, only that the plugin itself is loaded. Never fires the hook. Additive-only.

type HookReportedStatus

type HookReportedStatus struct {
	// SettingsKeys Sorted KEY NAMES of the observed settings bag, never its values.
	SettingsKeys    *[]string `json:"settings_keys"`
	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`).

KEY NAMES only, and for a sharper reason than the desired side: the reported bag is the hook's ECHO of the SECRET-RESOLVED settings busbar pushed it, i.e. the PLAINTEXT of every `SecretRef`, and this read is reachable at READ-ONLY admin scope. `null` when the hook answered `status` but reported no settings.

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
	// (KEY NAMES only, see [`super::HookView::settings_keys`]) and their version.
	Desired HookDesiredStatus `json:"desired"`
	Drift   *bool             `json:"drift"`

	// DriftKeys The DESIRED settings KEY NAMES the hook is not actually running: the actionable half of
	// `drift`, carrying names this body already serves and no value from either bag. Invariantly an
	// array (empty on the no-answer branch, where no drift is known).
	DriftKeys []string `json:"drift_keys"`

	// 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.
	//
	// schemars' blanket `JsonSchema` impl for
	// `serde_json::Value` renders as the JSON-Schema-2020-12 boolean `true` (`schemars-1.2.1`'s
	// `json_schema_impls/serdejson.rs`), which is legal 2020-12 but, nested here as this array's
	// `items`, is a boolean SUB-schema, and `kin-openapi` (the parser under `oapi-codegen`, which
	// every published SDK generates through) cannot represent one at all: the parse aborts, taking
	// out Python/TS/Go SDK regeneration simultaneously. `#[schemars(schema_with)]` overrides just
	// this field's schema to `{"type": "array", "items": {}}`; `{}` is the equivalent "accepts
	// anything" schema every generator DOES understand, and is what busbar-ui's own
	// `openapi-prep.py` already rewrites `items: true` into client-side. This is the only
	// `items: true` in the document; every other `additionalProperties: true` schemars emits
	// elsewhere is a boolean in a position `kin-openapi` handles fine and is deliberately untouched.
	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 `"plugin"` for a signed dlopen'd hook plugin, or `"none"` for a hook with no plugin
	// transport (compiled-in kinds, or a misconfigured entry).
	Kind string `json:"kind"`

	// Target The plugin's NAME (not a path or URL). `None` when `kind` is `"none"`.
	Target *string `json:"target"`
}

HookTransportView The transport half of a `HookView`. As of 1.5.0 a hook is EITHER a compiled-in kind (no transport at all) or a signed `kind: hook` dlopen'd plugin (`target` = the plugin NAME, not a socket path or URL); the retired 1.4.x socket/webhook sidecar transports are gone.

type HookView

type HookView struct {
	// At TAP observation stage (`"request"`/`"candidate"`/`"routing"`/`"response"`), 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: 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"`

	// SettingsKeys The KEY NAMES of the hook's opaque settings bag, sorted, WITHOUT their values, the same
	// redacted projection [`NamedDefView::settings_keys`] carries, produced by the same helper.
	//
	// This used to be the bag itself, under a doc comment claiming hook settings are "never a
	// secret by contract". That claim was retracted for `NamedDefView` and it is no more true here:
	// a hook's settings bag is a `SecretRef` carrier by design (`hooks::HookEnv::resolve_hook_settings`
	// resolves it before every configure push), and `config::secret::resolve_settings` forwards a
	// non-object bag verbatim, so a literal credential is fully supported too. `GET /hooks` and
	// `GET /hooks/{name}` serve this at READ-ONLY admin scope. The values are readable only where
	// they are writable: the config file and the config overlay.
	SettingsKeys []string `json:"settings_keys"`

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

	// Transport The transport half of a `HookView`. As of 1.5.0 a hook is EITHER a compiled-in kind (no
	// transport at all) or a signed `kind: hook` dlopen'd plugin (`target` = the plugin NAME, not a
	// socket path or URL); the retired 1.4.x socket/webhook sidecar transports are gone.
	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, INCLUDING the `settings:` bag, which is projected as KEY NAMES only (see [`HookView::settings_keys`]). `global` reports whether the hook fires on EVERY request. There is no `global_hooks:` config key to write: 1.5.3 deleted it, and a hook is now DEFINED once in the top-level `hooks:` named map (its `module:` naming the `kind: hook` plugin that backs it) and ATTACHED by bare name, at the reserved all-pools key `pools.hooks:`, which is what makes it global, or at one pool's own `hooks:` list. `groups:` and `phase:` are the config-file selection axes (which callers, which pipeline stages). On THIS API the same hook is written with `global: true`; the wire and the config file are deliberately different surfaces. 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, i.e. the config is MUTABLE with a writable
	// `config.overlay` backend: `true` = API-applied config changes are durable across restarts;
	// `false` = the config is LOCKED (`config.locked: true`) and admin-API config mutations are
	// refused. Lets tooling tell an operator whether runtime changes are accepted and durable.
	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".
	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 InspectPluginReq added in v0.3.0

type InspectPluginReq struct {
	File       string `json:"file"`
	TarballB64 string `json:"tarball_b64"`
}

InspectPluginReq `POST /api/v1/admin/plugins/inspect` request body. SAME shape as [`InstallPluginReq`]; `file` is accepted for shape parity with the install flow a UI composes around the same upload, but is otherwise UNUSED here: inspect never writes anything to disk, so there is no filename to bind an install would need.

type InstallPluginReq added in v0.2.0

type InstallPluginReq struct {
	File       string `json:"file"`
	TarballB64 string `json:"tarball_b64"`
}

InstallPluginReq The `POST /api/v1/admin/plugins` request body: install a SIGNED plugin tarball. The tarball bytes ride as base64 (`tarball_b64`): a plugin artifact is opaque binary, so base64 keeps it a clean JSON field. The engine RE-VERIFIES the contained signed manifest server-side against the running `plugins.*` trust posture (the client is never trusted). `file` is the bare `.tar.gz` filename to store it under (storage only; identity comes from the signed manifest inside).

type KeyMeteringView

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

	// BudgetPeriod Always `"total"` (the key attribution window).
	BudgetPeriod string `json:"budget_period"`

	// Group The bound `groups:` entry (`null` = unlimited key).
	Group        *string  `json:"group"`
	Id           string   `json:"id"`
	RateHeadroom *float64 `json:"rate_headroom"`
	Requests     uint64   `json:"requests"`
	SpendCents   int64    `json:"spend_cents"`
	Tokens       uint64   `json:"tokens"`

	// WindowStart Always `0` (the all-time window start).
	WindowStart uint64 `json:"window_start"`
}

KeyMeteringView `GET /keys/{id}/usage`: the key's all-time attribution counters (a 1.5.0 key bucket accrues in the `total` window; limits live on the bound group's own windows) plus the fraction of the tightest `requests`/`tokens` limit across the group chain remaining (`null` = no such limit).

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 the ABSTRACT cost unit (1e-6 unit -
	// integer math, sub-cent precise, no float drift), recomputed at read time from the raw token
	// split x the operator's CURRENT per-model rate card. Busbar attaches no currency - the rate
	// card's numbers are whatever unit the operator priced in; display/denomination is entirely
	// the consumer's concern. 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"`
	CreatedAt    uint64            `json:"created_at"`
	Enabled      bool              `json:"enabled"`
	Group        *string           `json:"group"`
	Id           string            `json:"id"`
	Labels       map[string]string `json:"labels"`
	Name         string            `json:"name"`

	// State `enabled` alone cannot distinguish a reversible pause from either of the two permanent
	// dispositions. `PATCH {enabled:false}`, `POST /keys/{id}/revoke`, and `DELETE /keys/{id}` all
	// used to leave `enabled: false` with nothing else to tell them apart. One of exactly four
	// values, additive and derived (never independently settable):
	// - `"active"`: enabled, not revoked, not deleted.
	// - `"disabled"`: `PATCH {enabled:false}`. Reversible: `PATCH {enabled:true}` restores it.
	// - `"revoked"`: `POST /keys/{id}/revoke`. Permanent: denylisted, but the binding row (and
	//   `GET /keys/{id}`) stays live for audit/usage attribution.
	// - `"tombstoned"`: `DELETE /keys/{id}`. Permanent: denylisted AND hard-deleted; the row is
	//   kept only so id-attributed billing/audit history keeps resolving. Omitted from a plain
	//   `GET /keys` by default; visible there with `?include=tombstoned`.
	State string `json:"state"`
}

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. 1.5.0: keys are PURE AUTH, no inline limits; `allowed_pools` is `null` = all pools, `[]` = no pools; `group` names the bound `groups:` entry (`null` = unlimited).

type LimitView added in v0.2.0

type LimitView struct {
	// Amount The cap amount (requests/tokens/cents, or the in-flight gauge for `concurrent`).
	Amount uint64 `json:"amount"`

	// DowngradeTo Where `on_exhaust: downgrade` sends exhausted traffic. Present iff downgrading.
	DowngradeTo *string `json:"downgrade_to,omitempty"`

	// Metric One of `requests` | `tokens` | `budget` | `concurrent`.
	Metric string `json:"metric"`

	// OnExhaust The budget-exhaustion behavior: `block` or `downgrade`. Absent = block (the default).
	OnExhaust *string `json:"on_exhaust,omitempty"`

	// Per The accounting window: `minute` | `hour` | `day` | `month` | `total`. Absent for `concurrent`.
	Per *string `json:"per,omitempty"`

	// Pool The pool scope: present when the limit carries `pool: <name>` (it accounts and enforces
	// only that pool's traffic, per `(group, pool)`); absent for a group-wide limit.
	Pool *string `json:"pool,omitempty"`
}

LimitView One limit inside a `GroupView`: an explicit `{ metric, amount, per, pool }` projection of a config `LimitCfg`. The config file's compact `{ budget: 3000, per: month }` form is deserialize-only sugar; the read API projects it explicitly so a consumer never has to know the metric is the map key. `per` is `None` only for `concurrent` (an instantaneous gauge, no window); `pool` is present only on a pool-scoped limit.

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 the ABSTRACT cost unit (1e-6 unit -
	// integer math, sub-cent precise, no float drift), recomputed at read time from the raw token
	// split x the operator's CURRENT per-model rate card. Busbar attaches no currency - the rate
	// card's numbers are whatever unit the operator priced in; display/denomination is entirely
	// the consumer's concern. 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 NamedDefView added in v0.4.0

type NamedDefView struct {
	// BrowserLoginConfigured `identity-providers` ONLY: whether a `browser_login:` block is configured, the presence that
	// puts a button on the hosted login page.
	BrowserLoginConfigured *bool `json:"browser_login_configured,omitempty"`

	// MaxAdminScope `identity-providers` ONLY: the per-provider ADMIN CEILING (`none` | `read-only` | `full`).
	// `None` ⇒ the definition names none, so the most restrictive default applies. Omitted entirely
	// for a section that carries no ceiling.
	MaxAdminScope *string `json:"max_admin_scope,omitempty"`

	// Module The `module:` backing this instance (a built-in name or a signed-plugin name/alias).
	Module string `json:"module"`

	// Name The instance NAME: the map key, and the token every reference site uses.
	Name string `json:"name"`

	// SettingsKeys The KEY NAMES of the module's opaque settings bag, sorted, WITHOUT their values, the
	// redacted projection of `settings:`. Operator/API-owned and never interpreted here, but also
	// never a place a VALUE can leak from: a settings value may be a credential (see the type doc),
	// and this surface is reachable at READ-ONLY admin scope. An empty bag ⇒ an empty list. The
	// values are readable only where they are writable: the config file and the config overlay.
	SettingsKeys []string `json:"settings_keys"`

	// TokenConfigured `identity-providers` ONLY: whether a `token:` secret REFERENCE is configured (the built-in
	// `admin-tokens` operator credential). The reference itself is never projected.
	TokenConfigured *bool `json:"token_configured,omitempty"`

	// Unparseable Set ONLY on an entry that is STORED in the config overlay but could NOT be parsed into this
	// section's typed config by this binary (a downgrade whose struct lost a field, a hand-edited
	// overlay); the value is the parse error. Such an entry is dropped at every rebuild, so it is
	// NOT live: `module`/`settings_keys` are the raw stored document's best-effort projection, not
	// a resolved definition. Present so the drop is DISCOVERABLE here rather than only in a boot
	// log line. Absent (and omitted from the body) for every live definition.
	Unparseable *string `json:"unparseable,omitempty"`
}

NamedDefView ONE definition of ONE 1.5.3 named-DEFINITION map: the read shape of the GENERIC named-map CRUD (`GET /api/v1/admin/identity-providers[/{name}]`, `GET /api/v1/admin/export[/{name}]`, and `tools:`/`agents:` when they land).

Deliberately ONE view for every section rather than one per kind: the sections share the frozen `{module, settings}` spine and differ only by optional kind-specific fields, which are `skip_serializing_if`-omitted for a section that has none. So `/export` serves exactly `{name, module, settings_keys}` while `/identity-providers` additionally carries its ceiling, and a new section adds fields here (additive) instead of a parallel view + a parallel handler.

SECRETS ARE NEVER PROJECTED, by construction, and that claim covers the `settings:` bag too, which is why this view carries `settings_keys` and NOT the bag itself. A `token:` is a SECRET REFERENCE collapsed to a boolean, and the module's opaque settings are a bag an operator legitimately puts a credential VALUE in (an OIDC `client_secret`, a webhook `auth_header` value), so projecting it verbatim would hand every READ-ONLY admin credential the deployment's secrets through `GET /identity-providers/{name}` / `GET /export/{name}`. Projecting the KEY NAMES keeps the introspection the read surface exists for ("what is configured here?") with no field a value could ride out on: the same discipline `token_configured` already applies to the reference.

type NamedSettingsReq added in v0.4.0

type NamedSettingsReq struct {
	Settings map[string]interface{} `json:"settings"`
}

NamedSettingsReq The `PATCH /api/v1/admin/<section>/{name}/settings` body: the whole replacement settings bag. A sibling of the hooks surface's `PatchSettingsReq` (same shape, same semantics: `settings:` is REPLACED, not deep-merged, so the stored bag is always exactly what the caller sent).

type OverlayResetView added in v0.2.0

type OverlayResetView struct {
	// Changed `true` when the reset discarded overlay mutations; `false` for an already-empty section.
	Changed       bool   `json:"changed"`
	ConfigVersion uint64 `json:"config_version"`

	// Reset The section that was reset (`groups` | `hooks` | `root` | `plugin_versions`).
	Reset string `json:"reset"`
}

OverlayResetView `DELETE /overlay/{section}`, per-section overlay reset result: the section reverted, the resulting config version, and whether anything changed (`false` = the section had no overlay state, an idempotent no-op).

type PageGroupView added in v0.2.0

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

PageGroupView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain. Generic over the item view so every list endpoint shares one shape.

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. 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. Generic over the item view so every list endpoint shares one shape.

type PageNamedDefView added in v0.4.0

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

PageNamedDefView A cursor-paginated list envelope. `items` is this page; `next_cursor` is `Some` when more remain. 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. 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. 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. Generic over the item view so every list endpoint shares one shape.

type PatchExportNameSettingsJSONRequestBody added in v0.4.0

type PatchExportNameSettingsJSONRequestBody = NamedSettingsReq

PatchExportNameSettingsJSONRequestBody defines body for PatchExportNameSettings for application/json ContentType.

type PatchExportNameSettingsParams added in v0.4.0

type PatchExportNameSettingsParams 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"`
}

PatchExportNameSettingsParams defines parameters for PatchExportNameSettings.

type PatchExportNameSettingsResponse added in v0.4.0

type PatchExportNameSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePatchExportNameSettingsResponse added in v0.4.0

func ParsePatchExportNameSettingsResponse(rsp *http.Response) (*PatchExportNameSettingsResponse, error)

ParsePatchExportNameSettingsResponse parses an HTTP response from a PatchExportNameSettingsWithResponse call

func (PatchExportNameSettingsResponse) ContentType added in v0.4.0

func (r PatchExportNameSettingsResponse) ContentType() string

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

func (PatchExportNameSettingsResponse) GetBody added in v0.4.0

func (r PatchExportNameSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchExportNameSettingsResponse) GetJSON200 added in v0.4.0

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

func (PatchExportNameSettingsResponse) GetJSON400 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON400() *Error

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

func (PatchExportNameSettingsResponse) GetJSON401 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON401() *Error

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

func (PatchExportNameSettingsResponse) GetJSON403 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON403() *Error

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

func (PatchExportNameSettingsResponse) GetJSON404 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON404() *Error

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

func (PatchExportNameSettingsResponse) GetJSON409 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON409() *Error

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

func (PatchExportNameSettingsResponse) GetJSON429 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON429() *Error

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

func (PatchExportNameSettingsResponse) GetJSON500 added in v0.4.0

func (r PatchExportNameSettingsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PatchExportNameSettingsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (PatchExportNameSettingsResponse) StatusCode added in v0.4.0

func (r PatchExportNameSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchGroupsNameJSONBody added in v0.2.0

type PatchGroupsNameJSONBody struct {
	// ChildDefault A `child_default:` template. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	ChildDefault *map[string]interface{}   `json:"child_default,omitempty"`
	Enabled      *bool                     `json:"enabled,omitempty"`
	Limits       *[]map[string]interface{} `json:"limits,omitempty"`
	Parent       *string                   `json:"parent,omitempty"`
}

PatchGroupsNameJSONBody defines parameters for PatchGroupsName.

type PatchGroupsNameJSONRequestBody added in v0.2.0

type PatchGroupsNameJSONRequestBody PatchGroupsNameJSONBody

PatchGroupsNameJSONRequestBody defines body for PatchGroupsName for application/json ContentType.

type PatchGroupsNameParams added in v0.2.0

type PatchGroupsNameParams 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"`
}

PatchGroupsNameParams defines parameters for PatchGroupsName.

type PatchGroupsNameResponse added in v0.2.0

type PatchGroupsNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GroupView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePatchGroupsNameResponse added in v0.2.0

func ParsePatchGroupsNameResponse(rsp *http.Response) (*PatchGroupsNameResponse, error)

ParsePatchGroupsNameResponse parses an HTTP response from a PatchGroupsNameWithResponse call

func (PatchGroupsNameResponse) ContentType added in v0.2.0

func (r PatchGroupsNameResponse) ContentType() string

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

func (PatchGroupsNameResponse) GetBody added in v0.2.0

func (r PatchGroupsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchGroupsNameResponse) GetJSON200 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON200() *GroupView

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

func (PatchGroupsNameResponse) GetJSON400 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON400() *Error

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

func (PatchGroupsNameResponse) GetJSON401 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON401() *Error

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

func (PatchGroupsNameResponse) GetJSON403 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON403() *Error

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

func (PatchGroupsNameResponse) GetJSON404 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON404() *Error

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

func (PatchGroupsNameResponse) GetJSON409 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON409() *Error

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

func (PatchGroupsNameResponse) GetJSON429 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON429() *Error

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

func (PatchGroupsNameResponse) GetJSON500 added in v0.2.0

func (r PatchGroupsNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PatchGroupsNameResponse) Status added in v0.2.0

func (r PatchGroupsNameResponse) Status() string

Status returns HTTPResponse.Status

func (PatchGroupsNameResponse) StatusCode added in v0.2.0

func (r PatchGroupsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchHooksNameSettingsJSONRequestBody added in v0.2.0

type PatchHooksNameSettingsJSONRequestBody = PatchSettingsReq

PatchHooksNameSettingsJSONRequestBody defines body for PatchHooksNameSettings for application/json ContentType.

type PatchHooksNameSettingsParams added in v0.2.0

type PatchHooksNameSettingsParams 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"`
}

PatchHooksNameSettingsParams defines parameters for PatchHooksNameSettings.

type PatchHooksNameSettingsResponse added in v0.2.0

type PatchHooksNameSettingsResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePatchHooksNameSettingsResponse added in v0.2.0

func ParsePatchHooksNameSettingsResponse(rsp *http.Response) (*PatchHooksNameSettingsResponse, error)

ParsePatchHooksNameSettingsResponse parses an HTTP response from a PatchHooksNameSettingsWithResponse call

func (PatchHooksNameSettingsResponse) ContentType added in v0.2.0

func (r PatchHooksNameSettingsResponse) ContentType() string

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

func (PatchHooksNameSettingsResponse) GetBody added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchHooksNameSettingsResponse) GetJSON200 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON200() *HookView

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

func (PatchHooksNameSettingsResponse) GetJSON400 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON400() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON401 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON401() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON403 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON403() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON404 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON404() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON409 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON409() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON429 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON429() *Error

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

func (PatchHooksNameSettingsResponse) GetJSON500 added in v0.2.0

func (r PatchHooksNameSettingsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PatchHooksNameSettingsResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PatchHooksNameSettingsResponse) StatusCode added in v0.2.0

func (r PatchHooksNameSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchIdentityProvidersNameSettingsJSONRequestBody added in v0.4.0

type PatchIdentityProvidersNameSettingsJSONRequestBody = NamedSettingsReq

PatchIdentityProvidersNameSettingsJSONRequestBody defines body for PatchIdentityProvidersNameSettings for application/json ContentType.

type PatchIdentityProvidersNameSettingsParams added in v0.4.0

type PatchIdentityProvidersNameSettingsParams 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"`
}

PatchIdentityProvidersNameSettingsParams defines parameters for PatchIdentityProvidersNameSettings.

type PatchIdentityProvidersNameSettingsResponse added in v0.4.0

type PatchIdentityProvidersNameSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePatchIdentityProvidersNameSettingsResponse added in v0.4.0

func ParsePatchIdentityProvidersNameSettingsResponse(rsp *http.Response) (*PatchIdentityProvidersNameSettingsResponse, error)

ParsePatchIdentityProvidersNameSettingsResponse parses an HTTP response from a PatchIdentityProvidersNameSettingsWithResponse call

func (PatchIdentityProvidersNameSettingsResponse) ContentType added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetBody added in v0.4.0

GetBody returns the raw response body bytes

func (PatchIdentityProvidersNameSettingsResponse) GetJSON200 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON400 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON401 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON403 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON404 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON409 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON429 added in v0.4.0

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

func (PatchIdentityProvidersNameSettingsResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PatchIdentityProvidersNameSettingsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (PatchIdentityProvidersNameSettingsResponse) StatusCode added in v0.4.0

StatusCode returns HTTPResponse.StatusCode

type PatchKeysIdJSONRequestBody added in v0.2.0

type PatchKeysIdJSONRequestBody = UpdateKeyReq

PatchKeysIdJSONRequestBody defines body for PatchKeysId for application/json ContentType.

type PatchKeysIdParams added in v0.2.0

type PatchKeysIdParams 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"`
}

PatchKeysIdParams defines parameters for PatchKeysId.

type PatchKeysIdResponse added in v0.2.0

type PatchKeysIdResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePatchKeysIdResponse added in v0.2.0

func ParsePatchKeysIdResponse(rsp *http.Response) (*PatchKeysIdResponse, error)

ParsePatchKeysIdResponse parses an HTTP response from a PatchKeysIdWithResponse call

func (PatchKeysIdResponse) ContentType added in v0.2.0

func (r PatchKeysIdResponse) ContentType() string

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

func (PatchKeysIdResponse) GetBody added in v0.2.0

func (r PatchKeysIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchKeysIdResponse) GetJSON200 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON200() *KeyView

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

func (PatchKeysIdResponse) GetJSON400 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON400() *Error

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

func (PatchKeysIdResponse) GetJSON401 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON401() *Error

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

func (PatchKeysIdResponse) GetJSON403 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON403() *Error

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

func (PatchKeysIdResponse) GetJSON404 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON404() *Error

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

func (PatchKeysIdResponse) GetJSON409 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON409() *Error

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

func (PatchKeysIdResponse) GetJSON429 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON429() *Error

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

func (PatchKeysIdResponse) GetJSON500 added in v0.2.0

func (r PatchKeysIdResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PatchKeysIdResponse) Status added in v0.2.0

func (r PatchKeysIdResponse) Status() string

Status returns HTTPResponse.Status

func (PatchKeysIdResponse) StatusCode added in v0.2.0

func (r PatchKeysIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchSettingsReq added in v0.2.0

type PatchSettingsReq struct {
	Settings map[string]interface{} `json:"settings"`
}

PatchSettingsReq The `PATCH /api/v1/admin/hooks/{name}/settings` body. Optimistic concurrency rides `If-Match`.

type PluginInstallView added in v0.2.0

type PluginInstallView struct {
	// File The library FILENAME written into the plugins directory (the handle `DELETE` takes).
	File string `json:"file"`

	// InterfaceVersion The store C-ABI (`interface_version`) the engine validated the library against.
	InterfaceVersion uint32 `json:"interface_version"`

	// Name The plugin name from its manifest (or the filename when unsigned).
	Name string `json:"name"`

	// Note A human note: this install is durable in the folder but takes effect on the next store (re)load.
	Note string `json:"note"`

	// Publisher The manifest publisher, when signed.
	Publisher *string `json:"publisher,omitempty"`

	// Trust The server-side trust verdict from the RE-VERIFY: `"trusted"` | `"unverified"`. (A `"rejected"`
	// verdict is an error, never a success body.)
	Trust string `json:"trust"`

	// Version The manifest version, when the upload carried a signed manifest.
	Version *string `json:"version,omitempty"`
}

PluginInstallView The result of installing a dynamic-library store plugin (`POST /api/v1/admin/plugins`). The engine RE-VERIFIED the uploaded bytes against the running trust posture (the client is never trusted), validated the ABI handshake, and atomically wrote the library (+ its manifest sidecar) into the plugins directory. `active` takes effect on the next store (re)load; a store change applies on restart / `store.module` apply, not as a hot swap (design: store install is boot-time/config-apply). Additive-only; never a secret.

type PluginReloadView added in v0.2.0

type PluginReloadView struct {
	// Note A human note on when a store change actually takes effect.
	Note string `json:"note"`

	// Plugins The dynamic-library plugins now present in the directory, sorted by filename.
	Plugins []PluginView `json:"plugins"`
}

PluginReloadView The result of re-scanning the plugins directory (`POST /api/v1/admin/plugins/reload`): the current dynamic-library inventory, each with its ABI-validity. Reconciles the reported set to the folder (the folder is the source of truth), exactly as `config/reload` reconciles config to disk. A store change still applies on the next store (re)load, not as a hot swap.

type PluginRollbackReq added in v0.2.0

type PluginRollbackReq struct {
	// File The plugin tarball FILENAME (in the plugins directory) carrying the prior version to pin to.
	File string `json:"file"`
}

PluginRollbackReq The `POST /api/v1/admin/plugins/rollback` body: the target library FILENAME to roll DOWN to.

type PluginRollbackView added in v0.2.0

type PluginRollbackView struct {
	// ConfigVersion The now-live config version after the hot swap (the ETag the response also carries).
	ConfigVersion uint64 `json:"config_version"`

	// File The library FILENAME the rollback selected in the plugins directory.
	File string `json:"file"`

	// Name The plugin's canonical manifest name that was pinned.
	Name string `json:"name"`

	// Note A human note on the rollback's semantics + durability.
	Note string `json:"note"`

	// Publisher The manifest publisher of the pinned artifact (`busbar` = first-party).
	Publisher string `json:"publisher"`

	// Version The version the plugin was pinned DOWN to (now serving), from the target artifact's manifest.
	Version string `json:"version"`
}

PluginRollbackView The result of an EXPLICIT plugin ROLLBACK (`POST /api/v1/admin/plugins/rollback`, 1.5.0 rollback-friendly versioning): the operator deliberately pinned a plugin DOWN to a prior version and the engine hot-swapped to that artifact. The pin is persisted (survives restart) and the trust floor was lowered to EXACTLY the pinned version for THIS plugin; a lower artifact still cannot load, and an automatic/silent replay of an old artifact is still refused (only this explicit, audited action lowered the floor). Additive-only; never a secret.

type PluginSchemaView added in v0.2.0

type PluginSchemaView struct {
	// Kind The plugin's `kind` (`hook` | `secret` | …) from its manifest. Both `GET /plugins/{file}/schema`
	// and `POST /plugins/inspect` emit it (`null` only when the plugin cannot be resolved to a
	// manifest). Declared so codegen'd clients keep it.
	Kind *string `json:"kind,omitempty"`
	Name string  `json:"name"`

	// RestartRequiredDefault The kind-derived restart-scoping default (`busbar_plugin_sign::kind_restart_default`), so
	// busbar-ui need not hardcode the kind→default table. Emitted by both schema endpoints (`null`
	// only when the plugin has no resolvable manifest/kind). Declared so codegen'd clients keep it.
	RestartRequiredDefault *bool `json:"restart_required_default,omitempty"`

	// Schema The plugin's settings JSON Schema verbatim, or `null`, either because the manifest never
	// set `settings_schema`, or (distinctly, see `schema_error`) because it did but the value
	// failed to parse.
	Schema interface{} `json:"schema"`

	// SchemaError Set only when the manifest's `settings_schema` was present but failed to parse as JSON;
	// `null` for a manifest that genuinely never set the field. Never collapsed into a bare
	// `schema: null`: a present-but-corrupt schema is a real
	// authoring/packaging bug, not "this plugin simply has none."
	SchemaError *string `json:"schema_error"`

	// Source `"describe"` when a currently-loaded `kind: hook` answered its live `describe` wire
	// message (the existing describe-proxy behavior, unchanged); `"manifest"` otherwise. Lets
	// busbar-ui explain "why does this form look different from what I expected" without
	// implementing the describe/manifest precedence rule itself.
	Source string `json:"source"`

	// Trust `"trusted" | "unverified" | "rejected"`: the same vocabulary the plugin catalog already
	// uses (never `"verified"`).
	Trust string `json:"trust"`

	// Version The plugin's semantic version from its manifest. Present on `POST /plugins/inspect` (which
	// previews an on-disk candidate's manifest); `null`/absent on `GET /plugins/{file}/schema`, which
	// does not surface the version. Declared here so a codegen'd client keeps the field the inspect
	// handler always sends, rather than silently dropping it.
	Version *string `json:"version,omitempty"`
}

PluginSchemaView `GET /plugins/{name}/schema`: the generalized, all-kinds sibling of [`HookSchemaView`]. Carries `trust`/`source`/`schema_error` on top of `{name, schema}` so busbar-ui never has to infer trust state or the describe/manifest precedence rule from context; the server always picks exactly one source and reports which.

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"`

	// Error Why a dynamic-library plugin did not validate (`valid: false`): a short, secret-free reason.
	Error *string `json:"error,omitempty"`

	// File The artifact FILENAME in `plugins.dir`: the `{file}` path segment `DELETE
	// /plugins/{file}` and `GET /plugins/{file}/schema` key off (a list row previously
	// carried no field a client could feed straight back into either sibling endpoint; `target`
	// is documented as the manifest NAME, not necessarily the on-disk filename, and is not a
	// reliable substitute). `None` for compiled-in/external rows, which have no backing artifact
	// to name. Additive; existing consumers reading only the pre-1.5.1 fields are unaffected.
	File *string `json:"file,omitempty"`

	// HasSchema `true` iff `GET /plugins/{file}/schema` would resolve this row's `file` to a manifest that
	// declares `settings_schema` at all, i.e. iff `schema_url` below is non-null, so a plugin
	// catalog can render which rows are configurable in one list call instead of a fetch per row.
	// Mirrors `schema_url.is_some()`; kept as its own boolean rather than requiring the
	// caller to null-check `schema_url` for the same fact. `false` for compiled-in/external rows
	// (no manifest to carry a schema) and for a dynamic-library row whose manifest never set
	// `settings_schema`. Additive.
	HasSchema bool `json:"has_schema"`

	// InterfaceVersion The store C-ABI (`interface_version`) the manifest declares (dynamic-library plugins with a
	// manifest). Operator-facing name for the "ABI" the engine speaks.
	InterfaceVersion *uint32 `json:"interface_version,omitempty"`

	// Loader `"compiled-in"` or `"plugin"` (a dlopen'd dynamic-library plugin: auth, hook, and store
	// kinds alike as of 1.5.0's signed plugin ABI).
	Loader string `json:"loader"`
	Name   string `json:"name"`

	// Publisher The manifest's declared publisher (dynamic-library plugins with a manifest).
	Publisher *string `json:"publisher,omitempty"`

	// SchemaError A manifest that SET `settings_schema` but whose value fails to parse (carried onto the
	// list row too), distinct from a manifest that never set the
	// field at all (`schema_url: null`, this field also `None`). `schema_url` stays non-null in
	// this case; the operator sees the row is degraded from the list alone, before ever following
	// the URL.
	SchemaError *string `json:"schema_error,omitempty"`

	// SchemaUrl Server-resolved path to this plugin's `GET /plugins/{name}/schema` endpoint: ALWAYS a
	// relative path under the admin origin
	// (the client MUST reject an absolute/cross-origin value rather than fetch it; this endpoint
	// only ever emits the admin-prefixed relative form, never anything else). Non-null whenever the
	// manifest declared a `settings_schema` AT ALL, even if it's unparseable (following it then
	// surfaces `schema_error`: a present-but-corrupt schema is a worse, distinct
	// condition from "no schema declared", never folded into the same `null`).
	// `null` for a compiled-in/external row (no manifest to carry a schema at all) and for any
	// dynamic-library row whose manifest never set `settings_schema`.
	SchemaUrl *string `json:"schema_url,omitempty"`

	// Target For a dynamic-library plugin, its NAME (not a socket path or URL, the retired 1.4.x
	// transport target). `None` for compiled-in.
	Target *string `json:"target"`

	// Trust The server-side trust verdict for a dynamic-library plugin, re-evaluated against the running
	// `plugins.trust` posture: `"trusted"` (signed by an allowlisted publisher), `"unverified"`
	// (loaded but not verified, the posture permits it), or `"rejected"` (the `halt` posture would
	// refuse it). `None` for compiled-in/external.
	Trust *string `json:"trust,omitempty"`

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

	// Valid For a dynamic-library plugin: whether the library validated as a busbar store plugin the engine
	// can load (ABI handshake). `None` for compiled-in/external.
	Valid *bool `json:"valid,omitempty"`

	// Version The plugin's semantic version, from its signed sidecar manifest (dynamic-library plugins only).
	// `None` for compiled-in/external, or a dynamic plugin with no/invalid manifest.
	Version *string `json:"version,omitempty"`
}

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 a signed DYNAMIC-LIBRARY plugin (a loadable `.so`/`.dll`/`.dylib`, dlopen'd over the signed plugin ABI; this covers `auth`, `hooks`, and `store` plugin kinds alike as of 1.5.0; the retired 1.4.x socket/webhook "external" transport is gone). `active` is `Some(true/false)` where activation is tracked (auth modules: in the chain?; hook plugins: configured = true; dynamic store: the configured `store.module`) 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: 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, so a consumer alerting on trips diffs this
	// count instead of trying to catch the live edge. 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) is an additive follow-up; the field set only grows.

type PostAuthCacheFlushJSONRequestBody added in v0.2.0

type PostAuthCacheFlushJSONRequestBody = FlushCacheReq

PostAuthCacheFlushJSONRequestBody defines body for PostAuthCacheFlush for application/json ContentType.

type PostAuthCacheFlushResponse added in v0.2.0

type PostAuthCacheFlushResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostAuthCacheFlushResponse added in v0.2.0

func ParsePostAuthCacheFlushResponse(rsp *http.Response) (*PostAuthCacheFlushResponse, error)

ParsePostAuthCacheFlushResponse parses an HTTP response from a PostAuthCacheFlushWithResponse call

func (PostAuthCacheFlushResponse) ContentType added in v0.2.0

func (r PostAuthCacheFlushResponse) ContentType() string

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

func (PostAuthCacheFlushResponse) GetBody added in v0.2.0

func (r PostAuthCacheFlushResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostAuthCacheFlushResponse) GetJSON200 added in v0.2.0

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

func (PostAuthCacheFlushResponse) GetJSON400 added in v0.2.0

func (r PostAuthCacheFlushResponse) GetJSON400() *Error

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

func (PostAuthCacheFlushResponse) GetJSON401 added in v0.2.0

func (r PostAuthCacheFlushResponse) GetJSON401() *Error

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

func (PostAuthCacheFlushResponse) GetJSON403 added in v0.2.0

func (r PostAuthCacheFlushResponse) GetJSON403() *Error

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

func (PostAuthCacheFlushResponse) GetJSON429 added in v0.2.0

func (r PostAuthCacheFlushResponse) GetJSON429() *Error

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

func (PostAuthCacheFlushResponse) GetJSON500 added in v0.2.0

func (r PostAuthCacheFlushResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostAuthCacheFlushResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PostAuthCacheFlushResponse) StatusCode added in v0.2.0

func (r PostAuthCacheFlushResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostConfigApplyJSONBody added in v0.2.0

type PostConfigApplyJSONBody struct {
	// Config A `config.yaml` deploy block, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`

	// Providers A `providers.yaml` document, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Providers *map[string]interface{} `json:"providers,omitempty"`
}

PostConfigApplyJSONBody defines parameters for PostConfigApply.

type PostConfigApplyJSONRequestBody added in v0.2.0

type PostConfigApplyJSONRequestBody PostConfigApplyJSONBody

PostConfigApplyJSONRequestBody defines body for PostConfigApply for application/json ContentType.

type PostConfigApplyParams added in v0.2.0

type PostConfigApplyParams 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"`
}

PostConfigApplyParams defines parameters for PostConfigApply.

type PostConfigApplyResponse added in v0.2.0

type PostConfigApplyResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostConfigApplyResponse added in v0.2.0

func ParsePostConfigApplyResponse(rsp *http.Response) (*PostConfigApplyResponse, error)

ParsePostConfigApplyResponse parses an HTTP response from a PostConfigApplyWithResponse call

func (PostConfigApplyResponse) ContentType added in v0.2.0

func (r PostConfigApplyResponse) ContentType() string

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

func (PostConfigApplyResponse) GetBody added in v0.2.0

func (r PostConfigApplyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostConfigApplyResponse) GetJSON200 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON200() *ConfigApplyView

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

func (PostConfigApplyResponse) GetJSON400 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON400() *Error

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

func (PostConfigApplyResponse) GetJSON401 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON401() *Error

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

func (PostConfigApplyResponse) GetJSON403 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON403() *Error

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

func (PostConfigApplyResponse) GetJSON409 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON409() *Error

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

func (PostConfigApplyResponse) GetJSON429 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON429() *Error

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

func (PostConfigApplyResponse) GetJSON500 added in v0.2.0

func (r PostConfigApplyResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostConfigApplyResponse) Status added in v0.2.0

func (r PostConfigApplyResponse) Status() string

Status returns HTTPResponse.Status

func (PostConfigApplyResponse) StatusCode added in v0.2.0

func (r PostConfigApplyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostConfigReloadResponse added in v0.2.0

type PostConfigReloadResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostConfigReloadResponse added in v0.2.0

func ParsePostConfigReloadResponse(rsp *http.Response) (*PostConfigReloadResponse, error)

ParsePostConfigReloadResponse parses an HTTP response from a PostConfigReloadWithResponse call

func (PostConfigReloadResponse) ContentType added in v0.2.0

func (r PostConfigReloadResponse) ContentType() string

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

func (PostConfigReloadResponse) GetBody added in v0.2.0

func (r PostConfigReloadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostConfigReloadResponse) GetJSON200 added in v0.2.0

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

func (PostConfigReloadResponse) GetJSON400 added in v0.2.0

func (r PostConfigReloadResponse) GetJSON400() *Error

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

func (PostConfigReloadResponse) GetJSON401 added in v0.2.0

func (r PostConfigReloadResponse) GetJSON401() *Error

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

func (PostConfigReloadResponse) GetJSON403 added in v0.2.0

func (r PostConfigReloadResponse) GetJSON403() *Error

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

func (PostConfigReloadResponse) GetJSON429 added in v0.2.0

func (r PostConfigReloadResponse) GetJSON429() *Error

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

func (PostConfigReloadResponse) GetJSON500 added in v0.2.0

func (r PostConfigReloadResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostConfigReloadResponse) Status added in v0.2.0

func (r PostConfigReloadResponse) Status() string

Status returns HTTPResponse.Status

func (PostConfigReloadResponse) StatusCode added in v0.2.0

func (r PostConfigReloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostConfigRollbackJSONRequestBody added in v0.2.0

type PostConfigRollbackJSONRequestBody = RollbackReq

PostConfigRollbackJSONRequestBody defines body for PostConfigRollback for application/json ContentType.

type PostConfigRollbackParams added in v0.2.0

type PostConfigRollbackParams 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"`
}

PostConfigRollbackParams defines parameters for PostConfigRollback.

type PostConfigRollbackResponse added in v0.2.0

type PostConfigRollbackResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostConfigRollbackResponse added in v0.2.0

func ParsePostConfigRollbackResponse(rsp *http.Response) (*PostConfigRollbackResponse, error)

ParsePostConfigRollbackResponse parses an HTTP response from a PostConfigRollbackWithResponse call

func (PostConfigRollbackResponse) ContentType added in v0.2.0

func (r PostConfigRollbackResponse) ContentType() string

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

func (PostConfigRollbackResponse) GetBody added in v0.2.0

func (r PostConfigRollbackResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostConfigRollbackResponse) GetJSON200 added in v0.2.0

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

func (PostConfigRollbackResponse) GetJSON400 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON400() *Error

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

func (PostConfigRollbackResponse) GetJSON401 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON401() *Error

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

func (PostConfigRollbackResponse) GetJSON403 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON403() *Error

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

func (PostConfigRollbackResponse) GetJSON404 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON404() *Error

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

func (PostConfigRollbackResponse) GetJSON409 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON409() *Error

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

func (PostConfigRollbackResponse) GetJSON429 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON429() *Error

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

func (PostConfigRollbackResponse) GetJSON500 added in v0.2.0

func (r PostConfigRollbackResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostConfigRollbackResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PostConfigRollbackResponse) StatusCode added in v0.2.0

func (r PostConfigRollbackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostConfigValidateJSONBody added in v0.2.0

type PostConfigValidateJSONBody struct {
	// Config A `config.yaml` deploy block, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`

	// Providers A `providers.yaml` document, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Providers *map[string]interface{} `json:"providers,omitempty"`
}

PostConfigValidateJSONBody defines parameters for PostConfigValidate.

type PostConfigValidateJSONRequestBody added in v0.2.0

type PostConfigValidateJSONRequestBody PostConfigValidateJSONBody

PostConfigValidateJSONRequestBody defines body for PostConfigValidate for application/json ContentType.

type PostConfigValidateResponse added in v0.2.0

type PostConfigValidateResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostConfigValidateResponse added in v0.2.0

func ParsePostConfigValidateResponse(rsp *http.Response) (*PostConfigValidateResponse, error)

ParsePostConfigValidateResponse parses an HTTP response from a PostConfigValidateWithResponse call

func (PostConfigValidateResponse) ContentType added in v0.2.0

func (r PostConfigValidateResponse) ContentType() string

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

func (PostConfigValidateResponse) GetBody added in v0.2.0

func (r PostConfigValidateResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostConfigValidateResponse) GetJSON200 added in v0.2.0

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

func (PostConfigValidateResponse) GetJSON400 added in v0.2.0

func (r PostConfigValidateResponse) GetJSON400() *Error

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

func (PostConfigValidateResponse) GetJSON401 added in v0.2.0

func (r PostConfigValidateResponse) GetJSON401() *Error

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

func (PostConfigValidateResponse) GetJSON403 added in v0.2.0

func (r PostConfigValidateResponse) GetJSON403() *Error

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

func (PostConfigValidateResponse) GetJSON429 added in v0.2.0

func (r PostConfigValidateResponse) GetJSON429() *Error

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

func (PostConfigValidateResponse) GetJSON500 added in v0.2.0

func (r PostConfigValidateResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostConfigValidateResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PostConfigValidateResponse) StatusCode added in v0.2.0

func (r PostConfigValidateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostGroupsJSONBody added in v0.2.0

type PostGroupsJSONBody struct {
	// Config A `groups:` entry, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`

	// Name The group name.
	Name string `json:"name"`
}

PostGroupsJSONBody defines parameters for PostGroups.

type PostGroupsJSONRequestBody added in v0.2.0

type PostGroupsJSONRequestBody PostGroupsJSONBody

PostGroupsJSONRequestBody defines body for PostGroups for application/json ContentType.

type PostGroupsParams added in v0.2.0

type PostGroupsParams 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"`
}

PostGroupsParams defines parameters for PostGroups.

type PostGroupsResponse added in v0.2.0

type PostGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GroupView
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *GroupView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostGroupsResponse added in v0.2.0

func ParsePostGroupsResponse(rsp *http.Response) (*PostGroupsResponse, error)

ParsePostGroupsResponse parses an HTTP response from a PostGroupsWithResponse call

func (PostGroupsResponse) ContentType added in v0.2.0

func (r PostGroupsResponse) ContentType() string

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

func (PostGroupsResponse) GetBody added in v0.2.0

func (r PostGroupsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostGroupsResponse) GetJSON200 added in v0.2.0

func (r PostGroupsResponse) GetJSON200() *GroupView

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

func (PostGroupsResponse) GetJSON201 added in v0.2.0

func (r PostGroupsResponse) GetJSON201() *GroupView

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

func (PostGroupsResponse) GetJSON400 added in v0.2.0

func (r PostGroupsResponse) GetJSON400() *Error

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

func (PostGroupsResponse) GetJSON401 added in v0.2.0

func (r PostGroupsResponse) GetJSON401() *Error

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

func (PostGroupsResponse) GetJSON403 added in v0.2.0

func (r PostGroupsResponse) GetJSON403() *Error

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

func (PostGroupsResponse) GetJSON409 added in v0.2.0

func (r PostGroupsResponse) GetJSON409() *Error

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

func (PostGroupsResponse) GetJSON429 added in v0.2.0

func (r PostGroupsResponse) GetJSON429() *Error

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

func (PostGroupsResponse) GetJSON500 added in v0.2.0

func (r PostGroupsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostGroupsResponse) Status added in v0.2.0

func (r PostGroupsResponse) Status() string

Status returns HTTPResponse.Status

func (PostGroupsResponse) StatusCode added in v0.2.0

func (r PostGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostHooksJSONBody added in v0.2.0

type PostHooksJSONBody struct {
	// Config A `hooks:` entry, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`

	// Name The hook name.
	Name string `json:"name"`
}

PostHooksJSONBody defines parameters for PostHooks.

type PostHooksJSONRequestBody added in v0.2.0

type PostHooksJSONRequestBody PostHooksJSONBody

PostHooksJSONRequestBody defines body for PostHooks for application/json ContentType.

type PostHooksParams added in v0.2.0

type PostHooksParams 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"`
}

PostHooksParams defines parameters for PostHooks.

type PostHooksResponse added in v0.2.0

type PostHooksResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostHooksResponse added in v0.2.0

func ParsePostHooksResponse(rsp *http.Response) (*PostHooksResponse, error)

ParsePostHooksResponse parses an HTTP response from a PostHooksWithResponse call

func (PostHooksResponse) ContentType added in v0.2.0

func (r PostHooksResponse) ContentType() string

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

func (PostHooksResponse) GetBody added in v0.2.0

func (r PostHooksResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostHooksResponse) GetJSON200 added in v0.2.0

func (r PostHooksResponse) GetJSON200() *HookView

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

func (PostHooksResponse) GetJSON201 added in v0.2.0

func (r PostHooksResponse) GetJSON201() *HookView

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

func (PostHooksResponse) GetJSON400 added in v0.2.0

func (r PostHooksResponse) GetJSON400() *Error

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

func (PostHooksResponse) GetJSON401 added in v0.2.0

func (r PostHooksResponse) GetJSON401() *Error

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

func (PostHooksResponse) GetJSON403 added in v0.2.0

func (r PostHooksResponse) GetJSON403() *Error

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

func (PostHooksResponse) GetJSON409 added in v0.2.0

func (r PostHooksResponse) GetJSON409() *Error

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

func (PostHooksResponse) GetJSON429 added in v0.2.0

func (r PostHooksResponse) GetJSON429() *Error

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

func (PostHooksResponse) GetJSON500 added in v0.2.0

func (r PostHooksResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostHooksResponse) Status added in v0.2.0

func (r PostHooksResponse) Status() string

Status returns HTTPResponse.Status

func (PostHooksResponse) StatusCode added in v0.2.0

func (r PostHooksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostKeysIdRevokeResponse added in v0.2.0

type PostKeysIdRevokeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RevokeView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostKeysIdRevokeResponse added in v0.2.0

func ParsePostKeysIdRevokeResponse(rsp *http.Response) (*PostKeysIdRevokeResponse, error)

ParsePostKeysIdRevokeResponse parses an HTTP response from a PostKeysIdRevokeWithResponse call

func (PostKeysIdRevokeResponse) ContentType added in v0.2.0

func (r PostKeysIdRevokeResponse) ContentType() string

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

func (PostKeysIdRevokeResponse) GetBody added in v0.2.0

func (r PostKeysIdRevokeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostKeysIdRevokeResponse) GetJSON200 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON200() *RevokeView

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

func (PostKeysIdRevokeResponse) GetJSON400 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON400() *Error

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

func (PostKeysIdRevokeResponse) GetJSON401 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON401() *Error

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

func (PostKeysIdRevokeResponse) GetJSON403 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON403() *Error

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

func (PostKeysIdRevokeResponse) GetJSON404 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON404() *Error

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

func (PostKeysIdRevokeResponse) GetJSON409 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON409() *Error

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

func (PostKeysIdRevokeResponse) GetJSON429 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON429() *Error

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

func (PostKeysIdRevokeResponse) GetJSON500 added in v0.2.0

func (r PostKeysIdRevokeResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostKeysIdRevokeResponse) Status added in v0.2.0

func (r PostKeysIdRevokeResponse) Status() string

Status returns HTTPResponse.Status

func (PostKeysIdRevokeResponse) StatusCode added in v0.2.0

func (r PostKeysIdRevokeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostKeysIdRotateResponse added in v0.2.0

type PostKeysIdRotateResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostKeysIdRotateResponse added in v0.2.0

func ParsePostKeysIdRotateResponse(rsp *http.Response) (*PostKeysIdRotateResponse, error)

ParsePostKeysIdRotateResponse parses an HTTP response from a PostKeysIdRotateWithResponse call

func (PostKeysIdRotateResponse) ContentType added in v0.2.0

func (r PostKeysIdRotateResponse) ContentType() string

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

func (PostKeysIdRotateResponse) GetBody added in v0.2.0

func (r PostKeysIdRotateResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostKeysIdRotateResponse) GetJSON200 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON200() *RotatedKeyView

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

func (PostKeysIdRotateResponse) GetJSON401 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON401() *Error

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

func (PostKeysIdRotateResponse) GetJSON403 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON403() *Error

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

func (PostKeysIdRotateResponse) GetJSON404 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON404() *Error

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

func (PostKeysIdRotateResponse) GetJSON409 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON409() *Error

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

func (PostKeysIdRotateResponse) GetJSON429 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON429() *Error

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

func (PostKeysIdRotateResponse) GetJSON500 added in v0.2.0

func (r PostKeysIdRotateResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostKeysIdRotateResponse) Status added in v0.2.0

func (r PostKeysIdRotateResponse) Status() string

Status returns HTTPResponse.Status

func (PostKeysIdRotateResponse) StatusCode added in v0.2.0

func (r PostKeysIdRotateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostKeysJSONRequestBody added in v0.2.0

type PostKeysJSONRequestBody = CreateKeyReq

PostKeysJSONRequestBody defines body for PostKeys for application/json ContentType.

type PostKeysResponse added in v0.2.0

type PostKeysResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostKeysResponse added in v0.2.0

func ParsePostKeysResponse(rsp *http.Response) (*PostKeysResponse, error)

ParsePostKeysResponse parses an HTTP response from a PostKeysWithResponse call

func (PostKeysResponse) ContentType added in v0.2.0

func (r PostKeysResponse) ContentType() string

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

func (PostKeysResponse) GetBody added in v0.2.0

func (r PostKeysResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostKeysResponse) GetJSON201 added in v0.2.0

func (r PostKeysResponse) GetJSON201() *CreatedKeyView

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

func (PostKeysResponse) GetJSON400 added in v0.2.0

func (r PostKeysResponse) GetJSON400() *Error

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

func (PostKeysResponse) GetJSON401 added in v0.2.0

func (r PostKeysResponse) GetJSON401() *Error

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

func (PostKeysResponse) GetJSON403 added in v0.2.0

func (r PostKeysResponse) GetJSON403() *Error

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

func (PostKeysResponse) GetJSON409 added in v0.2.0

func (r PostKeysResponse) GetJSON409() *Error

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

func (PostKeysResponse) GetJSON429 added in v0.2.0

func (r PostKeysResponse) GetJSON429() *Error

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

func (PostKeysResponse) GetJSON500 added in v0.2.0

func (r PostKeysResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostKeysResponse) Status added in v0.2.0

func (r PostKeysResponse) Status() string

Status returns HTTPResponse.Status

func (PostKeysResponse) StatusCode added in v0.2.0

func (r PostKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostPluginsInspectJSONRequestBody added in v0.3.0

type PostPluginsInspectJSONRequestBody = InspectPluginReq

PostPluginsInspectJSONRequestBody defines body for PostPluginsInspect for application/json ContentType.

type PostPluginsInspectResponse added in v0.3.0

type PostPluginsInspectResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PluginSchemaView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostPluginsInspectResponse added in v0.3.0

func ParsePostPluginsInspectResponse(rsp *http.Response) (*PostPluginsInspectResponse, error)

ParsePostPluginsInspectResponse parses an HTTP response from a PostPluginsInspectWithResponse call

func (PostPluginsInspectResponse) ContentType added in v0.3.0

func (r PostPluginsInspectResponse) ContentType() string

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

func (PostPluginsInspectResponse) GetBody added in v0.3.0

func (r PostPluginsInspectResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostPluginsInspectResponse) GetJSON200 added in v0.3.0

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

func (PostPluginsInspectResponse) GetJSON400 added in v0.3.0

func (r PostPluginsInspectResponse) GetJSON400() *Error

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

func (PostPluginsInspectResponse) GetJSON401 added in v0.3.0

func (r PostPluginsInspectResponse) GetJSON401() *Error

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

func (PostPluginsInspectResponse) GetJSON403 added in v0.3.0

func (r PostPluginsInspectResponse) GetJSON403() *Error

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

func (PostPluginsInspectResponse) GetJSON429 added in v0.3.0

func (r PostPluginsInspectResponse) GetJSON429() *Error

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

func (PostPluginsInspectResponse) GetJSON500 added in v0.3.0

func (r PostPluginsInspectResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostPluginsInspectResponse) Status added in v0.3.0

Status returns HTTPResponse.Status

func (PostPluginsInspectResponse) StatusCode added in v0.3.0

func (r PostPluginsInspectResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostPluginsJSONRequestBody added in v0.2.0

type PostPluginsJSONRequestBody = InstallPluginReq

PostPluginsJSONRequestBody defines body for PostPlugins for application/json ContentType.

type PostPluginsReloadResponse added in v0.2.0

type PostPluginsReloadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PluginReloadView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostPluginsReloadResponse added in v0.2.0

func ParsePostPluginsReloadResponse(rsp *http.Response) (*PostPluginsReloadResponse, error)

ParsePostPluginsReloadResponse parses an HTTP response from a PostPluginsReloadWithResponse call

func (PostPluginsReloadResponse) ContentType added in v0.2.0

func (r PostPluginsReloadResponse) ContentType() string

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

func (PostPluginsReloadResponse) GetBody added in v0.2.0

func (r PostPluginsReloadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostPluginsReloadResponse) GetJSON200 added in v0.2.0

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

func (PostPluginsReloadResponse) GetJSON400 added in v0.2.0

func (r PostPluginsReloadResponse) GetJSON400() *Error

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

func (PostPluginsReloadResponse) GetJSON401 added in v0.2.0

func (r PostPluginsReloadResponse) GetJSON401() *Error

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

func (PostPluginsReloadResponse) GetJSON403 added in v0.2.0

func (r PostPluginsReloadResponse) GetJSON403() *Error

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

func (PostPluginsReloadResponse) GetJSON429 added in v0.2.0

func (r PostPluginsReloadResponse) GetJSON429() *Error

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

func (PostPluginsReloadResponse) GetJSON500 added in v0.2.0

func (r PostPluginsReloadResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostPluginsReloadResponse) Status added in v0.2.0

func (r PostPluginsReloadResponse) Status() string

Status returns HTTPResponse.Status

func (PostPluginsReloadResponse) StatusCode added in v0.2.0

func (r PostPluginsReloadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostPluginsResponse added in v0.2.0

type PostPluginsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *PluginInstallView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostPluginsResponse added in v0.2.0

func ParsePostPluginsResponse(rsp *http.Response) (*PostPluginsResponse, error)

ParsePostPluginsResponse parses an HTTP response from a PostPluginsWithResponse call

func (PostPluginsResponse) ContentType added in v0.2.0

func (r PostPluginsResponse) ContentType() string

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

func (PostPluginsResponse) GetBody added in v0.2.0

func (r PostPluginsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostPluginsResponse) GetJSON201 added in v0.2.0

func (r PostPluginsResponse) GetJSON201() *PluginInstallView

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

func (PostPluginsResponse) GetJSON400 added in v0.2.0

func (r PostPluginsResponse) GetJSON400() *Error

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

func (PostPluginsResponse) GetJSON401 added in v0.2.0

func (r PostPluginsResponse) GetJSON401() *Error

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

func (PostPluginsResponse) GetJSON403 added in v0.2.0

func (r PostPluginsResponse) GetJSON403() *Error

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

func (PostPluginsResponse) GetJSON409 added in v0.2.0

func (r PostPluginsResponse) GetJSON409() *Error

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

func (PostPluginsResponse) GetJSON429 added in v0.2.0

func (r PostPluginsResponse) GetJSON429() *Error

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

func (PostPluginsResponse) GetJSON500 added in v0.2.0

func (r PostPluginsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostPluginsResponse) Status added in v0.2.0

func (r PostPluginsResponse) Status() string

Status returns HTTPResponse.Status

func (PostPluginsResponse) StatusCode added in v0.2.0

func (r PostPluginsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostPluginsRollbackJSONRequestBody added in v0.2.0

type PostPluginsRollbackJSONRequestBody = PluginRollbackReq

PostPluginsRollbackJSONRequestBody defines body for PostPluginsRollback for application/json ContentType.

type PostPluginsRollbackParams added in v0.2.0

type PostPluginsRollbackParams 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"`
}

PostPluginsRollbackParams defines parameters for PostPluginsRollback.

type PostPluginsRollbackResponse added in v0.2.0

type PostPluginsRollbackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PluginRollbackView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostPluginsRollbackResponse added in v0.2.0

func ParsePostPluginsRollbackResponse(rsp *http.Response) (*PostPluginsRollbackResponse, error)

ParsePostPluginsRollbackResponse parses an HTTP response from a PostPluginsRollbackWithResponse call

func (PostPluginsRollbackResponse) ContentType added in v0.2.0

func (r PostPluginsRollbackResponse) ContentType() string

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

func (PostPluginsRollbackResponse) GetBody added in v0.2.0

func (r PostPluginsRollbackResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostPluginsRollbackResponse) GetJSON200 added in v0.2.0

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

func (PostPluginsRollbackResponse) GetJSON400 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON400() *Error

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

func (PostPluginsRollbackResponse) GetJSON401 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON401() *Error

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

func (PostPluginsRollbackResponse) GetJSON403 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON403() *Error

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

func (PostPluginsRollbackResponse) GetJSON404 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON404() *Error

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

func (PostPluginsRollbackResponse) GetJSON409 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON409() *Error

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

func (PostPluginsRollbackResponse) GetJSON429 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON429() *Error

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

func (PostPluginsRollbackResponse) GetJSON500 added in v0.2.0

func (r PostPluginsRollbackResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostPluginsRollbackResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PostPluginsRollbackResponse) StatusCode added in v0.2.0

func (r PostPluginsRollbackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostRestartJSONRequestBody added in v0.2.0

type PostRestartJSONRequestBody = RestartReq

PostRestartJSONRequestBody defines body for PostRestart for application/json ContentType.

type PostRestartResponse added in v0.2.0

type PostRestartResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *RestartView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostRestartResponse added in v0.2.0

func ParsePostRestartResponse(rsp *http.Response) (*PostRestartResponse, error)

ParsePostRestartResponse parses an HTTP response from a PostRestartWithResponse call

func (PostRestartResponse) ContentType added in v0.2.0

func (r PostRestartResponse) ContentType() string

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

func (PostRestartResponse) GetBody added in v0.2.0

func (r PostRestartResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostRestartResponse) GetJSON202 added in v0.2.0

func (r PostRestartResponse) GetJSON202() *RestartView

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (PostRestartResponse) GetJSON400 added in v0.2.0

func (r PostRestartResponse) GetJSON400() *Error

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

func (PostRestartResponse) GetJSON401 added in v0.2.0

func (r PostRestartResponse) GetJSON401() *Error

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

func (PostRestartResponse) GetJSON403 added in v0.2.0

func (r PostRestartResponse) GetJSON403() *Error

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

func (PostRestartResponse) GetJSON409 added in v0.2.0

func (r PostRestartResponse) GetJSON409() *Error

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

func (PostRestartResponse) GetJSON429 added in v0.2.0

func (r PostRestartResponse) GetJSON429() *Error

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

func (PostRestartResponse) GetJSON500 added in v0.2.0

func (r PostRestartResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostRestartResponse) Status added in v0.2.0

func (r PostRestartResponse) Status() string

Status returns HTTPResponse.Status

func (PostRestartResponse) StatusCode added in v0.2.0

func (r PostRestartResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostSigningKeyRotateResponse added in v0.2.0

type PostSigningKeyRotateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SigningKeyRotateView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePostSigningKeyRotateResponse added in v0.2.0

func ParsePostSigningKeyRotateResponse(rsp *http.Response) (*PostSigningKeyRotateResponse, error)

ParsePostSigningKeyRotateResponse parses an HTTP response from a PostSigningKeyRotateWithResponse call

func (PostSigningKeyRotateResponse) ContentType added in v0.2.0

func (r PostSigningKeyRotateResponse) ContentType() string

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

func (PostSigningKeyRotateResponse) GetBody added in v0.2.0

func (r PostSigningKeyRotateResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PostSigningKeyRotateResponse) GetJSON200 added in v0.2.0

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

func (PostSigningKeyRotateResponse) GetJSON401 added in v0.2.0

func (r PostSigningKeyRotateResponse) GetJSON401() *Error

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

func (PostSigningKeyRotateResponse) GetJSON403 added in v0.2.0

func (r PostSigningKeyRotateResponse) GetJSON403() *Error

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

func (PostSigningKeyRotateResponse) GetJSON409 added in v0.2.0

func (r PostSigningKeyRotateResponse) GetJSON409() *Error

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

func (PostSigningKeyRotateResponse) GetJSON429 added in v0.2.0

func (r PostSigningKeyRotateResponse) GetJSON429() *Error

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

func (PostSigningKeyRotateResponse) GetJSON500 added in v0.2.0

func (r PostSigningKeyRotateResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PostSigningKeyRotateResponse) Status added in v0.2.0

Status returns HTTPResponse.Status

func (PostSigningKeyRotateResponse) StatusCode added in v0.2.0

func (r PostSigningKeyRotateResponse) 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 PutAdminAuthJSONRequestBody added in v0.2.0

type PutAdminAuthJSONRequestBody = PutAuthBody

PutAdminAuthJSONRequestBody defines body for PutAdminAuth for application/json ContentType.

type PutAdminAuthParams added in v0.2.0

type PutAdminAuthParams 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"`
}

PutAdminAuthParams defines parameters for PutAdminAuth.

type PutAdminAuthResponse added in v0.2.0

type PutAdminAuthResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutAdminAuthResponse added in v0.2.0

func ParsePutAdminAuthResponse(rsp *http.Response) (*PutAdminAuthResponse, error)

ParsePutAdminAuthResponse parses an HTTP response from a PutAdminAuthWithResponse call

func (PutAdminAuthResponse) ContentType added in v0.2.0

func (r PutAdminAuthResponse) ContentType() string

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

func (PutAdminAuthResponse) GetBody added in v0.2.0

func (r PutAdminAuthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutAdminAuthResponse) GetJSON200 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON200() *AdminAuthPutView

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

func (PutAdminAuthResponse) GetJSON400 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON400() *Error

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

func (PutAdminAuthResponse) GetJSON401 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON401() *Error

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

func (PutAdminAuthResponse) GetJSON403 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON403() *Error

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

func (PutAdminAuthResponse) GetJSON409 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON409() *Error

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

func (PutAdminAuthResponse) GetJSON429 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON429() *Error

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

func (PutAdminAuthResponse) GetJSON500 added in v0.2.0

func (r PutAdminAuthResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutAdminAuthResponse) Status added in v0.2.0

func (r PutAdminAuthResponse) Status() string

Status returns HTTPResponse.Status

func (PutAdminAuthResponse) StatusCode added in v0.2.0

func (r PutAdminAuthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutAuthBody added in v0.2.0

type PutAuthBody struct {
	// AdminAuth The ordered admin auth module chain. Empty is the explicit open dev posture.
	AdminAuth []string `json:"admin_auth"`
}

PutAuthBody The `PUT /api/v1/admin/admin-auth` body: the replacement admin auth chain.

type PutConfigSettingsJSONBody added in v0.2.0

type PutConfigSettingsJSONBody map[string]interface{}

PutConfigSettingsJSONBody defines parameters for PutConfigSettings.

type PutConfigSettingsJSONRequestBody added in v0.2.0

type PutConfigSettingsJSONRequestBody PutConfigSettingsJSONBody

PutConfigSettingsJSONRequestBody defines body for PutConfigSettings for application/json ContentType.

type PutConfigSettingsParams added in v0.2.0

type PutConfigSettingsParams 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"`
}

PutConfigSettingsParams defines parameters for PutConfigSettings.

type PutConfigSettingsResponse added in v0.2.0

type PutConfigSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ConfigSettingsView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutConfigSettingsResponse added in v0.2.0

func ParsePutConfigSettingsResponse(rsp *http.Response) (*PutConfigSettingsResponse, error)

ParsePutConfigSettingsResponse parses an HTTP response from a PutConfigSettingsWithResponse call

func (PutConfigSettingsResponse) ContentType added in v0.2.0

func (r PutConfigSettingsResponse) ContentType() string

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

func (PutConfigSettingsResponse) GetBody added in v0.2.0

func (r PutConfigSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutConfigSettingsResponse) GetJSON200 added in v0.2.0

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

func (PutConfigSettingsResponse) GetJSON400 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON400() *Error

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

func (PutConfigSettingsResponse) GetJSON401 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON401() *Error

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

func (PutConfigSettingsResponse) GetJSON403 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON403() *Error

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

func (PutConfigSettingsResponse) GetJSON409 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON409() *Error

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

func (PutConfigSettingsResponse) GetJSON429 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON429() *Error

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

func (PutConfigSettingsResponse) GetJSON500 added in v0.2.0

func (r PutConfigSettingsResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutConfigSettingsResponse) Status added in v0.2.0

func (r PutConfigSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (PutConfigSettingsResponse) StatusCode added in v0.2.0

func (r PutConfigSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutExportNameJSONBody added in v0.4.0

type PutExportNameJSONBody map[string]interface{}

PutExportNameJSONBody defines parameters for PutExportName.

type PutExportNameJSONRequestBody added in v0.4.0

type PutExportNameJSONRequestBody PutExportNameJSONBody

PutExportNameJSONRequestBody defines body for PutExportName for application/json ContentType.

type PutExportNameParams added in v0.4.0

type PutExportNameParams 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"`
}

PutExportNameParams defines parameters for PutExportName.

type PutExportNameResponse added in v0.4.0

type PutExportNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutExportNameResponse added in v0.4.0

func ParsePutExportNameResponse(rsp *http.Response) (*PutExportNameResponse, error)

ParsePutExportNameResponse parses an HTTP response from a PutExportNameWithResponse call

func (PutExportNameResponse) ContentType added in v0.4.0

func (r PutExportNameResponse) ContentType() string

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

func (PutExportNameResponse) GetBody added in v0.4.0

func (r PutExportNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutExportNameResponse) GetJSON200 added in v0.4.0

func (r PutExportNameResponse) GetJSON200() *NamedDefView

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

func (PutExportNameResponse) GetJSON400 added in v0.4.0

func (r PutExportNameResponse) GetJSON400() *Error

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

func (PutExportNameResponse) GetJSON401 added in v0.4.0

func (r PutExportNameResponse) GetJSON401() *Error

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

func (PutExportNameResponse) GetJSON403 added in v0.4.0

func (r PutExportNameResponse) GetJSON403() *Error

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

func (PutExportNameResponse) GetJSON409 added in v0.4.0

func (r PutExportNameResponse) GetJSON409() *Error

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

func (PutExportNameResponse) GetJSON429 added in v0.4.0

func (r PutExportNameResponse) GetJSON429() *Error

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

func (PutExportNameResponse) GetJSON500 added in v0.4.0

func (r PutExportNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutExportNameResponse) Status added in v0.4.0

func (r PutExportNameResponse) Status() string

Status returns HTTPResponse.Status

func (PutExportNameResponse) StatusCode added in v0.4.0

func (r PutExportNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutGroupsNameJSONBody added in v0.2.0

type PutGroupsNameJSONBody struct {
	// Config A `groups:` entry, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`
}

PutGroupsNameJSONBody defines parameters for PutGroupsName.

type PutGroupsNameJSONRequestBody added in v0.2.0

type PutGroupsNameJSONRequestBody PutGroupsNameJSONBody

PutGroupsNameJSONRequestBody defines body for PutGroupsName for application/json ContentType.

type PutGroupsNameParams added in v0.2.0

type PutGroupsNameParams 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"`
}

PutGroupsNameParams defines parameters for PutGroupsName.

type PutGroupsNameResponse added in v0.2.0

type PutGroupsNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *GroupView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutGroupsNameResponse added in v0.2.0

func ParsePutGroupsNameResponse(rsp *http.Response) (*PutGroupsNameResponse, error)

ParsePutGroupsNameResponse parses an HTTP response from a PutGroupsNameWithResponse call

func (PutGroupsNameResponse) ContentType added in v0.2.0

func (r PutGroupsNameResponse) ContentType() string

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

func (PutGroupsNameResponse) GetBody added in v0.2.0

func (r PutGroupsNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutGroupsNameResponse) GetJSON200 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON200() *GroupView

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

func (PutGroupsNameResponse) GetJSON400 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON400() *Error

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

func (PutGroupsNameResponse) GetJSON401 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON401() *Error

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

func (PutGroupsNameResponse) GetJSON403 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON403() *Error

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

func (PutGroupsNameResponse) GetJSON404 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON404() *Error

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

func (PutGroupsNameResponse) GetJSON409 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON409() *Error

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

func (PutGroupsNameResponse) GetJSON429 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON429() *Error

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

func (PutGroupsNameResponse) GetJSON500 added in v0.2.0

func (r PutGroupsNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutGroupsNameResponse) Status added in v0.2.0

func (r PutGroupsNameResponse) Status() string

Status returns HTTPResponse.Status

func (PutGroupsNameResponse) StatusCode added in v0.2.0

func (r PutGroupsNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutHooksNameJSONBody added in v0.2.0

type PutHooksNameJSONBody struct {
	// Config A `hooks:` entry, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.
	Config map[string]interface{} `json:"config"`
}

PutHooksNameJSONBody defines parameters for PutHooksName.

type PutHooksNameJSONRequestBody added in v0.2.0

type PutHooksNameJSONRequestBody PutHooksNameJSONBody

PutHooksNameJSONRequestBody defines body for PutHooksName for application/json ContentType.

type PutHooksNameParams added in v0.2.0

type PutHooksNameParams 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"`
}

PutHooksNameParams defines parameters for PutHooksName.

type PutHooksNameResponse added in v0.2.0

type PutHooksNameResponse 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutHooksNameResponse added in v0.2.0

func ParsePutHooksNameResponse(rsp *http.Response) (*PutHooksNameResponse, error)

ParsePutHooksNameResponse parses an HTTP response from a PutHooksNameWithResponse call

func (PutHooksNameResponse) ContentType added in v0.2.0

func (r PutHooksNameResponse) ContentType() string

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

func (PutHooksNameResponse) GetBody added in v0.2.0

func (r PutHooksNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutHooksNameResponse) GetJSON200 added in v0.2.0

func (r PutHooksNameResponse) GetJSON200() *HookView

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

func (PutHooksNameResponse) GetJSON400 added in v0.2.0

func (r PutHooksNameResponse) GetJSON400() *Error

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

func (PutHooksNameResponse) GetJSON401 added in v0.2.0

func (r PutHooksNameResponse) GetJSON401() *Error

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

func (PutHooksNameResponse) GetJSON403 added in v0.2.0

func (r PutHooksNameResponse) GetJSON403() *Error

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

func (PutHooksNameResponse) GetJSON404 added in v0.2.0

func (r PutHooksNameResponse) GetJSON404() *Error

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

func (PutHooksNameResponse) GetJSON409 added in v0.2.0

func (r PutHooksNameResponse) GetJSON409() *Error

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

func (PutHooksNameResponse) GetJSON429 added in v0.2.0

func (r PutHooksNameResponse) GetJSON429() *Error

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

func (PutHooksNameResponse) GetJSON500 added in v0.2.0

func (r PutHooksNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutHooksNameResponse) Status added in v0.2.0

func (r PutHooksNameResponse) Status() string

Status returns HTTPResponse.Status

func (PutHooksNameResponse) StatusCode added in v0.2.0

func (r PutHooksNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutIdentityProvidersNameJSONBody added in v0.4.0

type PutIdentityProvidersNameJSONBody map[string]interface{}

PutIdentityProvidersNameJSONBody defines parameters for PutIdentityProvidersName.

type PutIdentityProvidersNameJSONRequestBody added in v0.4.0

type PutIdentityProvidersNameJSONRequestBody PutIdentityProvidersNameJSONBody

PutIdentityProvidersNameJSONRequestBody defines body for PutIdentityProvidersName for application/json ContentType.

type PutIdentityProvidersNameParams added in v0.4.0

type PutIdentityProvidersNameParams 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"`
}

PutIdentityProvidersNameParams defines parameters for PutIdentityProvidersName.

type PutIdentityProvidersNameResponse added in v0.4.0

type PutIdentityProvidersNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *NamedDefView
	// 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
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *Error
}

func ParsePutIdentityProvidersNameResponse added in v0.4.0

func ParsePutIdentityProvidersNameResponse(rsp *http.Response) (*PutIdentityProvidersNameResponse, error)

ParsePutIdentityProvidersNameResponse parses an HTTP response from a PutIdentityProvidersNameWithResponse call

func (PutIdentityProvidersNameResponse) ContentType added in v0.4.0

func (r PutIdentityProvidersNameResponse) ContentType() string

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

func (PutIdentityProvidersNameResponse) GetBody added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PutIdentityProvidersNameResponse) GetJSON200 added in v0.4.0

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

func (PutIdentityProvidersNameResponse) GetJSON400 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON400() *Error

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

func (PutIdentityProvidersNameResponse) GetJSON401 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON401() *Error

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

func (PutIdentityProvidersNameResponse) GetJSON403 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON403() *Error

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

func (PutIdentityProvidersNameResponse) GetJSON409 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON409() *Error

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

func (PutIdentityProvidersNameResponse) GetJSON429 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON429() *Error

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

func (PutIdentityProvidersNameResponse) GetJSON500 added in v0.4.0

func (r PutIdentityProvidersNameResponse) GetJSON500() *Error

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PutIdentityProvidersNameResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (PutIdentityProvidersNameResponse) StatusCode added in v0.4.0

func (r PutIdentityProvidersNameResponse) 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 RestartReq added in v0.2.0

type RestartReq struct {
	// Confirm Proceed even though no supervisor was detected. Exiting only restarts busbar if something
	// restarts it; without this an undetected supervisor is refused rather than risking the
	// gateway staying down.
	Confirm *bool `json:"confirm,omitempty"`
}

RestartReq The `POST /api/v1/admin/restart` body. Absent is the same as `{}`.

type RestartView added in v0.2.0

type RestartView struct {
	Note       string `json:"note"`
	Restarting bool   `json:"restarting"`

	// SupervisorDetected Whether a process supervisor was detected. False means the caller confirmed explicitly.
	SupervisorDetected bool `json:"supervisor_detected"`
}

RestartView `POST /restart`: accepted-and-draining result.

type RevokeView added in v0.2.0

type RevokeView struct {
	// Revoked The id that was revoked (durably denylisted; the binding record remains).
	Revoked string `json:"revoked"`
}

RevokeView `POST /keys/{id}/revoke`: the revoked key's id (denylisted without deleting the binding). 1.5.0.

type RollbackReq added in v0.2.0

type RollbackReq struct {
	// Version The retained version to restore.
	Version uint64 `json:"version"`
}

RollbackReq The `POST /api/v1/admin/config/rollback` request body. Optimistic concurrency rides `If-Match`.

type RotatedKeyView

type RotatedKeyView struct {
	AllowedPools *[]string `json:"allowed_pools"`
	CreatedAt    uint64    `json:"created_at"`
	Enabled      bool      `json:"enabled"`

	// ExpiresAt Unix-seconds expiry of the re-minted signed token (present with `token`).
	ExpiresAt *uint64           `json:"expires_at,omitempty"`
	Group     *string           `json:"group"`
	Id        string            `json:"id"`
	Labels    map[string]string `json:"labels"`
	Name      string            `json:"name"`

	// Secret The fresh bearer secret, shown EXACTLY once (legacy hashed-secret keys only).
	Secret *string `json:"secret,omitempty"`

	// State Same field as `KeyView.state`; rotate does not change `enabled`/revoked/tombstoned
	// status, so this reflects whatever the key's disposition already was (rotating a `disabled` or
	// `revoked` key is legal and leaves it exactly that; only a `tombstoned` key refuses to rotate,
	// which surfaces as 404 instead of this response).
	State string `json:"state"`

	// Token The fresh busbar-SIGNED token, shown EXACTLY once (signed-token keys).
	Token *string `json:"token,omitempty"`
}

RotatedKeyView `POST /keys/{id}/rotate`: the key metadata plus the ONCE-shown fresh CREDENTIAL. Exactly one of `token`+`expires_at` (a 1.5.0 signed-token key: a new token at a new binding generation, every prior token now rejected) or `secret` (a legacy hashed-secret key) is present.

type SigningKeyRotateView added in v0.2.0

type SigningKeyRotateView struct {
	// CurrentKid The current signing-key id (`kid`) that tokens are minted under.
	CurrentKid string `json:"current_kid"`

	// Message Human-readable guidance for the operator-driven lockstep rotation.
	Message string `json:"message"`

	// RevokeAll Always `true`: rotating the signing key revokes every outstanding key (all must be re-minted).
	RevokeAll bool `json:"revoke_all"`
}

SigningKeyRotateView `POST /signing-key/rotate`: the current key-signing key id plus the REVOKE-ALL warning. 1.5.0 is single-key: the actual swap is an operator action, so this reports intent, not an in-process swap.

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 UpdateKeyReq added in v0.2.0

type UpdateKeyReq struct {
	Enabled *bool `json:"enabled,omitempty"`

	// Group Rebind or UNBIND the key's group. Absent = unchanged; `null` = unbind. The double `Option`
	// is what distinguishes those two, so the schema describes it as a nullable string.
	Group *string `json:"group,omitempty"`
}

UpdateKeyReq Partial update to an existing key. Keys are PURE AUTH (1.5.0), so the mutable surface is auth-shaped only. Every field is optional; only the present ones change. The credential, name, allowed-pools, and labels are immutable here (rotate/recreate for those).

`group` is THREE-STATE via serde double-option (`Option<Option<String>>`): - absent (`#[serde(default)]` -> outer `None`): leave the binding unchanged. - JSON `null` (`Some(None)`): UNBIND to no group (authed + unlimited). - a value (`Some(Some(name))`): REBIND to that group (must exist; mint-parity check).

A single `Option<T>` could not tell absent from present-null, so a binding could never be cleared once set. `enabled` is a plain `Option<bool>` (a bool has no clear state). The 1.4.x cap fields (`rpm_limit`/`tpm_limit`/`max_budget_cents`) are GONE: limits live on the group.

type UsageBreakdown

type UsageBreakdown struct {
	Requests uint64 `json:"requests"`

	// SpendMicros Busbar's derived cost estimate in MICRO-units of the ABSTRACT cost unit (1e-6 unit -
	// integer math, sub-cent precise, no float drift), recomputed at read time from the raw token
	// split x the operator's CURRENT per-model rate card. Busbar attaches no currency - the rate
	// card's numbers are whatever unit the operator priced in; display/denomination is entirely
	// the consumer's concern. 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`, currently
	// `"USD"`). A single-const source of truth so removal is one line. Emitted only here.
	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 defines model for UsageView.

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