cli

package

Go to main page

Versions in this module

v0

v0.4.0

May 9, 2026

Changes in this version

type Config

+ Filters []string

+ PruneUnusedComponents bool

+ RouteManifest string

type ConfigLoader

+ func ResolveConfigLoaderFromEntry(workdir string, entry Entry, path string) (ConfigLoader, error)

type Entry

+ ConfigImportPath string

+ ConfigTypeName string

type Overrides

+ Filters []string

+ FiltersSet bool

+ PruneUnusedComponents bool

+ PruneUnusedComponentsSet bool

+ RouteManifest string

+ RouteManifestSet bool

v0.3.0

May 5, 2026

v0.2.1

May 5, 2026

v0.2.0

May 5, 2026

Changes in this version

+ const FormatJSON

+ const FormatYAML

type Config

+ EntryAutoDiscovered bool

+ EntryConfig EntryConfig

+ EntryDiscoveryScope []string

+ ResolvedEntry *Entry

+ type ConfigLoader struct

+ FuncName string

+ ImportPath string

+ Path string

+ func ResolveConfigLoader(workdir, value, path string) (ConfigLoader, error)

type DriverData

+ ConfigLoader ConfigLoader

+ HasConfigLoader bool

type Entry

+ TakesConfig bool

+ TakesContext bool

+ func DiscoverEntry(workdir string, scope []string) (Entry, error)

+ type EntryCandidate struct

+ Entry Entry

+ Marked bool

+ func (c EntryCandidate) Symbol() string

+ type EntryConfig struct

+ Loader string

+ Path string

+ type InitOptions struct

+ ConfigPath string

+ Entry string

+ Force bool

+ Out string

+ Title string

+ Version string

+ Workdir string

+ type InitResult struct

+ AutoDiscovered bool

+ ConfigPath string

+ Entry string

+ func InitConfig(opts InitOptions) (InitResult, error)

type Overrides

+ EntryConfigLoader string

+ EntryConfigLoaderSet bool

+ EntryConfigPath string

+ EntryConfigPathSet bool

+ EntryDiscoveryScope []string

+ EntryDiscoveryScopeSet bool

+ InfoTitle string

+ InfoTitleSet bool

+ InfoVersion string

+ InfoVersionSet bool

+ Servers []string

+ ServersSet bool

type ServeConfig

+ Stdout io.Writer

v0.1.0

May 4, 2026

Changes in this version

+ const ExitBuildFailed

+ const ExitDrift

+ const ExitRunFailed

+ const ExitUsage

+ const ExitWriteFailed

+ var ErrDrift = errors.New("openapi output is out of date")

+ func CheckDrift(path string, data []byte) error

+ func CleanupDriver(driverDir string, keep bool)

+ func DriverDir(cfg Config) string

+ func EnsureOpenAPIModule(cfg Config) error

+ func ResolveOutputPath(cfg Config) string

+ func RunDriver(driverDir string) ([]byte, string, error)

+ func RunPipeline(cfg Config) ([]byte, []string, error)

+ func Serve(cfg Config, serveCfg ServeConfig) error

+ func WriteAtomic(path string, data []byte) error

+ func WriteDriver(cfg Config, entry Entry, hook *Hook) (string, error)

+ type Config struct

+ AutoAdd bool

+ ConfigExplicit bool

+ ConfigPath string

+ Entry string

+ Format string

+ IncludeTestFiles bool

+ Info InfoConfig

+ KeepDriver bool

+ MetadataHook string

+ Out string

+ SecuritySchemes map[string]Scheme

+ Servers []ServerConfig

+ Sources []string

+ Tags []TagConfig

+ Verbose bool

+ Workdir string

+ func LoadConfig(overrides Overrides) (Config, error)

+ type DriverData struct

+ Entry Entry

+ Format string

+ HasHook bool

+ Hook Hook

+ InfoDescription string

+ OptionSnippets []string

+ ServerDescriptions []string

+ TagSnippets []string

+ func BuildDriverData(cfg Config, entry Entry, hook *Hook) (DriverData, error)

+ type DriverError struct

+ Cause error

+ ExitCode int

+ Phase string

+ Stderr string

+ func (e *DriverError) Error() string

+ type Entry struct

+ FuncName string

+ ImportPath string

+ ReturnsError bool

+ func ResolveEntry(workdir, value string) (Entry, error)

+ type ExternalDocsConfig struct

+ Description string

+ URL string

+ type Hook struct

+ FuncName string

+ ImportPath string

+ func ResolveHook(workdir, value string) (Hook, error)

+ type InfoConfig struct

+ Description string

+ Title string

+ Version string

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type Overrides struct

+ AutoAdd bool

+ AutoAddSet bool

+ ConfigExplicit bool

+ ConfigPath string

+ Entry string

+ EntrySet bool

+ Format string

+ FormatSet bool

+ IncludeTestFiles bool

+ IncludeTestFilesSet bool

+ KeepDriver bool

+ KeepDriverSet bool

+ MetadataHook string

+ MetadataHookSet bool

+ Out string

+ OutSet bool

+ Sources []string

+ SourcesSet bool

+ Verbose bool

+ VerboseSet bool

+ Workdir string

+ WorkdirSet bool

+ type Scheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ type ServeConfig struct

+ Addr string

+ Open bool

+ UIs []string

+ Watch bool

+ type ServerConfig struct

+ Description string

+ URL string

+ type TagConfig struct

+ Description string

+ ExternalDocs *ExternalDocsConfig

+ Name string

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