goai

package

Go to main page

Versions in this module

v1

v1.15.18

May 7, 2026

Changes in this version

+ type HeadSpecProvider interface

+ GOAIHeadSpec func() Spec

v1.15.17

Apr 28, 2026

v1.15.16

Apr 28, 2026

v1.15.15

Apr 28, 2026

v1.15.14

Apr 28, 2026

v1.15.13

Apr 27, 2026

v1.15.12

Apr 27, 2026

v1.15.11

Apr 27, 2026

v1.15.10

Apr 27, 2026

v1.15.9

Apr 27, 2026

Changes in this version

type OperationDoc

+ EndpointOperations []OperationEndpointDoc

+ Endpoints []OperationEndpoint

+ type OperationEndpointDoc struct

+ Endpoint OperationEndpoint

+ Operation Operation

+ SchemaPackages map[string]string

+ Schemas map[string]*Schema

v1.15.8

Apr 27, 2026

v1.15.7

Apr 27, 2026

v1.15.6

Apr 27, 2026

v1.15.5

Apr 27, 2026

v1.15.4

Apr 27, 2026

v1.15.3

Apr 27, 2026

v1.15.2

Apr 27, 2026

v1.15.1

Apr 27, 2026

Changes in this version

type BuildOptions

+ OperationDocExtractor OperationDocExtractor

type Config

+ DocstringBuildTags []string

+ EnableDocstringExtraction bool

+ type OperationDoc struct

+ Endpoint OperationEndpoint

+ Operation Operation

+ SchemaPackages map[string]string

+ Schemas map[string]*Schema

+ type OperationDocExtractor func(handler any, methodName string) (*OperationDoc, bool)

+ func DefaultOperationDocExtractor() OperationDocExtractor

+ func DefaultOperationDocExtractorWithBuildTags(tags ...string) OperationDocExtractor

+ type OperationEndpoint struct

+ Method string

+ Path string

type Option

+ func WithRequestDescription(description string) Option

+ func WithResponse(status string, description string, opts ...ResponseOption) Option

+ func WithSuccessDescription(description string) Option

+ type ResponseOption func(*ResponseSpec)

+ func WithResponseExample(example any) ResponseOption

+ func WithResponseExampleObject(name string, example *Example) ResponseOption

+ func WithResponseHeader(h HeaderDef) ResponseOption

+ func WithResponseMediaType(mediaType string) ResponseOption

+ func WithResponseSchema(t reflect.Type) ResponseOption

+ func WithResponseSchemaPrebuilt(schema *Schema) ResponseOption

+ type ResponseSpec struct

+ Description string

+ Example any

+ Examples map[string]*Example

+ Headers []HeaderDef

+ MediaType string

+ Schema *Schema

+ SchemaType reflect.Type

type RunOptions

+ OperationDocExtractor OperationDocExtractor

+ type SchemaNameProvider interface

+ GOAISchemaName func() string

type Spec

+ func (s Spec) RequestDescription() string

+ func (s Spec) Responses() map[string]*ResponseSpec

+ func (s Spec) SuccessDescription() string

v1.15.0

Apr 26, 2026

Changes in this version

+ const Version

+ func BuiltinClassify(c OperationCandidate) []string

+ func CountOperations(doc *Document) int

+ func EmitYAML(doc *Document) ([]byte, error)

+ func Handler(route ghttp.RouteEntriesProvider, opts ...RuntimeOption) ghttp.HandlerTask

+ func LookupAll(handler ghttp.HandlerTask) map[string]Entry

+ func Merge3Way(generated, existing, overrides []byte) ([]byte, error)

+ func Register(handler ghttp.HandlerTask, method string, req any, resp any, opts ...Option)

+ func Reset()

+ func RunCLI(factory RouteFactory, opts RunOptions)

+ func RunCLIFromConfig(configPath string, factory RouteFactory, opts ...RunFromConfigOption)

+ type AcceptanceSecurityRule struct

+ Scheme string

+ Scopes []string

+ TypeName string

+ type BuildOptions struct

+ Classifier func(c OperationCandidate) []string

+ Contact *Contact

+ Description string

+ ExternalDocs *ExternalDocumentation

+ GlobalSecurity []map[string][]string

+ License *License

+ Servers []Server

+ SuppressEmptySchemas bool

+ TagSecurityClassifier *Classifier

+ Tags []Tag

+ TermsOfService string

+ Title string

+ Version string

+ type Callback map[string]*PathItem

+ type Classifier struct

+ AcceptanceSecurityRules []AcceptanceSecurityRule

+ PathTagRules []PathTagRule

+ func DefaultClassifier() *Classifier

+ func (c *Classifier) ClassifySecurity(acceptances []ghttp.Acceptance) []SecurityRef

+ func (c *Classifier) ClassifyTag(path string) string

+ type Components struct

+ Callbacks map[string]Callback

+ Examples map[string]*Example

+ Extensions map[string]any

+ Headers map[string]*Header

+ Links map[string]*Link

+ Parameters map[string]*Parameter

+ RequestBodies map[string]*RequestBody

+ Responses map[string]*Response

+ Schemas map[string]*Schema

+ SecuritySchemes map[string]*SecurityScheme

+ func NewComponents() *Components

+ type Config struct

+ BaseSpecPath string

+ Contact *Contact

+ DefaultOutput string

+ Description string

+ ExcludePaths []string

+ ExternalDocs *ExternalDocumentation

+ GlobalSecurity []map[string][]string

+ License *License

+ Output map[string]string

+ Profiles map[string]ConfigProfile

+ RestrictToBaseSpecPaths bool

+ SecuritySchemes map[string]*SecurityScheme

+ Servers []Server

+ Tags []Tag

+ TermsOfService string

+ Title string

+ Version string

+ func DefaultConfig() *Config

+ func LoadConfig(dir string) (*Config, error)

+ func (c *Config) BuildProfile(name string) *Profile

+ func (c *Config) ProfileNames() []string

+ func (c *Config) ToBuildOptions() BuildOptions

+ func (c *Config) ToRunOptions() RunOptions

+ type ConfigProfile struct

+ Exclude Selector

+ Include Selector

+ type Contact struct

+ Email string

+ Extensions map[string]any

+ Name string

+ URL string

+ type CreateSpecProvider interface

+ GOAICreateSpec func() Spec

+ type DeleteSpecProvider interface

+ GOAIDeleteSpec func() Spec

+ type Discriminator struct

+ Mapping map[string]string

+ PropertyName string

+ type Document struct

+ Components *Components

+ Extensions map[string]any

+ ExternalDocs *ExternalDocumentation

+ Info Info

+ OpenAPI string

+ Paths map[string]*PathItem

+ Security []map[string][]string

+ Servers []Server

+ Tags []Tag

+ func Build(candidates []OperationCandidate, profile *Profile, opts BuildOptions) *Document

+ type EmissionAwareParamInjector interface

+ InjectedParamsForEmission func(routePath string, ctx EmissionContext) []PathParam

+ type EmissionContext struct

+ GoMethod string

+ HTTPMethod string

+ ItemLevel bool

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode *bool

+ Extensions map[string]any

+ Headers map[string]*Header

+ Style string

+ type Entry struct

+ Handler ghttp.HandlerTask

+ Method string

+ ReqType reflect.Type

+ RespType reflect.Type

+ Spec Spec

+ func All() []Entry

+ func Lookup(handler ghttp.HandlerTask, method string) (Entry, bool)

+ type Example struct

+ Description string

+ Extensions map[string]any

+ ExternalValue string

+ Summary string

+ Value any

+ type ExternalDocumentation struct

+ Description string

+ Extensions map[string]any

+ URL string

+ type GetSpecProvider interface

+ GOAIGetSpec func() Spec

+ type Header struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]*MediaType

+ Deprecated bool

+ Description string

+ Example any

+ Examples map[string]*Example

+ Explode *bool

+ Extensions map[string]any

+ Required bool

+ Schema *Schema

+ Style string

+ type HeaderDef struct

+ Description string

+ Example string

+ In string

+ Name string

+ Required bool

+ type Hidden interface

+ Hidden func() bool

+ type IndexSpecProvider interface

+ GOAIIndexSpec func() Spec

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]any

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type ItemIDProvider interface

+ GOAIItemIDName func() string

+ type License struct

+ Extensions map[string]any

+ Name string

+ URL string

+ type Link struct

+ Description string

+ Extensions map[string]any

+ OperationID string

+ OperationRef string

+ Parameters map[string]any

+ RequestBody any

+ Server *Server

+ type LintReport struct

+ Errors []string

+ Operations int

+ Paths int

+ func LintYAML(body []byte) (*LintReport, error)

+ type MediaType struct

+ Encoding map[string]*Encoding

+ Example any

+ Examples map[string]*Example

+ Extensions map[string]any

+ Schema *Schema

+ type MethodAwareSecurityProvider interface

+ SecurityRequirementFor func(method string) (scheme string, scopes []string)

+ type OAuthFlow struct

+ AuthorizationURL string

+ Extensions map[string]any

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Extensions map[string]any

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type Operation struct

+ Callbacks map[string]Callback

+ Deprecated bool

+ Description string

+ Extensions map[string]any

+ ExternalDocs *ExternalDocumentation

+ OperationID string

+ Parameters []*Parameter

+ RequestBody *RequestBody

+ Responses map[string]*Response

+ Security *[]map[string][]string

+ Servers []Server

+ Summary string

+ Tags []string

+ type OperationCandidate struct

+ Acceptances []ghttp.Acceptance

+ Handler ghttp.HandlerTask

+ HandlerMethod string

+ Method string

+ Path string

+ PathParams []PathParam

+ Profiles []string

+ SecurityExplicitlyEmpty bool

+ SecurityRefs []SecurityRef

+ func Walk(route ghttp.RouteEntriesProvider) []OperationCandidate

+ type Option func(*Spec)

+ func WithCallback(name string, callback Callback) Option

+ func WithDeprecated() Option

+ func WithDescription(description string) Option

+ func WithExample(mediaType string, example any) Option

+ func WithExampleObject(mediaType, name string, ex *Example) Option

+ func WithExternalDocs(url, description string) Option

+ func WithHeader(h HeaderDef) Option

+ func WithOperationID(id string) Option

+ func WithOperationServer(server Server) Option

+ func WithParam(p PathParam) Option

+ func WithRequestMediaType(mediaType string) Option

+ func WithSecurity(scheme string, scopes ...string) Option

+ func WithSummary(summary string) Option

+ func WithTag(tags ...string) Option

+ type OptionsSpecProvider interface

+ GOAIOptionsSpec func() Spec

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content map[string]*MediaType

+ Deprecated bool

+ Description string

+ Example any

+ Examples map[string]*Example

+ Explode *bool

+ Extensions map[string]any

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ Style string

+ type PatchSpecProvider interface

+ GOAIPatchSpec func() Spec

+ type PathAwareParamInjector interface

+ InjectedParamsFor func(routePath string) []PathParam

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Extensions map[string]any

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []Server

+ Summary string

+ Trace *Operation

+ func (p *PathItem) SetOperation(method string, op *Operation)

+ type PathParam struct

+ AnchorAfter string

+ Description string

+ Example string

+ In string

+ IsItemIdentifier bool

+ Name string

+ Required bool

+ Style string

+ type PathParamInjector interface

+ InjectedParams func() []PathParam

+ type PathTagRule struct

+ Pattern string

+ Tag string

+ type PostSpecProvider interface

+ GOAIPostSpec func() Spec

+ type Profile struct

+ Exclude Selector

+ Include Selector

+ Name string

+ func (p *Profile) Matches(c OperationCandidate, declaredProfiles, operationTags []string) bool

+ type ProfileScope interface

+ GOAIProfileScope func() []string

+ type PutSpecProvider interface

+ GOAIPutSpec func() Spec

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Extensions map[string]any

+ Required bool

+ type Response struct

+ Content map[string]*MediaType

+ Description string

+ Extensions map[string]any

+ Headers map[string]*Header

+ Links map[string]*Link

+ type RouteFactory func() ghttp.RouteEntriesProvider

+ type RunFromConfigOption func(*runFromConfigOpts)

+ func WithClassifier(c *Classifier) RunFromConfigOption

+ type RunOptions struct

+ Args []string

+ BaseSpec []byte

+ BaseSpecPath string

+ Contact *Contact

+ DefaultOutput string

+ Description string

+ ExcludePaths []string

+ Exit func(int)

+ ExternalDocs *ExternalDocumentation

+ GlobalSecurity []map[string][]string

+ License *License

+ RestrictToBaseSpecPaths bool

+ SecuritySchemes map[string]*SecurityScheme

+ Servers []Server

+ Stderr io.Writer

+ Stdout io.Writer

+ TagSecurityClassifier *Classifier

+ Tags []Tag

+ TermsOfService string

+ Title string

+ Version string

+ type RuntimeOption func(*runtimeConfig)

+ func WithRuntimeBuildOptions(opts BuildOptions) RuntimeOption

+ func WithRuntimeCacheTTL(d time.Duration) RuntimeOption

+ func WithRuntimeProfile(name string) RuntimeOption

+ type Schema struct

+ AdditionalProperties any

+ AllOf []*Schema

+ AnyOf []*Schema

+ Default any

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ Enum []any

+ Example any

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Extensions map[string]any

+ ExternalDocs *ExternalDocumentation

+ Format string

+ Items *Schema

+ MaxItems *uint64

+ MaxLength *uint64

+ MaxProperties *uint64

+ Maximum *float64

+ MinItems *uint64

+ MinLength *uint64

+ MinProperties *uint64

+ Minimum *float64

+ MultipleOf *float64

+ Not *Schema

+ Nullable bool

+ OneOf []*Schema

+ Pattern string

+ Properties map[string]*Schema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ WriteOnly bool

+ XML *XML

+ type SecurityProvider interface

+ SecurityRequirement func() (scheme string, scopes []string)

+ type SecurityRef struct

+ Scheme string

+ Scopes []string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Extensions map[string]any

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ type Selector struct

+ Packages []string

+ Paths []string

+ Profiles []string

+ Tags []string

+ func (s Selector) IsEmpty() bool

+ func (s Selector) Match(c OperationCandidate, declaredProfiles, operationTags []string) bool

+ type Server struct

+ Description string

+ Extensions map[string]any

+ URL string

+ Variables map[string]*ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ Extensions map[string]any

+ type Spec struct

+ func NewSpec(opts ...Option) Spec

+ func (s Spec) Callbacks() map[string]Callback

+ func (s Spec) Deprecated() bool

+ func (s Spec) Description() string

+ func (s Spec) Examples() map[string]any

+ func (s Spec) ExternalDocs() *ExternalDocumentation

+ func (s Spec) ExtraHeaders() []HeaderDef

+ func (s Spec) ExtraParams() []PathParam

+ func (s Spec) MultiExamples() map[string]map[string]*Example

+ func (s Spec) OperationID() string

+ func (s Spec) OperationServers() []Server

+ func (s Spec) RequestMediaType() string

+ func (s Spec) Security() []SecurityRef

+ func (s Spec) Summary() string

+ func (s Spec) Tags() []string

+ type SpecProvider interface

+ GOAISpec func() Spec

+ type Tag struct

+ Description string

+ Extensions map[string]any

+ ExternalDocs *ExternalDocumentation

+ Name string

+ type TraceSpecProvider interface

+ GOAITraceSpec func() Spec

+ type XML struct

+ Attribute bool

+ Extensions map[string]any

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL