generator

type Config struct {
	Title       string
	Version     string
	Description string
	Servers     []string // server URLs; empty -> a single relative-root "/"
	License     *License
	// DisableTenantSecurity omits the X-Tenant-ID security scheme + root security
	// (for single-tenant services).
	DisableTenantSecurity bool
	// TenantHeader overrides the header name in the tenant security scheme
	// (default X-Tenant-ID; go-bricks header resolvers are configurable).
	TenantHeader string
}

type License struct {
	Name string
	URL  string
}

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

type OpenAPIInfo struct {
	Title       string          `yaml:"title"`
	Version     string          `yaml:"version"`
	Description string          `yaml:"description"`
	License     *openAPILicense `yaml:"license,omitempty"`
}

type OpenAPIMediaType struct {
	Schema *OpenAPIProperty `yaml:"schema"`
}

type OpenAPIOperation struct {
	OperationID string                      `yaml:"operationId"`
	Summary     string                      `yaml:"summary"`
	Description string                      `yaml:"description,omitempty"`
	Tags        []string                    `yaml:"tags,omitempty"`
	Parameters  []Parameter                 `yaml:"parameters,omitempty"`
	RequestBody *OpenAPIRequestBody         `yaml:"requestBody,omitempty"`
	Responses   map[string]*OpenAPIResponse `yaml:"responses"`
	// Security overrides the root security requirement for this operation.
	// nil => inherit the document-level security; a non-nil empty slice =>
	// emit `security: []` (no auth), used for tenant-agnostic routes.
	Security *[]map[string][]string `yaml:"security,omitempty"`
}

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

type OpenAPIProperty struct {
	Type string `yaml:"type,omitempty"`
	// AllOf wraps a $ref that must also carry sibling keywords (e.g. nullable):
	// in OpenAPI 3.0 a $ref ignores its siblings, so `allOf: [{$ref}]` plus the
	// sibling keyword is the encoding that actually applies.
	AllOf                []*OpenAPIProperty          `yaml:"allOf,omitempty"`
	Properties           map[string]*OpenAPIProperty `yaml:"properties,omitempty"`           // For inline objects (e.g. the data/meta envelope)
	AdditionalProperties *OpenAPIProperty            `yaml:"additionalProperties,omitempty"` // For maps (the value schema)
	Format               string                      `yaml:"format,omitempty"`
	Description          string                      `yaml:"description,omitempty"`
	Example              any                         `yaml:"example,omitempty"`
	Ref                  string                      `yaml:"$ref,omitempty"`
	Items                *OpenAPIProperty            `yaml:"items,omitempty"` // For arrays
	MinLength            *int                        `yaml:"minLength,omitempty"`
	MaxLength            *int                        `yaml:"maxLength,omitempty"`
	MinItems             *int                        `yaml:"minItems,omitempty"` // For arrays (slice cardinality)
	MaxItems             *int                        `yaml:"maxItems,omitempty"`
	MinProperties        *int                        `yaml:"minProperties,omitempty"` // For maps (entry-count cardinality)
	MaxProperties        *int                        `yaml:"maxProperties,omitempty"`
	Minimum              *float64                    `yaml:"minimum,omitempty"`
	Maximum              *float64                    `yaml:"maximum,omitempty"`
	ExclusiveMinimum     *bool                       `yaml:"exclusiveMinimum,omitempty"`
	ExclusiveMaximum     *bool                       `yaml:"exclusiveMaximum,omitempty"`
	Pattern              string                      `yaml:"pattern,omitempty"`
	Enum                 []any                       `yaml:"enum,omitempty"`
	Nullable             bool                        `yaml:"nullable,omitempty"`
}

type OpenAPIRequestBody struct {
	Required    bool                         `yaml:"required"`
	Description string                       `yaml:"description,omitempty"`
	Content     map[string]*OpenAPIMediaType `yaml:"content"`
}

type OpenAPIResponse struct {
	Description string                       `yaml:"description"`
	Content     map[string]*OpenAPIMediaType `yaml:"content,omitempty"`
}

type OpenAPISchema struct {
	Type        string                      `yaml:"type"`
	Properties  map[string]*OpenAPIProperty `yaml:"properties,omitempty"`
	Required    []string                    `yaml:"required,omitempty"`
	Description string                      `yaml:"description,omitempty"`
}

type Parameter struct {
	Name        string           `yaml:"name"`
	In          string           `yaml:"in"` // "path", "query", "header"
	Required    bool             `yaml:"required"`
	Description string           `yaml:"description,omitempty"`
	Schema      *OpenAPIProperty `yaml:"schema"`
	Example     any              `yaml:"example,omitempty"`
}