openapi2conv

package

v0.30.0 Latest Latest Go to latest Published: Nov 15, 2020 License: MIT Imports: 8 Imported by: 79

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getkin/kin-openapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package openapi2conv converts an OpenAPI v2 specification to v3.

Index ¶

func FromV3Operation(swagger *openapi3.Swagger, operation *openapi3.Operation) (*openapi2.Operation, error)
func FromV3Parameter(ref *openapi3.ParameterRef, components *openapi3.Components) (*openapi2.Parameter, error)
func FromV3PathItem(swagger *openapi3.Swagger, pathItem *openapi3.PathItem) (*openapi2.PathItem, error)
func FromV3Ref(ref string) string
func FromV3RequestBody(name string, requestBodyRef *openapi3.RequestBodyRef, ...) (*openapi2.Parameter, error)
func FromV3RequestBodyFormData(mediaType *openapi3.MediaType) openapi2.Parameters
func FromV3Response(ref *openapi3.ResponseRef, components *openapi3.Components) (*openapi2.Response, error)
func FromV3Responses(responses map[string]*openapi3.ResponseRef, components *openapi3.Components) (map[string]*openapi2.Response, error)
func FromV3SchemaRef(schema *openapi3.SchemaRef, components *openapi3.Components) (*openapi3.SchemaRef, *openapi2.Parameter)
func FromV3Schemas(schemas map[string]*openapi3.SchemaRef, components *openapi3.Components) (map[string]*openapi3.SchemaRef, map[string]*openapi2.Parameter)
func FromV3SecurityRequirements(requirements openapi3.SecurityRequirements) openapi2.SecurityRequirements
func FromV3SecurityScheme(swagger *openapi3.Swagger, ref *openapi3.SecuritySchemeRef) (*openapi2.SecurityScheme, error)
func FromV3Swagger(swagger *openapi3.Swagger) (*openapi2.Swagger, error)
func ToV3Operation(swagger *openapi2.Swagger, components *openapi3.Components, ...) (*openapi3.Operation, error)
func ToV3Parameter(components *openapi3.Components, parameter *openapi2.Parameter, ...) (*openapi3.ParameterRef, *openapi3.RequestBodyRef, ...)
func ToV3PathItem(swagger *openapi2.Swagger, components *openapi3.Components, ...) (*openapi3.PathItem, error)
func ToV3Ref(ref string) string
func ToV3Response(response *openapi2.Response) (*openapi3.ResponseRef, error)
func ToV3SchemaRef(schema *openapi3.SchemaRef) *openapi3.SchemaRef
func ToV3Schemas(defs map[string]*openapi3.SchemaRef) map[string]*openapi3.SchemaRef
func ToV3SecurityRequirements(requirements openapi2.SecurityRequirements) openapi3.SecurityRequirements
func ToV3SecurityScheme(securityScheme *openapi2.SecurityScheme) (*openapi3.SecuritySchemeRef, error)
func ToV3Swagger(swagger *openapi2.Swagger) (*openapi3.Swagger, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FromV3Operation ¶

func FromV3Operation(swagger *openapi3.Swagger, operation *openapi3.Operation) (*openapi2.Operation, error)

func FromV3Parameter ¶

func FromV3Parameter(ref *openapi3.ParameterRef, components *openapi3.Components) (*openapi2.Parameter, error)

func FromV3PathItem ¶

func FromV3PathItem(swagger *openapi3.Swagger, pathItem *openapi3.PathItem) (*openapi2.PathItem, error)

func FromV3Ref ¶ added in v0.3.0

func FromV3Ref(ref string) string

func FromV3RequestBody ¶

func FromV3RequestBody(name string, requestBodyRef *openapi3.RequestBodyRef, mediaType *openapi3.MediaType, components *openapi3.Components) (*openapi2.Parameter, error)

func FromV3RequestBodyFormData ¶ added in v0.17.0

func FromV3RequestBodyFormData(mediaType *openapi3.MediaType) openapi2.Parameters

func FromV3Response ¶

func FromV3Response(ref *openapi3.ResponseRef, components *openapi3.Components) (*openapi2.Response, error)

func FromV3Responses ¶ added in v0.3.0

func FromV3Responses(responses map[string]*openapi3.ResponseRef, components *openapi3.Components) (map[string]*openapi2.Response, error)

func FromV3SchemaRef ¶ added in v0.3.0

func FromV3SchemaRef(schema *openapi3.SchemaRef, components *openapi3.Components) (*openapi3.SchemaRef, *openapi2.Parameter)

func FromV3Schemas ¶ added in v0.3.0

func FromV3Schemas(schemas map[string]*openapi3.SchemaRef, components *openapi3.Components) (map[string]*openapi3.SchemaRef, map[string]*openapi2.Parameter)

func FromV3SecurityRequirements ¶

func FromV3SecurityRequirements(requirements openapi3.SecurityRequirements) openapi2.SecurityRequirements

func FromV3SecurityScheme ¶

func FromV3SecurityScheme(swagger *openapi3.Swagger, ref *openapi3.SecuritySchemeRef) (*openapi2.SecurityScheme, error)

func FromV3Swagger ¶

func FromV3Swagger(swagger *openapi3.Swagger) (*openapi2.Swagger, error)

FromV3Swagger converts an OpenAPIv3 spec to an OpenAPIv2 spec

func ToV3Operation ¶

func ToV3Operation(swagger *openapi2.Swagger, components *openapi3.Components, pathItem *openapi2.PathItem, operation *openapi2.Operation, consumes []string) (*openapi3.Operation, error)

func ToV3Parameter ¶

func ToV3Parameter(components *openapi3.Components, parameter *openapi2.Parameter, consumes []string) (*openapi3.ParameterRef, *openapi3.RequestBodyRef, map[string]*openapi3.SchemaRef, error)

func ToV3PathItem ¶

func ToV3PathItem(swagger *openapi2.Swagger, components *openapi3.Components, pathItem *openapi2.PathItem, consumes []string) (*openapi3.PathItem, error)

func ToV3Ref ¶ added in v0.3.0

func ToV3Ref(ref string) string

func ToV3Response ¶

func ToV3Response(response *openapi2.Response) (*openapi3.ResponseRef, error)

func ToV3SchemaRef ¶ added in v0.3.0

func ToV3SchemaRef(schema *openapi3.SchemaRef) *openapi3.SchemaRef

func ToV3Schemas ¶ added in v0.3.0

func ToV3Schemas(defs map[string]*openapi3.SchemaRef) map[string]*openapi3.SchemaRef

func ToV3SecurityRequirements ¶

func ToV3SecurityRequirements(requirements openapi2.SecurityRequirements) openapi3.SecurityRequirements

func ToV3SecurityScheme ¶

func ToV3SecurityScheme(securityScheme *openapi2.SecurityScheme) (*openapi3.SecuritySchemeRef, error)

func ToV3Swagger ¶

func ToV3Swagger(swagger *openapi2.Swagger) (*openapi3.Swagger, error)

ToV3Swagger converts an OpenAPIv2 spec to an OpenAPIv3 spec

Types ¶

This section is empty.

Source Files ¶

View all Source files

openapi2_conv.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL