openapi

May 11, 2026

Changes in this version

type OpDescriptor

+ Defaults map[string]string

+ func (op *OpDescriptor) ResolveCallParams(args map[string]string) (CallParams, error)

type OperationOverride

+ Defaults map[string]string

May 8, 2026

Changes in this version

+ func SynthesiseArgs(schema, table string, op OpDescriptor) []sdata.DBColumn

+ func SynthesiseColumns(schema, table string, ref *openapi3.SchemaRef, resultPath []string) []sdata.DBColumn

+ type AuthConfig struct

+ AttachAs string

+ AttachFormat string

+ AttachName string

+ CacheTTL string

+ ClientID string

+ ClientSecret string

+ KeyIn string

+ KeyName string

+ KeyValue string

+ Password string

+ Request *TokenExchangeRequest

+ Response *TokenExchangeResponse

+ Scheme string

+ Scopes []string

+ Token string

+ TokenFromRequest *TokenFromRequest

+ TokenURL string

+ Username string

+ type AuthProvider interface

+ Apply func(ctx context.Context, req *http.Request, hdrIn http.Header) error

+ OnUnauthorized func(ctx context.Context) error

+ func NewAuthProvider(cfg AuthConfig, httpClient *http.Client) (AuthProvider, error)

+ type CallParams struct

+ HeaderValues map[string]string

+ IncomingHeaders http.Header

+ PathValues map[string]string

+ QueryValues map[string]string

+ type Caller struct

+ func NewCaller(op *OpDescriptor, baseURL string, auth AuthProvider, lim *limiter, ...) *Caller

+ func (c *Caller) Call(ctx context.Context, p CallParams) ([]byte, error)

+ type ConcurrencyConfig struct

+ MaxConcurrent int

+ RateLimitPerSec int

+ type JoinConfig struct

+ ExposeAs string

+ Param string

+ ParentColumn string

+ ParentTable string

+ type LoadResult struct

+ Registry *Registry

+ Warnings []string

+ func Load(opts LoaderOptions, configs map[string]SpecConfig, logger *log.Logger) (*LoadResult, error)

+ type LoaderOptions struct

+ SpecsDir string

+ type OpDescriptor struct

+ ExposeAs string

+ HeaderParams []ParamSpec

+ IsArrayResponse bool

+ Join *JoinConfig

+ Method string

+ Mode OpMode

+ OperationID string

+ PathParams []ParamSpec

+ PathTemplate string

+ QueryParams []ParamSpec

+ ResponseSchema *openapi3.SchemaRef

+ ResultPath []string

+ SkipReason string

+ SpecKey string

+ type OpMode int

+ const OpModeList

+ const OpModeRowJoin

+ const OpModeSingleByID

+ const OpModeSkipped

+ func (m OpMode) String() string

+ type OperationOverride struct

+ Disabled bool

+ ExposeAs string

+ ExposeTopLevel bool

+ ResultPath string

+ type ParamLocation string

+ const ParamInHeader

+ const ParamInPath

+ const ParamInQuery

+ type ParamSpec struct

+ Format string

+ In ParamLocation

+ Name string

+ Required bool

+ Type string

+ type Registry struct

+ Specs []*Spec

+ func (r *Registry) AllOperations() []OpDescriptor

+ func (r *Registry) Get(key string) (*Spec, bool)

+ type Runtime struct

+ func NewRuntime(reg *Registry, httpClient *http.Client) (*Runtime, []string, error)

+ func (r *Runtime) AllSpecs() []*SpecRuntime

+ func (r *Runtime) Caller(specKey, operationID string) (*Caller, bool)

+ func (r *Runtime) Operation(specKey, operationID string) (*OpDescriptor, bool)

+ func (r *Runtime) Spec(specKey string) (*SpecRuntime, bool)

+ type Spec struct

+ Auth AuthConfig

+ BaseURL string

+ Concurrency ConcurrencyConfig

+ Doc *openapi3.T

+ Key string

+ Operations []OpDescriptor

+ SkippedCount int

+ SourcePath string

+ type SpecConfig struct

+ Auth AuthConfig

+ BaseURL string

+ Concurrency ConcurrencyConfig

+ Joins map[string]JoinConfig

+ Operations map[string]OperationOverride

+ type SpecRuntime struct

+ func NewSpecRuntime(spec *Spec, httpClient *http.Client) (*SpecRuntime, error)

+ func (r *SpecRuntime) Caller(operationID string) (*Caller, bool)

+ func (r *SpecRuntime) Spec() *Spec

+ type TokenExchangeRequest struct

+ Body map[string]interface{}

+ BodyFormat string

+ Headers map[string]string

+ Method string

+ type TokenExchangeResponse struct

+ ExpiresField string

+ TokenField string

+ type TokenFromRequest struct

+ Header string

+ Query string