gindocs

type AuthConfig struct {
	// Type is the authentication method.
	Type AuthType

	// Name is the header or query parameter name (for API key auth).
	Name string

	// In specifies where the API key is sent: "header" or "query" (for API key auth).
	In string

	// Scheme is the HTTP auth scheme (default: "bearer" for Bearer auth).
	Scheme string

	// BearerFormat describes the bearer token format (e.g., "JWT").
	BearerFormat string
}

type AuthType int

type ComponentsObject struct {
	Schemas         map[string]*SchemaObject         `json:"schemas,omitempty"`
	SecuritySchemes map[string]*SecuritySchemeObject `json:"securitySchemes,omitempty"`
	Parameters      map[string]*ParameterObject      `json:"parameters,omitempty"`
	RequestBodies   map[string]*RequestBodyObject    `json:"requestBodies,omitempty"`
	Responses       map[string]*Response             `json:"responses,omitempty"`
}

type Config struct {
	// Prefix is the URL prefix for docs endpoints (default: "/docs").
	Prefix string

	// Title is the API title shown in the docs (default: auto-detect from module name).
	Title string

	// Description is the API description.
	Description string

	// Version is the API version (default: "1.0.0").
	Version string

	// UI selects the documentation UI: UIScalar (default) or UISwagger.
	UI UIType

	// ScalarTheme sets the Scalar UI theme (default: "kepler").
	// Options: alternate, default, moon, purple, solarized, bluePlanet,
	// saturn, kepler, mars, deepSpace, laserwave.
	ScalarTheme string

	// DevMode re-introspects routes on every request when true.
	// Defaults to auto-detection from GIN_MODE.
	DevMode bool

	// ReadOnly disables "Try It" functionality when true.
	ReadOnly bool

	// Auth configures authentication for "Try It" requests.
	Auth AuthConfig

	// Servers lists API server URLs for "Try It" requests.
	Servers []ServerInfo

	// Contact holds API contact information.
	Contact ContactInfo

	// License holds API license information.
	License LicenseInfo

	// Logo is a URL to a custom logo displayed in the UI.
	Logo string

	// ExcludeRoutes is a list of glob patterns for routes to exclude from docs.
	ExcludeRoutes []string

	// ExcludePrefixes is a list of path prefixes for routes to exclude from docs.
	ExcludePrefixes []string

	// Models is a list of GORM model instances to register as schemas.
	Models []interface{}

	// CustomSections adds extra documentation sections rendered as markdown.
	CustomSections []Section

	// CustomCSS is custom CSS injected into the documentation UI.
	CustomCSS string
}

type ContactInfo struct {
	// Name is the contact name.
	Name string

	// URL is the contact URL.
	URL string

	// Email is the contact email.
	Email string
}

type ContactObject struct {
	Name  string `json:"name,omitempty"`
	URL   string `json:"url,omitempty"`
	Email string `json:"email,omitempty"`
}

type DocConfig struct {
	// Summary is the operation summary.
	Summary string
	// Description is the operation description.
	Description string
	// Tags are the operation tags.
	Tags []string
	// RequestBody is the request body type (pass a struct instance).
	RequestBody interface{}
	// Response is the response body type (pass a struct instance).
	Response interface{}
	// ResponseCode is the primary success status code.
	ResponseCode int
	// Deprecated marks the operation as deprecated.
	Deprecated bool
}

type ExternalDocsObject struct {
	Description string `json:"description,omitempty"`
	URL         string `json:"url"`
}

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

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

type Header struct {
	Description string        `json:"description,omitempty"`
	Schema      *SchemaObject `json:"schema,omitempty"`
}

type InfoObject struct {
	Title          string         `json:"title"`
	Description    string         `json:"description,omitempty"`
	TermsOfService string         `json:"termsOfService,omitempty"`
	Contact        *ContactObject `json:"contact,omitempty"`
	License        *LicenseObject `json:"license,omitempty"`
	Version        string         `json:"version"`
}

type InsomniaExport struct {
	Type      string             `json:"_type"`
	Format    int                `json:"__export_format"`
	Source    string             `json:"__export_source"`
	Resources []InsomniaResource `json:"resources"`
}

type InsomniaHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type InsomniaResource struct {
	ID          string           `json:"_id"`
	Type        string           `json:"_type"`
	ParentID    string           `json:"parentId,omitempty"`
	Name        string           `json:"name"`
	Description string           `json:"description,omitempty"`
	URL         string           `json:"url,omitempty"`
	Method      string           `json:"method,omitempty"`
	Body        interface{}      `json:"body,omitempty"`
	Headers     []InsomniaHeader `json:"headers,omitempty"`
}

type LicenseInfo struct {
	// Name is the license name (e.g., "MIT").
	Name string

	// URL is the license URL.
	URL string
}

type LicenseObject struct {
	Name string `json:"name"`
	URL  string `json:"url,omitempty"`
}

type MediaType struct {
	Schema  *SchemaObject `json:"schema,omitempty"`
	Example interface{}   `json:"example,omitempty"`
}

type OpenAPISpec struct {
	OpenAPI      string                `json:"openapi"`
	Info         InfoObject            `json:"info"`
	Servers      []ServerObject        `json:"servers,omitempty"`
	Paths        map[string]*PathItem  `json:"paths"`
	Components   *ComponentsObject     `json:"components,omitempty"`
	Security     []SecurityRequirement `json:"security,omitempty"`
	Tags         []TagObject           `json:"tags,omitempty"`
	ExternalDocs *ExternalDocsObject   `json:"externalDocs,omitempty"`
}

type OperationObject struct {
	Tags         []string              `json:"tags,omitempty"`
	Summary      string                `json:"summary,omitempty"`
	Description  string                `json:"description,omitempty"`
	OperationID  string                `json:"operationId,omitempty"`
	Parameters   []ParameterObject     `json:"parameters,omitempty"`
	RequestBody  *RequestBodyObject    `json:"requestBody,omitempty"`
	Responses    map[string]*Response  `json:"responses"`
	Security     []SecurityRequirement `json:"security,omitempty"`
	Deprecated   bool                  `json:"deprecated,omitempty"`
	ExternalDocs *ExternalDocsObject   `json:"externalDocs,omitempty"`
}

type ParameterObject struct {
	Name        string        `json:"name"`
	In          string        `json:"in"` // "query", "header", "path", "cookie"
	Description string        `json:"description,omitempty"`
	Required    bool          `json:"required,omitempty"`
	Deprecated  bool          `json:"deprecated,omitempty"`
	Schema      *SchemaObject `json:"schema,omitempty"`
	Example     interface{}   `json:"example,omitempty"`
}

type PathItem struct {
	Get     *OperationObject `json:"get,omitempty"`
	Post    *OperationObject `json:"post,omitempty"`
	Put     *OperationObject `json:"put,omitempty"`
	Patch   *OperationObject `json:"patch,omitempty"`
	Delete  *OperationObject `json:"delete,omitempty"`
	Head    *OperationObject `json:"head,omitempty"`
	Options *OperationObject `json:"options,omitempty"`
}

type PostmanBody struct {
	Mode    string              `json:"mode"`
	Raw     string              `json:"raw,omitempty"`
	Options *PostmanBodyOptions `json:"options,omitempty"`
}

type PostmanBodyOptions struct {
	Raw PostmanRawOptions `json:"raw"`
}

type PostmanCollection struct {
	Info PostmanInfo   `json:"info"`
	Item []PostmanItem `json:"item"`
}

type PostmanHeader struct {
	Key   string `json:"key"`
	Value string `json:"value"`
	Type  string `json:"type"`
}

type PostmanInfo struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Schema      string `json:"schema"`
}

type PostmanItem struct {
	Name    string          `json:"name"`
	Item    []PostmanItem   `json:"item,omitempty"`
	Request *PostmanRequest `json:"request,omitempty"`
}

type PostmanRawOptions struct {
	Language string `json:"language"`
}

type PostmanRequest struct {
	Method      string          `json:"method"`
	Header      []PostmanHeader `json:"header,omitempty"`
	Body        *PostmanBody    `json:"body,omitempty"`
	URL         PostmanURL      `json:"url"`
	Description string          `json:"description,omitempty"`
}

type PostmanURL struct {
	Raw      string   `json:"raw"`
	Protocol string   `json:"protocol,omitempty"`
	Host     []string `json:"host,omitempty"`
	Path     []string `json:"path,omitempty"`
}

type RelType int

type RelationshipInfo struct {
	// FieldName is the struct field name.
	FieldName string
	// Type is the relationship type.
	Type RelType
	// RelatedModel is the name of the related model.
	RelatedModel string
}

type RequestBodyObject struct {
	Description string               `json:"description,omitempty"`
	Content     map[string]MediaType `json:"content"`
	Required    bool                 `json:"required,omitempty"`
}

type Response struct {
	Description string               `json:"description"`
	Content     map[string]MediaType `json:"content,omitempty"`
	Headers     map[string]*Header   `json:"headers,omitempty"`
}

type RouteMetadata struct {
	// Method is the HTTP method (GET, POST, PUT, PATCH, DELETE, etc.).
	Method string

	// Path is the Gin route path (e.g., "/api/users/:id").
	Path string

	// OpenAPIPath is the path converted to OpenAPI format (e.g., "/api/users/{id}").
	OpenAPIPath string

	// HandlerName is the fully qualified handler function name.
	HandlerName string

	// PathParams lists path parameter names extracted from the route.
	PathParams []string

	// Tags are auto-detected operation tags (from route groups).
	Tags []string
}

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

type SchemaObject struct {
	// Reference
	Ref string `json:"$ref,omitempty"`

	// Type
	Type   string `json:"type,omitempty"`
	Format string `json:"format,omitempty"`

	// Metadata
	Title       string      `json:"title,omitempty"`
	Description string      `json:"description,omitempty"`
	Default     interface{} `json:"default,omitempty"`
	Example     interface{} `json:"example,omitempty"`
	Deprecated  bool        `json:"deprecated,omitempty"`
	ReadOnly    bool        `json:"readOnly,omitempty"`
	WriteOnly   bool        `json:"writeOnly,omitempty"`
	Nullable    bool        `json:"nullable,omitempty"`

	// Validation — numbers
	Minimum          *float64 `json:"minimum,omitempty"`
	Maximum          *float64 `json:"maximum,omitempty"`
	ExclusiveMinimum *float64 `json:"exclusiveMinimum,omitempty"`
	ExclusiveMaximum *float64 `json:"exclusiveMaximum,omitempty"`
	MultipleOf       *float64 `json:"multipleOf,omitempty"`

	// Validation — strings
	MinLength *int   `json:"minLength,omitempty"`
	MaxLength *int   `json:"maxLength,omitempty"`
	Pattern   string `json:"pattern,omitempty"`

	// Validation — arrays
	Items    *SchemaObject `json:"items,omitempty"`
	MinItems *int          `json:"minItems,omitempty"`
	MaxItems *int          `json:"maxItems,omitempty"`

	// Validation — objects
	Properties           map[string]*SchemaObject `json:"properties,omitempty"`
	Required             []string                 `json:"required,omitempty"`
	AdditionalProperties *SchemaObject            `json:"additionalProperties,omitempty"`

	// Enum
	Enum []interface{} `json:"enum,omitempty"`

	// Composition
	AllOf []*SchemaObject `json:"allOf,omitempty"`
	OneOf []*SchemaObject `json:"oneOf,omitempty"`
	AnyOf []*SchemaObject `json:"anyOf,omitempty"`
}

type Section struct {
	// Title is the section heading.
	Title string

	// Content is the section body in markdown.
	Content string
}

type SecurityRequirement map[string][]string

type SecuritySchemeObject struct {
	Type         string `json:"type"`
	Description  string `json:"description,omitempty"`
	Name         string `json:"name,omitempty"`   // for apiKey
	In           string `json:"in,omitempty"`     // for apiKey: "header", "query", "cookie"
	Scheme       string `json:"scheme,omitempty"` // for http: "bearer", "basic"
	BearerFormat string `json:"bearerFormat,omitempty"`
}

type ServerInfo struct {
	// URL is the server URL.
	URL string

	// Description describes this server.
	Description string
}

type ServerObject struct {
	URL         string `json:"url"`
	Description string `json:"description,omitempty"`
}

type TagInfo struct {
	// JSON tag
	JSONName  string
	OmitEmpty bool
	JSONSkip  bool

	// Binding/validate tag
	Required    bool
	MinLength   *int
	MaxLength   *int
	Minimum     *float64
	Maximum     *float64
	Enum        []string
	Format      string // e.g., "email", "uri", "uuid"
	Pattern     string
	BindingSkip bool

	// GORM tag
	PrimaryKey     bool
	AutoCreateTime bool
	AutoUpdateTime bool
	GORMSize       *int
	GORMDefault    *string
	UniqueIndex    bool
	GORMSkip       bool
	GORMType       string

	// Docs tag
	Description string
	Example     string
	Deprecated  bool
	Hidden      bool
	DocsFormat  string
	DocsEnum    []string
}

type TagObject struct {
	Name         string              `json:"name"`
	Description  string              `json:"description,omitempty"`
	ExternalDocs *ExternalDocsObject `json:"externalDocs,omitempty"`
}

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

type UIType int