v2

type APIKeySecurityScheme struct {
	SecuritySchemeFields `yaml:",inline"`
	Name                 string // required
	In                   string // required
}

type AllOfSchema struct {
	SchemaFields `yaml:",inline"`
	AllOf        []Schema `yaml:"allOf"`
}

type ArrayFields struct {
	CollectionFormat *string `yaml:"collectionFormat"`

	Default interface{}
	Enum    *[]interface{}

	MaxItems    *uint64
	MinItems    *uint64
	UniqueItems bool
}

type ArrayHeader struct {
	HeaderFields `yaml:",inline"`
	ArrayItem    `yaml:",inline"`
}

type ArrayItem struct {
	ArrayFields `yaml:",inline"`
	Items       Items // required
}

type ArrayParameter struct {
	ParameterFields `yaml:",inline"`
	ArrayItem       `yaml:",inline"`
	AllowEmptyValue bool
}

type ArraySchema struct {
	SchemaFields `yaml:",inline"`
	ArrayFields  `yaml:",inline"`
	Items        Schema // required
}

type BasicSecurityScheme struct {
	SecuritySchemeFields `yaml:",inline"`
}

type BodyParameter struct {
	ParameterFields `yaml:",inline"`
	Schema          Schema // required
}

type BooleanHeader struct {
	HeaderFields `yaml:",inline"`
	BooleanItem  `yaml:",inline"`
}

type BooleanItem struct {
	Default *bool
	Enum    *[]bool
}

type BooleanParameter struct {
	ParameterFields `yaml:",inline"`
	BooleanItem     `yaml:",inline"`
	AllowEmptyValue bool
}

type BooleanSchema struct {
	SchemaFields `yaml:",inline"`
	BooleanItem  `yaml:",inline"`
}

type Contact struct {
	Name  *string
	URL   *url.URL
	Email *string
}

type Document struct {
	Version string // required
	Info    *Info  // required

	Host     *string
	BasePath *string `yaml:"basePath"`
	Schemes  []string
	Consumes []string
	Produces []string

	Paths map[string]PathItem // required

	Definitions *SchemaMap
	Parameters  *ParameterMap
	Responses   *map[string]Response

	SecurityDefinitions *SecuritySchemeMap `yaml:"securityDefinitions"`
	Security            []map[string][]string

	Tags          []Tag
	Documentation *ExternalDocumentation
}

type ExternalDocumentation struct {
	Description *string
	URL         *url.URL // required
}

type FileParameter struct {
	ParameterFields `yaml:",inline"`
	AllowEmptyValue bool
}

type Header interface {
	Description() *string
	Items
}

type HeaderFields struct {
	Description *string
}

type Info struct {
	Title       string // required
	Description *string

	TermsOfService *string
	Contact        *Contact
	License        *License

	Version string // required
}

type IntegerHeader struct {
	HeaderFields `yaml:",inline"`
	IntegerItem  `yaml:",inline"`
}

type IntegerItem struct {
	Format *string

	Default *int64
	Enum    *[]int64

	Maximum          *int64
	ExclusiveMaximum bool
	Minium           *int64
	ExclusiveMinimum bool
	MultipleOf       *int64
}

type IntegerParameter struct {
	ParameterFields `yaml:",inline"`
	IntegerItem     `yaml:",inline"`
	AllowEmptyValue bool
}

type IntegerSchema struct {
	SchemaFields `yaml:",inline"`
	IntegerItem  `yaml:",inline"`
}

type Items interface {
	Type() string // required
}

type License struct {
	Name string // required
	URL  *url.URL
}

type NullSchema struct {
	SchemaFields `yaml:",inline"`
}

type NumberHeader struct {
	HeaderFields `yaml:",inline"`
	NumberItem   `yaml:",inline"`
}

type NumberItem struct {
	Format *string

	Default *float64
	Enum    *[]float64

	Maximum          *float64
	ExclusiveMaximum bool
	Minium           *float64
	ExclusiveMinimum bool
	MultipleOf       *float64
}

type NumberParameter struct {
	ParameterFields `yaml:",inline"`
	NumberItem      `yaml:",inline"`
	AllowEmptyValue bool
}

type NumberSchema struct {
	SchemaFields `yaml:",inline"`
	NumberItem   `yaml:",inline"`
}

type OAuth2SecurityScheme struct {
	SecuritySchemeFields `yaml:",inline"`
	Flow                 string // required

	AuthorizationURL *url.URL `yaml:"authorizationUrl"` // required for implicit or accessCode flows
	TokenURL         *url.URL `yaml:"tokenUrl"`         // required for password, application, and accessCode flows.

	Scopes map[string]string // required
}

type ObjectSchema struct {
	SchemaFields  `yaml:",inline"`
	Descriminator *string

	Properties *SchemaMap
	Required   *[]string

	AdditionalProperties    Schema `yaml:"additionalProperties"` // null if defined as false
	AnyAdditionalProperties bool   // if additionalProperties is true, this is set

	MinProperties *uint64
	MaxProperties *uint64
}

type Operation struct {
	Tags []string

	Summary       *string
	Description   *string
	Documentation *ExternalDocumentation

	OperationID *string

	Consumes []string
	Produces []string

	Parameters Parameters
	Responses  *Responses // required

	Schemes []string

	Deprecated bool

	Security []map[string][]string
}

type Parameter interface {
	GetName() string // required
	GetIn() string   // required
	GetDescription() *string
	IsRequired() bool
}

type ParameterFields struct {
	Name        string // required
	In          string // required
	Description *string
	Required    bool
}

type ParameterMap map[string]Parameter

type Parameters []Parameter

type PathItem struct {
	Reference *string

	Get     *Operation
	Put     *Operation
	Post    *Operation
	Delete  *Operation
	Options *Operation
	Head    *Operation
	Patch   *Operation

	Parameters Parameters
}

type ReferenceParamter struct {
	Reference string `yaml:"$ref"`
}

type ReferenceSchema struct {
	Reference string `yaml:"$ref"` // required
}

type Response struct {
	Reference   string `yaml:"$ref"` // XXX should be distinct type?
	Description string // required
	Schema      Schema
	Headers     map[string]Header
	Examples    map[string]interface{} // mime type to anything
}

type Responses struct {
	Default *Response
	Codes   map[int]Response
}

type Schema interface {
	GetTitle() *string
	GetDescription() *string
	GetDocumentation() *ExternalDocumentation
	GetExample() interface{}
}

type SchemaFields struct {
	Title         *string
	Description   *string
	Documentation *ExternalDocumentation
	Example       interface{}

	ReadOnly bool        // valid only for items under properties
	XML      interface{} // valid only for items under properties
}

type SchemaMap []struct {
	Name   string
	Schema Schema
}

type SecurityScheme interface {
	Type() string // required
	GetDescription() *string
}

type SecuritySchemeFields struct {
	Description *string
}

type SecuritySchemeMap map[string]SecurityScheme

type StringHeader struct {
	HeaderFields `yaml:",inline"`
	StringItem   `yaml:",inline"`
}

type StringItem struct {
	Format *string

	Default *string
	Enum    *[]string

	MaxLength *int64
	MinLength *int64
	Pattern   *string
}

type StringParameter struct {
	ParameterFields `yaml:",inline"`
	StringItem      `yaml:",inline"`
	AllowEmptyValue bool
}

type StringSchema struct {
	SchemaFields `yaml:",inline"`
	StringItem   `yaml:",inline"`
}

type Tag struct {
	Name          string // required
	Description   *string
	Documentation *ExternalDocumentation
}