swagger

type AnnotationParser struct {
	// contains filtered or unexported fields
}

type ApiServerConfig struct {
	Host     string `json:"host" yaml:"host"`           // e.g. "localhost:8080" (lynx-http listen address)
	BasePath string `json:"base_path" yaml:"base_path"` // e.g. "/api/v1"
}

type Field struct {
	Name     string
	Type     string
	Tag      string
	Required bool
	Doc      string
}

type FileWatcher struct {
	// contains filtered or unexported fields
}

type FileWatcherConfig struct {
	Enabled       bool          `json:"enabled" yaml:"enabled"`
	Interval      time.Duration `json:"interval" yaml:"interval"`
	DebounceDelay time.Duration `json:"debounce_delay" yaml:"debounce_delay"`
	MaxRetries    int           `json:"max_retries" yaml:"max_retries"`
	RetryDelay    time.Duration `json:"retry_delay" yaml:"retry_delay"`
	BatchSize     int           `json:"batch_size" yaml:"batch_size"`
	HealthCheck   bool          `json:"health_check" yaml:"health_check"`
}

type GenConfig struct {
	Enabled     bool              `json:"enabled" yaml:"enabled"`
	ScanDirs    []string          `json:"scan_dirs" yaml:"scan_dirs"`
	SpecFiles   []string          `json:"spec_files" yaml:"spec_files"` // External OpenAPI/Swagger files (YAML or JSON, OAS2 or OAS3)
	OutputPath  string            `json:"output_path" yaml:"output_path"`
	WatchFiles  bool              `json:"watch_files" yaml:"watch_files"`
	FileWatcher FileWatcherConfig `json:"file_watcher" yaml:"file_watcher"`
}

type Generator struct {
	// contains filtered or unexported fields
}

type HeaderInfo struct {
	Type        string
	Format      string
	Description string
}

type InfoConfig struct {
	Title          string `json:"title" yaml:"title"`
	Description    string `json:"description" yaml:"description"`
	Version        string `json:"version" yaml:"version"`
	TermsOfService string `json:"termsOfService" yaml:"termsOfService"`
	Contact        struct {
		Name  string `json:"name" yaml:"name"`
		Email string `json:"email" yaml:"email"`
		URL   string `json:"url" yaml:"url"`
	} `json:"contact" yaml:"contact"`
	License struct {
		Name string `json:"name" yaml:"name"`
		URL  string `json:"url" yaml:"url"`
	} `json:"license" yaml:"license"`
}

type ModelInfo struct {
	Name        string
	Description string
	Properties  map[string]PropertyInfo
	Required    []string
}

type Package struct {
	Name    string
	Structs map[string]*Struct
}

type ParamInfo struct {
	Name        string
	In          string // path, query, header, body, formData
	Type        string
	Format      string
	Required    bool
	Description string
	Default     any
	Example     any
}

type Parameter struct {
	Name        string
	In          string
	Type        string
	Required    bool
	Description string
	Example     string
}

type ParseError struct {
	File    string
	Line    int
	Message string
	Type    string
	Time    time.Time
}

type ParseStats struct {
	TotalFiles   int
	SuccessFiles int
	FailedFiles  int
	TotalLines   int
	ParsedRoutes int
	ParsedModels int
	Errors       []ParseError
	StartTime    time.Time
	EndTime      time.Time
}

type Parser struct {
	// contains filtered or unexported fields
}

type PlugSwagger struct {
	*plugins.BasePlugin
	// contains filtered or unexported fields
}

type PropertyInfo struct {
	Type        string
	Format      string
	Description string
	Example     any
	Enum        []any
	Minimum     *float64
	Maximum     *float64
	MinLength   *int64
	MaxLength   *int64
	Pattern     string
}

type Response struct {
	Description string
	Schema      any
	Examples    map[string]any
}

type ResponseInfo struct {
	Description string
	Schema      *SchemaInfo
	Headers     map[string]HeaderInfo
}

type Route struct {
	Method      string
	Path        string
	Handler     string
	Summary     string
	Description string
	Tags        []string
	Parameters  []Parameter
	Responses   map[string]Response
}

type RouteInfo struct {
	Method      string
	Path        string
	Summary     string
	Description string
	Tags        []string
	Params      []ParamInfo
	Responses   map[int]ResponseInfo
	Security    []map[string][]string
}

type SchemaInfo struct {
	Type       string
	Format     string
	Ref        string
	Properties map[string]*SchemaInfo
	Items      *SchemaInfo
	Required   []string
}

type SecurityConfig struct {
	Environment    string   `json:"environment" yaml:"environment"`
	AllowedEnvs    []string `json:"allowed_environments" yaml:"allowed_environments"`
	DisableInProd  bool     `json:"disable_in_production" yaml:"disable_in_production"`
	TrustedOrigins []string `json:"trusted_origins" yaml:"trusted_origins"`
	RequireAuth    bool     `json:"require_auth" yaml:"require_auth"`
	// AuthToken, when set, is the expected bearer token presented via the
	// "Authorization: Bearer <token>" header when RequireAuth is true.
	AuthToken string `json:"auth_token" yaml:"auth_token"`
	// AuthUsername/AuthPassword, when set, enable HTTP Basic auth as an
	// alternative to AuthToken when RequireAuth is true.
	AuthUsername string `json:"auth_username" yaml:"auth_username"`
	AuthPassword string `json:"auth_password" yaml:"auth_password"`
}

type StringBuilderPool struct {
	// contains filtered or unexported fields
}

type Struct struct {
	Name   string
	Fields []Field
	Doc    string
}

type SwaggerConfig struct {
	Enabled   bool            `json:"enabled" yaml:"enabled"`
	Info      InfoConfig      `json:"info" yaml:"info"`
	UI        UIConfig        `json:"ui" yaml:"ui"`
	Gen       GenConfig       `json:"generator" yaml:"generator"`
	Security  SecurityConfig  `json:"security" yaml:"security"`
	ApiServer ApiServerConfig `json:"api_server" yaml:"api_server"` // API server for Swagger UI "Try it out" (lynx-http address)
}

type UIConfig struct {
	Path                     string `json:"path" yaml:"path"`
	Enabled                  bool   `json:"enabled" yaml:"enabled"`
	DeepLinking              bool   `json:"deepLinking" yaml:"deepLinking"`
	DisplayRequestDuration   bool   `json:"displayRequestDuration" yaml:"displayRequestDuration"`
	DocExpansion             string `json:"docExpansion" yaml:"docExpansion"`
	DefaultModelsExpandDepth int    `json:"defaultModelsExpandDepth" yaml:"defaultModelsExpandDepth"`
	Port                     int    `json:"port" yaml:"port"`
	// BindAddress is the network interface the UI server listens on. When
	// empty it defaults to 127.0.0.1 (loopback only). Set explicitly to
	// "0.0.0.0" (or a specific external interface) to expose the UI beyond
	// the local host. ExposeExternally must also be true for any non-loopback bind.
	BindAddress string `json:"bind_address" yaml:"bind_address"`
	// ExposeExternally must be explicitly set to true to allow binding to a
	// non-loopback address. This is an opt-in guard against accidentally
	// serving the API spec/UI on all interfaces.
	ExposeExternally bool `json:"expose_externally" yaml:"expose_externally"`
}