# README
OpenAPI v3 Protocol Buffer Models
This directory contains a Protocol Buffer-language model and related code for supporting OpenAPI v3.
Gnostic applications and plugins can use OpenAPIv3.proto to generate Protocol Buffer support code for their preferred languages.
OpenAPIv3.go is used by Gnostic to read JSON and YAML OpenAPI descriptions into the Protocol Buffer-based datastructures generated from OpenAPIv3.proto.
OpenAPIv3.proto and OpenAPIv3.go are generated by the Gnostic compiler generator, and OpenAPIv3.pb.go is generated by protoc, the Protocol Buffer compiler, and protoc-gen-go, the Protocol Buffer Go code generation plugin.
openapi-3.0.json is a preliminary draft JSON schema for OpenAPI 3.0. It is not the official OpenAPI 3.0 JSON Schema, which at the time of this commit, does not exist.
The schema-generator directory contains support code which generates openapi-3.0.json from a draft of the OpenAPI 3.0 specification document (Markdown).
# Packages
schema-generator is a support tool that generates the OpenAPI v3 JSON schema.
# 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.
NewAnyOrExpression creates an object of type AnyOrExpression if possible, returning an error if not.
NewAnysOrExpressions creates an object of type AnysOrExpressions if possible, returning an error if not.
NewCallback creates an object of type Callback if possible, returning an error if not.
NewCallbackOrReference creates an object of type CallbackOrReference if possible, returning an error if not.
NewCallbacksOrReferences creates an object of type CallbacksOrReferences if possible, returning an error if not.
NewComponents creates an object of type Components if possible, returning an error if not.
NewContact creates an object of type Contact if possible, returning an error if not.
NewDefaultType creates an object of type DefaultType if possible, returning an error if not.
NewDiscriminator creates an object of type Discriminator if possible, returning an error if not.
NewDocument creates an object of type Document if possible, returning an error if not.
NewEncoding creates an object of type Encoding if possible, returning an error if not.
NewEncodings creates an object of type Encodings if possible, returning an error if not.
NewExample creates an object of type Example if possible, returning an error if not.
NewExampleOrReference creates an object of type ExampleOrReference if possible, returning an error if not.
NewExamplesOrReferences creates an object of type ExamplesOrReferences if possible, returning an error if not.
NewExpression creates an object of type Expression if possible, returning an error if not.
NewExternalDocs creates an object of type ExternalDocs if possible, returning an error if not.
NewHeader creates an object of type Header if possible, returning an error if not.
NewHeaderOrReference creates an object of type HeaderOrReference if possible, returning an error if not.
NewHeadersOrReferences creates an object of type HeadersOrReferences 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.
NewLicense creates an object of type License if possible, returning an error if not.
NewLink creates an object of type Link if possible, returning an error if not.
NewLinkOrReference creates an object of type LinkOrReference if possible, returning an error if not.
NewLinksOrReferences creates an object of type LinksOrReferences if possible, returning an error if not.
NewMediaType creates an object of type MediaType if possible, returning an error if not.
NewMediaTypes creates an object of type MediaTypes if possible, returning an error if not.
NewNamedAny creates an object of type NamedAny if possible, returning an error if not.
NewNamedAnyOrExpression creates an object of type NamedAnyOrExpression if possible, returning an error if not.
NewNamedCallbackOrReference creates an object of type NamedCallbackOrReference if possible, returning an error if not.
NewNamedEncoding creates an object of type NamedEncoding if possible, returning an error if not.
NewNamedExampleOrReference creates an object of type NamedExampleOrReference if possible, returning an error if not.
NewNamedHeaderOrReference creates an object of type NamedHeaderOrReference if possible, returning an error if not.
NewNamedLinkOrReference creates an object of type NamedLinkOrReference if possible, returning an error if not.
NewNamedMediaType creates an object of type NamedMediaType if possible, returning an error if not.
NewNamedParameterOrReference creates an object of type NamedParameterOrReference if possible, returning an error if not.
NewNamedPathItem creates an object of type NamedPathItem if possible, returning an error if not.
NewNamedRequestBodyOrReference creates an object of type NamedRequestBodyOrReference if possible, returning an error if not.
NewNamedResponseOrReference creates an object of type NamedResponseOrReference if possible, returning an error if not.
NewNamedSchemaOrReference creates an object of type NamedSchemaOrReference if possible, returning an error if not.
NewNamedSecuritySchemeOrReference creates an object of type NamedSecuritySchemeOrReference if possible, returning an error if not.
NewNamedServerVariable creates an object of type NamedServerVariable if possible, returning an error if not.
NewNamedString creates an object of type NamedString if possible, returning an error if not.
NewOauthFlow creates an object of type OauthFlow if possible, returning an error if not.
NewOauthFlows creates an object of type OauthFlows if possible, returning an error if not.
NewObject creates an object of type Object 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.
NewParameterOrReference creates an object of type ParameterOrReference if possible, returning an error if not.
NewParametersOrReferences creates an object of type ParametersOrReferences if possible, returning an error if not.
NewPathItem creates an object of type PathItem if possible, returning an error if not.
NewPaths creates an object of type Paths if possible, returning an error if not.
NewProperties creates an object of type Properties if possible, returning an error if not.
NewReference creates an object of type Reference if possible, returning an error if not.
NewRequestBodiesOrReferences creates an object of type RequestBodiesOrReferences if possible, returning an error if not.
NewRequestBody creates an object of type RequestBody if possible, returning an error if not.
NewRequestBodyOrReference creates an object of type RequestBodyOrReference if possible, returning an error if not.
NewResponse creates an object of type Response if possible, returning an error if not.
NewResponseOrReference creates an object of type ResponseOrReference if possible, returning an error if not.
NewResponses creates an object of type Responses if possible, returning an error if not.
NewResponsesOrReferences creates an object of type ResponsesOrReferences if possible, returning an error if not.
NewSchema creates an object of type Schema if possible, returning an error if not.
NewSchemaOrReference creates an object of type SchemaOrReference if possible, returning an error if not.
NewSchemasOrReferences creates an object of type SchemasOrReferences if possible, returning an error if not.
NewSecurityRequirement creates an object of type SecurityRequirement if possible, returning an error if not.
NewSecurityScheme creates an object of type SecurityScheme if possible, returning an error if not.
NewSecuritySchemeOrReference creates an object of type SecuritySchemeOrReference if possible, returning an error if not.
NewSecuritySchemesOrReferences creates an object of type SecuritySchemesOrReferences if possible, returning an error if not.
NewServer creates an object of type Server if possible, returning an error if not.
NewServerVariable creates an object of type ServerVariable if possible, returning an error if not.
NewServerVariables creates an object of type ServerVariables if possible, returning an error if not.
NewSpecificationExtension creates an object of type SpecificationExtension if possible, returning an error if not.
NewStringArray creates an object of type StringArray if possible, returning an error if not.
NewStrings creates an object of type Strings if possible, returning an error if not.
NewTag creates an object of type Tag 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
No description provided by the author
A map of possible out-of band callbacks related to the parent operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Holds a set of reusable objects for different aspects of the OAS.
Contact information for the exposed API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation.
No description provided by the author
A single encoding definition applied to a single schema property.
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
Allows referencing an external resource for extended documentation.
The Header Object follows the structure of the Parameter Object with the following changes: 1.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The object provides metadata about the API.
No description provided by the author
License information for the exposed API.
The `Link object` represents a possible design-time link for a response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Each Media Type Object provides schema and examples for the media type identified by its key.
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 AnyOrExpression as ordered (name,value) pairs.
Automatically-generated message used to represent maps of CallbackOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of Encoding as ordered (name,value) pairs.
Automatically-generated message used to represent maps of ExampleOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of HeaderOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of LinkOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of MediaType as ordered (name,value) pairs.
Automatically-generated message used to represent maps of ParameterOrReference 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 RequestBodyOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of ResponseOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of SchemaOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of SecuritySchemeOrReference as ordered (name,value) pairs.
Automatically-generated message used to represent maps of ServerVariable as ordered (name,value) pairs.
Automatically-generated message used to represent maps of string as ordered (name,value) pairs.
Configuration details for a supported OAuth Flow.
Allows configuration of the supported OAuth Flows.
No description provided by the author
Describes a single API operation on a path.
Describes a single operation parameter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the operations available on a single path.
Holds the relative paths to the individual endpoints and their operations.
No description provided by the author
A simple object to allow referencing other components in the specification, internally and externally.
No description provided by the author
Describes a single request body.
No description provided by the author
No description provided by the author
No description provided by the author
Describes a single response from an API Operation, including design-time, static `links` to operations based on the response.
No description provided by the author
No description provided by the author
No description provided by the author
A container for the expected responses of an operation.
No description provided by the author
The Schema Object allows the definition of input and output data types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Lists the required security schemes to execute this operation.
Defines a security scheme that can be used by the operations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An object representing a Server.
An object representing a Server Variable for server URL template substitution.
No description provided by the author
Any property starting with x- is valid.
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
Adds metadata to a single tag that is used by the Operation Object.
A metadata object that allows for more fine-tuned XML model definitions.