openapi_v2

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2023 License: Apache-2.0 Imports: 7 Imported by: 143

README

OpenAPI v2 Protocol Buffer Models

This directory contains a Protocol Buffer-language model and related code for supporting OpenAPI v2.

Gnostic applications and plugins can use OpenAPIv2.proto to generate Protocol Buffer support code for their preferred languages.

OpenAPIv2.go is used by Gnostic to read JSON and YAML OpenAPI descriptions into the Protocol Buffer-based datastructures generated from OpenAPIv2.proto.

OpenAPIv2.proto and OpenAPIv2.go are generated by the Gnostic compiler generator, and OpenAPIv2.pb.go is generated by protoc, the Protocol Buffer compiler, and protoc-gen-go, the Protocol Buffer Go code generation plugin.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_openapiv2_OpenAPIv2_proto = openapiv2.File_openapiv2_OpenAPIv2_proto

Functions

func Version 

func Version() string

Version returns the package name (and OpenAPI version).

Types

type AdditionalPropertiesItem 

type AdditionalPropertiesItem = openapiv2.AdditionalPropertiesItem

func NewAdditionalPropertiesItem 

func NewAdditionalPropertiesItem(in *yaml.Node, context *compiler.Context) (*AdditionalPropertiesItem, error)

NewAdditionalPropertiesItem creates an object of type AdditionalPropertiesItem if possible, returning an error if not.

type AdditionalPropertiesItem_Boolean 

type AdditionalPropertiesItem_Boolean = openapiv2.AdditionalPropertiesItem_Boolean

type AdditionalPropertiesItem_Schema 

type AdditionalPropertiesItem_Schema = openapiv2.AdditionalPropertiesItem_Schema

type Any 

type Any = openapiv2.Any

func NewAny 

func NewAny(in *yaml.Node, context *compiler.Context) (*Any, error)

NewAny creates an object of type Any if possible, returning an error if not.

type ApiKeySecurity 

type ApiKeySecurity = openapiv2.ApiKeySecurity

func NewApiKeySecurity 

func NewApiKeySecurity(in *yaml.Node, context *compiler.Context) (*ApiKeySecurity, error)

NewApiKeySecurity creates an object of type ApiKeySecurity if possible, returning an error if not.

type BasicAuthenticationSecurity 

type BasicAuthenticationSecurity = openapiv2.BasicAuthenticationSecurity

func NewBasicAuthenticationSecurity 

func NewBasicAuthenticationSecurity(in *yaml.Node, context *compiler.Context) (*BasicAuthenticationSecurity, error)

NewBasicAuthenticationSecurity creates an object of type BasicAuthenticationSecurity if possible, returning an error if not.

type BodyParameter 

type BodyParameter = openapiv2.BodyParameter

func NewBodyParameter 

func NewBodyParameter(in *yaml.Node, context *compiler.Context) (*BodyParameter, error)

NewBodyParameter creates an object of type BodyParameter if possible, returning an error if not.

type Contact 

type Contact = openapiv2.Contact

func NewContact 

func NewContact(in *yaml.Node, context *compiler.Context) (*Contact, error)

NewContact creates an object of type Contact if possible, returning an error if not.

type Default 

type Default = openapiv2.Default

func NewDefault 

func NewDefault(in *yaml.Node, context *compiler.Context) (*Default, error)

NewDefault creates an object of type Default if possible, returning an error if not.

type Definitions 

type Definitions = openapiv2.Definitions

func NewDefinitions 

func NewDefinitions(in *yaml.Node, context *compiler.Context) (*Definitions, error)

NewDefinitions creates an object of type Definitions if possible, returning an error if not.

type Document 

type Document = openapiv2.Document

func NewDocument 

func NewDocument(in *yaml.Node, context *compiler.Context) (*Document, error)

NewDocument creates an object of type Document if possible, returning an error if not.

func ParseDocument 

func ParseDocument(b []byte) (*Document, error)

ParseDocument reads an OpenAPI v2 description from a YAML/JSON representation.

type Examples 

type Examples = openapiv2.Examples

func NewExamples 

func NewExamples(in *yaml.Node, context *compiler.Context) (*Examples, error)

NewExamples creates an object of type Examples if possible, returning an error if not.

type ExternalDocs 

type ExternalDocs = openapiv2.ExternalDocs

func NewExternalDocs 

func NewExternalDocs(in *yaml.Node, context *compiler.Context) (*ExternalDocs, error)

NewExternalDocs creates an object of type ExternalDocs if possible, returning an error if not.

type FileSchema 

type FileSchema = openapiv2.FileSchema

func NewFileSchema 

func NewFileSchema(in *yaml.Node, context *compiler.Context) (*FileSchema, error)

NewFileSchema creates an object of type FileSchema if possible, returning an error if not.

type FormDataParameterSubSchema 

type FormDataParameterSubSchema = openapiv2.FormDataParameterSubSchema

func NewFormDataParameterSubSchema 

func NewFormDataParameterSubSchema(in *yaml.Node, context *compiler.Context) (*FormDataParameterSubSchema, error)

NewFormDataParameterSubSchema creates an object of type FormDataParameterSubSchema if possible, returning an error if not. 

type Header = openapiv2.Header

func NewHeader 

func NewHeader(in *yaml.Node, context *compiler.Context) (*Header, error)

NewHeader creates an object of type Header if possible, returning an error if not.

type HeaderParameterSubSchema 

type HeaderParameterSubSchema = openapiv2.HeaderParameterSubSchema

func NewHeaderParameterSubSchema 

func NewHeaderParameterSubSchema(in *yaml.Node, context *compiler.Context) (*HeaderParameterSubSchema, error)

NewHeaderParameterSubSchema creates an object of type HeaderParameterSubSchema if possible, returning an error if not.

type Headers 

type Headers = openapiv2.Headers

func NewHeaders 

func NewHeaders(in *yaml.Node, context *compiler.Context) (*Headers, error)

NewHeaders creates an object of type Headers if possible, returning an error if not.

type Info 

type Info = openapiv2.Info

func NewInfo 

func NewInfo(in *yaml.Node, context *compiler.Context) (*Info, error)

NewInfo creates an object of type Info if possible, returning an error if not.

type ItemsItem 

type ItemsItem = openapiv2.ItemsItem

func NewItemsItem 

func NewItemsItem(in *yaml.Node, context *compiler.Context) (*ItemsItem, error)

NewItemsItem creates an object of type ItemsItem if possible, returning an error if not.

type JsonReference 

type JsonReference = openapiv2.JsonReference

func NewJsonReference 

func NewJsonReference(in *yaml.Node, context *compiler.Context) (*JsonReference, error)

NewJsonReference creates an object of type JsonReference if possible, returning an error if not.

type License 

type License = openapiv2.License

func NewLicense 

func NewLicense(in *yaml.Node, context *compiler.Context) (*License, error)

NewLicense creates an object of type License if possible, returning an error if not.

type NamedAny 

type NamedAny = openapiv2.NamedAny

func NewNamedAny 

func NewNamedAny(in *yaml.Node, context *compiler.Context) (*NamedAny, error)

NewNamedAny creates an object of type NamedAny if possible, returning an error if not.

type NamedHeader 

type NamedHeader = openapiv2.NamedHeader

func NewNamedHeader 

func NewNamedHeader(in *yaml.Node, context *compiler.Context) (*NamedHeader, error)

NewNamedHeader creates an object of type NamedHeader if possible, returning an error if not.

type NamedParameter 

type NamedParameter = openapiv2.NamedParameter

func NewNamedParameter 

func NewNamedParameter(in *yaml.Node, context *compiler.Context) (*NamedParameter, error)

NewNamedParameter creates an object of type NamedParameter if possible, returning an error if not.

type NamedPathItem 

type NamedPathItem = openapiv2.NamedPathItem

func NewNamedPathItem 

func NewNamedPathItem(in *yaml.Node, context *compiler.Context) (*NamedPathItem, error)

NewNamedPathItem creates an object of type NamedPathItem if possible, returning an error if not.

type NamedResponse 

type NamedResponse = openapiv2.NamedResponse

func NewNamedResponse 

func NewNamedResponse(in *yaml.Node, context *compiler.Context) (*NamedResponse, error)

NewNamedResponse creates an object of type NamedResponse if possible, returning an error if not.

type NamedResponseValue 

type NamedResponseValue = openapiv2.NamedResponseValue

func NewNamedResponseValue 

func NewNamedResponseValue(in *yaml.Node, context *compiler.Context) (*NamedResponseValue, error)

NewNamedResponseValue creates an object of type NamedResponseValue if possible, returning an error if not.

type NamedSchema 

type NamedSchema = openapiv2.NamedSchema

func NewNamedSchema 

func NewNamedSchema(in *yaml.Node, context *compiler.Context) (*NamedSchema, error)

NewNamedSchema creates an object of type NamedSchema if possible, returning an error if not.

type NamedSecurityDefinitionsItem 

type NamedSecurityDefinitionsItem = openapiv2.NamedSecurityDefinitionsItem

func NewNamedSecurityDefinitionsItem 

func NewNamedSecurityDefinitionsItem(in *yaml.Node, context *compiler.Context) (*NamedSecurityDefinitionsItem, error)

NewNamedSecurityDefinitionsItem creates an object of type NamedSecurityDefinitionsItem if possible, returning an error if not.

type NamedString 

type NamedString = openapiv2.NamedString

func NewNamedString 

func NewNamedString(in *yaml.Node, context *compiler.Context) (*NamedString, error)

NewNamedString creates an object of type NamedString if possible, returning an error if not.

type NamedStringArray 

type NamedStringArray = openapiv2.NamedStringArray

func NewNamedStringArray 

func NewNamedStringArray(in *yaml.Node, context *compiler.Context) (*NamedStringArray, error)

NewNamedStringArray creates an object of type NamedStringArray if possible, returning an error if not.

type NonBodyParameter 

type NonBodyParameter = openapiv2.NonBodyParameter

func NewNonBodyParameter 

func NewNonBodyParameter(in *yaml.Node, context *compiler.Context) (*NonBodyParameter, error)

NewNonBodyParameter creates an object of type NonBodyParameter if possible, returning an error if not.

type NonBodyParameter_FormDataParameterSubSchema 

type NonBodyParameter_FormDataParameterSubSchema = openapiv2.NonBodyParameter_FormDataParameterSubSchema

type NonBodyParameter_HeaderParameterSubSchema 

type NonBodyParameter_HeaderParameterSubSchema = openapiv2.NonBodyParameter_HeaderParameterSubSchema

type NonBodyParameter_PathParameterSubSchema 

type NonBodyParameter_PathParameterSubSchema = openapiv2.NonBodyParameter_PathParameterSubSchema

type NonBodyParameter_QueryParameterSubSchema 

type NonBodyParameter_QueryParameterSubSchema = openapiv2.NonBodyParameter_QueryParameterSubSchema

type Oauth2AccessCodeSecurity 

type Oauth2AccessCodeSecurity = openapiv2.Oauth2AccessCodeSecurity

func NewOauth2AccessCodeSecurity 

func NewOauth2AccessCodeSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2AccessCodeSecurity, error)

NewOauth2AccessCodeSecurity creates an object of type Oauth2AccessCodeSecurity if possible, returning an error if not.

type Oauth2ApplicationSecurity 

type Oauth2ApplicationSecurity = openapiv2.Oauth2ApplicationSecurity

func NewOauth2ApplicationSecurity 

func NewOauth2ApplicationSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2ApplicationSecurity, error)

NewOauth2ApplicationSecurity creates an object of type Oauth2ApplicationSecurity if possible, returning an error if not.

type Oauth2ImplicitSecurity 

type Oauth2ImplicitSecurity = openapiv2.Oauth2ImplicitSecurity

func NewOauth2ImplicitSecurity 

func NewOauth2ImplicitSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2ImplicitSecurity, error)

NewOauth2ImplicitSecurity creates an object of type Oauth2ImplicitSecurity if possible, returning an error if not.

type Oauth2PasswordSecurity 

type Oauth2PasswordSecurity = openapiv2.Oauth2PasswordSecurity

func NewOauth2PasswordSecurity 

func NewOauth2PasswordSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2PasswordSecurity, error)

NewOauth2PasswordSecurity creates an object of type Oauth2PasswordSecurity if possible, returning an error if not.

type Oauth2Scopes 

type Oauth2Scopes = openapiv2.Oauth2Scopes

func NewOauth2Scopes 

func NewOauth2Scopes(in *yaml.Node, context *compiler.Context) (*Oauth2Scopes, error)

NewOauth2Scopes creates an object of type Oauth2Scopes if possible, returning an error if not.

type Operation 

type Operation = openapiv2.Operation

func NewOperation 

func NewOperation(in *yaml.Node, context *compiler.Context) (*Operation, error)

NewOperation creates an object of type Operation if possible, returning an error if not.

type Parameter 

type Parameter = openapiv2.Parameter

func NewParameter 

func NewParameter(in *yaml.Node, context *compiler.Context) (*Parameter, error)

NewParameter creates an object of type Parameter if possible, returning an error if not.

type ParameterDefinitions 

type ParameterDefinitions = openapiv2.ParameterDefinitions

func NewParameterDefinitions 

func NewParameterDefinitions(in *yaml.Node, context *compiler.Context) (*ParameterDefinitions, error)

NewParameterDefinitions creates an object of type ParameterDefinitions if possible, returning an error if not.

type Parameter_BodyParameter 

type Parameter_BodyParameter = openapiv2.Parameter_BodyParameter

type Parameter_NonBodyParameter 

type Parameter_NonBodyParameter = openapiv2.Parameter_NonBodyParameter

type ParametersItem 

type ParametersItem = openapiv2.ParametersItem

func NewParametersItem 

func NewParametersItem(in *yaml.Node, context *compiler.Context) (*ParametersItem, error)

NewParametersItem creates an object of type ParametersItem if possible, returning an error if not.

type ParametersItem_JsonReference 

type ParametersItem_JsonReference = openapiv2.ParametersItem_JsonReference

type ParametersItem_Parameter 

type ParametersItem_Parameter = openapiv2.ParametersItem_Parameter

type PathItem 

type PathItem = openapiv2.PathItem

func NewPathItem 

func NewPathItem(in *yaml.Node, context *compiler.Context) (*PathItem, error)

NewPathItem creates an object of type PathItem if possible, returning an error if not.

type PathParameterSubSchema 

type PathParameterSubSchema = openapiv2.PathParameterSubSchema

func NewPathParameterSubSchema 

func NewPathParameterSubSchema(in *yaml.Node, context *compiler.Context) (*PathParameterSubSchema, error)

NewPathParameterSubSchema creates an object of type PathParameterSubSchema if possible, returning an error if not.

type Paths 

type Paths = openapiv2.Paths

func NewPaths 

func NewPaths(in *yaml.Node, context *compiler.Context) (*Paths, error)

NewPaths creates an object of type Paths if possible, returning an error if not.

type PrimitivesItems 

type PrimitivesItems = openapiv2.PrimitivesItems

func NewPrimitivesItems 

func NewPrimitivesItems(in *yaml.Node, context *compiler.Context) (*PrimitivesItems, error)

NewPrimitivesItems creates an object of type PrimitivesItems if possible, returning an error if not.

type Properties 

type Properties = openapiv2.Properties

func NewProperties 

func NewProperties(in *yaml.Node, context *compiler.Context) (*Properties, error)

NewProperties creates an object of type Properties if possible, returning an error if not.

type QueryParameterSubSchema 

type QueryParameterSubSchema = openapiv2.QueryParameterSubSchema

func NewQueryParameterSubSchema 

func NewQueryParameterSubSchema(in *yaml.Node, context *compiler.Context) (*QueryParameterSubSchema, error)

NewQueryParameterSubSchema creates an object of type QueryParameterSubSchema if possible, returning an error if not.

type Response 

type Response = openapiv2.Response

func NewResponse 

func NewResponse(in *yaml.Node, context *compiler.Context) (*Response, error)

NewResponse creates an object of type Response if possible, returning an error if not.

type ResponseDefinitions 

type ResponseDefinitions = openapiv2.ResponseDefinitions

func NewResponseDefinitions 

func NewResponseDefinitions(in *yaml.Node, context *compiler.Context) (*ResponseDefinitions, error)

NewResponseDefinitions creates an object of type ResponseDefinitions if possible, returning an error if not.

type ResponseValue 

type ResponseValue = openapiv2.ResponseValue

func NewResponseValue 

func NewResponseValue(in *yaml.Node, context *compiler.Context) (*ResponseValue, error)

NewResponseValue creates an object of type ResponseValue if possible, returning an error if not.

type ResponseValue_JsonReference 

type ResponseValue_JsonReference = openapiv2.ResponseValue_JsonReference

type ResponseValue_Response 

type ResponseValue_Response = openapiv2.ResponseValue_Response

type Responses 

type Responses = openapiv2.Responses

func NewResponses 

func NewResponses(in *yaml.Node, context *compiler.Context) (*Responses, error)

NewResponses creates an object of type Responses if possible, returning an error if not.

type Schema 

type Schema = openapiv2.Schema

func NewSchema 

func NewSchema(in *yaml.Node, context *compiler.Context) (*Schema, error)

NewSchema creates an object of type Schema if possible, returning an error if not.

type SchemaItem 

type SchemaItem = openapiv2.SchemaItem

func NewSchemaItem 

func NewSchemaItem(in *yaml.Node, context *compiler.Context) (*SchemaItem, error)

NewSchemaItem creates an object of type SchemaItem if possible, returning an error if not.

type SchemaItem_FileSchema 

type SchemaItem_FileSchema = openapiv2.SchemaItem_FileSchema

type SchemaItem_Schema 

type SchemaItem_Schema = openapiv2.SchemaItem_Schema

type SecurityDefinitions 

type SecurityDefinitions = openapiv2.SecurityDefinitions

func NewSecurityDefinitions 

func NewSecurityDefinitions(in *yaml.Node, context *compiler.Context) (*SecurityDefinitions, error)

NewSecurityDefinitions creates an object of type SecurityDefinitions if possible, returning an error if not.

type SecurityDefinitionsItem 

type SecurityDefinitionsItem = openapiv2.SecurityDefinitionsItem

func NewSecurityDefinitionsItem 

func NewSecurityDefinitionsItem(in *yaml.Node, context *compiler.Context) (*SecurityDefinitionsItem, error)

NewSecurityDefinitionsItem creates an object of type SecurityDefinitionsItem if possible, returning an error if not.

type SecurityDefinitionsItem_ApiKeySecurity 

type SecurityDefinitionsItem_ApiKeySecurity = openapiv2.SecurityDefinitionsItem_ApiKeySecurity

type SecurityDefinitionsItem_BasicAuthenticationSecurity 

type SecurityDefinitionsItem_BasicAuthenticationSecurity = openapiv2.SecurityDefinitionsItem_BasicAuthenticationSecurity

type SecurityDefinitionsItem_Oauth2AccessCodeSecurity 

type SecurityDefinitionsItem_Oauth2AccessCodeSecurity = openapiv2.SecurityDefinitionsItem_Oauth2AccessCodeSecurity

type SecurityDefinitionsItem_Oauth2ApplicationSecurity 

type SecurityDefinitionsItem_Oauth2ApplicationSecurity = openapiv2.SecurityDefinitionsItem_Oauth2ApplicationSecurity

type SecurityDefinitionsItem_Oauth2ImplicitSecurity 

type SecurityDefinitionsItem_Oauth2ImplicitSecurity = openapiv2.SecurityDefinitionsItem_Oauth2ImplicitSecurity

type SecurityDefinitionsItem_Oauth2PasswordSecurity 

type SecurityDefinitionsItem_Oauth2PasswordSecurity = openapiv2.SecurityDefinitionsItem_Oauth2PasswordSecurity

type SecurityRequirement 

type SecurityRequirement = openapiv2.SecurityRequirement

func NewSecurityRequirement 

func NewSecurityRequirement(in *yaml.Node, context *compiler.Context) (*SecurityRequirement, error)

NewSecurityRequirement creates an object of type SecurityRequirement if possible, returning an error if not.

type StringArray 

type StringArray = openapiv2.StringArray

func NewStringArray 

func NewStringArray(in *yaml.Node, context *compiler.Context) (*StringArray, error)

NewStringArray creates an object of type StringArray if possible, returning an error if not.

type Tag 

type Tag = openapiv2.Tag

func NewTag 

func NewTag(in *yaml.Node, context *compiler.Context) (*Tag, error)

NewTag creates an object of type Tag if possible, returning an error if not.

type TypeItem 

type TypeItem = openapiv2.TypeItem

func NewTypeItem 

func NewTypeItem(in *yaml.Node, context *compiler.Context) (*TypeItem, error)

NewTypeItem creates an object of type TypeItem if possible, returning an error if not.

type VendorExtension 

type VendorExtension = openapiv2.VendorExtension

func NewVendorExtension 

func NewVendorExtension(in *yaml.Node, context *compiler.Context) (*VendorExtension, error)

NewVendorExtension creates an object of type VendorExtension if possible, returning an error if not.

type Xml 

type Xml = openapiv2.Xml

func NewXml 

func NewXml(in *yaml.Node, context *compiler.Context) (*Xml, error)

NewXml creates an object of type Xml if possible, returning an error if not.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.