Documentation ¶
Index ¶
- Variables
- func Version() string
- type AdditionalPropertiesItem
- type AdditionalPropertiesItem_Boolean
- type AdditionalPropertiesItem_SchemaOrReference
- type Any
- type AnyOrExpression
- type AnyOrExpression_Any
- type AnyOrExpression_Expression
- type Callback
- type CallbackOrReference
- type CallbackOrReference_Callback
- type CallbackOrReference_Reference
- type CallbacksOrReferences
- type Components
- type Contact
- type DefaultType
- type DefaultType_Boolean
- type DefaultType_Number
- type DefaultType_String_
- type Discriminator
- type Document
- type Encoding
- type Encodings
- type Example
- type ExampleOrReference
- type ExampleOrReference_Example
- type ExampleOrReference_Reference
- type ExamplesOrReferences
- type Expression
- type ExternalDocs
- type Header
- type HeaderOrReference
- type HeaderOrReference_Header
- type HeaderOrReference_Reference
- type HeadersOrReferences
- type Info
- type ItemsItem
- type License
- type Link
- type LinkOrReference
- type LinkOrReference_Link
- type LinkOrReference_Reference
- type LinksOrReferences
- type MediaType
- type MediaTypes
- type NamedAny
- type NamedCallbackOrReference
- type NamedEncoding
- type NamedExampleOrReference
- type NamedHeaderOrReference
- type NamedLinkOrReference
- type NamedMediaType
- type NamedParameterOrReference
- type NamedPathItem
- type NamedRequestBodyOrReference
- type NamedResponseOrReference
- type NamedSchemaOrReference
- type NamedSecuritySchemeOrReference
- type NamedServerVariable
- type NamedString
- type NamedStringArray
- type OauthFlow
- type OauthFlows
- type Object
- type Operation
- type Parameter
- type ParameterOrReference
- type ParameterOrReference_Parameter
- type ParameterOrReference_Reference
- type ParametersOrReferences
- type PathItem
- type Paths
- type Properties
- type Reference
- type RequestBodiesOrReferences
- type RequestBody
- type RequestBodyOrReference
- type RequestBodyOrReference_Reference
- type RequestBodyOrReference_RequestBody
- type Response
- type ResponseOrReference
- type ResponseOrReference_Reference
- type ResponseOrReference_Response
- type Responses
- type ResponsesOrReferences
- type Schema
- type SchemaOrReference
- type SchemaOrReference_Reference
- type SchemaOrReference_Schema
- type SchemasOrReferences
- type SecurityRequirement
- type SecurityScheme
- type SecuritySchemeOrReference
- type SecuritySchemeOrReference_Reference
- type SecuritySchemeOrReference_SecurityScheme
- type SecuritySchemesOrReferences
- type Server
- type ServerVariable
- type ServerVariables
- type SpecificationExtension
- type SpecificationExtension_Boolean
- type SpecificationExtension_Number
- type SpecificationExtension_String_
- type StringArray
- type Strings
- type Tag
- type Xml
Constants ¶
This section is empty.
Variables ¶
var ( E_Document = openapiv3.E_Document E_Operation = openapiv3.E_Operation E_Schema = openapiv3.E_Schema E_Property = openapiv3.E_Property )
var File_openapiv3_OpenAPIv3_proto = openapiv3.File_openapiv3_OpenAPIv3_proto
var File_openapiv3_annotations_proto = openapiv3.File_openapiv3_annotations_proto
Functions ¶
Types ¶
type AdditionalPropertiesItem ¶
type AdditionalPropertiesItem = openapiv3.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 = openapiv3.AdditionalPropertiesItem_Boolean
type AdditionalPropertiesItem_SchemaOrReference ¶
type AdditionalPropertiesItem_SchemaOrReference = openapiv3.AdditionalPropertiesItem_SchemaOrReference
type AnyOrExpression ¶
type AnyOrExpression = openapiv3.AnyOrExpression
func NewAnyOrExpression ¶
func NewAnyOrExpression(in *yaml.Node, context *compiler.Context) (*AnyOrExpression, error)
NewAnyOrExpression creates an object of type AnyOrExpression if possible, returning an error if not.
type AnyOrExpression_Any ¶
type AnyOrExpression_Any = openapiv3.AnyOrExpression_Any
type AnyOrExpression_Expression ¶
type AnyOrExpression_Expression = openapiv3.AnyOrExpression_Expression
type CallbackOrReference ¶
type CallbackOrReference = openapiv3.CallbackOrReference
func NewCallbackOrReference ¶
func NewCallbackOrReference(in *yaml.Node, context *compiler.Context) (*CallbackOrReference, error)
NewCallbackOrReference creates an object of type CallbackOrReference if possible, returning an error if not.
type CallbackOrReference_Callback ¶
type CallbackOrReference_Callback = openapiv3.CallbackOrReference_Callback
type CallbackOrReference_Reference ¶
type CallbackOrReference_Reference = openapiv3.CallbackOrReference_Reference
type CallbacksOrReferences ¶
type CallbacksOrReferences = openapiv3.CallbacksOrReferences
func NewCallbacksOrReferences ¶
func NewCallbacksOrReferences(in *yaml.Node, context *compiler.Context) (*CallbacksOrReferences, error)
NewCallbacksOrReferences creates an object of type CallbacksOrReferences if possible, returning an error if not.
type Components ¶
type Components = openapiv3.Components
func NewComponents ¶
func NewComponents(in *yaml.Node, context *compiler.Context) (*Components, error)
NewComponents creates an object of type Components if possible, returning an error if not.
type DefaultType ¶
type DefaultType = openapiv3.DefaultType
func NewDefaultType ¶
func NewDefaultType(in *yaml.Node, context *compiler.Context) (*DefaultType, error)
NewDefaultType creates an object of type DefaultType if possible, returning an error if not.
type DefaultType_Boolean ¶
type DefaultType_Boolean = openapiv3.DefaultType_Boolean
type DefaultType_Number ¶
type DefaultType_Number = openapiv3.DefaultType_Number
type DefaultType_String_ ¶
type DefaultType_String_ = openapiv3.DefaultType_String_
type Discriminator ¶
type Discriminator = openapiv3.Discriminator
func NewDiscriminator ¶
func NewDiscriminator(in *yaml.Node, context *compiler.Context) (*Discriminator, error)
NewDiscriminator creates an object of type Discriminator if possible, returning an error if not.
type Document ¶
func NewDocument ¶
NewDocument creates an object of type Document if possible, returning an error if not.
func ParseDocument ¶
ParseDocument reads an OpenAPI v3 description from a YAML/JSON representation.
type ExampleOrReference ¶
type ExampleOrReference = openapiv3.ExampleOrReference
func NewExampleOrReference ¶
func NewExampleOrReference(in *yaml.Node, context *compiler.Context) (*ExampleOrReference, error)
NewExampleOrReference creates an object of type ExampleOrReference if possible, returning an error if not.
type ExampleOrReference_Example ¶
type ExampleOrReference_Example = openapiv3.ExampleOrReference_Example
type ExampleOrReference_Reference ¶
type ExampleOrReference_Reference = openapiv3.ExampleOrReference_Reference
type ExamplesOrReferences ¶
type ExamplesOrReferences = openapiv3.ExamplesOrReferences
func NewExamplesOrReferences ¶
func NewExamplesOrReferences(in *yaml.Node, context *compiler.Context) (*ExamplesOrReferences, error)
NewExamplesOrReferences creates an object of type ExamplesOrReferences if possible, returning an error if not.
type Expression ¶
type Expression = openapiv3.Expression
func NewExpression ¶
func NewExpression(in *yaml.Node, context *compiler.Context) (*Expression, error)
NewExpression creates an object of type Expression if possible, returning an error if not.
type ExternalDocs ¶
type ExternalDocs = openapiv3.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 HeaderOrReference ¶
type HeaderOrReference = openapiv3.HeaderOrReference
func NewHeaderOrReference ¶
func NewHeaderOrReference(in *yaml.Node, context *compiler.Context) (*HeaderOrReference, error)
NewHeaderOrReference creates an object of type HeaderOrReference if possible, returning an error if not.
type HeaderOrReference_Header ¶
type HeaderOrReference_Header = openapiv3.HeaderOrReference_Header
type HeaderOrReference_Reference ¶
type HeaderOrReference_Reference = openapiv3.HeaderOrReference_Reference
type HeadersOrReferences ¶
type HeadersOrReferences = openapiv3.HeadersOrReferences
func NewHeadersOrReferences ¶
func NewHeadersOrReferences(in *yaml.Node, context *compiler.Context) (*HeadersOrReferences, error)
NewHeadersOrReferences creates an object of type HeadersOrReferences if possible, returning an error if not.
type LinkOrReference ¶
type LinkOrReference = openapiv3.LinkOrReference
func NewLinkOrReference ¶
func NewLinkOrReference(in *yaml.Node, context *compiler.Context) (*LinkOrReference, error)
NewLinkOrReference creates an object of type LinkOrReference if possible, returning an error if not.
type LinkOrReference_Link ¶
type LinkOrReference_Link = openapiv3.LinkOrReference_Link
type LinkOrReference_Reference ¶
type LinkOrReference_Reference = openapiv3.LinkOrReference_Reference
type LinksOrReferences ¶
type LinksOrReferences = openapiv3.LinksOrReferences
func NewLinksOrReferences ¶
func NewLinksOrReferences(in *yaml.Node, context *compiler.Context) (*LinksOrReferences, error)
NewLinksOrReferences creates an object of type LinksOrReferences if possible, returning an error if not.
type MediaTypes ¶
type MediaTypes = openapiv3.MediaTypes
func NewMediaTypes ¶
func NewMediaTypes(in *yaml.Node, context *compiler.Context) (*MediaTypes, error)
NewMediaTypes creates an object of type MediaTypes if possible, returning an error if not.
type NamedCallbackOrReference ¶
type NamedCallbackOrReference = openapiv3.NamedCallbackOrReference
func NewNamedCallbackOrReference ¶
func NewNamedCallbackOrReference(in *yaml.Node, context *compiler.Context) (*NamedCallbackOrReference, error)
NewNamedCallbackOrReference creates an object of type NamedCallbackOrReference if possible, returning an error if not.
type NamedEncoding ¶
type NamedEncoding = openapiv3.NamedEncoding
func NewNamedEncoding ¶
func NewNamedEncoding(in *yaml.Node, context *compiler.Context) (*NamedEncoding, error)
NewNamedEncoding creates an object of type NamedEncoding if possible, returning an error if not.
type NamedExampleOrReference ¶
type NamedExampleOrReference = openapiv3.NamedExampleOrReference
func NewNamedExampleOrReference ¶
func NewNamedExampleOrReference(in *yaml.Node, context *compiler.Context) (*NamedExampleOrReference, error)
NewNamedExampleOrReference creates an object of type NamedExampleOrReference if possible, returning an error if not.
type NamedHeaderOrReference ¶
type NamedHeaderOrReference = openapiv3.NamedHeaderOrReference
func NewNamedHeaderOrReference ¶
func NewNamedHeaderOrReference(in *yaml.Node, context *compiler.Context) (*NamedHeaderOrReference, error)
NewNamedHeaderOrReference creates an object of type NamedHeaderOrReference if possible, returning an error if not.
type NamedLinkOrReference ¶
type NamedLinkOrReference = openapiv3.NamedLinkOrReference
func NewNamedLinkOrReference ¶
func NewNamedLinkOrReference(in *yaml.Node, context *compiler.Context) (*NamedLinkOrReference, error)
NewNamedLinkOrReference creates an object of type NamedLinkOrReference if possible, returning an error if not.
type NamedMediaType ¶
type NamedMediaType = openapiv3.NamedMediaType
func NewNamedMediaType ¶
func NewNamedMediaType(in *yaml.Node, context *compiler.Context) (*NamedMediaType, error)
NewNamedMediaType creates an object of type NamedMediaType if possible, returning an error if not.
type NamedParameterOrReference ¶
type NamedParameterOrReference = openapiv3.NamedParameterOrReference
func NewNamedParameterOrReference ¶
func NewNamedParameterOrReference(in *yaml.Node, context *compiler.Context) (*NamedParameterOrReference, error)
NewNamedParameterOrReference creates an object of type NamedParameterOrReference if possible, returning an error if not.
type NamedPathItem ¶
type NamedPathItem = openapiv3.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 NamedRequestBodyOrReference ¶
type NamedRequestBodyOrReference = openapiv3.NamedRequestBodyOrReference
func NewNamedRequestBodyOrReference ¶
func NewNamedRequestBodyOrReference(in *yaml.Node, context *compiler.Context) (*NamedRequestBodyOrReference, error)
NewNamedRequestBodyOrReference creates an object of type NamedRequestBodyOrReference if possible, returning an error if not.
type NamedResponseOrReference ¶
type NamedResponseOrReference = openapiv3.NamedResponseOrReference
func NewNamedResponseOrReference ¶
func NewNamedResponseOrReference(in *yaml.Node, context *compiler.Context) (*NamedResponseOrReference, error)
NewNamedResponseOrReference creates an object of type NamedResponseOrReference if possible, returning an error if not.
type NamedSchemaOrReference ¶
type NamedSchemaOrReference = openapiv3.NamedSchemaOrReference
func NewNamedSchemaOrReference ¶
func NewNamedSchemaOrReference(in *yaml.Node, context *compiler.Context) (*NamedSchemaOrReference, error)
NewNamedSchemaOrReference creates an object of type NamedSchemaOrReference if possible, returning an error if not.
type NamedSecuritySchemeOrReference ¶
type NamedSecuritySchemeOrReference = openapiv3.NamedSecuritySchemeOrReference
func NewNamedSecuritySchemeOrReference ¶
func NewNamedSecuritySchemeOrReference(in *yaml.Node, context *compiler.Context) (*NamedSecuritySchemeOrReference, error)
NewNamedSecuritySchemeOrReference creates an object of type NamedSecuritySchemeOrReference if possible, returning an error if not.
type NamedServerVariable ¶
type NamedServerVariable = openapiv3.NamedServerVariable
func NewNamedServerVariable ¶
func NewNamedServerVariable(in *yaml.Node, context *compiler.Context) (*NamedServerVariable, error)
NewNamedServerVariable creates an object of type NamedServerVariable if possible, returning an error if not.
type NamedString ¶
type NamedString = openapiv3.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 = openapiv3.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 OauthFlows ¶
type OauthFlows = openapiv3.OauthFlows
func NewOauthFlows ¶
func NewOauthFlows(in *yaml.Node, context *compiler.Context) (*OauthFlows, error)
NewOauthFlows creates an object of type OauthFlows if possible, returning an error if not.
type ParameterOrReference ¶
type ParameterOrReference = openapiv3.ParameterOrReference
func NewParameterOrReference ¶
func NewParameterOrReference(in *yaml.Node, context *compiler.Context) (*ParameterOrReference, error)
NewParameterOrReference creates an object of type ParameterOrReference if possible, returning an error if not.
type ParameterOrReference_Parameter ¶
type ParameterOrReference_Parameter = openapiv3.ParameterOrReference_Parameter
type ParameterOrReference_Reference ¶
type ParameterOrReference_Reference = openapiv3.ParameterOrReference_Reference
type ParametersOrReferences ¶
type ParametersOrReferences = openapiv3.ParametersOrReferences
func NewParametersOrReferences ¶
func NewParametersOrReferences(in *yaml.Node, context *compiler.Context) (*ParametersOrReferences, error)
NewParametersOrReferences creates an object of type ParametersOrReferences if possible, returning an error if not.
type Properties ¶
type Properties = openapiv3.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 RequestBodiesOrReferences ¶
type RequestBodiesOrReferences = openapiv3.RequestBodiesOrReferences
func NewRequestBodiesOrReferences ¶
func NewRequestBodiesOrReferences(in *yaml.Node, context *compiler.Context) (*RequestBodiesOrReferences, error)
NewRequestBodiesOrReferences creates an object of type RequestBodiesOrReferences if possible, returning an error if not.
type RequestBody ¶
type RequestBody = openapiv3.RequestBody
func NewRequestBody ¶
func NewRequestBody(in *yaml.Node, context *compiler.Context) (*RequestBody, error)
NewRequestBody creates an object of type RequestBody if possible, returning an error if not.
type RequestBodyOrReference ¶
type RequestBodyOrReference = openapiv3.RequestBodyOrReference
func NewRequestBodyOrReference ¶
func NewRequestBodyOrReference(in *yaml.Node, context *compiler.Context) (*RequestBodyOrReference, error)
NewRequestBodyOrReference creates an object of type RequestBodyOrReference if possible, returning an error if not.
type RequestBodyOrReference_Reference ¶
type RequestBodyOrReference_Reference = openapiv3.RequestBodyOrReference_Reference
type RequestBodyOrReference_RequestBody ¶
type RequestBodyOrReference_RequestBody = openapiv3.RequestBodyOrReference_RequestBody
type ResponseOrReference ¶
type ResponseOrReference = openapiv3.ResponseOrReference
func NewResponseOrReference ¶
func NewResponseOrReference(in *yaml.Node, context *compiler.Context) (*ResponseOrReference, error)
NewResponseOrReference creates an object of type ResponseOrReference if possible, returning an error if not.
type ResponseOrReference_Reference ¶
type ResponseOrReference_Reference = openapiv3.ResponseOrReference_Reference
type ResponseOrReference_Response ¶
type ResponseOrReference_Response = openapiv3.ResponseOrReference_Response
type ResponsesOrReferences ¶
type ResponsesOrReferences = openapiv3.ResponsesOrReferences
func NewResponsesOrReferences ¶
func NewResponsesOrReferences(in *yaml.Node, context *compiler.Context) (*ResponsesOrReferences, error)
NewResponsesOrReferences creates an object of type ResponsesOrReferences if possible, returning an error if not.
type SchemaOrReference ¶
type SchemaOrReference = openapiv3.SchemaOrReference
func NewSchemaOrReference ¶
func NewSchemaOrReference(in *yaml.Node, context *compiler.Context) (*SchemaOrReference, error)
NewSchemaOrReference creates an object of type SchemaOrReference if possible, returning an error if not.
type SchemaOrReference_Reference ¶
type SchemaOrReference_Reference = openapiv3.SchemaOrReference_Reference
type SchemaOrReference_Schema ¶
type SchemaOrReference_Schema = openapiv3.SchemaOrReference_Schema
type SchemasOrReferences ¶
type SchemasOrReferences = openapiv3.SchemasOrReferences
func NewSchemasOrReferences ¶
func NewSchemasOrReferences(in *yaml.Node, context *compiler.Context) (*SchemasOrReferences, error)
NewSchemasOrReferences creates an object of type SchemasOrReferences if possible, returning an error if not.
type SecurityRequirement ¶
type SecurityRequirement = openapiv3.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 SecurityScheme ¶
type SecurityScheme = openapiv3.SecurityScheme
func NewSecurityScheme ¶
func NewSecurityScheme(in *yaml.Node, context *compiler.Context) (*SecurityScheme, error)
NewSecurityScheme creates an object of type SecurityScheme if possible, returning an error if not.
type SecuritySchemeOrReference ¶
type SecuritySchemeOrReference = openapiv3.SecuritySchemeOrReference
func NewSecuritySchemeOrReference ¶
func NewSecuritySchemeOrReference(in *yaml.Node, context *compiler.Context) (*SecuritySchemeOrReference, error)
NewSecuritySchemeOrReference creates an object of type SecuritySchemeOrReference if possible, returning an error if not.
type SecuritySchemeOrReference_Reference ¶
type SecuritySchemeOrReference_Reference = openapiv3.SecuritySchemeOrReference_Reference
type SecuritySchemeOrReference_SecurityScheme ¶
type SecuritySchemeOrReference_SecurityScheme = openapiv3.SecuritySchemeOrReference_SecurityScheme
type SecuritySchemesOrReferences ¶
type SecuritySchemesOrReferences = openapiv3.SecuritySchemesOrReferences
func NewSecuritySchemesOrReferences ¶
func NewSecuritySchemesOrReferences(in *yaml.Node, context *compiler.Context) (*SecuritySchemesOrReferences, error)
NewSecuritySchemesOrReferences creates an object of type SecuritySchemesOrReferences if possible, returning an error if not.
type ServerVariable ¶
type ServerVariable = openapiv3.ServerVariable
func NewServerVariable ¶
func NewServerVariable(in *yaml.Node, context *compiler.Context) (*ServerVariable, error)
NewServerVariable creates an object of type ServerVariable if possible, returning an error if not.
type ServerVariables ¶
type ServerVariables = openapiv3.ServerVariables
func NewServerVariables ¶
func NewServerVariables(in *yaml.Node, context *compiler.Context) (*ServerVariables, error)
NewServerVariables creates an object of type ServerVariables if possible, returning an error if not.
type SpecificationExtension ¶
type SpecificationExtension = openapiv3.SpecificationExtension
func NewSpecificationExtension ¶
func NewSpecificationExtension(in *yaml.Node, context *compiler.Context) (*SpecificationExtension, error)
NewSpecificationExtension creates an object of type SpecificationExtension if possible, returning an error if not.
type SpecificationExtension_Boolean ¶
type SpecificationExtension_Boolean = openapiv3.SpecificationExtension_Boolean
type SpecificationExtension_Number ¶
type SpecificationExtension_Number = openapiv3.SpecificationExtension_Number
type SpecificationExtension_String_ ¶
type SpecificationExtension_String_ = openapiv3.SpecificationExtension_String_
type StringArray ¶
type StringArray = openapiv3.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.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
schema-generator is a support tool that generates the OpenAPI v3 JSON schema.
|
schema-generator is a support tool that generates the OpenAPI v3 JSON schema. |