markdown

type API struct {
	Swagger     string                  `json,yaml:"swagger"`
	Info        Info                    `json,yaml:"info"`
	Host        string                  `json,yaml:"host"`
	BasePath    string                  `json,yaml:"basePath"`
	Schemes     []string                `json,yaml:"schemes"`
	Consumes    []string                `json,yaml:"consumes"`
	Produces    []string                `json,yaml:"produces"`
	Paths       map[string]Operations   `json,yaml:"paths"`
	Definitions map[string]SchemaObject `json,yaml:"definitions"`
}

type APIError map[string]string

type Contact struct {
	Name  string `json,yaml:"name"`
	Email string `json,yaml:"email"`
	URL   string `json,yaml:"url"`
}

type ExternalDocumentation struct {
	Description string `json,yaml:"description"`
	URL         string `json,yaml:"url"`
}

type Info struct {
	Version        string  `json,yaml:"version"`
	Title          string  `json,yaml:"title"`
	Description    string  `json,yaml:"description"`
	TermsOfService string  `json,yaml:"termsOfService"`
	Contact        Contact `json,yaml:"contact"`
	License        License `json,yaml:"license"`
}

type License struct {
	Name string `json,yaml:"name"`
	URL  string `json,yaml:"url"`
}

type Method struct {
	Index int
	*Operation
}

type Operation struct {
	API         *API
	Operation   string
	Path        string
	Tags        []string                `json,yaml:"tags"`
	Description string                  `json,yaml:"description"`
	OperationID string                  `json,yaml:"operationId"`
	Summary     string                  `json,yaml:"summary"`
	Parameters  []Parameter             `json,yaml:"parameters"`
	Responses   map[string]Response     `json,yaml:"responses"`
	Definitions map[string]SchemaObject `json,yaml:"definitions"`
}

type Operations map[string]*Operation

type Parameter struct {
	Name             string                 `json,yaml:"name"`
	In               string                 `json,yaml:"in"`
	Description      string                 `json,yaml:"description"`
	Required         bool                   `json,yaml:"required"`
	Type             string                 `json,yaml:"type"`
	CollectionFormat string                 `json,yaml:"collectionFormat"`
	Items            map[string]interface{} `json,yaml:"items"`
	Schema           SchemaObject           `json,yaml:"schema"`
}

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

type SchemaContext struct {
	TopRef      string
	Definitions map[string]SchemaObject
	Definition  SchemaObject
}

type SchemaObject struct {
	Type        string                  `json:"type"`
	Example     string                  `json,yaml:"example"`
	Properties  map[string]SchemaObject `json:"properties"`
	Description string                  `json:"description"`
	Ref         string                  `json:"$ref"`
	Items       struct {
		Type string `json:"type"`
		Ref  string `json:"$ref"`
	} `json:"items"`
	ExternalDocs ExternalDocumentation `json,yaml:"external_docs"`
}

type Tag struct {
	TagIndex int
	Tag      string
	BasePath string
	Methods  map[int]*Method
}

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

type Writer interface {
	For(filename string) io.Writer
}