openapi_v3

package
v0.6.9 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: Apache-2.0 Imports: 11 Imported by: 22

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.1.json is a JSON schema for OpenAPI 3.1 that is automatically generated from the OpenAPI 3.1 specification. It is not an official JSON Schema for OpenAPI.

The schema-generator directory contains support code which generates openapi-3.1.json from the OpenAPI 3.1 specification document (Markdown).

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// optional openapi.v3.Document document = 1143;
	E_Document = &file_openapiv3_annotations_proto_extTypes[0]
)

Extension fields to descriptorpb.FileOptions.

View Source 
var (
	// optional openapi.v3.Operation operation = 1143;
	E_Operation = &file_openapiv3_annotations_proto_extTypes[1]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var (
	// optional openapi.v3.Schema property = 1143;
	E_Property = &file_openapiv3_annotations_proto_extTypes[3]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var (
	// optional openapi.v3.Schema schema = 1143;
	E_Schema = &file_openapiv3_annotations_proto_extTypes[2]
)

Extension fields to descriptorpb.MessageOptions.

View Source 
var File_openapiv3_OpenAPIv3_proto protoreflect.FileDescriptor
View Source 
var File_openapiv3_annotations_proto protoreflect.FileDescriptor

Functions

func Version 

func Version() string

Version returns the package name (and OpenAPI version).

Types

type AdditionalPropertiesItem 

type AdditionalPropertiesItem struct {

	// Types that are assignable to Oneof:
	//
	//	*AdditionalPropertiesItem_SchemaOrReference
	//	*AdditionalPropertiesItem_Boolean
	Oneof isAdditionalPropertiesItem_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*AdditionalPropertiesItem) Descriptor deprecated 

func (*AdditionalPropertiesItem) Descriptor() ([]byte, []int)

Deprecated: Use AdditionalPropertiesItem.ProtoReflect.Descriptor instead.

func (*AdditionalPropertiesItem) GetBoolean 

func (x *AdditionalPropertiesItem) GetBoolean() bool

func (*AdditionalPropertiesItem) GetOneof 

func (m *AdditionalPropertiesItem) GetOneof() isAdditionalPropertiesItem_Oneof

func (*AdditionalPropertiesItem) GetSchemaOrReference 

func (x *AdditionalPropertiesItem) GetSchemaOrReference() *SchemaOrReference

func (*AdditionalPropertiesItem) ProtoMessage 

func (*AdditionalPropertiesItem) ProtoMessage()

func (*AdditionalPropertiesItem) ProtoReflect 

func (x *AdditionalPropertiesItem) ProtoReflect() protoreflect.Message

func (*AdditionalPropertiesItem) Reset 

func (x *AdditionalPropertiesItem) Reset()

func (*AdditionalPropertiesItem) ResolveReferences 

func (m *AdditionalPropertiesItem) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside AdditionalPropertiesItem objects.

func (*AdditionalPropertiesItem) String 

func (x *AdditionalPropertiesItem) String() string

func (*AdditionalPropertiesItem) ToRawInfo 

func (m *AdditionalPropertiesItem) ToRawInfo() *yaml.Node

ToRawInfo returns a description of AdditionalPropertiesItem suitable for JSON or YAML export.

type AdditionalPropertiesItem_Boolean 

type AdditionalPropertiesItem_Boolean struct {
	Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}

type AdditionalPropertiesItem_SchemaOrReference 

type AdditionalPropertiesItem_SchemaOrReference struct {
	SchemaOrReference *SchemaOrReference `protobuf:"bytes,1,opt,name=schema_or_reference,json=schemaOrReference,proto3,oneof"`
}

type Any 

type Any struct {
	Value *anypb.Any `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	Yaml  string     `protobuf:"bytes,2,opt,name=yaml,proto3" json:"yaml,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Any) Descriptor deprecated 

func (*Any) Descriptor() ([]byte, []int)

Deprecated: Use Any.ProtoReflect.Descriptor instead.

func (*Any) GetValue 

func (x *Any) GetValue() *anypb.Any

func (*Any) GetYaml 

func (x *Any) GetYaml() string

func (*Any) ProtoMessage 

func (*Any) ProtoMessage()

func (*Any) ProtoReflect 

func (x *Any) ProtoReflect() protoreflect.Message

func (*Any) Reset 

func (x *Any) Reset()

func (*Any) ResolveReferences 

func (m *Any) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Any objects.

func (*Any) String 

func (x *Any) String() string

func (*Any) ToRawInfo 

func (m *Any) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Any suitable for JSON or YAML export.

type AnyOrExpression 

type AnyOrExpression struct {

	// Types that are assignable to Oneof:
	//
	//	*AnyOrExpression_Any
	//	*AnyOrExpression_Expression
	Oneof isAnyOrExpression_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*AnyOrExpression) Descriptor deprecated 

func (*AnyOrExpression) Descriptor() ([]byte, []int)

Deprecated: Use AnyOrExpression.ProtoReflect.Descriptor instead.

func (*AnyOrExpression) GetAny 

func (x *AnyOrExpression) GetAny() *Any

func (*AnyOrExpression) GetExpression 

func (x *AnyOrExpression) GetExpression() *Expression

func (*AnyOrExpression) GetOneof 

func (m *AnyOrExpression) GetOneof() isAnyOrExpression_Oneof

func (*AnyOrExpression) ProtoMessage 

func (*AnyOrExpression) ProtoMessage()

func (*AnyOrExpression) ProtoReflect 

func (x *AnyOrExpression) ProtoReflect() protoreflect.Message

func (*AnyOrExpression) Reset 

func (x *AnyOrExpression) Reset()

func (*AnyOrExpression) ResolveReferences 

func (m *AnyOrExpression) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside AnyOrExpression objects.

func (*AnyOrExpression) String 

func (x *AnyOrExpression) String() string

func (*AnyOrExpression) ToRawInfo 

func (m *AnyOrExpression) ToRawInfo() *yaml.Node

ToRawInfo returns a description of AnyOrExpression suitable for JSON or YAML export.

type AnyOrExpression_Any 

type AnyOrExpression_Any struct {
	Any *Any `protobuf:"bytes,1,opt,name=any,proto3,oneof"`
}

type AnyOrExpression_Expression 

type AnyOrExpression_Expression struct {
	Expression *Expression `protobuf:"bytes,2,opt,name=expression,proto3,oneof"`
}

type Callback 

type Callback struct {
	Path                   []*NamedPathItem `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"`
	SpecificationExtension []*NamedAny      `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.

func NewCallback 

func NewCallback(in *yaml.Node, context *compiler.Context) (*Callback, error)

NewCallback creates an object of type Callback if possible, returning an error if not.

func (*Callback) Descriptor deprecated 

func (*Callback) Descriptor() ([]byte, []int)

Deprecated: Use Callback.ProtoReflect.Descriptor instead.

func (*Callback) GetPath 

func (x *Callback) GetPath() []*NamedPathItem

func (*Callback) GetSpecificationExtension 

func (x *Callback) GetSpecificationExtension() []*NamedAny

func (*Callback) ProtoMessage 

func (*Callback) ProtoMessage()

func (*Callback) ProtoReflect 

func (x *Callback) ProtoReflect() protoreflect.Message

func (*Callback) Reset 

func (x *Callback) Reset()

func (*Callback) ResolveReferences 

func (m *Callback) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Callback objects.

func (*Callback) String 

func (x *Callback) String() string

func (*Callback) ToRawInfo 

func (m *Callback) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Callback suitable for JSON or YAML export.

type CallbackOrReference 

type CallbackOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*CallbackOrReference_Callback
	//	*CallbackOrReference_Reference
	Oneof isCallbackOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*CallbackOrReference) Descriptor deprecated 

func (*CallbackOrReference) Descriptor() ([]byte, []int)

Deprecated: Use CallbackOrReference.ProtoReflect.Descriptor instead.

func (*CallbackOrReference) GetCallback 

func (x *CallbackOrReference) GetCallback() *Callback

func (*CallbackOrReference) GetOneof 

func (m *CallbackOrReference) GetOneof() isCallbackOrReference_Oneof

func (*CallbackOrReference) GetReference 

func (x *CallbackOrReference) GetReference() *Reference

func (*CallbackOrReference) ProtoMessage 

func (*CallbackOrReference) ProtoMessage()

func (*CallbackOrReference) ProtoReflect 

func (x *CallbackOrReference) ProtoReflect() protoreflect.Message

func (*CallbackOrReference) Reset 

func (x *CallbackOrReference) Reset()

func (*CallbackOrReference) ResolveReferences 

func (m *CallbackOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside CallbackOrReference objects.

func (*CallbackOrReference) String 

func (x *CallbackOrReference) String() string

func (*CallbackOrReference) ToRawInfo 

func (m *CallbackOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of CallbackOrReference suitable for JSON or YAML export.

type CallbackOrReference_Callback 

type CallbackOrReference_Callback struct {
	Callback *Callback `protobuf:"bytes,1,opt,name=callback,proto3,oneof"`
}

type CallbackOrReference_Reference 

type CallbackOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type CallbacksOrReferences 

type CallbacksOrReferences struct {
	AdditionalProperties []*NamedCallbackOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*CallbacksOrReferences) Descriptor deprecated 

func (*CallbacksOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use CallbacksOrReferences.ProtoReflect.Descriptor instead.

func (*CallbacksOrReferences) GetAdditionalProperties 

func (x *CallbacksOrReferences) GetAdditionalProperties() []*NamedCallbackOrReference

func (*CallbacksOrReferences) ProtoMessage 

func (*CallbacksOrReferences) ProtoMessage()

func (*CallbacksOrReferences) ProtoReflect 

func (x *CallbacksOrReferences) ProtoReflect() protoreflect.Message

func (*CallbacksOrReferences) Reset 

func (x *CallbacksOrReferences) Reset()

func (*CallbacksOrReferences) ResolveReferences 

func (m *CallbacksOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside CallbacksOrReferences objects.

func (*CallbacksOrReferences) String 

func (x *CallbacksOrReferences) String() string

func (*CallbacksOrReferences) ToRawInfo 

func (m *CallbacksOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of CallbacksOrReferences suitable for JSON or YAML export.

type Components 

type Components struct {
	Schemas                *SchemasOrReferences         `protobuf:"bytes,1,opt,name=schemas,proto3" json:"schemas,omitempty"`
	Responses              *ResponsesOrReferences       `protobuf:"bytes,2,opt,name=responses,proto3" json:"responses,omitempty"`
	Parameters             *ParametersOrReferences      `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	Examples               *ExamplesOrReferences        `protobuf:"bytes,4,opt,name=examples,proto3" json:"examples,omitempty"`
	RequestBodies          *RequestBodiesOrReferences   `protobuf:"bytes,5,opt,name=request_bodies,json=requestBodies,proto3" json:"request_bodies,omitempty"`
	Headers                *HeadersOrReferences         `protobuf:"bytes,6,opt,name=headers,proto3" json:"headers,omitempty"`
	SecuritySchemes        *SecuritySchemesOrReferences `protobuf:"bytes,7,opt,name=security_schemes,json=securitySchemes,proto3" json:"security_schemes,omitempty"`
	Links                  *LinksOrReferences           `protobuf:"bytes,8,opt,name=links,proto3" json:"links,omitempty"`
	Callbacks              *CallbacksOrReferences       `protobuf:"bytes,9,opt,name=callbacks,proto3" json:"callbacks,omitempty"`
	SpecificationExtension []*NamedAny                  `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

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.

func (*Components) Descriptor deprecated 

func (*Components) Descriptor() ([]byte, []int)

Deprecated: Use Components.ProtoReflect.Descriptor instead.

func (*Components) GetCallbacks 

func (x *Components) GetCallbacks() *CallbacksOrReferences

func (*Components) GetExamples 

func (x *Components) GetExamples() *ExamplesOrReferences

func (*Components) GetHeaders 

func (x *Components) GetHeaders() *HeadersOrReferences
func (x *Components) GetLinks() *LinksOrReferences

func (*Components) GetParameters 

func (x *Components) GetParameters() *ParametersOrReferences

func (*Components) GetRequestBodies 

func (x *Components) GetRequestBodies() *RequestBodiesOrReferences

func (*Components) GetResponses 

func (x *Components) GetResponses() *ResponsesOrReferences

func (*Components) GetSchemas 

func (x *Components) GetSchemas() *SchemasOrReferences

func (*Components) GetSecuritySchemes 

func (x *Components) GetSecuritySchemes() *SecuritySchemesOrReferences

func (*Components) GetSpecificationExtension 

func (x *Components) GetSpecificationExtension() []*NamedAny

func (*Components) ProtoMessage 

func (*Components) ProtoMessage()

func (*Components) ProtoReflect 

func (x *Components) ProtoReflect() protoreflect.Message

func (*Components) Reset 

func (x *Components) Reset()

func (*Components) ResolveReferences 

func (m *Components) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Components objects.

func (*Components) String 

func (x *Components) String() string

func (*Components) ToRawInfo 

func (m *Components) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Components suitable for JSON or YAML export.

type Contact 

type Contact struct {
	Name                   string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Url                    string      `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	Email                  string      `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Contact information for the exposed API.

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.

func (*Contact) Descriptor deprecated 

func (*Contact) Descriptor() ([]byte, []int)

Deprecated: Use Contact.ProtoReflect.Descriptor instead.

func (*Contact) GetEmail 

func (x *Contact) GetEmail() string

func (*Contact) GetName 

func (x *Contact) GetName() string

func (*Contact) GetSpecificationExtension 

func (x *Contact) GetSpecificationExtension() []*NamedAny

func (*Contact) GetUrl 

func (x *Contact) GetUrl() string

func (*Contact) ProtoMessage 

func (*Contact) ProtoMessage()

func (*Contact) ProtoReflect 

func (x *Contact) ProtoReflect() protoreflect.Message

func (*Contact) Reset 

func (x *Contact) Reset()

func (*Contact) ResolveReferences 

func (m *Contact) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Contact objects.

func (*Contact) String 

func (x *Contact) String() string

func (*Contact) ToRawInfo 

func (m *Contact) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Contact suitable for JSON or YAML export.

type DefaultType 

type DefaultType struct {

	// Types that are assignable to Oneof:
	//
	//	*DefaultType_Number
	//	*DefaultType_Boolean
	//	*DefaultType_String_
	Oneof isDefaultType_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*DefaultType) Descriptor deprecated 

func (*DefaultType) Descriptor() ([]byte, []int)

Deprecated: Use DefaultType.ProtoReflect.Descriptor instead.

func (*DefaultType) GetBoolean 

func (x *DefaultType) GetBoolean() bool

func (*DefaultType) GetNumber 

func (x *DefaultType) GetNumber() float64

func (*DefaultType) GetOneof 

func (m *DefaultType) GetOneof() isDefaultType_Oneof

func (*DefaultType) GetString_ 

func (x *DefaultType) GetString_() string

func (*DefaultType) ProtoMessage 

func (*DefaultType) ProtoMessage()

func (*DefaultType) ProtoReflect 

func (x *DefaultType) ProtoReflect() protoreflect.Message

func (*DefaultType) Reset 

func (x *DefaultType) Reset()

func (*DefaultType) ResolveReferences 

func (m *DefaultType) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside DefaultType objects.

func (*DefaultType) String 

func (x *DefaultType) String() string

func (*DefaultType) ToRawInfo 

func (m *DefaultType) ToRawInfo() *yaml.Node

ToRawInfo returns a description of DefaultType suitable for JSON or YAML export.

type DefaultType_Boolean 

type DefaultType_Boolean struct {
	Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}

type DefaultType_Number 

type DefaultType_Number struct {
	Number float64 `protobuf:"fixed64,1,opt,name=number,proto3,oneof"`
}

type DefaultType_String_ 

type DefaultType_String_ struct {
	String_ string `protobuf:"bytes,3,opt,name=string,proto3,oneof"`
}

type Discriminator 

type Discriminator struct {
	PropertyName           string      `protobuf:"bytes,1,opt,name=property_name,json=propertyName,proto3" json:"property_name,omitempty"`
	Mapping                *Strings    `protobuf:"bytes,2,opt,name=mapping,proto3" json:"mapping,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

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. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered.

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.

func (*Discriminator) Descriptor deprecated 

func (*Discriminator) Descriptor() ([]byte, []int)

Deprecated: Use Discriminator.ProtoReflect.Descriptor instead.

func (*Discriminator) GetMapping 

func (x *Discriminator) GetMapping() *Strings

func (*Discriminator) GetPropertyName 

func (x *Discriminator) GetPropertyName() string

func (*Discriminator) GetSpecificationExtension 

func (x *Discriminator) GetSpecificationExtension() []*NamedAny

func (*Discriminator) ProtoMessage 

func (*Discriminator) ProtoMessage()

func (*Discriminator) ProtoReflect 

func (x *Discriminator) ProtoReflect() protoreflect.Message

func (*Discriminator) Reset 

func (x *Discriminator) Reset()

func (*Discriminator) ResolveReferences 

func (m *Discriminator) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Discriminator objects.

func (*Discriminator) String 

func (x *Discriminator) String() string

func (*Discriminator) ToRawInfo 

func (m *Discriminator) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Discriminator suitable for JSON or YAML export.

type Document 

type Document struct {
	Openapi                string                 `protobuf:"bytes,1,opt,name=openapi,proto3" json:"openapi,omitempty"`
	Info                   *Info                  `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
	Servers                []*Server              `protobuf:"bytes,3,rep,name=servers,proto3" json:"servers,omitempty"`
	Paths                  *Paths                 `protobuf:"bytes,4,opt,name=paths,proto3" json:"paths,omitempty"`
	Components             *Components            `protobuf:"bytes,5,opt,name=components,proto3" json:"components,omitempty"`
	Security               []*SecurityRequirement `protobuf:"bytes,6,rep,name=security,proto3" json:"security,omitempty"`
	Tags                   []*Tag                 `protobuf:"bytes,7,rep,name=tags,proto3" json:"tags,omitempty"`
	ExternalDocs           *ExternalDocs          `protobuf:"bytes,8,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	SpecificationExtension []*NamedAny            `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

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 v3 description from a YAML/JSON representation.

func (*Document) Descriptor deprecated 

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetComponents 

func (x *Document) GetComponents() *Components

func (*Document) GetExternalDocs 

func (x *Document) GetExternalDocs() *ExternalDocs

func (*Document) GetInfo 

func (x *Document) GetInfo() *Info

func (*Document) GetOpenapi 

func (x *Document) GetOpenapi() string

func (*Document) GetPaths 

func (x *Document) GetPaths() *Paths

func (*Document) GetSecurity 

func (x *Document) GetSecurity() []*SecurityRequirement

func (*Document) GetServers 

func (x *Document) GetServers() []*Server

func (*Document) GetSpecificationExtension 

func (x *Document) GetSpecificationExtension() []*NamedAny

func (*Document) GetTags 

func (x *Document) GetTags() []*Tag

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) ResolveReferences 

func (m *Document) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Document objects.

func (*Document) String 

func (x *Document) String() string

func (*Document) ToRawInfo 

func (m *Document) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Document suitable for JSON or YAML export.

func (*Document) YAMLValue 

func (d *Document) YAMLValue(comment string) ([]byte, error)

YAMLValue produces a serialized YAML representation of the document.

type Encoding 

type Encoding struct {
	ContentType            string               `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	Headers                *HeadersOrReferences `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	Style                  string               `protobuf:"bytes,3,opt,name=style,proto3" json:"style,omitempty"`
	Explode                bool                 `protobuf:"varint,4,opt,name=explode,proto3" json:"explode,omitempty"`
	AllowReserved          bool                 `protobuf:"varint,5,opt,name=allow_reserved,json=allowReserved,proto3" json:"allow_reserved,omitempty"`
	SpecificationExtension []*NamedAny          `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single encoding definition applied to a single schema property.

func NewEncoding 

func NewEncoding(in *yaml.Node, context *compiler.Context) (*Encoding, error)

NewEncoding creates an object of type Encoding if possible, returning an error if not.

func (*Encoding) Descriptor deprecated 

func (*Encoding) Descriptor() ([]byte, []int)

Deprecated: Use Encoding.ProtoReflect.Descriptor instead.

func (*Encoding) GetAllowReserved 

func (x *Encoding) GetAllowReserved() bool

func (*Encoding) GetContentType 

func (x *Encoding) GetContentType() string

func (*Encoding) GetExplode 

func (x *Encoding) GetExplode() bool

func (*Encoding) GetHeaders 

func (x *Encoding) GetHeaders() *HeadersOrReferences

func (*Encoding) GetSpecificationExtension 

func (x *Encoding) GetSpecificationExtension() []*NamedAny

func (*Encoding) GetStyle 

func (x *Encoding) GetStyle() string

func (*Encoding) ProtoMessage 

func (*Encoding) ProtoMessage()

func (*Encoding) ProtoReflect 

func (x *Encoding) ProtoReflect() protoreflect.Message

func (*Encoding) Reset 

func (x *Encoding) Reset()

func (*Encoding) ResolveReferences 

func (m *Encoding) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Encoding objects.

func (*Encoding) String 

func (x *Encoding) String() string

func (*Encoding) ToRawInfo 

func (m *Encoding) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Encoding suitable for JSON or YAML export.

type Encodings 

type Encodings struct {
	AdditionalProperties []*NamedEncoding `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

func NewEncodings 

func NewEncodings(in *yaml.Node, context *compiler.Context) (*Encodings, error)

NewEncodings creates an object of type Encodings if possible, returning an error if not.

func (*Encodings) Descriptor deprecated 

func (*Encodings) Descriptor() ([]byte, []int)

Deprecated: Use Encodings.ProtoReflect.Descriptor instead.

func (*Encodings) GetAdditionalProperties 

func (x *Encodings) GetAdditionalProperties() []*NamedEncoding

func (*Encodings) ProtoMessage 

func (*Encodings) ProtoMessage()

func (*Encodings) ProtoReflect 

func (x *Encodings) ProtoReflect() protoreflect.Message

func (*Encodings) Reset 

func (x *Encodings) Reset()

func (*Encodings) ResolveReferences 

func (m *Encodings) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Encodings objects.

func (*Encodings) String 

func (x *Encodings) String() string

func (*Encodings) ToRawInfo 

func (m *Encodings) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Encodings suitable for JSON or YAML export.

type Example 

type Example struct {
	Summary                string      `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	Description            string      `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Value                  *Any        `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	ExternalValue          string      `protobuf:"bytes,4,opt,name=external_value,json=externalValue,proto3" json:"external_value,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func NewExample 

func NewExample(in *yaml.Node, context *compiler.Context) (*Example, error)

NewExample creates an object of type Example if possible, returning an error if not.

func (*Example) Descriptor deprecated 

func (*Example) Descriptor() ([]byte, []int)

Deprecated: Use Example.ProtoReflect.Descriptor instead.

func (*Example) GetDescription 

func (x *Example) GetDescription() string

func (*Example) GetExternalValue 

func (x *Example) GetExternalValue() string

func (*Example) GetSpecificationExtension 

func (x *Example) GetSpecificationExtension() []*NamedAny

func (*Example) GetSummary 

func (x *Example) GetSummary() string

func (*Example) GetValue 

func (x *Example) GetValue() *Any

func (*Example) ProtoMessage 

func (*Example) ProtoMessage()

func (*Example) ProtoReflect 

func (x *Example) ProtoReflect() protoreflect.Message

func (*Example) Reset 

func (x *Example) Reset()

func (*Example) ResolveReferences 

func (m *Example) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Example objects.

func (*Example) String 

func (x *Example) String() string

func (*Example) ToRawInfo 

func (m *Example) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Example suitable for JSON or YAML export.

type ExampleOrReference 

type ExampleOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*ExampleOrReference_Example
	//	*ExampleOrReference_Reference
	Oneof isExampleOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*ExampleOrReference) Descriptor deprecated 

func (*ExampleOrReference) Descriptor() ([]byte, []int)

Deprecated: Use ExampleOrReference.ProtoReflect.Descriptor instead.

func (*ExampleOrReference) GetExample 

func (x *ExampleOrReference) GetExample() *Example

func (*ExampleOrReference) GetOneof 

func (m *ExampleOrReference) GetOneof() isExampleOrReference_Oneof

func (*ExampleOrReference) GetReference 

func (x *ExampleOrReference) GetReference() *Reference

func (*ExampleOrReference) ProtoMessage 

func (*ExampleOrReference) ProtoMessage()

func (*ExampleOrReference) ProtoReflect 

func (x *ExampleOrReference) ProtoReflect() protoreflect.Message

func (*ExampleOrReference) Reset 

func (x *ExampleOrReference) Reset()

func (*ExampleOrReference) ResolveReferences 

func (m *ExampleOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ExampleOrReference objects.

func (*ExampleOrReference) String 

func (x *ExampleOrReference) String() string

func (*ExampleOrReference) ToRawInfo 

func (m *ExampleOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ExampleOrReference suitable for JSON or YAML export.

type ExampleOrReference_Example 

type ExampleOrReference_Example struct {
	Example *Example `protobuf:"bytes,1,opt,name=example,proto3,oneof"`
}

type ExampleOrReference_Reference 

type ExampleOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type ExamplesOrReferences 

type ExamplesOrReferences struct {
	AdditionalProperties []*NamedExampleOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ExamplesOrReferences) Descriptor deprecated 

func (*ExamplesOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use ExamplesOrReferences.ProtoReflect.Descriptor instead.

func (*ExamplesOrReferences) GetAdditionalProperties 

func (x *ExamplesOrReferences) GetAdditionalProperties() []*NamedExampleOrReference

func (*ExamplesOrReferences) ProtoMessage 

func (*ExamplesOrReferences) ProtoMessage()

func (*ExamplesOrReferences) ProtoReflect 

func (x *ExamplesOrReferences) ProtoReflect() protoreflect.Message

func (*ExamplesOrReferences) Reset 

func (x *ExamplesOrReferences) Reset()

func (*ExamplesOrReferences) ResolveReferences 

func (m *ExamplesOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ExamplesOrReferences objects.

func (*ExamplesOrReferences) String 

func (x *ExamplesOrReferences) String() string

func (*ExamplesOrReferences) ToRawInfo 

func (m *ExamplesOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ExamplesOrReferences suitable for JSON or YAML export.

type Expression 

type Expression struct {
	AdditionalProperties []*NamedAny `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Expression) Descriptor deprecated 

func (*Expression) Descriptor() ([]byte, []int)

Deprecated: Use Expression.ProtoReflect.Descriptor instead.

func (*Expression) GetAdditionalProperties 

func (x *Expression) GetAdditionalProperties() []*NamedAny

func (*Expression) ProtoMessage 

func (*Expression) ProtoMessage()

func (*Expression) ProtoReflect 

func (x *Expression) ProtoReflect() protoreflect.Message

func (*Expression) Reset 

func (x *Expression) Reset()

func (*Expression) ResolveReferences 

func (m *Expression) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Expression objects.

func (*Expression) String 

func (x *Expression) String() string

func (*Expression) ToRawInfo 

func (m *Expression) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Expression suitable for JSON or YAML export.

type ExternalDocs 

type ExternalDocs struct {
	Description            string      `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	Url                    string      `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Allows referencing an external resource for extended documentation.

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.

func (*ExternalDocs) Descriptor deprecated 

func (*ExternalDocs) Descriptor() ([]byte, []int)

Deprecated: Use ExternalDocs.ProtoReflect.Descriptor instead.

func (*ExternalDocs) GetDescription 

func (x *ExternalDocs) GetDescription() string

func (*ExternalDocs) GetSpecificationExtension 

func (x *ExternalDocs) GetSpecificationExtension() []*NamedAny

func (*ExternalDocs) GetUrl 

func (x *ExternalDocs) GetUrl() string

func (*ExternalDocs) ProtoMessage 

func (*ExternalDocs) ProtoMessage()

func (*ExternalDocs) ProtoReflect 

func (x *ExternalDocs) ProtoReflect() protoreflect.Message

func (*ExternalDocs) Reset 

func (x *ExternalDocs) Reset()

func (*ExternalDocs) ResolveReferences 

func (m *ExternalDocs) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ExternalDocs objects.

func (*ExternalDocs) String 

func (x *ExternalDocs) String() string

func (*ExternalDocs) ToRawInfo 

func (m *ExternalDocs) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ExternalDocs suitable for JSON or YAML export. 

type Header struct {
	Description            string                `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	Required               bool                  `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	Deprecated             bool                  `protobuf:"varint,3,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	AllowEmptyValue        bool                  `protobuf:"varint,4,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
	Style                  string                `protobuf:"bytes,5,opt,name=style,proto3" json:"style,omitempty"`
	Explode                bool                  `protobuf:"varint,6,opt,name=explode,proto3" json:"explode,omitempty"`
	AllowReserved          bool                  `protobuf:"varint,7,opt,name=allow_reserved,json=allowReserved,proto3" json:"allow_reserved,omitempty"`
	Schema                 *SchemaOrReference    `protobuf:"bytes,8,opt,name=schema,proto3" json:"schema,omitempty"`
	Example                *Any                  `protobuf:"bytes,9,opt,name=example,proto3" json:"example,omitempty"`
	Examples               *ExamplesOrReferences `protobuf:"bytes,10,opt,name=examples,proto3" json:"examples,omitempty"`
	Content                *MediaTypes           `protobuf:"bytes,11,opt,name=content,proto3" json:"content,omitempty"`
	SpecificationExtension []*NamedAny           `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map. 1. `in` MUST NOT be specified, it is implicitly in `header`. 1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`).

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.

func (*Header) Descriptor deprecated 

func (*Header) Descriptor() ([]byte, []int)

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetAllowEmptyValue 

func (x *Header) GetAllowEmptyValue() bool

func (*Header) GetAllowReserved 

func (x *Header) GetAllowReserved() bool

func (*Header) GetContent 

func (x *Header) GetContent() *MediaTypes

func (*Header) GetDeprecated 

func (x *Header) GetDeprecated() bool

func (*Header) GetDescription 

func (x *Header) GetDescription() string

func (*Header) GetExample 

func (x *Header) GetExample() *Any

func (*Header) GetExamples 

func (x *Header) GetExamples() *ExamplesOrReferences

func (*Header) GetExplode 

func (x *Header) GetExplode() bool

func (*Header) GetRequired 

func (x *Header) GetRequired() bool

func (*Header) GetSchema 

func (x *Header) GetSchema() *SchemaOrReference

func (*Header) GetSpecificationExtension 

func (x *Header) GetSpecificationExtension() []*NamedAny

func (*Header) GetStyle 

func (x *Header) GetStyle() string

func (*Header) ProtoMessage 

func (*Header) ProtoMessage()

func (*Header) ProtoReflect 

func (x *Header) ProtoReflect() protoreflect.Message

func (*Header) Reset 

func (x *Header) Reset()

func (*Header) ResolveReferences 

func (m *Header) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Header objects.

func (*Header) String 

func (x *Header) String() string

func (*Header) ToRawInfo 

func (m *Header) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Header suitable for JSON or YAML export.

type HeaderOrReference 

type HeaderOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*HeaderOrReference_Header
	//	*HeaderOrReference_Reference
	Oneof isHeaderOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*HeaderOrReference) Descriptor deprecated 

func (*HeaderOrReference) Descriptor() ([]byte, []int)

Deprecated: Use HeaderOrReference.ProtoReflect.Descriptor instead.

func (*HeaderOrReference) GetHeader 

func (x *HeaderOrReference) GetHeader() *Header

func (*HeaderOrReference) GetOneof 

func (m *HeaderOrReference) GetOneof() isHeaderOrReference_Oneof

func (*HeaderOrReference) GetReference 

func (x *HeaderOrReference) GetReference() *Reference

func (*HeaderOrReference) ProtoMessage 

func (*HeaderOrReference) ProtoMessage()

func (*HeaderOrReference) ProtoReflect 

func (x *HeaderOrReference) ProtoReflect() protoreflect.Message

func (*HeaderOrReference) Reset 

func (x *HeaderOrReference) Reset()

func (*HeaderOrReference) ResolveReferences 

func (m *HeaderOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside HeaderOrReference objects.

func (*HeaderOrReference) String 

func (x *HeaderOrReference) String() string

func (*HeaderOrReference) ToRawInfo 

func (m *HeaderOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of HeaderOrReference suitable for JSON or YAML export.

type HeaderOrReference_Header 

type HeaderOrReference_Header struct {
	Header *Header `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}

type HeaderOrReference_Reference 

type HeaderOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type HeadersOrReferences 

type HeadersOrReferences struct {
	AdditionalProperties []*NamedHeaderOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*HeadersOrReferences) Descriptor deprecated 

func (*HeadersOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use HeadersOrReferences.ProtoReflect.Descriptor instead.

func (*HeadersOrReferences) GetAdditionalProperties 

func (x *HeadersOrReferences) GetAdditionalProperties() []*NamedHeaderOrReference

func (*HeadersOrReferences) ProtoMessage 

func (*HeadersOrReferences) ProtoMessage()

func (*HeadersOrReferences) ProtoReflect 

func (x *HeadersOrReferences) ProtoReflect() protoreflect.Message

func (*HeadersOrReferences) Reset 

func (x *HeadersOrReferences) Reset()

func (*HeadersOrReferences) ResolveReferences 

func (m *HeadersOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside HeadersOrReferences objects.

func (*HeadersOrReferences) String 

func (x *HeadersOrReferences) String() string

func (*HeadersOrReferences) ToRawInfo 

func (m *HeadersOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of HeadersOrReferences suitable for JSON or YAML export.

type Info 

type Info struct {
	Title                  string      `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Description            string      `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	TermsOfService         string      `protobuf:"bytes,3,opt,name=terms_of_service,json=termsOfService,proto3" json:"terms_of_service,omitempty"`
	Contact                *Contact    `protobuf:"bytes,4,opt,name=contact,proto3" json:"contact,omitempty"`
	License                *License    `protobuf:"bytes,5,opt,name=license,proto3" json:"license,omitempty"`
	Version                string      `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	Summary                string      `protobuf:"bytes,8,opt,name=summary,proto3" json:"summary,omitempty"`
	// contains filtered or unexported fields
}

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

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.

func (*Info) Descriptor deprecated 

func (*Info) Descriptor() ([]byte, []int)

Deprecated: Use Info.ProtoReflect.Descriptor instead.

func (*Info) GetContact 

func (x *Info) GetContact() *Contact

func (*Info) GetDescription 

func (x *Info) GetDescription() string

func (*Info) GetLicense 

func (x *Info) GetLicense() *License

func (*Info) GetSpecificationExtension 

func (x *Info) GetSpecificationExtension() []*NamedAny

func (*Info) GetSummary 

func (x *Info) GetSummary() string

func (*Info) GetTermsOfService 

func (x *Info) GetTermsOfService() string

func (*Info) GetTitle 

func (x *Info) GetTitle() string

func (*Info) GetVersion 

func (x *Info) GetVersion() string

func (*Info) ProtoMessage 

func (*Info) ProtoMessage()

func (*Info) ProtoReflect 

func (x *Info) ProtoReflect() protoreflect.Message

func (*Info) Reset 

func (x *Info) Reset()

func (*Info) ResolveReferences 

func (m *Info) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Info objects.

func (*Info) String 

func (x *Info) String() string

func (*Info) ToRawInfo 

func (m *Info) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Info suitable for JSON or YAML export.

type ItemsItem 

type ItemsItem struct {
	SchemaOrReference []*SchemaOrReference `protobuf:"bytes,1,rep,name=schema_or_reference,json=schemaOrReference,proto3" json:"schema_or_reference,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ItemsItem) Descriptor deprecated 

func (*ItemsItem) Descriptor() ([]byte, []int)

Deprecated: Use ItemsItem.ProtoReflect.Descriptor instead.

func (*ItemsItem) GetSchemaOrReference 

func (x *ItemsItem) GetSchemaOrReference() []*SchemaOrReference

func (*ItemsItem) ProtoMessage 

func (*ItemsItem) ProtoMessage()

func (*ItemsItem) ProtoReflect 

func (x *ItemsItem) ProtoReflect() protoreflect.Message

func (*ItemsItem) Reset 

func (x *ItemsItem) Reset()

func (*ItemsItem) ResolveReferences 

func (m *ItemsItem) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ItemsItem objects.

func (*ItemsItem) String 

func (x *ItemsItem) String() string

func (*ItemsItem) ToRawInfo 

func (m *ItemsItem) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ItemsItem suitable for JSON or YAML export.

type License 

type License struct {
	Name                   string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Url                    string      `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

License information for the exposed API.

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.

func (*License) Descriptor deprecated 

func (*License) Descriptor() ([]byte, []int)

Deprecated: Use License.ProtoReflect.Descriptor instead.

func (*License) GetName 

func (x *License) GetName() string

func (*License) GetSpecificationExtension 

func (x *License) GetSpecificationExtension() []*NamedAny

func (*License) GetUrl 

func (x *License) GetUrl() string

func (*License) ProtoMessage 

func (*License) ProtoMessage()

func (*License) ProtoReflect 

func (x *License) ProtoReflect() protoreflect.Message

func (*License) Reset 

func (x *License) Reset()

func (*License) ResolveReferences 

func (m *License) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside License objects.

func (*License) String 

func (x *License) String() string

func (*License) ToRawInfo 

func (m *License) ToRawInfo() *yaml.Node

ToRawInfo returns a description of License suitable for JSON or YAML export. 

type Link struct {
	OperationRef           string           `protobuf:"bytes,1,opt,name=operation_ref,json=operationRef,proto3" json:"operation_ref,omitempty"`
	OperationId            string           `protobuf:"bytes,2,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	Parameters             *AnyOrExpression `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
	RequestBody            *AnyOrExpression `protobuf:"bytes,4,opt,name=request_body,json=requestBody,proto3" json:"request_body,omitempty"`
	Description            string           `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	Server                 *Server          `protobuf:"bytes,6,opt,name=server,proto3" json:"server,omitempty"`
	SpecificationExtension []*NamedAny      `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

The `Link object` represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations. Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation. 

func NewLink(in *yaml.Node, context *compiler.Context) (*Link, error)

NewLink creates an object of type Link if possible, returning an error if not.

func (*Link) Descriptor deprecated 

func (*Link) Descriptor() ([]byte, []int)

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (*Link) GetDescription 

func (x *Link) GetDescription() string

func (*Link) GetOperationId 

func (x *Link) GetOperationId() string

func (*Link) GetOperationRef 

func (x *Link) GetOperationRef() string

func (*Link) GetParameters 

func (x *Link) GetParameters() *AnyOrExpression

func (*Link) GetRequestBody 

func (x *Link) GetRequestBody() *AnyOrExpression

func (*Link) GetServer 

func (x *Link) GetServer() *Server

func (*Link) GetSpecificationExtension 

func (x *Link) GetSpecificationExtension() []*NamedAny

func (*Link) ProtoMessage 

func (*Link) ProtoMessage()

func (*Link) ProtoReflect 

func (x *Link) ProtoReflect() protoreflect.Message

func (*Link) Reset 

func (x *Link) Reset()

func (*Link) ResolveReferences 

func (m *Link) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Link objects.

func (*Link) String 

func (x *Link) String() string

func (*Link) ToRawInfo 

func (m *Link) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Link suitable for JSON or YAML export.

type LinkOrReference 

type LinkOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*LinkOrReference_Link
	//	*LinkOrReference_Reference
	Oneof isLinkOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*LinkOrReference) Descriptor deprecated 

func (*LinkOrReference) Descriptor() ([]byte, []int)

Deprecated: Use LinkOrReference.ProtoReflect.Descriptor instead. 

func (x *LinkOrReference) GetLink() *Link

func (*LinkOrReference) GetOneof 

func (m *LinkOrReference) GetOneof() isLinkOrReference_Oneof

func (*LinkOrReference) GetReference 

func (x *LinkOrReference) GetReference() *Reference

func (*LinkOrReference) ProtoMessage 

func (*LinkOrReference) ProtoMessage()

func (*LinkOrReference) ProtoReflect 

func (x *LinkOrReference) ProtoReflect() protoreflect.Message

func (*LinkOrReference) Reset 

func (x *LinkOrReference) Reset()

func (*LinkOrReference) ResolveReferences 

func (m *LinkOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside LinkOrReference objects.

func (*LinkOrReference) String 

func (x *LinkOrReference) String() string

func (*LinkOrReference) ToRawInfo 

func (m *LinkOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of LinkOrReference suitable for JSON or YAML export. 

type LinkOrReference_Link struct {
	Link *Link `protobuf:"bytes,1,opt,name=link,proto3,oneof"`
}

type LinkOrReference_Reference 

type LinkOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type LinksOrReferences 

type LinksOrReferences struct {
	AdditionalProperties []*NamedLinkOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*LinksOrReferences) Descriptor deprecated 

func (*LinksOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use LinksOrReferences.ProtoReflect.Descriptor instead.

func (*LinksOrReferences) GetAdditionalProperties 

func (x *LinksOrReferences) GetAdditionalProperties() []*NamedLinkOrReference

func (*LinksOrReferences) ProtoMessage 

func (*LinksOrReferences) ProtoMessage()

func (*LinksOrReferences) ProtoReflect 

func (x *LinksOrReferences) ProtoReflect() protoreflect.Message

func (*LinksOrReferences) Reset 

func (x *LinksOrReferences) Reset()

func (*LinksOrReferences) ResolveReferences 

func (m *LinksOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside LinksOrReferences objects.

func (*LinksOrReferences) String 

func (x *LinksOrReferences) String() string

func (*LinksOrReferences) ToRawInfo 

func (m *LinksOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of LinksOrReferences suitable for JSON or YAML export.

type MediaType 

type MediaType struct {
	Schema                 *SchemaOrReference    `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	Example                *Any                  `protobuf:"bytes,2,opt,name=example,proto3" json:"example,omitempty"`
	Examples               *ExamplesOrReferences `protobuf:"bytes,3,opt,name=examples,proto3" json:"examples,omitempty"`
	Encoding               *Encodings            `protobuf:"bytes,4,opt,name=encoding,proto3" json:"encoding,omitempty"`
	SpecificationExtension []*NamedAny           `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Each Media Type Object provides schema and examples for the media type identified by its key.

func NewMediaType 

func NewMediaType(in *yaml.Node, context *compiler.Context) (*MediaType, error)

NewMediaType creates an object of type MediaType if possible, returning an error if not.

func (*MediaType) Descriptor deprecated 

func (*MediaType) Descriptor() ([]byte, []int)

Deprecated: Use MediaType.ProtoReflect.Descriptor instead.

func (*MediaType) GetEncoding 

func (x *MediaType) GetEncoding() *Encodings

func (*MediaType) GetExample 

func (x *MediaType) GetExample() *Any

func (*MediaType) GetExamples 

func (x *MediaType) GetExamples() *ExamplesOrReferences

func (*MediaType) GetSchema 

func (x *MediaType) GetSchema() *SchemaOrReference

func (*MediaType) GetSpecificationExtension 

func (x *MediaType) GetSpecificationExtension() []*NamedAny

func (*MediaType) ProtoMessage 

func (*MediaType) ProtoMessage()

func (*MediaType) ProtoReflect 

func (x *MediaType) ProtoReflect() protoreflect.Message

func (*MediaType) Reset 

func (x *MediaType) Reset()

func (*MediaType) ResolveReferences 

func (m *MediaType) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside MediaType objects.

func (*MediaType) String 

func (x *MediaType) String() string

func (*MediaType) ToRawInfo 

func (m *MediaType) ToRawInfo() *yaml.Node

ToRawInfo returns a description of MediaType suitable for JSON or YAML export.

type MediaTypes 

type MediaTypes struct {
	AdditionalProperties []*NamedMediaType `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*MediaTypes) Descriptor deprecated 

func (*MediaTypes) Descriptor() ([]byte, []int)

Deprecated: Use MediaTypes.ProtoReflect.Descriptor instead.

func (*MediaTypes) GetAdditionalProperties 

func (x *MediaTypes) GetAdditionalProperties() []*NamedMediaType

func (*MediaTypes) ProtoMessage 

func (*MediaTypes) ProtoMessage()

func (*MediaTypes) ProtoReflect 

func (x *MediaTypes) ProtoReflect() protoreflect.Message

func (*MediaTypes) Reset 

func (x *MediaTypes) Reset()

func (*MediaTypes) ResolveReferences 

func (m *MediaTypes) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside MediaTypes objects.

func (*MediaTypes) String 

func (x *MediaTypes) String() string

func (*MediaTypes) ToRawInfo 

func (m *MediaTypes) ToRawInfo() *yaml.Node

ToRawInfo returns a description of MediaTypes suitable for JSON or YAML export.

type NamedAny 

type NamedAny struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *Any `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of Any as ordered (name,value) pairs.

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.

func (*NamedAny) Descriptor deprecated 

func (*NamedAny) Descriptor() ([]byte, []int)

Deprecated: Use NamedAny.ProtoReflect.Descriptor instead.

func (*NamedAny) GetName 

func (x *NamedAny) GetName() string

func (*NamedAny) GetValue 

func (x *NamedAny) GetValue() *Any

func (*NamedAny) ProtoMessage 

func (*NamedAny) ProtoMessage()

func (*NamedAny) ProtoReflect 

func (x *NamedAny) ProtoReflect() protoreflect.Message

func (*NamedAny) Reset 

func (x *NamedAny) Reset()

func (*NamedAny) ResolveReferences 

func (m *NamedAny) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedAny objects.

func (*NamedAny) String 

func (x *NamedAny) String() string

func (*NamedAny) ToRawInfo 

func (m *NamedAny) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedAny suitable for JSON or YAML export.

type NamedCallbackOrReference 

type NamedCallbackOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *CallbackOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of CallbackOrReference as ordered (name,value) pairs.

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.

func (*NamedCallbackOrReference) Descriptor deprecated 

func (*NamedCallbackOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedCallbackOrReference.ProtoReflect.Descriptor instead.

func (*NamedCallbackOrReference) GetName 

func (x *NamedCallbackOrReference) GetName() string

func (*NamedCallbackOrReference) GetValue 

func (x *NamedCallbackOrReference) GetValue() *CallbackOrReference

func (*NamedCallbackOrReference) ProtoMessage 

func (*NamedCallbackOrReference) ProtoMessage()

func (*NamedCallbackOrReference) ProtoReflect 

func (x *NamedCallbackOrReference) ProtoReflect() protoreflect.Message

func (*NamedCallbackOrReference) Reset 

func (x *NamedCallbackOrReference) Reset()

func (*NamedCallbackOrReference) ResolveReferences 

func (m *NamedCallbackOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedCallbackOrReference objects.

func (*NamedCallbackOrReference) String 

func (x *NamedCallbackOrReference) String() string

func (*NamedCallbackOrReference) ToRawInfo 

func (m *NamedCallbackOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedCallbackOrReference suitable for JSON or YAML export.

type NamedEncoding 

type NamedEncoding struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *Encoding `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of Encoding as ordered (name,value) pairs.

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.

func (*NamedEncoding) Descriptor deprecated 

func (*NamedEncoding) Descriptor() ([]byte, []int)

Deprecated: Use NamedEncoding.ProtoReflect.Descriptor instead.

func (*NamedEncoding) GetName 

func (x *NamedEncoding) GetName() string

func (*NamedEncoding) GetValue 

func (x *NamedEncoding) GetValue() *Encoding

func (*NamedEncoding) ProtoMessage 

func (*NamedEncoding) ProtoMessage()

func (*NamedEncoding) ProtoReflect 

func (x *NamedEncoding) ProtoReflect() protoreflect.Message

func (*NamedEncoding) Reset 

func (x *NamedEncoding) Reset()

func (*NamedEncoding) ResolveReferences 

func (m *NamedEncoding) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedEncoding objects.

func (*NamedEncoding) String 

func (x *NamedEncoding) String() string

func (*NamedEncoding) ToRawInfo 

func (m *NamedEncoding) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedEncoding suitable for JSON or YAML export.

type NamedExampleOrReference 

type NamedExampleOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *ExampleOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of ExampleOrReference as ordered (name,value) pairs.

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.

func (*NamedExampleOrReference) Descriptor deprecated 

func (*NamedExampleOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedExampleOrReference.ProtoReflect.Descriptor instead.

func (*NamedExampleOrReference) GetName 

func (x *NamedExampleOrReference) GetName() string

func (*NamedExampleOrReference) GetValue 

func (x *NamedExampleOrReference) GetValue() *ExampleOrReference

func (*NamedExampleOrReference) ProtoMessage 

func (*NamedExampleOrReference) ProtoMessage()

func (*NamedExampleOrReference) ProtoReflect 

func (x *NamedExampleOrReference) ProtoReflect() protoreflect.Message

func (*NamedExampleOrReference) Reset 

func (x *NamedExampleOrReference) Reset()

func (*NamedExampleOrReference) ResolveReferences 

func (m *NamedExampleOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedExampleOrReference objects.

func (*NamedExampleOrReference) String 

func (x *NamedExampleOrReference) String() string

func (*NamedExampleOrReference) ToRawInfo 

func (m *NamedExampleOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedExampleOrReference suitable for JSON or YAML export.

type NamedHeaderOrReference 

type NamedHeaderOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *HeaderOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of HeaderOrReference as ordered (name,value) pairs.

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.

func (*NamedHeaderOrReference) Descriptor deprecated 

func (*NamedHeaderOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedHeaderOrReference.ProtoReflect.Descriptor instead.

func (*NamedHeaderOrReference) GetName 

func (x *NamedHeaderOrReference) GetName() string

func (*NamedHeaderOrReference) GetValue 

func (x *NamedHeaderOrReference) GetValue() *HeaderOrReference

func (*NamedHeaderOrReference) ProtoMessage 

func (*NamedHeaderOrReference) ProtoMessage()

func (*NamedHeaderOrReference) ProtoReflect 

func (x *NamedHeaderOrReference) ProtoReflect() protoreflect.Message

func (*NamedHeaderOrReference) Reset 

func (x *NamedHeaderOrReference) Reset()

func (*NamedHeaderOrReference) ResolveReferences 

func (m *NamedHeaderOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedHeaderOrReference objects.

func (*NamedHeaderOrReference) String 

func (x *NamedHeaderOrReference) String() string

func (*NamedHeaderOrReference) ToRawInfo 

func (m *NamedHeaderOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedHeaderOrReference suitable for JSON or YAML export.

type NamedLinkOrReference 

type NamedLinkOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *LinkOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of LinkOrReference as ordered (name,value) pairs.

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.

func (*NamedLinkOrReference) Descriptor deprecated 

func (*NamedLinkOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedLinkOrReference.ProtoReflect.Descriptor instead.

func (*NamedLinkOrReference) GetName 

func (x *NamedLinkOrReference) GetName() string

func (*NamedLinkOrReference) GetValue 

func (x *NamedLinkOrReference) GetValue() *LinkOrReference

func (*NamedLinkOrReference) ProtoMessage 

func (*NamedLinkOrReference) ProtoMessage()

func (*NamedLinkOrReference) ProtoReflect 

func (x *NamedLinkOrReference) ProtoReflect() protoreflect.Message

func (*NamedLinkOrReference) Reset 

func (x *NamedLinkOrReference) Reset()

func (*NamedLinkOrReference) ResolveReferences 

func (m *NamedLinkOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedLinkOrReference objects.

func (*NamedLinkOrReference) String 

func (x *NamedLinkOrReference) String() string

func (*NamedLinkOrReference) ToRawInfo 

func (m *NamedLinkOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedLinkOrReference suitable for JSON or YAML export.

type NamedMediaType 

type NamedMediaType struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *MediaType `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of MediaType as ordered (name,value) pairs.

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.

func (*NamedMediaType) Descriptor deprecated 

func (*NamedMediaType) Descriptor() ([]byte, []int)

Deprecated: Use NamedMediaType.ProtoReflect.Descriptor instead.

func (*NamedMediaType) GetName 

func (x *NamedMediaType) GetName() string

func (*NamedMediaType) GetValue 

func (x *NamedMediaType) GetValue() *MediaType

func (*NamedMediaType) ProtoMessage 

func (*NamedMediaType) ProtoMessage()

func (*NamedMediaType) ProtoReflect 

func (x *NamedMediaType) ProtoReflect() protoreflect.Message

func (*NamedMediaType) Reset 

func (x *NamedMediaType) Reset()

func (*NamedMediaType) ResolveReferences 

func (m *NamedMediaType) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedMediaType objects.

func (*NamedMediaType) String 

func (x *NamedMediaType) String() string

func (*NamedMediaType) ToRawInfo 

func (m *NamedMediaType) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedMediaType suitable for JSON or YAML export.

type NamedParameterOrReference 

type NamedParameterOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *ParameterOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of ParameterOrReference as ordered (name,value) pairs.

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.

func (*NamedParameterOrReference) Descriptor deprecated 

func (*NamedParameterOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedParameterOrReference.ProtoReflect.Descriptor instead.

func (*NamedParameterOrReference) GetName 

func (x *NamedParameterOrReference) GetName() string

func (*NamedParameterOrReference) GetValue 

func (x *NamedParameterOrReference) GetValue() *ParameterOrReference

func (*NamedParameterOrReference) ProtoMessage 

func (*NamedParameterOrReference) ProtoMessage()

func (*NamedParameterOrReference) ProtoReflect 

func (x *NamedParameterOrReference) ProtoReflect() protoreflect.Message

func (*NamedParameterOrReference) Reset 

func (x *NamedParameterOrReference) Reset()

func (*NamedParameterOrReference) ResolveReferences 

func (m *NamedParameterOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedParameterOrReference objects.

func (*NamedParameterOrReference) String 

func (x *NamedParameterOrReference) String() string

func (*NamedParameterOrReference) ToRawInfo 

func (m *NamedParameterOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedParameterOrReference suitable for JSON or YAML export.

type NamedPathItem 

type NamedPathItem struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *PathItem `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of PathItem as ordered (name,value) pairs.

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.

func (*NamedPathItem) Descriptor deprecated 

func (*NamedPathItem) Descriptor() ([]byte, []int)

Deprecated: Use NamedPathItem.ProtoReflect.Descriptor instead.

func (*NamedPathItem) GetName 

func (x *NamedPathItem) GetName() string

func (*NamedPathItem) GetValue 

func (x *NamedPathItem) GetValue() *PathItem

func (*NamedPathItem) ProtoMessage 

func (*NamedPathItem) ProtoMessage()

func (*NamedPathItem) ProtoReflect 

func (x *NamedPathItem) ProtoReflect() protoreflect.Message

func (*NamedPathItem) Reset 

func (x *NamedPathItem) Reset()

func (*NamedPathItem) ResolveReferences 

func (m *NamedPathItem) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedPathItem objects.

func (*NamedPathItem) String 

func (x *NamedPathItem) String() string

func (*NamedPathItem) ToRawInfo 

func (m *NamedPathItem) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedPathItem suitable for JSON or YAML export.

type NamedRequestBodyOrReference 

type NamedRequestBodyOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *RequestBodyOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of RequestBodyOrReference as ordered (name,value) pairs.

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.

func (*NamedRequestBodyOrReference) Descriptor deprecated 

func (*NamedRequestBodyOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedRequestBodyOrReference.ProtoReflect.Descriptor instead.

func (*NamedRequestBodyOrReference) GetName 

func (x *NamedRequestBodyOrReference) GetName() string

func (*NamedRequestBodyOrReference) GetValue 

func (x *NamedRequestBodyOrReference) GetValue() *RequestBodyOrReference

func (*NamedRequestBodyOrReference) ProtoMessage 

func (*NamedRequestBodyOrReference) ProtoMessage()

func (*NamedRequestBodyOrReference) ProtoReflect 

func (x *NamedRequestBodyOrReference) ProtoReflect() protoreflect.Message

func (*NamedRequestBodyOrReference) Reset 

func (x *NamedRequestBodyOrReference) Reset()

func (*NamedRequestBodyOrReference) ResolveReferences 

func (m *NamedRequestBodyOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedRequestBodyOrReference objects.

func (*NamedRequestBodyOrReference) String 

func (x *NamedRequestBodyOrReference) String() string

func (*NamedRequestBodyOrReference) ToRawInfo 

func (m *NamedRequestBodyOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedRequestBodyOrReference suitable for JSON or YAML export.

type NamedResponseOrReference 

type NamedResponseOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *ResponseOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of ResponseOrReference as ordered (name,value) pairs.

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.

func (*NamedResponseOrReference) Descriptor deprecated 

func (*NamedResponseOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedResponseOrReference.ProtoReflect.Descriptor instead.

func (*NamedResponseOrReference) GetName 

func (x *NamedResponseOrReference) GetName() string

func (*NamedResponseOrReference) GetValue 

func (x *NamedResponseOrReference) GetValue() *ResponseOrReference

func (*NamedResponseOrReference) ProtoMessage 

func (*NamedResponseOrReference) ProtoMessage()

func (*NamedResponseOrReference) ProtoReflect 

func (x *NamedResponseOrReference) ProtoReflect() protoreflect.Message

func (*NamedResponseOrReference) Reset 

func (x *NamedResponseOrReference) Reset()

func (*NamedResponseOrReference) ResolveReferences 

func (m *NamedResponseOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedResponseOrReference objects.

func (*NamedResponseOrReference) String 

func (x *NamedResponseOrReference) String() string

func (*NamedResponseOrReference) ToRawInfo 

func (m *NamedResponseOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedResponseOrReference suitable for JSON or YAML export.

type NamedSchemaOrReference 

type NamedSchemaOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *SchemaOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of SchemaOrReference as ordered (name,value) pairs.

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.

func (*NamedSchemaOrReference) Descriptor deprecated 

func (*NamedSchemaOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedSchemaOrReference.ProtoReflect.Descriptor instead.

func (*NamedSchemaOrReference) GetName 

func (x *NamedSchemaOrReference) GetName() string

func (*NamedSchemaOrReference) GetValue 

func (x *NamedSchemaOrReference) GetValue() *SchemaOrReference

func (*NamedSchemaOrReference) ProtoMessage 

func (*NamedSchemaOrReference) ProtoMessage()

func (*NamedSchemaOrReference) ProtoReflect 

func (x *NamedSchemaOrReference) ProtoReflect() protoreflect.Message

func (*NamedSchemaOrReference) Reset 

func (x *NamedSchemaOrReference) Reset()

func (*NamedSchemaOrReference) ResolveReferences 

func (m *NamedSchemaOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedSchemaOrReference objects.

func (*NamedSchemaOrReference) String 

func (x *NamedSchemaOrReference) String() string

func (*NamedSchemaOrReference) ToRawInfo 

func (m *NamedSchemaOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedSchemaOrReference suitable for JSON or YAML export.

type NamedSecuritySchemeOrReference 

type NamedSecuritySchemeOrReference struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *SecuritySchemeOrReference `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of SecuritySchemeOrReference as ordered (name,value) pairs.

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.

func (*NamedSecuritySchemeOrReference) Descriptor deprecated 

func (*NamedSecuritySchemeOrReference) Descriptor() ([]byte, []int)

Deprecated: Use NamedSecuritySchemeOrReference.ProtoReflect.Descriptor instead.

func (*NamedSecuritySchemeOrReference) GetName 

func (x *NamedSecuritySchemeOrReference) GetName() string

func (*NamedSecuritySchemeOrReference) GetValue 

func (x *NamedSecuritySchemeOrReference) GetValue() *SecuritySchemeOrReference

func (*NamedSecuritySchemeOrReference) ProtoMessage 

func (*NamedSecuritySchemeOrReference) ProtoMessage()

func (*NamedSecuritySchemeOrReference) ProtoReflect 

func (x *NamedSecuritySchemeOrReference) ProtoReflect() protoreflect.Message

func (*NamedSecuritySchemeOrReference) Reset 

func (x *NamedSecuritySchemeOrReference) Reset()

func (*NamedSecuritySchemeOrReference) ResolveReferences 

func (m *NamedSecuritySchemeOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedSecuritySchemeOrReference objects.

func (*NamedSecuritySchemeOrReference) String 

func (x *NamedSecuritySchemeOrReference) String() string

func (*NamedSecuritySchemeOrReference) ToRawInfo 

func (m *NamedSecuritySchemeOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedSecuritySchemeOrReference suitable for JSON or YAML export.

type NamedServerVariable 

type NamedServerVariable struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *ServerVariable `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of ServerVariable as ordered (name,value) pairs.

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.

func (*NamedServerVariable) Descriptor deprecated 

func (*NamedServerVariable) Descriptor() ([]byte, []int)

Deprecated: Use NamedServerVariable.ProtoReflect.Descriptor instead.

func (*NamedServerVariable) GetName 

func (x *NamedServerVariable) GetName() string

func (*NamedServerVariable) GetValue 

func (x *NamedServerVariable) GetValue() *ServerVariable

func (*NamedServerVariable) ProtoMessage 

func (*NamedServerVariable) ProtoMessage()

func (*NamedServerVariable) ProtoReflect 

func (x *NamedServerVariable) ProtoReflect() protoreflect.Message

func (*NamedServerVariable) Reset 

func (x *NamedServerVariable) Reset()

func (*NamedServerVariable) ResolveReferences 

func (m *NamedServerVariable) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedServerVariable objects.

func (*NamedServerVariable) String 

func (x *NamedServerVariable) String() string

func (*NamedServerVariable) ToRawInfo 

func (m *NamedServerVariable) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedServerVariable suitable for JSON or YAML export.

type NamedString 

type NamedString struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of string as ordered (name,value) pairs.

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.

func (*NamedString) Descriptor deprecated 

func (*NamedString) Descriptor() ([]byte, []int)

Deprecated: Use NamedString.ProtoReflect.Descriptor instead.

func (*NamedString) GetName 

func (x *NamedString) GetName() string

func (*NamedString) GetValue 

func (x *NamedString) GetValue() string

func (*NamedString) ProtoMessage 

func (*NamedString) ProtoMessage()

func (*NamedString) ProtoReflect 

func (x *NamedString) ProtoReflect() protoreflect.Message

func (*NamedString) Reset 

func (x *NamedString) Reset()

func (*NamedString) ResolveReferences 

func (m *NamedString) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedString objects.

func (*NamedString) String 

func (x *NamedString) String() string

func (*NamedString) ToRawInfo 

func (m *NamedString) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedString suitable for JSON or YAML export.

type NamedStringArray 

type NamedStringArray struct {

	// Map key
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Mapped value
	Value *StringArray `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Automatically-generated message used to represent maps of StringArray as ordered (name,value) pairs.

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.

func (*NamedStringArray) Descriptor deprecated 

func (*NamedStringArray) Descriptor() ([]byte, []int)

Deprecated: Use NamedStringArray.ProtoReflect.Descriptor instead.

func (*NamedStringArray) GetName 

func (x *NamedStringArray) GetName() string

func (*NamedStringArray) GetValue 

func (x *NamedStringArray) GetValue() *StringArray

func (*NamedStringArray) ProtoMessage 

func (*NamedStringArray) ProtoMessage()

func (*NamedStringArray) ProtoReflect 

func (x *NamedStringArray) ProtoReflect() protoreflect.Message

func (*NamedStringArray) Reset 

func (x *NamedStringArray) Reset()

func (*NamedStringArray) ResolveReferences 

func (m *NamedStringArray) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside NamedStringArray objects.

func (*NamedStringArray) String 

func (x *NamedStringArray) String() string

func (*NamedStringArray) ToRawInfo 

func (m *NamedStringArray) ToRawInfo() *yaml.Node

ToRawInfo returns a description of NamedStringArray suitable for JSON or YAML export.

type OauthFlow 

type OauthFlow struct {
	AuthorizationUrl       string      `protobuf:"bytes,1,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"`
	TokenUrl               string      `protobuf:"bytes,2,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`
	RefreshUrl             string      `protobuf:"bytes,3,opt,name=refresh_url,json=refreshUrl,proto3" json:"refresh_url,omitempty"`
	Scopes                 *Strings    `protobuf:"bytes,4,opt,name=scopes,proto3" json:"scopes,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration details for a supported OAuth Flow

func NewOauthFlow 

func NewOauthFlow(in *yaml.Node, context *compiler.Context) (*OauthFlow, error)

NewOauthFlow creates an object of type OauthFlow if possible, returning an error if not.

func (*OauthFlow) Descriptor deprecated 

func (*OauthFlow) Descriptor() ([]byte, []int)

Deprecated: Use OauthFlow.ProtoReflect.Descriptor instead.

func (*OauthFlow) GetAuthorizationUrl 

func (x *OauthFlow) GetAuthorizationUrl() string

func (*OauthFlow) GetRefreshUrl 

func (x *OauthFlow) GetRefreshUrl() string

func (*OauthFlow) GetScopes 

func (x *OauthFlow) GetScopes() *Strings

func (*OauthFlow) GetSpecificationExtension 

func (x *OauthFlow) GetSpecificationExtension() []*NamedAny

func (*OauthFlow) GetTokenUrl 

func (x *OauthFlow) GetTokenUrl() string

func (*OauthFlow) ProtoMessage 

func (*OauthFlow) ProtoMessage()

func (*OauthFlow) ProtoReflect 

func (x *OauthFlow) ProtoReflect() protoreflect.Message

func (*OauthFlow) Reset 

func (x *OauthFlow) Reset()

func (*OauthFlow) ResolveReferences 

func (m *OauthFlow) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside OauthFlow objects.

func (*OauthFlow) String 

func (x *OauthFlow) String() string

func (*OauthFlow) ToRawInfo 

func (m *OauthFlow) ToRawInfo() *yaml.Node

ToRawInfo returns a description of OauthFlow suitable for JSON or YAML export.

type OauthFlows 

type OauthFlows struct {
	Implicit               *OauthFlow  `protobuf:"bytes,1,opt,name=implicit,proto3" json:"implicit,omitempty"`
	Password               *OauthFlow  `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	ClientCredentials      *OauthFlow  `protobuf:"bytes,3,opt,name=client_credentials,json=clientCredentials,proto3" json:"client_credentials,omitempty"`
	AuthorizationCode      *OauthFlow  `protobuf:"bytes,4,opt,name=authorization_code,json=authorizationCode,proto3" json:"authorization_code,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Allows configuration of the supported OAuth Flows.

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.

func (*OauthFlows) Descriptor deprecated 

func (*OauthFlows) Descriptor() ([]byte, []int)

Deprecated: Use OauthFlows.ProtoReflect.Descriptor instead.

func (*OauthFlows) GetAuthorizationCode 

func (x *OauthFlows) GetAuthorizationCode() *OauthFlow

func (*OauthFlows) GetClientCredentials 

func (x *OauthFlows) GetClientCredentials() *OauthFlow

func (*OauthFlows) GetImplicit 

func (x *OauthFlows) GetImplicit() *OauthFlow

func (*OauthFlows) GetPassword 

func (x *OauthFlows) GetPassword() *OauthFlow

func (*OauthFlows) GetSpecificationExtension 

func (x *OauthFlows) GetSpecificationExtension() []*NamedAny

func (*OauthFlows) ProtoMessage 

func (*OauthFlows) ProtoMessage()

func (*OauthFlows) ProtoReflect 

func (x *OauthFlows) ProtoReflect() protoreflect.Message

func (*OauthFlows) Reset 

func (x *OauthFlows) Reset()

func (*OauthFlows) ResolveReferences 

func (m *OauthFlows) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside OauthFlows objects.

func (*OauthFlows) String 

func (x *OauthFlows) String() string

func (*OauthFlows) ToRawInfo 

func (m *OauthFlows) ToRawInfo() *yaml.Node

ToRawInfo returns a description of OauthFlows suitable for JSON or YAML export.

type Object 

type Object struct {
	AdditionalProperties []*NamedAny `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

func NewObject 

func NewObject(in *yaml.Node, context *compiler.Context) (*Object, error)

NewObject creates an object of type Object if possible, returning an error if not.

func (*Object) Descriptor deprecated 

func (*Object) Descriptor() ([]byte, []int)

Deprecated: Use Object.ProtoReflect.Descriptor instead.

func (*Object) GetAdditionalProperties 

func (x *Object) GetAdditionalProperties() []*NamedAny

func (*Object) ProtoMessage 

func (*Object) ProtoMessage()

func (*Object) ProtoReflect 

func (x *Object) ProtoReflect() protoreflect.Message

func (*Object) Reset 

func (x *Object) Reset()

func (*Object) ResolveReferences 

func (m *Object) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Object objects.

func (*Object) String 

func (x *Object) String() string

func (*Object) ToRawInfo 

func (m *Object) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Object suitable for JSON or YAML export.

type Operation 

type Operation struct {
	Tags                   []string                `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
	Summary                string                  `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	Description            string                  `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	ExternalDocs           *ExternalDocs           `protobuf:"bytes,4,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	OperationId            string                  `protobuf:"bytes,5,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	Parameters             []*ParameterOrReference `protobuf:"bytes,6,rep,name=parameters,proto3" json:"parameters,omitempty"`
	RequestBody            *RequestBodyOrReference `protobuf:"bytes,7,opt,name=request_body,json=requestBody,proto3" json:"request_body,omitempty"`
	Responses              *Responses              `protobuf:"bytes,8,opt,name=responses,proto3" json:"responses,omitempty"`
	Callbacks              *CallbacksOrReferences  `protobuf:"bytes,9,opt,name=callbacks,proto3" json:"callbacks,omitempty"`
	Deprecated             bool                    `protobuf:"varint,10,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	Security               []*SecurityRequirement  `protobuf:"bytes,11,rep,name=security,proto3" json:"security,omitempty"`
	Servers                []*Server               `protobuf:"bytes,12,rep,name=servers,proto3" json:"servers,omitempty"`
	SpecificationExtension []*NamedAny             `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single API operation on a path.

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.

func (*Operation) Descriptor deprecated 

func (*Operation) Descriptor() ([]byte, []int)

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetCallbacks 

func (x *Operation) GetCallbacks() *CallbacksOrReferences

func (*Operation) GetDeprecated 

func (x *Operation) GetDeprecated() bool

func (*Operation) GetDescription 

func (x *Operation) GetDescription() string

func (*Operation) GetExternalDocs 

func (x *Operation) GetExternalDocs() *ExternalDocs

func (*Operation) GetOperationId 

func (x *Operation) GetOperationId() string

func (*Operation) GetParameters 

func (x *Operation) GetParameters() []*ParameterOrReference

func (*Operation) GetRequestBody 

func (x *Operation) GetRequestBody() *RequestBodyOrReference

func (*Operation) GetResponses 

func (x *Operation) GetResponses() *Responses

func (*Operation) GetSecurity 

func (x *Operation) GetSecurity() []*SecurityRequirement

func (*Operation) GetServers 

func (x *Operation) GetServers() []*Server

func (*Operation) GetSpecificationExtension 

func (x *Operation) GetSpecificationExtension() []*NamedAny

func (*Operation) GetSummary 

func (x *Operation) GetSummary() string

func (*Operation) GetTags 

func (x *Operation) GetTags() []string

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

func (x *Operation) ProtoReflect() protoreflect.Message

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) ResolveReferences 

func (m *Operation) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Operation objects.

func (*Operation) String 

func (x *Operation) String() string

func (*Operation) ToRawInfo 

func (m *Operation) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Operation suitable for JSON or YAML export.

type Parameter 

type Parameter struct {
	Name                   string                `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	In                     string                `protobuf:"bytes,2,opt,name=in,proto3" json:"in,omitempty"`
	Description            string                `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Required               bool                  `protobuf:"varint,4,opt,name=required,proto3" json:"required,omitempty"`
	Deprecated             bool                  `protobuf:"varint,5,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	AllowEmptyValue        bool                  `protobuf:"varint,6,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
	Style                  string                `protobuf:"bytes,7,opt,name=style,proto3" json:"style,omitempty"`
	Explode                bool                  `protobuf:"varint,8,opt,name=explode,proto3" json:"explode,omitempty"`
	AllowReserved          bool                  `protobuf:"varint,9,opt,name=allow_reserved,json=allowReserved,proto3" json:"allow_reserved,omitempty"`
	Schema                 *SchemaOrReference    `protobuf:"bytes,10,opt,name=schema,proto3" json:"schema,omitempty"`
	Example                *Any                  `protobuf:"bytes,11,opt,name=example,proto3" json:"example,omitempty"`
	Examples               *ExamplesOrReferences `protobuf:"bytes,12,opt,name=examples,proto3" json:"examples,omitempty"`
	Content                *MediaTypes           `protobuf:"bytes,13,opt,name=content,proto3" json:"content,omitempty"`
	SpecificationExtension []*NamedAny           `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

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.

func (*Parameter) Descriptor deprecated 

func (*Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Parameter.ProtoReflect.Descriptor instead.

func (*Parameter) GetAllowEmptyValue 

func (x *Parameter) GetAllowEmptyValue() bool

func (*Parameter) GetAllowReserved 

func (x *Parameter) GetAllowReserved() bool

func (*Parameter) GetContent 

func (x *Parameter) GetContent() *MediaTypes

func (*Parameter) GetDeprecated 

func (x *Parameter) GetDeprecated() bool

func (*Parameter) GetDescription 

func (x *Parameter) GetDescription() string

func (*Parameter) GetExample 

func (x *Parameter) GetExample() *Any

func (*Parameter) GetExamples 

func (x *Parameter) GetExamples() *ExamplesOrReferences

func (*Parameter) GetExplode 

func (x *Parameter) GetExplode() bool

func (*Parameter) GetIn 

func (x *Parameter) GetIn() string

func (*Parameter) GetName 

func (x *Parameter) GetName() string

func (*Parameter) GetRequired 

func (x *Parameter) GetRequired() bool

func (*Parameter) GetSchema 

func (x *Parameter) GetSchema() *SchemaOrReference

func (*Parameter) GetSpecificationExtension 

func (x *Parameter) GetSpecificationExtension() []*NamedAny

func (*Parameter) GetStyle 

func (x *Parameter) GetStyle() string

func (*Parameter) ProtoMessage 

func (*Parameter) ProtoMessage()

func (*Parameter) ProtoReflect 

func (x *Parameter) ProtoReflect() protoreflect.Message

func (*Parameter) Reset 

func (x *Parameter) Reset()

func (*Parameter) ResolveReferences 

func (m *Parameter) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Parameter objects.

func (*Parameter) String 

func (x *Parameter) String() string

func (*Parameter) ToRawInfo 

func (m *Parameter) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Parameter suitable for JSON or YAML export.

type ParameterOrReference 

type ParameterOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*ParameterOrReference_Parameter
	//	*ParameterOrReference_Reference
	Oneof isParameterOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*ParameterOrReference) Descriptor deprecated 

func (*ParameterOrReference) Descriptor() ([]byte, []int)

Deprecated: Use ParameterOrReference.ProtoReflect.Descriptor instead.

func (*ParameterOrReference) GetOneof 

func (m *ParameterOrReference) GetOneof() isParameterOrReference_Oneof

func (*ParameterOrReference) GetParameter 

func (x *ParameterOrReference) GetParameter() *Parameter

func (*ParameterOrReference) GetReference 

func (x *ParameterOrReference) GetReference() *Reference

func (*ParameterOrReference) ProtoMessage 

func (*ParameterOrReference) ProtoMessage()

func (*ParameterOrReference) ProtoReflect 

func (x *ParameterOrReference) ProtoReflect() protoreflect.Message

func (*ParameterOrReference) Reset 

func (x *ParameterOrReference) Reset()

func (*ParameterOrReference) ResolveReferences 

func (m *ParameterOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ParameterOrReference objects.

func (*ParameterOrReference) String 

func (x *ParameterOrReference) String() string

func (*ParameterOrReference) ToRawInfo 

func (m *ParameterOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ParameterOrReference suitable for JSON or YAML export.

type ParameterOrReference_Parameter 

type ParameterOrReference_Parameter struct {
	Parameter *Parameter `protobuf:"bytes,1,opt,name=parameter,proto3,oneof"`
}

type ParameterOrReference_Reference 

type ParameterOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type ParametersOrReferences 

type ParametersOrReferences struct {
	AdditionalProperties []*NamedParameterOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ParametersOrReferences) Descriptor deprecated 

func (*ParametersOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use ParametersOrReferences.ProtoReflect.Descriptor instead.

func (*ParametersOrReferences) GetAdditionalProperties 

func (x *ParametersOrReferences) GetAdditionalProperties() []*NamedParameterOrReference

func (*ParametersOrReferences) ProtoMessage 

func (*ParametersOrReferences) ProtoMessage()

func (*ParametersOrReferences) ProtoReflect 

func (x *ParametersOrReferences) ProtoReflect() protoreflect.Message

func (*ParametersOrReferences) Reset 

func (x *ParametersOrReferences) Reset()

func (*ParametersOrReferences) ResolveReferences 

func (m *ParametersOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ParametersOrReferences objects.

func (*ParametersOrReferences) String 

func (x *ParametersOrReferences) String() string

func (*ParametersOrReferences) ToRawInfo 

func (m *ParametersOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ParametersOrReferences suitable for JSON or YAML export.

type PathItem 

type PathItem struct {
	XRef                   string                  `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
	Summary                string                  `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	Description            string                  `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Get                    *Operation              `protobuf:"bytes,4,opt,name=get,proto3" json:"get,omitempty"`
	Put                    *Operation              `protobuf:"bytes,5,opt,name=put,proto3" json:"put,omitempty"`
	Post                   *Operation              `protobuf:"bytes,6,opt,name=post,proto3" json:"post,omitempty"`
	Delete                 *Operation              `protobuf:"bytes,7,opt,name=delete,proto3" json:"delete,omitempty"`
	Options                *Operation              `protobuf:"bytes,8,opt,name=options,proto3" json:"options,omitempty"`
	Head                   *Operation              `protobuf:"bytes,9,opt,name=head,proto3" json:"head,omitempty"`
	Patch                  *Operation              `protobuf:"bytes,10,opt,name=patch,proto3" json:"patch,omitempty"`
	Trace                  *Operation              `protobuf:"bytes,11,opt,name=trace,proto3" json:"trace,omitempty"`
	Servers                []*Server               `protobuf:"bytes,12,rep,name=servers,proto3" json:"servers,omitempty"`
	Parameters             []*ParameterOrReference `protobuf:"bytes,13,rep,name=parameters,proto3" json:"parameters,omitempty"`
	SpecificationExtension []*NamedAny             `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.

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.

func (*PathItem) Descriptor deprecated 

func (*PathItem) Descriptor() ([]byte, []int)

Deprecated: Use PathItem.ProtoReflect.Descriptor instead.

func (*PathItem) GetDelete 

func (x *PathItem) GetDelete() *Operation

func (*PathItem) GetDescription 

func (x *PathItem) GetDescription() string

func (*PathItem) GetGet 

func (x *PathItem) GetGet() *Operation

func (*PathItem) GetHead 

func (x *PathItem) GetHead() *Operation

func (*PathItem) GetOptions 

func (x *PathItem) GetOptions() *Operation

func (*PathItem) GetParameters 

func (x *PathItem) GetParameters() []*ParameterOrReference

func (*PathItem) GetPatch 

func (x *PathItem) GetPatch() *Operation

func (*PathItem) GetPost 

func (x *PathItem) GetPost() *Operation

func (*PathItem) GetPut 

func (x *PathItem) GetPut() *Operation

func (*PathItem) GetServers 

func (x *PathItem) GetServers() []*Server

func (*PathItem) GetSpecificationExtension 

func (x *PathItem) GetSpecificationExtension() []*NamedAny

func (*PathItem) GetSummary 

func (x *PathItem) GetSummary() string

func (*PathItem) GetTrace 

func (x *PathItem) GetTrace() *Operation

func (*PathItem) GetXRef 

func (x *PathItem) GetXRef() string

func (*PathItem) ProtoMessage 

func (*PathItem) ProtoMessage()

func (*PathItem) ProtoReflect 

func (x *PathItem) ProtoReflect() protoreflect.Message

func (*PathItem) Reset 

func (x *PathItem) Reset()

func (*PathItem) ResolveReferences 

func (m *PathItem) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside PathItem objects.

func (*PathItem) String 

func (x *PathItem) String() string

func (*PathItem) ToRawInfo 

func (m *PathItem) ToRawInfo() *yaml.Node

ToRawInfo returns a description of PathItem suitable for JSON or YAML export.

type Paths 

type Paths struct {
	Path                   []*NamedPathItem `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"`
	SpecificationExtension []*NamedAny      `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the `Server Object` in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.

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.

func (*Paths) Descriptor deprecated 

func (*Paths) Descriptor() ([]byte, []int)

Deprecated: Use Paths.ProtoReflect.Descriptor instead.

func (*Paths) GetPath 

func (x *Paths) GetPath() []*NamedPathItem

func (*Paths) GetSpecificationExtension 

func (x *Paths) GetSpecificationExtension() []*NamedAny

func (*Paths) ProtoMessage 

func (*Paths) ProtoMessage()

func (*Paths) ProtoReflect 

func (x *Paths) ProtoReflect() protoreflect.Message

func (*Paths) Reset 

func (x *Paths) Reset()

func (*Paths) ResolveReferences 

func (m *Paths) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Paths objects.

func (*Paths) String 

func (x *Paths) String() string

func (*Paths) ToRawInfo 

func (m *Paths) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Paths suitable for JSON or YAML export.

type Properties 

type Properties struct {
	AdditionalProperties []*NamedSchemaOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Properties) Descriptor deprecated 

func (*Properties) Descriptor() ([]byte, []int)

Deprecated: Use Properties.ProtoReflect.Descriptor instead.

func (*Properties) GetAdditionalProperties 

func (x *Properties) GetAdditionalProperties() []*NamedSchemaOrReference

func (*Properties) ProtoMessage 

func (*Properties) ProtoMessage()

func (*Properties) ProtoReflect 

func (x *Properties) ProtoReflect() protoreflect.Message

func (*Properties) Reset 

func (x *Properties) Reset()

func (*Properties) ResolveReferences 

func (m *Properties) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Properties objects.

func (*Properties) String 

func (x *Properties) String() string

func (*Properties) ToRawInfo 

func (m *Properties) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Properties suitable for JSON or YAML export.

type Reference 

type Reference struct {
	XRef        string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
	Summary     string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

A simple object to allow referencing other components in the specification, internally and externally. The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules. For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification.

func NewReference 

func NewReference(in *yaml.Node, context *compiler.Context) (*Reference, error)

NewReference creates an object of type Reference if possible, returning an error if not.

func (*Reference) Descriptor deprecated 

func (*Reference) Descriptor() ([]byte, []int)

Deprecated: Use Reference.ProtoReflect.Descriptor instead.

func (*Reference) GetDescription 

func (x *Reference) GetDescription() string

func (*Reference) GetSummary 

func (x *Reference) GetSummary() string

func (*Reference) GetXRef 

func (x *Reference) GetXRef() string

func (*Reference) ProtoMessage 

func (*Reference) ProtoMessage()

func (*Reference) ProtoReflect 

func (x *Reference) ProtoReflect() protoreflect.Message

func (*Reference) Reset 

func (x *Reference) Reset()

func (*Reference) ResolveReferences 

func (m *Reference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Reference objects.

func (*Reference) String 

func (x *Reference) String() string

func (*Reference) ToRawInfo 

func (m *Reference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Reference suitable for JSON or YAML export.

type RequestBodiesOrReferences 

type RequestBodiesOrReferences struct {
	AdditionalProperties []*NamedRequestBodyOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*RequestBodiesOrReferences) Descriptor deprecated 

func (*RequestBodiesOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use RequestBodiesOrReferences.ProtoReflect.Descriptor instead.

func (*RequestBodiesOrReferences) GetAdditionalProperties 

func (x *RequestBodiesOrReferences) GetAdditionalProperties() []*NamedRequestBodyOrReference

func (*RequestBodiesOrReferences) ProtoMessage 

func (*RequestBodiesOrReferences) ProtoMessage()

func (*RequestBodiesOrReferences) ProtoReflect 

func (x *RequestBodiesOrReferences) ProtoReflect() protoreflect.Message

func (*RequestBodiesOrReferences) Reset 

func (x *RequestBodiesOrReferences) Reset()

func (*RequestBodiesOrReferences) ResolveReferences 

func (m *RequestBodiesOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside RequestBodiesOrReferences objects.

func (*RequestBodiesOrReferences) String 

func (x *RequestBodiesOrReferences) String() string

func (*RequestBodiesOrReferences) ToRawInfo 

func (m *RequestBodiesOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of RequestBodiesOrReferences suitable for JSON or YAML export.

type RequestBody 

type RequestBody struct {
	Description            string      `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	Content                *MediaTypes `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	Required               bool        `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single request body.

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.

func (*RequestBody) Descriptor deprecated 

func (*RequestBody) Descriptor() ([]byte, []int)

Deprecated: Use RequestBody.ProtoReflect.Descriptor instead.

func (*RequestBody) GetContent 

func (x *RequestBody) GetContent() *MediaTypes

func (*RequestBody) GetDescription 

func (x *RequestBody) GetDescription() string

func (*RequestBody) GetRequired 

func (x *RequestBody) GetRequired() bool

func (*RequestBody) GetSpecificationExtension 

func (x *RequestBody) GetSpecificationExtension() []*NamedAny

func (*RequestBody) ProtoMessage 

func (*RequestBody) ProtoMessage()

func (*RequestBody) ProtoReflect 

func (x *RequestBody) ProtoReflect() protoreflect.Message

func (*RequestBody) Reset 

func (x *RequestBody) Reset()

func (*RequestBody) ResolveReferences 

func (m *RequestBody) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside RequestBody objects.

func (*RequestBody) String 

func (x *RequestBody) String() string

func (*RequestBody) ToRawInfo 

func (m *RequestBody) ToRawInfo() *yaml.Node

ToRawInfo returns a description of RequestBody suitable for JSON or YAML export.

type RequestBodyOrReference 

type RequestBodyOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*RequestBodyOrReference_RequestBody
	//	*RequestBodyOrReference_Reference
	Oneof isRequestBodyOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*RequestBodyOrReference) Descriptor deprecated 

func (*RequestBodyOrReference) Descriptor() ([]byte, []int)

Deprecated: Use RequestBodyOrReference.ProtoReflect.Descriptor instead.

func (*RequestBodyOrReference) GetOneof 

func (m *RequestBodyOrReference) GetOneof() isRequestBodyOrReference_Oneof

func (*RequestBodyOrReference) GetReference 

func (x *RequestBodyOrReference) GetReference() *Reference

func (*RequestBodyOrReference) GetRequestBody 

func (x *RequestBodyOrReference) GetRequestBody() *RequestBody

func (*RequestBodyOrReference) ProtoMessage 

func (*RequestBodyOrReference) ProtoMessage()

func (*RequestBodyOrReference) ProtoReflect 

func (x *RequestBodyOrReference) ProtoReflect() protoreflect.Message

func (*RequestBodyOrReference) Reset 

func (x *RequestBodyOrReference) Reset()

func (*RequestBodyOrReference) ResolveReferences 

func (m *RequestBodyOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside RequestBodyOrReference objects.

func (*RequestBodyOrReference) String 

func (x *RequestBodyOrReference) String() string

func (*RequestBodyOrReference) ToRawInfo 

func (m *RequestBodyOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of RequestBodyOrReference suitable for JSON or YAML export.

type RequestBodyOrReference_Reference 

type RequestBodyOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type RequestBodyOrReference_RequestBody 

type RequestBodyOrReference_RequestBody struct {
	RequestBody *RequestBody `protobuf:"bytes,1,opt,name=request_body,json=requestBody,proto3,oneof"`
}

type Response 

type Response struct {
	Description            string               `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	Headers                *HeadersOrReferences `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	Content                *MediaTypes          `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	Links                  *LinksOrReferences   `protobuf:"bytes,4,opt,name=links,proto3" json:"links,omitempty"`
	SpecificationExtension []*NamedAny          `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single response from an API Operation, including design-time, static `links` to operations based on the 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.

func (*Response) Descriptor deprecated 

func (*Response) Descriptor() ([]byte, []int)

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetContent 

func (x *Response) GetContent() *MediaTypes

func (*Response) GetDescription 

func (x *Response) GetDescription() string

func (*Response) GetHeaders 

func (x *Response) GetHeaders() *HeadersOrReferences
func (x *Response) GetLinks() *LinksOrReferences

func (*Response) GetSpecificationExtension 

func (x *Response) GetSpecificationExtension() []*NamedAny

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) ProtoReflect 

func (x *Response) ProtoReflect() protoreflect.Message

func (*Response) Reset 

func (x *Response) Reset()

func (*Response) ResolveReferences 

func (m *Response) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Response objects.

func (*Response) String 

func (x *Response) String() string

func (*Response) ToRawInfo 

func (m *Response) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Response suitable for JSON or YAML export.

type ResponseOrReference 

type ResponseOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*ResponseOrReference_Response
	//	*ResponseOrReference_Reference
	Oneof isResponseOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*ResponseOrReference) Descriptor deprecated 

func (*ResponseOrReference) Descriptor() ([]byte, []int)

Deprecated: Use ResponseOrReference.ProtoReflect.Descriptor instead.

func (*ResponseOrReference) GetOneof 

func (m *ResponseOrReference) GetOneof() isResponseOrReference_Oneof

func (*ResponseOrReference) GetReference 

func (x *ResponseOrReference) GetReference() *Reference

func (*ResponseOrReference) GetResponse 

func (x *ResponseOrReference) GetResponse() *Response

func (*ResponseOrReference) ProtoMessage 

func (*ResponseOrReference) ProtoMessage()

func (*ResponseOrReference) ProtoReflect 

func (x *ResponseOrReference) ProtoReflect() protoreflect.Message

func (*ResponseOrReference) Reset 

func (x *ResponseOrReference) Reset()

func (*ResponseOrReference) ResolveReferences 

func (m *ResponseOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ResponseOrReference objects.

func (*ResponseOrReference) String 

func (x *ResponseOrReference) String() string

func (*ResponseOrReference) ToRawInfo 

func (m *ResponseOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ResponseOrReference suitable for JSON or YAML export.

type ResponseOrReference_Reference 

type ResponseOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type ResponseOrReference_Response 

type ResponseOrReference_Response struct {
	Response *Response `protobuf:"bytes,1,opt,name=response,proto3,oneof"`
}

type Responses 

type Responses struct {
	Default                *ResponseOrReference        `protobuf:"bytes,1,opt,name=default,proto3" json:"default,omitempty"`
	ResponseOrReference    []*NamedResponseOrReference `protobuf:"bytes,2,rep,name=response_or_reference,json=responseOrReference,proto3" json:"response_or_reference,omitempty"`
	SpecificationExtension []*NamedAny                 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors. The `default` MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call.

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.

func (*Responses) Descriptor deprecated 

func (*Responses) Descriptor() ([]byte, []int)

Deprecated: Use Responses.ProtoReflect.Descriptor instead.

func (*Responses) GetDefault 

func (x *Responses) GetDefault() *ResponseOrReference

func (*Responses) GetResponseOrReference 

func (x *Responses) GetResponseOrReference() []*NamedResponseOrReference

func (*Responses) GetSpecificationExtension 

func (x *Responses) GetSpecificationExtension() []*NamedAny

func (*Responses) ProtoMessage 

func (*Responses) ProtoMessage()

func (*Responses) ProtoReflect 

func (x *Responses) ProtoReflect() protoreflect.Message

func (*Responses) Reset 

func (x *Responses) Reset()

func (*Responses) ResolveReferences 

func (m *Responses) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Responses objects.

func (*Responses) String 

func (x *Responses) String() string

func (*Responses) ToRawInfo 

func (m *Responses) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Responses suitable for JSON or YAML export.

type ResponsesOrReferences 

type ResponsesOrReferences struct {
	AdditionalProperties []*NamedResponseOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ResponsesOrReferences) Descriptor deprecated 

func (*ResponsesOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use ResponsesOrReferences.ProtoReflect.Descriptor instead.

func (*ResponsesOrReferences) GetAdditionalProperties 

func (x *ResponsesOrReferences) GetAdditionalProperties() []*NamedResponseOrReference

func (*ResponsesOrReferences) ProtoMessage 

func (*ResponsesOrReferences) ProtoMessage()

func (*ResponsesOrReferences) ProtoReflect 

func (x *ResponsesOrReferences) ProtoReflect() protoreflect.Message

func (*ResponsesOrReferences) Reset 

func (x *ResponsesOrReferences) Reset()

func (*ResponsesOrReferences) ResolveReferences 

func (m *ResponsesOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ResponsesOrReferences objects.

func (*ResponsesOrReferences) String 

func (x *ResponsesOrReferences) String() string

func (*ResponsesOrReferences) ToRawInfo 

func (m *ResponsesOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ResponsesOrReferences suitable for JSON or YAML export.

type Schema 

type Schema struct {
	Nullable               bool                      `protobuf:"varint,1,opt,name=nullable,proto3" json:"nullable,omitempty"`
	Discriminator          *Discriminator            `protobuf:"bytes,2,opt,name=discriminator,proto3" json:"discriminator,omitempty"`
	ReadOnly               bool                      `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	WriteOnly              bool                      `protobuf:"varint,4,opt,name=write_only,json=writeOnly,proto3" json:"write_only,omitempty"`
	Xml                    *Xml                      `protobuf:"bytes,5,opt,name=xml,proto3" json:"xml,omitempty"`
	ExternalDocs           *ExternalDocs             `protobuf:"bytes,6,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	Example                *Any                      `protobuf:"bytes,7,opt,name=example,proto3" json:"example,omitempty"`
	Deprecated             bool                      `protobuf:"varint,8,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	Title                  string                    `protobuf:"bytes,9,opt,name=title,proto3" json:"title,omitempty"`
	MultipleOf             float64                   `protobuf:"fixed64,10,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
	Maximum                float64                   `protobuf:"fixed64,11,opt,name=maximum,proto3" json:"maximum,omitempty"`
	ExclusiveMaximum       bool                      `protobuf:"varint,12,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
	Minimum                float64                   `protobuf:"fixed64,13,opt,name=minimum,proto3" json:"minimum,omitempty"`
	ExclusiveMinimum       bool                      `protobuf:"varint,14,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
	MaxLength              int64                     `protobuf:"varint,15,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	MinLength              int64                     `protobuf:"varint,16,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
	Pattern                string                    `protobuf:"bytes,17,opt,name=pattern,proto3" json:"pattern,omitempty"`
	MaxItems               int64                     `protobuf:"varint,18,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
	MinItems               int64                     `protobuf:"varint,19,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
	UniqueItems            bool                      `protobuf:"varint,20,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
	MaxProperties          int64                     `protobuf:"varint,21,opt,name=max_properties,json=maxProperties,proto3" json:"max_properties,omitempty"`
	MinProperties          int64                     `protobuf:"varint,22,opt,name=min_properties,json=minProperties,proto3" json:"min_properties,omitempty"`
	Required               []string                  `protobuf:"bytes,23,rep,name=required,proto3" json:"required,omitempty"`
	Enum                   []*Any                    `protobuf:"bytes,24,rep,name=enum,proto3" json:"enum,omitempty"`
	Type                   string                    `protobuf:"bytes,25,opt,name=type,proto3" json:"type,omitempty"`
	AllOf                  []*SchemaOrReference      `protobuf:"bytes,26,rep,name=all_of,json=allOf,proto3" json:"all_of,omitempty"`
	OneOf                  []*SchemaOrReference      `protobuf:"bytes,27,rep,name=one_of,json=oneOf,proto3" json:"one_of,omitempty"`
	AnyOf                  []*SchemaOrReference      `protobuf:"bytes,28,rep,name=any_of,json=anyOf,proto3" json:"any_of,omitempty"`
	Not                    *Schema                   `protobuf:"bytes,29,opt,name=not,proto3" json:"not,omitempty"`
	Items                  *ItemsItem                `protobuf:"bytes,30,opt,name=items,proto3" json:"items,omitempty"`
	Properties             *Properties               `protobuf:"bytes,31,opt,name=properties,proto3" json:"properties,omitempty"`
	AdditionalProperties   *AdditionalPropertiesItem `protobuf:"bytes,32,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	Default                *DefaultType              `protobuf:"bytes,33,opt,name=default,proto3" json:"default,omitempty"`
	Description            string                    `protobuf:"bytes,34,opt,name=description,proto3" json:"description,omitempty"`
	Format                 string                    `protobuf:"bytes,35,opt,name=format,proto3" json:"format,omitempty"`
	SpecificationExtension []*NamedAny               `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON 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.

func (*Schema) Descriptor deprecated 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetAdditionalProperties 

func (x *Schema) GetAdditionalProperties() *AdditionalPropertiesItem

func (*Schema) GetAllOf 

func (x *Schema) GetAllOf() []*SchemaOrReference

func (*Schema) GetAnyOf 

func (x *Schema) GetAnyOf() []*SchemaOrReference

func (*Schema) GetDefault 

func (x *Schema) GetDefault() *DefaultType

func (*Schema) GetDeprecated 

func (x *Schema) GetDeprecated() bool

func (*Schema) GetDescription 

func (x *Schema) GetDescription() string

func (*Schema) GetDiscriminator 

func (x *Schema) GetDiscriminator() *Discriminator

func (*Schema) GetEnum 

func (x *Schema) GetEnum() []*Any

func (*Schema) GetExample 

func (x *Schema) GetExample() *Any

func (*Schema) GetExclusiveMaximum 

func (x *Schema) GetExclusiveMaximum() bool

func (*Schema) GetExclusiveMinimum 

func (x *Schema) GetExclusiveMinimum() bool

func (*Schema) GetExternalDocs 

func (x *Schema) GetExternalDocs() *ExternalDocs

func (*Schema) GetFormat 

func (x *Schema) GetFormat() string

func (*Schema) GetItems 

func (x *Schema) GetItems() *ItemsItem

func (*Schema) GetMaxItems 

func (x *Schema) GetMaxItems() int64

func (*Schema) GetMaxLength 

func (x *Schema) GetMaxLength() int64

func (*Schema) GetMaxProperties 

func (x *Schema) GetMaxProperties() int64

func (*Schema) GetMaximum 

func (x *Schema) GetMaximum() float64

func (*Schema) GetMinItems 

func (x *Schema) GetMinItems() int64

func (*Schema) GetMinLength 

func (x *Schema) GetMinLength() int64

func (*Schema) GetMinProperties 

func (x *Schema) GetMinProperties() int64

func (*Schema) GetMinimum 

func (x *Schema) GetMinimum() float64

func (*Schema) GetMultipleOf 

func (x *Schema) GetMultipleOf() float64

func (*Schema) GetNot 

func (x *Schema) GetNot() *Schema

func (*Schema) GetNullable 

func (x *Schema) GetNullable() bool

func (*Schema) GetOneOf 

func (x *Schema) GetOneOf() []*SchemaOrReference

func (*Schema) GetPattern 

func (x *Schema) GetPattern() string

func (*Schema) GetProperties 

func (x *Schema) GetProperties() *Properties

func (*Schema) GetReadOnly 

func (x *Schema) GetReadOnly() bool

func (*Schema) GetRequired 

func (x *Schema) GetRequired() []string

func (*Schema) GetSpecificationExtension 

func (x *Schema) GetSpecificationExtension() []*NamedAny

func (*Schema) GetTitle 

func (x *Schema) GetTitle() string

func (*Schema) GetType 

func (x *Schema) GetType() string

func (*Schema) GetUniqueItems 

func (x *Schema) GetUniqueItems() bool

func (*Schema) GetWriteOnly 

func (x *Schema) GetWriteOnly() bool

func (*Schema) GetXml 

func (x *Schema) GetXml() *Xml

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset 

func (x *Schema) Reset()

func (*Schema) ResolveReferences 

func (m *Schema) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Schema objects.

func (*Schema) String 

func (x *Schema) String() string

func (*Schema) ToRawInfo 

func (m *Schema) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Schema suitable for JSON or YAML export.

type SchemaOrReference 

type SchemaOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*SchemaOrReference_Schema
	//	*SchemaOrReference_Reference
	Oneof isSchemaOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*SchemaOrReference) Descriptor deprecated 

func (*SchemaOrReference) Descriptor() ([]byte, []int)

Deprecated: Use SchemaOrReference.ProtoReflect.Descriptor instead.

func (*SchemaOrReference) GetOneof 

func (m *SchemaOrReference) GetOneof() isSchemaOrReference_Oneof

func (*SchemaOrReference) GetReference 

func (x *SchemaOrReference) GetReference() *Reference

func (*SchemaOrReference) GetSchema 

func (x *SchemaOrReference) GetSchema() *Schema

func (*SchemaOrReference) ProtoMessage 

func (*SchemaOrReference) ProtoMessage()

func (*SchemaOrReference) ProtoReflect 

func (x *SchemaOrReference) ProtoReflect() protoreflect.Message

func (*SchemaOrReference) Reset 

func (x *SchemaOrReference) Reset()

func (*SchemaOrReference) ResolveReferences 

func (m *SchemaOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SchemaOrReference objects.

func (*SchemaOrReference) String 

func (x *SchemaOrReference) String() string

func (*SchemaOrReference) ToRawInfo 

func (m *SchemaOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SchemaOrReference suitable for JSON or YAML export.

type SchemaOrReference_Reference 

type SchemaOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type SchemaOrReference_Schema 

type SchemaOrReference_Schema struct {
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3,oneof"`
}

type SchemasOrReferences 

type SchemasOrReferences struct {
	AdditionalProperties []*NamedSchemaOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SchemasOrReferences) Descriptor deprecated 

func (*SchemasOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use SchemasOrReferences.ProtoReflect.Descriptor instead.

func (*SchemasOrReferences) GetAdditionalProperties 

func (x *SchemasOrReferences) GetAdditionalProperties() []*NamedSchemaOrReference

func (*SchemasOrReferences) ProtoMessage 

func (*SchemasOrReferences) ProtoMessage()

func (*SchemasOrReferences) ProtoReflect 

func (x *SchemasOrReferences) ProtoReflect() protoreflect.Message

func (*SchemasOrReferences) Reset 

func (x *SchemasOrReferences) Reset()

func (*SchemasOrReferences) ResolveReferences 

func (m *SchemasOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SchemasOrReferences objects.

func (*SchemasOrReferences) String 

func (x *SchemasOrReferences) String() string

func (*SchemasOrReferences) ToRawInfo 

func (m *SchemasOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SchemasOrReferences suitable for JSON or YAML export.

type SecurityRequirement 

type SecurityRequirement struct {
	AdditionalProperties []*NamedStringArray `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object. Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. When a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.

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.

func (*SecurityRequirement) Descriptor deprecated 

func (*SecurityRequirement) Descriptor() ([]byte, []int)

Deprecated: Use SecurityRequirement.ProtoReflect.Descriptor instead.

func (*SecurityRequirement) GetAdditionalProperties 

func (x *SecurityRequirement) GetAdditionalProperties() []*NamedStringArray

func (*SecurityRequirement) ProtoMessage 

func (*SecurityRequirement) ProtoMessage()

func (*SecurityRequirement) ProtoReflect 

func (x *SecurityRequirement) ProtoReflect() protoreflect.Message

func (*SecurityRequirement) Reset 

func (x *SecurityRequirement) Reset()

func (*SecurityRequirement) ResolveReferences 

func (m *SecurityRequirement) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SecurityRequirement objects.

func (*SecurityRequirement) String 

func (x *SecurityRequirement) String() string

func (*SecurityRequirement) ToRawInfo 

func (m *SecurityRequirement) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SecurityRequirement suitable for JSON or YAML export.

type SecurityScheme 

type SecurityScheme struct {
	Type                   string      `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Description            string      `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Name                   string      `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	In                     string      `protobuf:"bytes,4,opt,name=in,proto3" json:"in,omitempty"`
	Scheme                 string      `protobuf:"bytes,5,opt,name=scheme,proto3" json:"scheme,omitempty"`
	BearerFormat           string      `protobuf:"bytes,6,opt,name=bearer_format,json=bearerFormat,proto3" json:"bearer_format,omitempty"`
	Flows                  *OauthFlows `protobuf:"bytes,7,opt,name=flows,proto3" json:"flows,omitempty"`
	OpenIdConnectUrl       string      `protobuf:"bytes,8,opt,name=open_id_connect_url,json=openIdConnectUrl,proto3" json:"open_id_connect_url,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect. Please note that currently (2019) the implicit flow is about to be deprecated OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE.

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.

func (*SecurityScheme) Descriptor deprecated 

func (*SecurityScheme) Descriptor() ([]byte, []int)

Deprecated: Use SecurityScheme.ProtoReflect.Descriptor instead.

func (*SecurityScheme) GetBearerFormat 

func (x *SecurityScheme) GetBearerFormat() string

func (*SecurityScheme) GetDescription 

func (x *SecurityScheme) GetDescription() string

func (*SecurityScheme) GetFlows 

func (x *SecurityScheme) GetFlows() *OauthFlows

func (*SecurityScheme) GetIn 

func (x *SecurityScheme) GetIn() string

func (*SecurityScheme) GetName 

func (x *SecurityScheme) GetName() string

func (*SecurityScheme) GetOpenIdConnectUrl 

func (x *SecurityScheme) GetOpenIdConnectUrl() string

func (*SecurityScheme) GetScheme 

func (x *SecurityScheme) GetScheme() string

func (*SecurityScheme) GetSpecificationExtension 

func (x *SecurityScheme) GetSpecificationExtension() []*NamedAny

func (*SecurityScheme) GetType 

func (x *SecurityScheme) GetType() string

func (*SecurityScheme) ProtoMessage 

func (*SecurityScheme) ProtoMessage()

func (*SecurityScheme) ProtoReflect 

func (x *SecurityScheme) ProtoReflect() protoreflect.Message

func (*SecurityScheme) Reset 

func (x *SecurityScheme) Reset()

func (*SecurityScheme) ResolveReferences 

func (m *SecurityScheme) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SecurityScheme objects.

func (*SecurityScheme) String 

func (x *SecurityScheme) String() string

func (*SecurityScheme) ToRawInfo 

func (m *SecurityScheme) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SecurityScheme suitable for JSON or YAML export.

type SecuritySchemeOrReference 

type SecuritySchemeOrReference struct {

	// Types that are assignable to Oneof:
	//
	//	*SecuritySchemeOrReference_SecurityScheme
	//	*SecuritySchemeOrReference_Reference
	Oneof isSecuritySchemeOrReference_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

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.

func (*SecuritySchemeOrReference) Descriptor deprecated 

func (*SecuritySchemeOrReference) Descriptor() ([]byte, []int)

Deprecated: Use SecuritySchemeOrReference.ProtoReflect.Descriptor instead.

func (*SecuritySchemeOrReference) GetOneof 

func (m *SecuritySchemeOrReference) GetOneof() isSecuritySchemeOrReference_Oneof

func (*SecuritySchemeOrReference) GetReference 

func (x *SecuritySchemeOrReference) GetReference() *Reference

func (*SecuritySchemeOrReference) GetSecurityScheme 

func (x *SecuritySchemeOrReference) GetSecurityScheme() *SecurityScheme

func (*SecuritySchemeOrReference) ProtoMessage 

func (*SecuritySchemeOrReference) ProtoMessage()

func (*SecuritySchemeOrReference) ProtoReflect 

func (x *SecuritySchemeOrReference) ProtoReflect() protoreflect.Message

func (*SecuritySchemeOrReference) Reset 

func (x *SecuritySchemeOrReference) Reset()

func (*SecuritySchemeOrReference) ResolveReferences 

func (m *SecuritySchemeOrReference) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SecuritySchemeOrReference objects.

func (*SecuritySchemeOrReference) String 

func (x *SecuritySchemeOrReference) String() string

func (*SecuritySchemeOrReference) ToRawInfo 

func (m *SecuritySchemeOrReference) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SecuritySchemeOrReference suitable for JSON or YAML export.

type SecuritySchemeOrReference_Reference 

type SecuritySchemeOrReference_Reference struct {
	Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}

type SecuritySchemeOrReference_SecurityScheme 

type SecuritySchemeOrReference_SecurityScheme struct {
	SecurityScheme *SecurityScheme `protobuf:"bytes,1,opt,name=security_scheme,json=securityScheme,proto3,oneof"`
}

type SecuritySchemesOrReferences 

type SecuritySchemesOrReferences struct {
	AdditionalProperties []*NamedSecuritySchemeOrReference `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SecuritySchemesOrReferences) Descriptor deprecated 

func (*SecuritySchemesOrReferences) Descriptor() ([]byte, []int)

Deprecated: Use SecuritySchemesOrReferences.ProtoReflect.Descriptor instead.

func (*SecuritySchemesOrReferences) GetAdditionalProperties 

func (x *SecuritySchemesOrReferences) GetAdditionalProperties() []*NamedSecuritySchemeOrReference

func (*SecuritySchemesOrReferences) ProtoMessage 

func (*SecuritySchemesOrReferences) ProtoMessage()

func (*SecuritySchemesOrReferences) ProtoReflect 

func (x *SecuritySchemesOrReferences) ProtoReflect() protoreflect.Message

func (*SecuritySchemesOrReferences) Reset 

func (x *SecuritySchemesOrReferences) Reset()

func (*SecuritySchemesOrReferences) ResolveReferences 

func (m *SecuritySchemesOrReferences) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SecuritySchemesOrReferences objects.

func (*SecuritySchemesOrReferences) String 

func (x *SecuritySchemesOrReferences) String() string

func (*SecuritySchemesOrReferences) ToRawInfo 

func (m *SecuritySchemesOrReferences) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SecuritySchemesOrReferences suitable for JSON or YAML export.

type Server 

type Server struct {
	Url                    string           `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	Description            string           `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Variables              *ServerVariables `protobuf:"bytes,3,opt,name=variables,proto3" json:"variables,omitempty"`
	SpecificationExtension []*NamedAny      `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

An object representing a Server.

func NewServer 

func NewServer(in *yaml.Node, context *compiler.Context) (*Server, error)

NewServer creates an object of type Server if possible, returning an error if not.

func (*Server) Descriptor deprecated 

func (*Server) Descriptor() ([]byte, []int)

Deprecated: Use Server.ProtoReflect.Descriptor instead.

func (*Server) GetDescription 

func (x *Server) GetDescription() string

func (*Server) GetSpecificationExtension 

func (x *Server) GetSpecificationExtension() []*NamedAny

func (*Server) GetUrl 

func (x *Server) GetUrl() string

func (*Server) GetVariables 

func (x *Server) GetVariables() *ServerVariables

func (*Server) ProtoMessage 

func (*Server) ProtoMessage()

func (*Server) ProtoReflect 

func (x *Server) ProtoReflect() protoreflect.Message

func (*Server) Reset 

func (x *Server) Reset()

func (*Server) ResolveReferences 

func (m *Server) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Server objects.

func (*Server) String 

func (x *Server) String() string

func (*Server) ToRawInfo 

func (m *Server) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Server suitable for JSON or YAML export.

type ServerVariable 

type ServerVariable struct {
	Enum                   []string    `protobuf:"bytes,1,rep,name=enum,proto3" json:"enum,omitempty"`
	Default                string      `protobuf:"bytes,2,opt,name=default,proto3" json:"default,omitempty"`
	Description            string      `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

An object representing a Server Variable for server URL template substitution.

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.

func (*ServerVariable) Descriptor deprecated 

func (*ServerVariable) Descriptor() ([]byte, []int)

Deprecated: Use ServerVariable.ProtoReflect.Descriptor instead.

func (*ServerVariable) GetDefault 

func (x *ServerVariable) GetDefault() string

func (*ServerVariable) GetDescription 

func (x *ServerVariable) GetDescription() string

func (*ServerVariable) GetEnum 

func (x *ServerVariable) GetEnum() []string

func (*ServerVariable) GetSpecificationExtension 

func (x *ServerVariable) GetSpecificationExtension() []*NamedAny

func (*ServerVariable) ProtoMessage 

func (*ServerVariable) ProtoMessage()

func (*ServerVariable) ProtoReflect 

func (x *ServerVariable) ProtoReflect() protoreflect.Message

func (*ServerVariable) Reset 

func (x *ServerVariable) Reset()

func (*ServerVariable) ResolveReferences 

func (m *ServerVariable) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ServerVariable objects.

func (*ServerVariable) String 

func (x *ServerVariable) String() string

func (*ServerVariable) ToRawInfo 

func (m *ServerVariable) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ServerVariable suitable for JSON or YAML export.

type ServerVariables 

type ServerVariables struct {
	AdditionalProperties []*NamedServerVariable `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*ServerVariables) Descriptor deprecated 

func (*ServerVariables) Descriptor() ([]byte, []int)

Deprecated: Use ServerVariables.ProtoReflect.Descriptor instead.

func (*ServerVariables) GetAdditionalProperties 

func (x *ServerVariables) GetAdditionalProperties() []*NamedServerVariable

func (*ServerVariables) ProtoMessage 

func (*ServerVariables) ProtoMessage()

func (*ServerVariables) ProtoReflect 

func (x *ServerVariables) ProtoReflect() protoreflect.Message

func (*ServerVariables) Reset 

func (x *ServerVariables) Reset()

func (*ServerVariables) ResolveReferences 

func (m *ServerVariables) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside ServerVariables objects.

func (*ServerVariables) String 

func (x *ServerVariables) String() string

func (*ServerVariables) ToRawInfo 

func (m *ServerVariables) ToRawInfo() *yaml.Node

ToRawInfo returns a description of ServerVariables suitable for JSON or YAML export.

type SpecificationExtension 

type SpecificationExtension struct {

	// Types that are assignable to Oneof:
	//
	//	*SpecificationExtension_Number
	//	*SpecificationExtension_Boolean
	//	*SpecificationExtension_String_
	Oneof isSpecificationExtension_Oneof `protobuf_oneof:"oneof"`
	// contains filtered or unexported fields
}

Any property starting with x- is valid.

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.

func (*SpecificationExtension) Descriptor deprecated 

func (*SpecificationExtension) Descriptor() ([]byte, []int)

Deprecated: Use SpecificationExtension.ProtoReflect.Descriptor instead.

func (*SpecificationExtension) GetBoolean 

func (x *SpecificationExtension) GetBoolean() bool

func (*SpecificationExtension) GetNumber 

func (x *SpecificationExtension) GetNumber() float64

func (*SpecificationExtension) GetOneof 

func (m *SpecificationExtension) GetOneof() isSpecificationExtension_Oneof

func (*SpecificationExtension) GetString_ 

func (x *SpecificationExtension) GetString_() string

func (*SpecificationExtension) ProtoMessage 

func (*SpecificationExtension) ProtoMessage()

func (*SpecificationExtension) ProtoReflect 

func (x *SpecificationExtension) ProtoReflect() protoreflect.Message

func (*SpecificationExtension) Reset 

func (x *SpecificationExtension) Reset()

func (*SpecificationExtension) ResolveReferences 

func (m *SpecificationExtension) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside SpecificationExtension objects.

func (*SpecificationExtension) String 

func (x *SpecificationExtension) String() string

func (*SpecificationExtension) ToRawInfo 

func (m *SpecificationExtension) ToRawInfo() *yaml.Node

ToRawInfo returns a description of SpecificationExtension suitable for JSON or YAML export.

type SpecificationExtension_Boolean 

type SpecificationExtension_Boolean struct {
	Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}

type SpecificationExtension_Number 

type SpecificationExtension_Number struct {
	Number float64 `protobuf:"fixed64,1,opt,name=number,proto3,oneof"`
}

type SpecificationExtension_String_ 

type SpecificationExtension_String_ struct {
	String_ string `protobuf:"bytes,3,opt,name=string,proto3,oneof"`
}

type StringArray 

type StringArray struct {
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*StringArray) Descriptor deprecated 

func (*StringArray) Descriptor() ([]byte, []int)

Deprecated: Use StringArray.ProtoReflect.Descriptor instead.

func (*StringArray) GetValue 

func (x *StringArray) GetValue() []string

func (*StringArray) ProtoMessage 

func (*StringArray) ProtoMessage()

func (*StringArray) ProtoReflect 

func (x *StringArray) ProtoReflect() protoreflect.Message

func (*StringArray) Reset 

func (x *StringArray) Reset()

func (*StringArray) ResolveReferences 

func (m *StringArray) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside StringArray objects.

func (*StringArray) String 

func (x *StringArray) String() string

func (*StringArray) ToRawInfo 

func (m *StringArray) ToRawInfo() *yaml.Node

ToRawInfo returns a description of StringArray suitable for JSON or YAML export.

type Strings 

type Strings struct {
	AdditionalProperties []*NamedString `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// contains filtered or unexported fields
}

func NewStrings 

func NewStrings(in *yaml.Node, context *compiler.Context) (*Strings, error)

NewStrings creates an object of type Strings if possible, returning an error if not.

func (*Strings) Descriptor deprecated 

func (*Strings) Descriptor() ([]byte, []int)

Deprecated: Use Strings.ProtoReflect.Descriptor instead.

func (*Strings) GetAdditionalProperties 

func (x *Strings) GetAdditionalProperties() []*NamedString

func (*Strings) ProtoMessage 

func (*Strings) ProtoMessage()

func (*Strings) ProtoReflect 

func (x *Strings) ProtoReflect() protoreflect.Message

func (*Strings) Reset 

func (x *Strings) Reset()

func (*Strings) ResolveReferences 

func (m *Strings) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Strings objects.

func (*Strings) String 

func (x *Strings) String() string

func (*Strings) ToRawInfo 

func (m *Strings) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Strings suitable for JSON or YAML export.

type Tag 

type Tag struct {
	Name                   string        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description            string        `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	ExternalDocs           *ExternalDocs `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	SpecificationExtension []*NamedAny   `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.

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.

func (*Tag) Descriptor deprecated 

func (*Tag) Descriptor() ([]byte, []int)

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetDescription 

func (x *Tag) GetDescription() string

func (*Tag) GetExternalDocs 

func (x *Tag) GetExternalDocs() *ExternalDocs

func (*Tag) GetName 

func (x *Tag) GetName() string

func (*Tag) GetSpecificationExtension 

func (x *Tag) GetSpecificationExtension() []*NamedAny

func (*Tag) ProtoMessage 

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect 

func (x *Tag) ProtoReflect() protoreflect.Message

func (*Tag) Reset 

func (x *Tag) Reset()

func (*Tag) ResolveReferences 

func (m *Tag) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Tag objects.

func (*Tag) String 

func (x *Tag) String() string

func (*Tag) ToRawInfo 

func (m *Tag) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Tag suitable for JSON or YAML export.

type Xml 

type Xml struct {
	Name                   string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Namespace              string      `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	Prefix                 string      `protobuf:"bytes,3,opt,name=prefix,proto3" json:"prefix,omitempty"`
	Attribute              bool        `protobuf:"varint,4,opt,name=attribute,proto3" json:"attribute,omitempty"`
	Wrapped                bool        `protobuf:"varint,5,opt,name=wrapped,proto3" json:"wrapped,omitempty"`
	SpecificationExtension []*NamedAny `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior.

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.

func (*Xml) Descriptor deprecated 

func (*Xml) Descriptor() ([]byte, []int)

Deprecated: Use Xml.ProtoReflect.Descriptor instead.

func (*Xml) GetAttribute 

func (x *Xml) GetAttribute() bool

func (*Xml) GetName 

func (x *Xml) GetName() string

func (*Xml) GetNamespace 

func (x *Xml) GetNamespace() string

func (*Xml) GetPrefix 

func (x *Xml) GetPrefix() string

func (*Xml) GetSpecificationExtension 

func (x *Xml) GetSpecificationExtension() []*NamedAny

func (*Xml) GetWrapped 

func (x *Xml) GetWrapped() bool

func (*Xml) ProtoMessage 

func (*Xml) ProtoMessage()

func (*Xml) ProtoReflect 

func (x *Xml) ProtoReflect() protoreflect.Message

func (*Xml) Reset 

func (x *Xml) Reset()

func (*Xml) ResolveReferences 

func (m *Xml) ResolveReferences(root string) (*yaml.Node, error)

ResolveReferences resolves references found inside Xml objects.

func (*Xml) String 

func (x *Xml) String() string

func (*Xml) ToRawInfo 

func (m *Xml) ToRawInfo() *yaml.Node

ToRawInfo returns a description of Xml suitable for JSON or YAML export.

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.