specification

type Components struct {
	Schemas ComponentsSchemas

	Headers       Map[Ref[Header]]
	RequestBodies Map[Ref[RequestBody]]
	Responses     Map[Ref[Response]]

	// ---------------- Parameters ----------------
	QueryParameters  Map[Ref[QueryParameter]]
	HeaderParameters Map[Ref[HeaderParameter]]
	PathParameters   Map[Ref[PathParameter]]
	CookieParameters Map[Ref[CookieParameter]]

	SecuritySchemes SecuritySchemes
	Links           Map[Ref[Link]]
	PathItems       Map[Ref[PathItem]]
}

type ComponentsSchemas = Map[Ref[Schema]]

type Contact struct {
	Name  string
	URL   string
	Email string
}

type CookieParameter struct {
	NoRef[CookieParameter]

	Name        string
	Description string
	Required    bool
	Deprecated  bool

	Style   string
	Explode Maybe[bool]

	Schema Ref[Schema]
}

type HTTPMethod string

type HTTPMethodTitle string

type Header struct {
	NoRef[Header]

	Description string
	Required    bool
	Deprecated  bool

	Schema Ref[Schema]
}

type HeaderOld struct {
	Spec *openapi3.Header
	Ref  string

	Name      string
	SchemaRef *openapi3.SchemaRef

	Description string
	Required    bool
	Deprecated  bool
}

type HeaderParameter struct {
	NoRef[HeaderParameter]

	Name        string
	Description string
	Required    bool
	Deprecated  bool

	Style   string
	Explode Maybe[bool]

	Schema Ref[Schema]
}

type HeaderParameterOld struct {
	RefName     string
	Name        string
	Description string
	Required    bool
	Schema      Ref[Schema]
}

type Info struct {
	Title          string
	Summary        string
	Description    string
	TermsOfService string
	Contact        Contact
	License        License
	Version        string
}

type License struct {
	Name       string
	Identifier string
	URL        string
}

type Link struct {
	NoRef[Link]
}

type Map[T any] struct {
	List []*Object[string, T]
	// contains filtered or unexported fields
}

type Maybe[T any] struct {
	Set   bool
	Value T
}

type MediaType struct {
	Schema Ref[Schema]
}

type NoRef[T any] struct{}

type OAuthFlow struct {
	AuthorizationURL string
	TokenURL         string
	RefreshURL       string
	Scopes           Map[string]
}

type OAuthFlows struct {
	Implicit          Maybe[OAuthFlow]
	Password          Maybe[OAuthFlow]
	ClientCredentials Maybe[OAuthFlow]
	AuthorizationCode Maybe[OAuthFlow]
}

type Object[K, T any] struct {
	Name K
	V    T
}

type Operation struct {
	PathItem *PathItem

	Path Path

	Tags        []string
	Summary     string
	Description string
	OperationID string

	Parameters OperationParameters

	RequestBody Maybe[Ref[RequestBody]]

	HTTPMethod HTTPMethod
	Method     HTTPMethodTitle

	Operation *openapi3.Operation

	Security SecurityRequirements

	Responses Map[Ref[Response]]
}

type OperationParameters struct {
	Query   Map[Ref[QueryParameter]]
	Headers Map[Ref[HeaderParameter]]
	Path    Map[Ref[PathParameter]]
	Cookie  Map[Ref[CookieParameter]]
}

type Path struct {
	Raw  string
	Dirs []*PathDir
	Refs Map[*PathDir]
}

type PathDir struct {
	V          string
	IsVariable bool
	Param      Ref[PathParameter]
}

type PathDirOld struct {
	Raw      Prefix
	ParamRef *PathParameterOld
}

type PathItem struct {
	NoRef[PathItem]

	RawPath    string // TODO
	Operations []*Operation

	// Deprecated // TODO
	Path     PathOld2
	PathItem *openapi3.PathItem
}

type PathOld2 struct {
	Spec   string
	Dirs   []*PathDirOld
	Params PathParameters
}

type PathParameter struct {
	NoRef[PathParameter]

	Name        string
	Description string
	Deprecated  bool

	Style   string
	Explode Maybe[bool]

	Schema Ref[Schema]
}

type PathParameterOld struct {
	RefName     string
	Name        string
	Description string
	Schema      Ref[Schema]
}

type PathParameters []*PathParameterOld

type Prefix string

type QueryParameter struct {
	NoRef[QueryParameter]

	Name            string
	Description     string
	Required        bool
	Deprecated      bool
	AllowEmptyValue bool

	Style         string
	Explode       Maybe[bool]
	AllowReserved bool

	Schema Ref[Schema]
}

type QueryParameterOld struct {
	RefName     string
	Name        string
	Description string
	Required    bool
	Schema      Ref[Schema]
}

type Ref[T any] interface {
	Ref() *Object[string, Ref[T]]
	Value() *T
}

type RefKey string

type RefObject[T any] struct {
	V *Object[string, Ref[T]]
}

type RequestBody struct {
	NoRef[RequestBody]

	Description string
	Content     Map[*MediaType]
	Required    bool
}

type Response struct {
	NoRef[Response]

	Description string
	Headers     Map[Ref[Header]]
	Content     Map[*MediaType]
	Links       Map[Ref[Link]]

	UsedIn []ResponseUsedIn
}

type ResponseOld struct {
	StatusCode string
	Operation  *Operation
	Spec       *openapi3.Response

	RefName string
	Headers []HeaderOld
}

type ResponseUsedIn struct {
	Operation *Operation
	Status    string
}

type Schema struct {
	NoRef[Schema]

	Type        string
	Format      string
	Items       Ref[Schema]
	Properties  []SchemaProperty
	AllOf       []Ref[Schema]
	Description string

	AdditionalProperties Maybe[Ref[Schema]]

	Custom Maybe[string]
}

type SchemaProperty struct {
	Name   string
	Schema Ref[Schema]
}

type Security struct {
	Requirement []string
	Scheme      openapi3.SecurityScheme
}

type SecurityRequirement struct {
	Scheme       *SecurityScheme
	Requirements []string
}

type SecurityRequirements []SecurityRequirement

type SecurityScheme struct {
	NoRef[SecurityScheme]

	// Any
	Type        SecuritySchemeType
	Description string

	// apiKey
	Name string
	In   SecuritySchemeIn

	// http
	Scheme       string
	BearerFormat string

	// oauth2
	Flows OAuthFlows

	// openIdConnect
	OpenIDConnectURL string
}

type SecuritySchemeIn string

type SecuritySchemeType string

type SecuritySchemes = Map[Ref[SecurityScheme]]

type Server struct {
	URL         string
	Description string
	Variables   Map[ServerVariable]
}

type ServerVariable struct {
	Enum        []string
	Default     string
	Description string
}

type Sourcer[T any] interface {
	Get(string) (*Object[string, Ref[T]], bool)
}

type SourcerFunc[T any] func(string) (*Object[string, Ref[T]], bool)

type Spec struct {
	OpenAPI string
	Info    Info
	Servers []Server

	PathItems  []*PathItem
	Operations []*Operation

	Components Components

	Security []SecurityRequirement
}