types

Documentation

Index

• func GenerateCode() error
• type CollectionFormat
• type Contact
• type ExampleMap
• type ExampleMapKey
• type Extensions
• type ExternalDocumentation
• type Header
• type HeaderMap
• type HeaderMapKey
• type Info
• type InterfaceList
• type InterfaceMap
• type InterfaceMapKey
• type Items
• type License
• type Location
• type MIMEType
• type MIMETypeList
• type MediaType
• type OpenAPI
• type Operation
• type Parameter
• type ParameterList
• type ParameterMap
• type ParameterMapKey
• type PathItem
• type PathItemMap
• type PathItemMapKey
• type Paths
• type PrimitiveType
• type ResolveError
• type Resolver
• type Response
• type ResponseMap
• type ResponseMapKey
• type Responses
• type Schema
• type SchemaConverter
• type SchemaList
• type SchemaMap
• type SchemaMapKey
• type Scheme
• type SchemeList
• type ScopesMap
• type ScopesMapKey
• type SecurityRequirement
• type SecurityRequirementList
• type SecurityScheme
• type SecuritySchemeMap
• type SecuritySchemeMapKey
• type StringList
• type StringMap
• type StringMapKey
• type Swagger
• type Tag
• type TagList
• type Validator
• type XML

Functions

func GenerateCode

func GenerateCode() error

Types

type CollectionFormat

type CollectionFormat string

const (
	CSV   CollectionFormat = "csv"
	SSV   CollectionFormat = "ssv"
	TSV   CollectionFormat = "tsv"
	Pipes CollectionFormat = "pipes"
	Multi CollectionFormat = "multi"
)

type Contact

type Contact interface {
}

type ExampleMap

type ExampleMap map[ExampleMapKey]interface{}

type ExampleMapKey

type ExampleMapKey = string

type Extensions

type Extensions map[string]interface{}

type ExternalDocumentation

type ExternalDocumentation interface {
}

type Header

type Header interface {
}

type HeaderMap

type HeaderMap map[HeaderMapKey]Header

type HeaderMapKey

type HeaderMapKey = string

type Info

type Info interface {
}

type InterfaceList

type InterfaceList []interface{}

type InterfaceMap

type InterfaceMap map[InterfaceMapKey]interface{}

type InterfaceMapKey

type InterfaceMapKey = string

type Items

type Items interface {
	SchemaConverter
}

type License

type License interface {
}

type Location

type Location string

const (
	InPath   Location = "path"
	InQuery  Location = "query"
	InHeader Location = "header"
	InBody   Location = "body"
	InForm   Location = "formData"
)

type MIMEType

type MIMEType = string

const (
	WWWFormURLEncoded MIMEType = "application/x-www-form-urlencoded"
	MultiparFormDaata MIMEType = "multipart/form-data"
)

type MIMETypeList

type MIMETypeList []MIMEType

type MediaType

type MediaType = string

type OpenAPI

type OpenAPI = Swagger

type Operation

type Operation interface {
}

type Parameter

type Parameter interface {
	SchemaConverter
}

type ParameterList

type ParameterList []Parameter

type ParameterMap

type ParameterMap map[ParameterMapKey]Parameter

type ParameterMapKey

type ParameterMapKey = string

type PathItem

type PathItem interface {
}

type PathItemMap

type PathItemMap map[PathItemMapKey]PathItem

type PathItemMapKey

type PathItemMapKey = string

type Paths

type Paths interface {
}

type PrimitiveType

type PrimitiveType string

const (
	Invalid PrimitiveType = "invalid"
	Integer PrimitiveType = "integer"
	Number  PrimitiveType = "number"
	String  PrimitiveType = "string"
	Boolean PrimitiveType = "boolean"
	Object  PrimitiveType = "object"
	Array   PrimitiveType = "array"
	File    PrimitiveType = "file"
	Null    PrimitiveType = "null"
)

type ResolveError

type ResolveError interface {
	Fatal() bool
}

ResolveError is returned when Resolver fails to resolve a reference (`$ref`)

type Resolver

type Resolver interface {
	// Resolves a JSON reference. In very rare occasions where
	// you do not want to actually resolve the value but allow
	// processing to continue, you may return an error value
	// that implements ResolveError and return false for the
	// `Fatal` method.
	Resolve(string) (interface{}, error)
}

Resolver resolves JSON references (`$ref`)

type Response

type Response interface {
}

type ResponseMap

type ResponseMap map[ResponseMapKey]Response

type ResponseMapKey

type ResponseMapKey = string

type Responses

type Responses interface {
}

type Schema

type Schema interface {
	IsRequiredProperty(string) bool
	IsValid() bool
	SchemaConverter
}

type SchemaConverter

type SchemaConverter interface {
	ConvertToSchema() (Schema, error)
}

SchemaConverter is available for those types which resemble a Schema object, such as Parameter and Items. The resulting Schema will not be 100% compatible as the original object as available fields differ slightly, but should be close enough to be used interchangeably.

type SchemaList

type SchemaList []Schema

type SchemaMap

type SchemaMap map[SchemaMapKey]Schema

type SchemaMapKey

type SchemaMapKey = string

type Scheme

type Scheme = string

type SchemeList

type SchemeList []string

type ScopesMap

type ScopesMap map[ScopesMapKey][]string

type ScopesMapKey

type ScopesMapKey = string

type SecurityRequirement

type SecurityRequirement interface {
}

type SecurityRequirementList

type SecurityRequirementList []SecurityRequirement

type SecurityScheme

type SecurityScheme interface {
}

type SecuritySchemeMap

type SecuritySchemeMap map[SecuritySchemeMapKey]SecurityScheme

type SecuritySchemeMapKey

type SecuritySchemeMapKey = string

type StringList

type StringList []string

type StringMap

type StringMap map[StringMapKey]string

type StringMapKey

type StringMapKey = string

type Swagger

type Swagger interface {
	QueryJSON(string) (interface{}, bool)
}

type Tag

type Tag interface {
}

type TagList

type TagList []Tag

type Validator

type Validator interface {
	Validate(bool) error
}

Validator objects can validate themselves.

type XML

type XML interface {
}