openapi

type Endpoint struct {
	Path          string                 `yaml:"-" json:"-"` // this is added internally
	Verb          string                 `yaml:"-" json:"-"` // this is added internally
	Summary       string                 `yaml:"summary" json:"summary"`
	Description   string                 `yaml:"description" json:"description"`
	Parameters    Parameters             `yaml:"parameters" json:"parameters"`
	Tags          []string               `yaml:"tags" json:"tags"`
	Responses     map[string]*Response   `yaml:"responses" json:"responses"`
	OperationID   string                 `yaml:"operationId" json:"operationId"`
	CustomOptions map[string]interface{} `yaml:"x-options" json:"x-options"`
}

type Extension struct {
	Base   string            `json:"base" yaml:"base"`
	Fields []*ExtensionField `json:"fields" yaml:"fields"`
}

type ExtensionField struct {
	Name   string `yaml:"name" json:"name"`
	Type   string `yaml:"type" json:"type"`
	Number int    `yaml:"number" json:"number"`
}

type GlobalOptions map[string]string

type Model struct {
	Properties map[string]*Schema `yaml:"properties" json:"properties"`
	Name       string
	Depth      int
}

type Option = option.Option

type Parameter struct {
	Name        string     `yaml:"name" json:"name"`
	Description string     `yaml:"description" json:"description"`
	Enum        []string   `yaml:"enum,omitempty" json:"enum,omitempty"`
	Format      string     `yaml:"format,omitempty" json:"format,omitempty"`
	In          string     `yaml:"in,omitempty" json:"in,omitempty"`
	Items       *Schema    `yaml:"items,omitempty" json:"items,omitempty"`
	ProtoTag    int        `yaml:"x-proto-tag" json:"x-proto-tag"`
	Ref         string     `yaml:"$ref" json:"$ref"`
	Required    bool       `yaml:"required,omitempty" json:"required,omitempty"`
	Schema      *Schema    `yaml:"schema,omitempty" json:"schema,omitempty"` // if in == "body", then schema is present
	Type        SchemaType `yaml:"type,omitempty" json:"type,omitempty"`
}

type Parameters []*Parameter

type Path struct {
	Get        *Endpoint  `yaml:"get" json:"get"`
	Put        *Endpoint  `yaml:"put" json:"put"`
	Post       *Endpoint  `yaml:"post" json:"post"`
	Patch      *Endpoint  `yaml:"patch" json:"patch"`
	Delete     *Endpoint  `yaml:"delete" json:"delete"`
	Parameters Parameters `yaml:"parameters" json:"parameters"`
}

type Response struct {
	Description string  `yaml:"description" json:"description"`
	Schema      *Schema `yaml:"schema" json:"schema"`
}

type Schema struct {

	// if this schema refers to a definition found elsewhere, this value
	// is used. Note that if present, this takes precedence over other values
	Ref string `yaml:"$ref" json:"$ref"`

	Description string `yaml:"description,omitempty" json:"description,omitempty"`
	// scalar
	// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
	Type   SchemaType `yaml:"type" json:"type"`
	Format string     `yaml:"format,omitempty" json:"format,omitempty"`
	Enum   []string   `yaml:"enum,omitempty" json:"enum,omitempty"`

	ProtoName string `yaml:"-" json:"-"`
	ProtoTag  int    `yaml:"x-proto-tag" json:"x-proto-tag"`

	// objects
	Required             []string           `yaml:"required" json:"required"`
	Properties           map[string]*Schema `yaml:"properties" json:"properties"`
	AdditionalProperties *Schema            `yaml:"additionalProperties" json:"additionalProperties"`

	// is an array
	Items *Schema `yaml:"items" json:"items"`

	// validation (regex pattern, max/min length)
	Pattern   string `yaml:"pattern,omitempty" json:"pattern,omitempty"`
	MaxLength int    `yaml:"maxLength,omitempty" json:"maxLength,omitempty"`
	MinLength int    `yaml:"minLength,omitempty" json:"minLength,omitempty"`
	Maximum   int    `yaml:"maximum,omitempty" json:"maximum,omitempty"`
	Minimum   int    `yaml:"minimum,omitempty" json:"minimum,omitempty"`
	// contains filtered or unexported fields
}

type SchemaType []string

type Spec struct {
	FileName string // internal use to pass file path
	Swagger  string `yaml:"swagger" json:"swagger"`
	Info     struct {
		Title       string `yaml:"title" json:"title"`
		Description string `yaml:"description" json:"description"`
		Version     string `yaml:"version" json:"version"`
	} `yaml:"info" json:"info"`
	Host          string                `yaml:"host" json:"host"`
	Schemes       []string              `yaml:"schemes" json:"schemes"`
	BasePath      string                `yaml:"basePath" json:"basePath"`
	Produces      []string              `yaml:"produces" json:"produces"`
	Paths         map[string]*Path      `yaml:"paths" json:"paths"`
	Definitions   map[string]*Schema    `yaml:"definitions" json:"definitions"`
	Parameters    map[string]*Parameter `yaml:"parameters" json:"parameters"`
	Extensions    []*Extension          `yaml:"x-extensions" json:"x-extensions"`
	GlobalOptions GlobalOptions         `yaml:"x-global-options" json:"x-global-options"`
}