openapi2conv

package
v0.124.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2024 License: MIT Imports: 7 Imported by: 53

Documentation

Overview

Package openapi2conv converts an OpenAPI v2 specification document to v3.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FromV3 added in v0.61.0

func FromV3(doc3 *openapi3.T) (*openapi2.T, error)

FromV3 converts an OpenAPIv3 spec to an OpenAPIv2 spec

func FromV3Headers added in v0.89.0

func FromV3Headers(defs openapi3.Headers, components *openapi3.Components) (map[string]*openapi2.Header, error)

func FromV3Operation

func FromV3Operation(doc3 *openapi3.T, operation *openapi3.Operation) (*openapi2.Operation, error)

func FromV3Parameter

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

func FromV3PathItem

func FromV3PathItem(doc3 *openapi3.T, 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(doc3 *openapi3.T, ref *openapi3.SecuritySchemeRef) (*openapi2.SecurityScheme, error)

func ToV3 added in v0.61.0

func ToV3(doc2 *openapi2.T) (*openapi3.T, error)

ToV3 converts an OpenAPIv2 spec to an OpenAPIv3 spec

func ToV3Headers added in v0.89.0

func ToV3Headers(defs map[string]*openapi2.Header) openapi3.Headers

func ToV3Operation

func ToV3Operation(doc2 *openapi2.T, 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(doc2 *openapi2.T, 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, produces []string) (*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 ToV3WithLoader added in v0.121.0

func ToV3WithLoader(doc2 *openapi2.T, loader *openapi3.Loader, location *url.URL) (*openapi3.T, error)

Types

This section is empty.

Jump to

Keyboard shortcuts

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