openapi

type Config struct {
	OpenAPIVersion  string                     // OpenAPI version, e.g., "3.1.0"
	Title           string                     // Title of the API
	Version         string                     // Version of the API
	Description     *string                    // Optional description of the API
	Contact         *Contact                   // Contact information for the API
	License         *License                   // License information for the API
	Servers         []Server                   // List of servers for the API
	SecuritySchemes map[string]*SecurityScheme // Security schemes for the API
	Tags            []Tag                      // Tags for the API
	ExternalDocs    *ExternalDocs              // External documentation for the API

	ReflectorConfig *ReflectorConfig // Configuration for the OpenAPI reflector

	DisableOpenAPI bool
	BaseURL        string
	DocsPath       string
	SwaggerConfig  *SwaggerConfig
	Logger         Logger
}

type Contact struct {
	Name          string
	URL           string         // Format: uri.
	Email         string         // Format: email.
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type ExternalDocs struct {
	Description string
	// Format: uri.
	// Required.
	URL           string
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type InterceptDefNameFunc func(t reflect.Type, defaultDefName string) string

type InterceptPropFunc func(params InterceptPropParams) error

type InterceptPropParams struct {
	Context        *jsonschema.ReflectContext
	Path           []string
	Name           string
	Field          reflect.StructField
	PropertySchema *jsonschema.Schema
	ParentSchema   *jsonschema.Schema
	Processed      bool
}

type InterceptSchemaFunc func(params InterceptSchemaParams) (stop bool, err error)

type InterceptSchemaParams struct {
	Context   *jsonschema.ReflectContext
	Value     reflect.Value
	Schema    *jsonschema.Schema
	Processed bool
}

type License struct {
	Name          string // Required.
	Identifier    string
	URL           string         // Format: uri.
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type Logger interface {
	Printf(format string, v ...any)
}

type OAuthFlows struct {
	Implicit          *OAuthFlowsDefsImplicit
	Password          *OAuthFlowsDefsPassword
	ClientCredentials *OAuthFlowsDefsClientCredentials
	AuthorizationCode *OAuthFlowsDefsAuthorizationCode
	MapOfAnything     map[string]any // Key must match pattern: `^x-`.
}

type OAuthFlowsDefsAuthorizationCode struct {
	// Format: uri.
	// Required.
	AuthorizationURL string
	// Format: uri.
	// Required.
	TokenURL      string
	RefreshURL    *string           // Format: uri.
	Scopes        map[string]string // Required.
	MapOfAnything map[string]any    // Key must match pattern: `^x-`.
}

type OAuthFlowsDefsClientCredentials struct {
	// Format: uri.
	// Required.
	TokenURL      string
	RefreshURL    *string           // Format: uri.
	Scopes        map[string]string // Required.
	MapOfAnything map[string]any    // Key must match pattern: `^x-`.
}

type OAuthFlowsDefsImplicit struct {
	// Format: uri.
	// Required.
	AuthorizationURL string
	RefreshURL       *string           // Format: uri.
	Scopes           map[string]string // Required.
	MapOfAnything    map[string]any    // Key must match pattern: `^x-`.
}

type OAuthFlowsDefsPassword struct {
	// Format: uri.
	// Required.
	TokenURL      string
	RefreshURL    *string           // Format: uri.
	Scopes        map[string]string // Required.
	MapOfAnything map[string]any    // Key must match pattern: `^x-`.
}

type ReflectorConfig struct {
	InlineRefs           bool                 // Whether to inline references in schemas
	RootRef              bool                 // Whether to use a root reference
	RootNullable         bool                 // Whether to allow root schemas to be nullable
	StripDefNamePrefix   []string             // Prefixes to strip from definition names
	InterceptDefNameFunc InterceptDefNameFunc // Function to customize schema definition names
	InterceptPropFunc    InterceptPropFunc    // Function to intercept property schema generation
	InterceptSchemaFunc  InterceptSchemaFunc  // Function to intercept schema generation
	TypeMappings         []TypeMapping        // Custom type mappings for OpenAPI generation
}

type SecurityScheme struct {
	Description   *string
	APIKey        *SecuritySchemeAPIKey
	HTTPBearer    *SecuritySchemeHTTPBearer
	OAuth2        *SecuritySchemeOAuth2
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type SecuritySchemeAPIKey struct {
	Name string                 // Required.
	In   SecuritySchemeAPIKeyIn // Required.
}

type SecuritySchemeAPIKeyIn string

type SecuritySchemeHTTPBearer struct {
	// Value must match pattern: `^[Bb][Ee][Aa][Rr][Ee][Rr]$`.
	// Required.
	Scheme       string  `json:"scheme"`
	BearerFormat *string `json:"bearerFormat,omitempty"`
}

type SecuritySchemeOAuth2 struct {
	Flows OAuthFlows // Required.
}

type Server struct {
	// Format: uri-reference.
	// Required.
	URL           string
	Description   *string
	Variables     map[string]ServerVariable
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type ServerVariable struct {
	Enum          []string
	Default       string // Required.
	Description   string
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type SwaggerConfig struct {
	ShowTopBar         bool
	HideCurl           bool
	JsonEditor         bool
	PreAuthorizeApiKey map[string]string

	// SettingsUI contains keys and plain javascript values of SwaggerUIBundle configuration.
	// Overrides default values.
	// See https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ for available options.
	SettingsUI map[string]string

	// Proxy enables proxying requests through swgui handler.
	// Can be useful if API is not directly available due to CORS policy.
	Proxy bool
}

type Tag struct {
	Name          string // Required.
	Description   string
	ExternalDocs  *ExternalDocs
	MapOfAnything map[string]any // Key must match pattern: `^x-`.
}

type TypeMapping struct {
	Src any // Source type
	Dst any // Destination type
}