types

Documentation

Overview

This file serves as the base template of openapi/v3/interface_gen.go. This is separated from the main openapi/v3 files because if we rely on code that resides in the same directory as where we are generating code, we risk messing up the code and not being able to run code generation tools again because of compile problems

Index

• Constants
• func GenerateCode() error
• type Callback
• type CallbackMap
• type CallbackMapKey
• type Components
• type Contact
• type Discriminator
• type Encoding
• type EncodingMap
• type EncodingMapKey
• type Example
• type ExampleMap
• type ExampleMapKey
• type Extensions
• type ExternalDocumentation
• type Header
• type HeaderMap
• type HeaderMapKey
• type Info
• type InterfaceList
• type InterfaceMap
• type InterfaceMapKey
• type License
• type Link
• type LinkMap
• type LinkMapKey
• type Location
• type MediaType
• type MediaTypeMap
• type MediaTypeMapKey
• type OAuthFlow
• type OAuthFlows
• type OpenAPI
• type Operation
• type Parameter
• type ParameterList
• type ParameterMap
• type ParameterMapKey
• type PathItem
• type PathItemMap
• type PathItemMapKey
• type Paths
• type PrimitiveType
• type RequestBody
• type RequestBodyMap
• type RequestBodyMapKey
• type Response
• type ResponseMap
• type ResponseMapKey
• type Responses
• type Schema
• type SchemaList
• type SchemaMap
• type SchemaMapKey
• type ScopeMap
• type ScopeMapKey
• type SecurityRequirement
• type SecurityRequirementList
• type SecurityScheme
• type SecuritySchemeMap
• type SecuritySchemeMapKey
• type Server
• type ServerList
• type ServerVariable
• type ServerVariableMap
• type ServerVariableMapKey
• type StringList
• type StringListMap
• type StringListMapKey
• type StringMap
• type StringMapKey
• type Tag
• type TagList
• type Validator

Constants

const (
	DefaultSpecVersion = "0.0.1"
	DefaultVersion     = "3.0.1"
)

Functions

func GenerateCode

func GenerateCode() error

Types

type Callback

type Callback interface {
	// contains filtered or unexported methods
}

type CallbackMap

type CallbackMap map[CallbackMapKey]Callback

type CallbackMapKey

type CallbackMapKey = string

type Components

type Components interface {
}

type Contact

type Contact interface {
}

Contact represents the contact object https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#contactObject

type Discriminator

type Discriminator interface {
}

type Encoding

type Encoding interface {
	// contains filtered or unexported methods
}

type EncodingMap

type EncodingMap map[EncodingMapKey]Encoding

type EncodingMapKey

type EncodingMapKey = string

type Example

type Example interface {
	// contains filtered or unexported methods
}

type ExampleMap

type ExampleMap map[ExampleMapKey]Example

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 License

type License interface {
}

type Link

type Link interface {
	// contains filtered or unexported methods
}

type LinkMap

type LinkMap map[LinkMapKey]Link

type LinkMapKey

type LinkMapKey = string

type Location

type Location string

const (
	InHeader Location = "header"
	InQuery  Location = "query"
	InPath   Location = "path"
	InCookie Location = "cookie"
)

type MediaType

type MediaType interface {
	// contains filtered or unexported methods
}

type MediaTypeMap

type MediaTypeMap map[MediaTypeMapKey]MediaType

type MediaTypeMapKey

type MediaTypeMapKey = string

type OAuthFlow

type OAuthFlow interface {
}

type OAuthFlows

type OAuthFlows interface {
}

type OpenAPI

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

type Operation

type Operation interface {
	Path() string
	Detached() bool
	// contains filtered or unexported methods
}

type Parameter

type Parameter interface {
}

type ParameterList

type ParameterList []Parameter

type ParameterMap

type ParameterMap map[ParameterMapKey]Parameter

type ParameterMapKey

type ParameterMapKey = string

type PathItem

type PathItem interface {
	// contains filtered or unexported methods
}

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"
	Null    PrimitiveType = "null"
)

type RequestBody

type RequestBody interface {
	// contains filtered or unexported methods
}

type RequestBodyMap

type RequestBodyMap map[RequestBodyMapKey]RequestBody

type RequestBodyMapKey

type RequestBodyMapKey = string

type Response

type Response interface {
	// contains filtered or unexported methods
}

type ResponseMap

type ResponseMap map[ResponseMapKey]Response

type ResponseMapKey

type ResponseMapKey = string

type Responses

type Responses interface {
}

type Schema

type Schema interface {
	Type() PrimitiveType
	// contains filtered or unexported methods
}

type SchemaList

type SchemaList []Schema

type SchemaMap

type SchemaMap map[SchemaMapKey]Schema

type SchemaMapKey

type SchemaMapKey = string

type ScopeMap

type ScopeMap map[ScopeMapKey]string

type ScopeMapKey

type ScopeMapKey = 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 Server

type Server interface {
}

type ServerList

type ServerList []Server

type ServerVariable

type ServerVariable interface {
	// contains filtered or unexported methods
}

type ServerVariableMap

type ServerVariableMap map[ServerVariableMapKey]ServerVariable

type ServerVariableMapKey

type ServerVariableMapKey = string

type StringList

type StringList []string

type StringListMap

type StringListMap map[StringListMapKey][]string

type StringListMapKey

type StringListMapKey = string

type StringMap

type StringMap map[StringMapKey]string

type StringMapKey

type StringMapKey = string

type Tag

type Tag interface {
}

type TagList

type TagList []Tag

type Validator

type Validator interface {
	Validate(bool) error
}

Validator objects can validate themselves.