swgen

type CommonFields struct {
	Title       string      `json:"title,omitempty"`
	Description string      `json:"description,omitempty"`
	Default     interface{} `json:"default,omitempty"`

	// Type is defined with reflection.
	Type string `json:"type,omitempty"`

	Pattern string `json:"pattern,omitempty"`
	Format  string `json:"format,omitempty"`

	MultipleOf float64  `json:"multipleOf,omitempty"`
	Maximum    *float64 `json:"maximum,omitempty"`
	Minimum    *float64 `json:"minimum,omitempty"`

	MaxLength     *int64 `json:"maxLength,omitempty"`
	MinLength     *int64 `json:"minLength,omitempty"`
	MaxItems      *int64 `json:"maxItems,omitempty"`
	MinItems      *int64 `json:"minItems,omitempty"`
	MaxProperties *int64 `json:"maxProperties,omitempty"`
	MinProperties *int64 `json:"minProperties,omitempty"`

	ExclusiveMaximum bool `json:"exclusiveMaximum,omitempty"`
	ExclusiveMinimum bool `json:"exclusiveMinimum,omitempty"`
	UniqueItems      bool `json:"uniqueItems,omitempty"`

	// Enum defines value enumeration.
	//
	// Can be populated from
	//   NamedEnum() ([]interface{}, []string)
	// or
	//   Enum() []interface{}
	//
	// Can be imported from tag `enum`.
	Enum
}

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

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,omitempty"`            // The base path on which the API is served, which is relative to the host
	Schemes             []string               `json:"schemes,omitempty"`             // 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,omitempty"`         // An object to hold data types produced and consumed by operations
	SecurityDefinitions map[string]SecurityDef `json:"securityDefinitions,omitempty"` // An object to hold available security mechanisms
	// 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 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 JSONSchemaConfig struct {
	CollectDefinitions map[string]map[string]interface{}
	StripDefinitions   bool
	DefinitionsPrefix  string
}

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

type ObjectJSONSchema struct {
	ID         string                            `json:"id,omitempty"`
	Schema     string                            `json:"$schema,omitempty"`
	Type       string                            `json:"type"`
	Required   []string                          `json:"required,omitempty"`
	Properties map[string]map[string]interface{} `json:"properties"`
}

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"`
	Produces    []string              `json:"produces,omitempty"`
	Consumes    []string              `json:"consumes,omitempty"`
	Responses   Responses             `json:"responses"`
	Security    []map[string][]string `json:"security,omitempty"`
	Deprecated  bool                  `json:"deprecated,omitempty"`
	// contains filtered or unexported fields
}

type ParamItemObj struct {
	CommonFields
	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 {
	CommonFields
	Name   string        `json:"name,omitempty"`
	In     string        `json:"in,omitempty"`     // Possible values are "query", "header", "path", "formData" or "body"
	Items  *ParamItemObj `json:"items,omitempty"`  // Required if type is "array"
	Schema *SchemaObj    `json:"schema,omitempty"` // Required if type is "body"

	// CollectionFormat defines serialization:
	// "multi" is valid only for parameters in "query" or "formData": foo=value&foo=another_value
	// "csv" is comma-separated values: "foo,bar,baz"
	// "ssv" is space-separated values: "foo bar baz"
	// "tsv" is tab-separated values: "foo\tbar\tbaz"
	// "pipes" is pipe-separated values: "foo|bar|baz"
	CollectionFormat string `json:"collectionFormat,omitempty"`

	Required bool `json:"required,omitempty"`
	// contains filtered or unexported fields
}

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

	// Request holds a sample of request structure, e.g. new(MyRequest).
	Request interface{}

	// Output holds a sample of successful response, e.g. new(MyResponse).
	Response interface{}

	// MIME types of input and output
	Produces []string
	Consumes []string

	Security       []string            // Names of security definitions.
	SecurityOAuth2 map[string][]string // Map of names of security definitions to required scopes.

	SuccessfulResponseCode int
	// 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[int]ResponseObj

type SchemaDefinition interface {
	SwaggerDef() SwaggerData
}

type SchemaDefinitionFunc func() SwaggerData

type SchemaObj struct {
	CommonFields
	Ref                  string               `json:"$ref,omitempty"`
	Items                *SchemaObj           `json:"items,omitempty"`                // if type is array
	AdditionalProperties *SchemaObj           `json:"additionalProperties,omitempty"` // if type is object (map[])
	Required             []string             `json:"required,omitempty"`
	Properties           map[string]SchemaObj `json:"properties,omitempty"` // if type is object
	Example              interface{}          `json:"example,omitempty"`
	Nullable             bool                 `json:"x-nullable,omitempty"`
	TypeName             string               `json:"-"` // for internal using, passing typeName
	GoType               string               `json:"x-go-type,omitempty"`
	GoPropertyNames      map[string]string    `json:"x-go-property-names,omitempty"`
	GoPropertyTypes      map[string]string    `json:"x-go-property-types,omitempty"`
	// contains filtered or unexported fields
}

type SecurityDef struct {
	Type securityType `json:"type"`

	// apiKey properties.
	In   apiKeyIn `json:"in,omitempty"`
	Name string   `json:"name,omitempty"` // Example: X-API-Key.

	// oauth2 properties.
	Flow             oauthFlow         `json:"flow,omitempty"`
	AuthorizationURL string            `json:"authorizationUrl,omitempty"` // Example: https://example.com/oauth/authorize.
	TokenURL         string            `json:"tokenUrl,omitempty"`         // Example: https://example.com/oauth/token.
	Scopes           map[string]string `json:"scopes,omitempty"`           // Example: {"read": "Grants read access", "write": "Grants write access"}.

	// BearerFormat holds arbitrary value for documentation , for example "JWT".
	BearerFormat string `json:"-"`

	Description string `json:"description,omitempty"`
}

type SwaggerData struct {
	CommonFields
	ParamObj
	SchemaObj // nolint:govet
}

type WithStatusCode interface {
	StatusCode() int
}