# 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.
# Functions
NewAdditionalPropertiesItem creates an object of type AdditionalPropertiesItem if possible, returning an error if not.
NewAny creates an object of type Any if possible, returning an error if not.
NewApiKeySecurity creates an object of type ApiKeySecurity if possible, returning an error if not.
NewBasicAuthenticationSecurity creates an object of type BasicAuthenticationSecurity if possible, returning an error if not.
NewBodyParameter creates an object of type BodyParameter if possible, returning an error if not.
NewContact creates an object of type Contact if possible, returning an error if not.
NewDefault creates an object of type Default if possible, returning an error if not.
NewDefinitions creates an object of type Definitions if possible, returning an error if not.
NewDocument creates an object of type Document if possible, returning an error if not.
NewExamples creates an object of type Examples if possible, returning an error if not.
NewExternalDocs creates an object of type ExternalDocs if possible, returning an error if not.
NewFileSchema creates an object of type FileSchema if possible, returning an error if not.
NewFormDataParameterSubSchema creates an object of type FormDataParameterSubSchema if possible, returning an error if not.
NewHeader creates an object of type Header if possible, returning an error if not.
NewHeaderParameterSubSchema creates an object of type HeaderParameterSubSchema if possible, returning an error if not.
NewHeaders creates an object of type Headers if possible, returning an error if not.
NewInfo creates an object of type Info if possible, returning an error if not.
NewItemsItem creates an object of type ItemsItem if possible, returning an error if not.
NewJsonReference creates an object of type JsonReference if possible, returning an error if not.
NewLicense creates an object of type License if possible, returning an error if not.
NewNamedAny creates an object of type NamedAny if possible, returning an error if not.
NewNamedHeader creates an object of type NamedHeader if possible, returning an error if not.
NewNamedParameter creates an object of type NamedParameter if possible, returning an error if not.
NewNamedPathItem creates an object of type NamedPathItem if possible, returning an error if not.
NewNamedResponse creates an object of type NamedResponse if possible, returning an error if not.
NewNamedResponseValue creates an object of type NamedResponseValue if possible, returning an error if not.
NewNamedSchema creates an object of type NamedSchema if possible, returning an error if not.
NewNamedSecurityDefinitionsItem creates an object of type NamedSecurityDefinitionsItem if possible, returning an error if not.
NewNamedString creates an object of type NamedString if possible, returning an error if not.
NewNamedStringArray creates an object of type NamedStringArray if possible, returning an error if not.
NewNonBodyParameter creates an object of type NonBodyParameter if possible, returning an error if not.
NewOauth2AccessCodeSecurity creates an object of type Oauth2AccessCodeSecurity if possible, returning an error if not.
NewOauth2ApplicationSecurity creates an object of type Oauth2ApplicationSecurity if possible, returning an error if not.
NewOauth2ImplicitSecurity creates an object of type Oauth2ImplicitSecurity if possible, returning an error if not.
NewOauth2PasswordSecurity creates an object of type Oauth2PasswordSecurity if possible, returning an error if not.
NewOauth2Scopes creates an object of type Oauth2Scopes if possible, returning an error if not.
NewOperation creates an object of type Operation if possible, returning an error if not.
NewParameter creates an object of type Parameter if possible, returning an error if not.
NewParameterDefinitions creates an object of type ParameterDefinitions if possible, returning an error if not.
NewParametersItem creates an object of type ParametersItem if possible, returning an error if not.
NewPathItem creates an object of type PathItem if possible, returning an error if not.
NewPathParameterSubSchema creates an object of type PathParameterSubSchema if possible, returning an error if not.
NewPaths creates an object of type Paths if possible, returning an error if not.
NewPrimitivesItems creates an object of type PrimitivesItems if possible, returning an error if not.
NewProperties creates an object of type Properties if possible, returning an error if not.
NewQueryParameterSubSchema creates an object of type QueryParameterSubSchema if possible, returning an error if not.
NewResponse creates an object of type Response if possible, returning an error if not.
NewResponseDefinitions creates an object of type ResponseDefinitions if possible, returning an error if not.
NewResponses creates an object of type Responses if possible, returning an error if not.
NewResponseValue creates an object of type ResponseValue if possible, returning an error if not.
NewSchema creates an object of type Schema if possible, returning an error if not.
NewSchemaItem creates an object of type SchemaItem if possible, returning an error if not.
NewSecurityDefinitions creates an object of type SecurityDefinitions if possible, returning an error if not.
NewSecurityDefinitionsItem creates an object of type SecurityDefinitionsItem if possible, returning an error if not.
NewSecurityRequirement creates an object of type SecurityRequirement if possible, returning an error if not.
NewStringArray creates an object of type StringArray if possible, returning an error if not.
NewTag creates an object of type Tag if possible, returning an error if not.
NewTypeItem creates an object of type TypeItem if possible, returning an error if not.
NewVendorExtension creates an object of type VendorExtension if possible, returning an error if not.
NewXml creates an object of type Xml if possible, returning an error if not.
Version returns the package name (and OpenAPI version).
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Contact information for the owners of the API.
No description provided by the author
One or more JSON objects describing the schemas being consumed and produced by the API.
No description provided by the author
No description provided by the author
information about external documentation.
A deterministic version of a JSON Schema object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
General information about the API.
No description provided by the author
No description provided by the author
No description provided by the author
Automatically-generated message used to represent maps of Any as ordered (name,value) pairs.
Automatically-generated message used to represent maps of Header as ordered (name,value) pairs.
Automatically-generated message used to represent maps of Parameter as ordered (name,value) pairs.
Automatically-generated message used to represent maps of PathItem as ordered (name,value) pairs.
Automatically-generated message used to represent maps of Response as ordered (name,value) pairs.
Automatically-generated message used to represent maps of ResponseValue as ordered (name,value) pairs.
Automatically-generated message used to represent maps of Schema as ordered (name,value) pairs.
Automatically-generated message used to represent maps of SecurityDefinitionsItem as ordered (name,value) pairs.
Automatically-generated message used to represent maps of string as ordered (name,value) pairs.
Automatically-generated message used to represent maps of StringArray as ordered (name,value) pairs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
One or more JSON representations for parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Relative paths to the individual endpoints.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
One or more JSON representations for parameters.
Response objects names can either be any valid HTTP status code or 'default'.
No description provided by the author
No description provided by the author
No description provided by the author
A deterministic version of a JSON Schema object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Any property starting with x- is valid.
No description provided by the author