swgen

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

type Document struct {
	Version     string               `json:"swagger"`        // Specifies the Swagger Specification version being used
	Info        InfoObj              `json:"info"`           // Provides metadata about the API
	Host        string               `json:"host,omitempty"` // The host (name or ip) serving the API
	BasePath    string               `json:"basePath"`       // The base path on which the API is served, which is relative to the host
	Schemes     []string             `json:"schemes"`        // Values MUST be from the list: "http", "https", "ws", "wss"
	Paths       map[string]PathItem  `json:"paths"`          // The available paths and operations for the API
	Definitions map[string]SchemaObj `json:"definitions"`    // An object to hold data types produced and consumed by operations
	// contains filtered or unexported fields
}

type Enum struct {
	Enum      []interface{} `json:"enum,omitempty"`
	EnumNames []string      `json:"x-enum-names,omitempty"`
}

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

type IDefinition interface {
	SwgenDefinition() (typeName string, typeDef SchemaObj, err error)
}

type IParameter interface {
	SwgenParameter() (name string, params []ParamObj, err error)
}

type InfoObj struct {
	Title          string     `json:"title"` // The title of the application
	Description    string     `json:"description"`
	TermsOfService string     `json:"termsOfService"`
	Contact        ContactObj `json:"contact"`
	License        LicenseObj `json:"license"`
	Version        string     `json:"version"`
}

type LicenseObj struct {
	Name string `json:"name"`
	URL  string `json:"url,omitempty"`
}

type OperationObj struct {
	Tags        []string   `json:"tags,omitempty"`
	Summary     string     `json:"summary"`     // like a title, a short summary of what the operation does (120 chars)
	Description string     `json:"description"` // A verbose explanation of the operation behavior
	Parameters  []ParamObj `json:"parameters,omitempty"`
	Responses   Responses  `json:"responses"`
	Deprecated  bool       `json:"deprecated"`
	// contains filtered or unexported fields
}

type ParamItemObj struct {
	Ref              string        `json:"$ref,omitempty"`
	Type             string        `json:"type"`
	Format           string        `json:"format,omitempty"`
	Items            *ParamItemObj `json:"items,omitempty"`            // Required if type is "array"
	CollectionFormat string        `json:"collectionFormat,omitempty"` // "multi" - this is valid only for parameters in "query" or "formData"
}

type ParamObj struct {
	Ref              string        `json:"$ref,omitempty"`
	Name             string        `json:"name"`
	In               string        `json:"in"` // Possible values are "query", "header", "path", "formData" or "body"
	Type             string        `json:"type,omitempty"`
	Format           string        `json:"format,omitempty"`
	Items            *ParamItemObj `json:"items,omitempty"`            // Required if type is "array"
	Schema           *SchemaObj    `json:"schema,omitempty"`           // Required if type is "body"
	CollectionFormat string        `json:"collectionFormat,omitempty"` // "multi" - this is valid only for parameters in "query" or "formData"
	Description      string        `json:"description,omitempty"`
	Default          interface{}   `json:"default,omitempty"`
	Required         bool          `json:"required"`
	Enum
}

type PathItem struct {
	Ref     string        `json:"$ref,omitempty"`
	Get     *OperationObj `json:"get,omitempty"`
	Put     *OperationObj `json:"put,omitempty"`
	Post    *OperationObj `json:"post,omitempty"`
	Delete  *OperationObj `json:"delete,omitempty"`
	Options *OperationObj `json:"options,omitempty"`
	Head    *OperationObj `json:"head,omitempty"`
	Patch   *OperationObj `json:"patch,omitempty"`
	Params  *ParamObj     `json:"parameters,omitempty"`
}

type PathItemInfo struct {
	Path        string
	Method      string
	Title       string
	Description string
	Tag         string
	Deprecated  bool
	// contains filtered or unexported fields
}

type ResponseObj struct {
	Ref         string      `json:"$ref,omitempty"`
	Description string      `json:"description,omitempty"`
	Schema      *SchemaObj  `json:"schema,omitempty"`
	Headers     interface{} `json:"headers,omitempty"`
	Examples    interface{} `json:"examples,omitempty"`
}

type Responses map[string]ResponseObj

type SchemaObj struct {
	Ref                  string               `json:"$ref,omitempty"`
	Description          string               `json:"description,omitempty"`
	Default              interface{}          `json:"default,omitempty"`
	Type                 string               `json:"type,omitempty"`
	Format               string               `json:"format,omitempty"`
	Title                string               `json:"title,omitempty"`
	Items                *SchemaObj           `json:"items,omitempty"`                // if type is array
	AdditionalProperties *SchemaObj           `json:"additionalProperties,omitempty"` // if type is object (map[])
	Properties           map[string]SchemaObj `json:"properties,omitempty"`           // if type is object
	TypeName             string               `json:"-"`                              // for internal using, passing typeName
}

type ServiceType string