Extension fields to descriptorpb.FileOptions.
var (
// optional openapi.v3.Document document = 1143;
E_Document = &file_openapiv3_annotations_proto_extTypes[0]
)
Extension fields to descriptorpb.MethodOptions.
var (
// optional openapi.v3.Operation operation = 1143;
E_Operation = &file_openapiv3_annotations_proto_extTypes[1]
)
Extension fields to descriptorpb.FieldOptions.
var (
// optional openapi.v3.Schema property = 1143;
E_Property = &file_openapiv3_annotations_proto_extTypes[3]
)
Extension fields to descriptorpb.MessageOptions.
var (
// optional openapi.v3.Schema schema = 1143;
E_Schema = &file_openapiv3_annotations_proto_extTypes[2]
)
var File_openapiv3_OpenAPIv3_proto protoreflect.FileDescriptor
var File_openapiv3_annotations_proto protoreflect.FileDescriptor
func Version() string
Version returns the package name (and OpenAPI version).
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(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() ([]byte, []int)
Deprecated: Use AdditionalPropertiesItem.ProtoReflect.Descriptor instead.
func (x *AdditionalPropertiesItem) GetBoolean() bool
func (m *AdditionalPropertiesItem) GetOneof() isAdditionalPropertiesItem_Oneof
func (x *AdditionalPropertiesItem) GetSchemaOrReference() *SchemaOrReference
func (*AdditionalPropertiesItem) ProtoMessage()
func (x *AdditionalPropertiesItem) ProtoReflect() protoreflect.Message
func (x *AdditionalPropertiesItem) Reset()
func (m *AdditionalPropertiesItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside AdditionalPropertiesItem objects.
func (x *AdditionalPropertiesItem) String() string
func (m *AdditionalPropertiesItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of AdditionalPropertiesItem suitable for JSON or YAML export.
type AdditionalPropertiesItem_Boolean struct {
Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}
type AdditionalPropertiesItem_SchemaOrReference struct {
SchemaOrReference *SchemaOrReference `protobuf:"bytes,1,opt,name=schema_or_reference,json=schemaOrReference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use Any.ProtoReflect.Descriptor instead.
func (x *Any) GetValue() *anypb.Any
func (x *Any) GetYaml() string
func (*Any) ProtoMessage()
func (x *Any) ProtoReflect() protoreflect.Message
func (x *Any) Reset()
func (m *Any) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Any objects.
func (x *Any) String() string
func (m *Any) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Any suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use AnyOrExpression.ProtoReflect.Descriptor instead.
func (x *AnyOrExpression) GetAny() *Any
func (x *AnyOrExpression) GetExpression() *Expression
func (m *AnyOrExpression) GetOneof() isAnyOrExpression_Oneof
func (*AnyOrExpression) ProtoMessage()
func (x *AnyOrExpression) ProtoReflect() protoreflect.Message
func (x *AnyOrExpression) Reset()
func (m *AnyOrExpression) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside AnyOrExpression objects.
func (x *AnyOrExpression) String() string
func (m *AnyOrExpression) ToRawInfo() *yaml.Node
ToRawInfo returns a description of AnyOrExpression suitable for JSON or YAML export.
type AnyOrExpression_Any struct {
Any *Any `protobuf:"bytes,1,opt,name=any,proto3,oneof"`
}
type AnyOrExpression_Expression struct {
Expression *Expression `protobuf:"bytes,2,opt,name=expression,proto3,oneof"`
}
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.
type Callback struct {
Path []*NamedPathItem `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"`
SpecificationExtension []*NamedAny `protobuf:"bytes,2,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Callback.ProtoReflect.Descriptor instead.
func (x *Callback) GetPath() []*NamedPathItem
func (x *Callback) GetSpecificationExtension() []*NamedAny
func (*Callback) ProtoMessage()
func (x *Callback) ProtoReflect() protoreflect.Message
func (x *Callback) Reset()
func (m *Callback) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Callback objects.
func (x *Callback) String() string
func (m *Callback) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Callback suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use CallbackOrReference.ProtoReflect.Descriptor instead.
func (x *CallbackOrReference) GetCallback() *Callback
func (m *CallbackOrReference) GetOneof() isCallbackOrReference_Oneof
func (x *CallbackOrReference) GetReference() *Reference
func (*CallbackOrReference) ProtoMessage()
func (x *CallbackOrReference) ProtoReflect() protoreflect.Message
func (x *CallbackOrReference) Reset()
func (m *CallbackOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside CallbackOrReference objects.
func (x *CallbackOrReference) String() string
func (m *CallbackOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of CallbackOrReference suitable for JSON or YAML export.
type CallbackOrReference_Callback struct {
Callback *Callback `protobuf:"bytes,1,opt,name=callback,proto3,oneof"`
}
type CallbackOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use CallbacksOrReferences.ProtoReflect.Descriptor instead.
func (x *CallbacksOrReferences) GetAdditionalProperties() []*NamedCallbackOrReference
func (*CallbacksOrReferences) ProtoMessage()
func (x *CallbacksOrReferences) ProtoReflect() protoreflect.Message
func (x *CallbacksOrReferences) Reset()
func (m *CallbacksOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside CallbacksOrReferences objects.
func (x *CallbacksOrReferences) String() string
func (m *CallbacksOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of CallbacksOrReferences suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,10,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Components.ProtoReflect.Descriptor instead.
func (x *Components) GetCallbacks() *CallbacksOrReferences
func (x *Components) GetExamples() *ExamplesOrReferences
func (x *Components) GetHeaders() *HeadersOrReferences
func (x *Components) GetLinks() *LinksOrReferences
func (x *Components) GetParameters() *ParametersOrReferences
func (x *Components) GetRequestBodies() *RequestBodiesOrReferences
func (x *Components) GetResponses() *ResponsesOrReferences
func (x *Components) GetSchemas() *SchemasOrReferences
func (x *Components) GetSecuritySchemes() *SecuritySchemesOrReferences
func (x *Components) GetSpecificationExtension() []*NamedAny
func (*Components) ProtoMessage()
func (x *Components) ProtoReflect() protoreflect.Message
func (x *Components) Reset()
func (m *Components) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Components objects.
func (x *Components) String() string
func (m *Components) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Components suitable for JSON or YAML export.
Contact information for the exposed API.
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 `protobuf:"bytes,4,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Contact.ProtoReflect.Descriptor instead.
func (x *Contact) GetEmail() string
func (x *Contact) GetName() string
func (x *Contact) GetSpecificationExtension() []*NamedAny
func (x *Contact) GetUrl() string
func (*Contact) ProtoMessage()
func (x *Contact) ProtoReflect() protoreflect.Message
func (x *Contact) Reset()
func (m *Contact) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Contact objects.
func (x *Contact) String() string
func (m *Contact) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Contact suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use DefaultType.ProtoReflect.Descriptor instead.
func (x *DefaultType) GetBoolean() bool
func (x *DefaultType) GetNumber() float64
func (m *DefaultType) GetOneof() isDefaultType_Oneof
func (x *DefaultType) GetString_() string
func (*DefaultType) ProtoMessage()
func (x *DefaultType) ProtoReflect() protoreflect.Message
func (x *DefaultType) Reset()
func (m *DefaultType) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside DefaultType objects.
func (x *DefaultType) String() string
func (m *DefaultType) ToRawInfo() *yaml.Node
ToRawInfo returns a description of DefaultType suitable for JSON or YAML export.
type DefaultType_Boolean struct {
Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}
type DefaultType_Number struct {
Number float64 `protobuf:"fixed64,1,opt,name=number,proto3,oneof"`
}
type DefaultType_String_ struct {
String_ string `protobuf:"bytes,3,opt,name=string,proto3,oneof"`
}
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.
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 `protobuf:"bytes,3,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Discriminator.ProtoReflect.Descriptor instead.
func (x *Discriminator) GetMapping() *Strings
func (x *Discriminator) GetPropertyName() string
func (x *Discriminator) GetSpecificationExtension() []*NamedAny
func (*Discriminator) ProtoMessage()
func (x *Discriminator) ProtoReflect() protoreflect.Message
func (x *Discriminator) Reset()
func (m *Discriminator) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Discriminator objects.
func (x *Discriminator) String() string
func (m *Discriminator) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Discriminator suitable for JSON or YAML export.
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 `protobuf:"bytes,9,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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(b []byte) (*Document, error)
ParseDocument reads an OpenAPI v3 description from a YAML/JSON representation.
func (*Document) Descriptor() ([]byte, []int)
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (x *Document) GetComponents() *Components
func (x *Document) GetExternalDocs() *ExternalDocs
func (x *Document) GetInfo() *Info
func (x *Document) GetOpenapi() string
func (x *Document) GetPaths() *Paths
func (x *Document) GetSecurity() []*SecurityRequirement
func (x *Document) GetServers() []*Server
func (x *Document) GetSpecificationExtension() []*NamedAny
func (x *Document) GetTags() []*Tag
func (*Document) ProtoMessage()
func (x *Document) ProtoReflect() protoreflect.Message
func (x *Document) Reset()
func (m *Document) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Document objects.
func (x *Document) String() string
func (m *Document) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Document suitable for JSON or YAML export.
func (d *Document) YAMLValue(comment string) ([]byte, error)
YAMLValue produces a serialized YAML representation of the document.
A single encoding definition applied to a single schema property.
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 `protobuf:"bytes,6,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Encoding.ProtoReflect.Descriptor instead.
func (x *Encoding) GetAllowReserved() bool
func (x *Encoding) GetContentType() string
func (x *Encoding) GetExplode() bool
func (x *Encoding) GetHeaders() *HeadersOrReferences
func (x *Encoding) GetSpecificationExtension() []*NamedAny
func (x *Encoding) GetStyle() string
func (*Encoding) ProtoMessage()
func (x *Encoding) ProtoReflect() protoreflect.Message
func (x *Encoding) Reset()
func (m *Encoding) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Encoding objects.
func (x *Encoding) String() string
func (m *Encoding) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Encoding suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use Encodings.ProtoReflect.Descriptor instead.
func (x *Encodings) GetAdditionalProperties() []*NamedEncoding
func (*Encodings) ProtoMessage()
func (x *Encodings) ProtoReflect() protoreflect.Message
func (x *Encodings) Reset()
func (m *Encodings) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Encodings objects.
func (x *Encodings) String() string
func (m *Encodings) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Encodings suitable for JSON or YAML export.
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 `protobuf:"bytes,5,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Example.ProtoReflect.Descriptor instead.
func (x *Example) GetDescription() string
func (x *Example) GetExternalValue() string
func (x *Example) GetSpecificationExtension() []*NamedAny
func (x *Example) GetSummary() string
func (x *Example) GetValue() *Any
func (*Example) ProtoMessage()
func (x *Example) ProtoReflect() protoreflect.Message
func (x *Example) Reset()
func (m *Example) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Example objects.
func (x *Example) String() string
func (m *Example) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Example suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ExampleOrReference.ProtoReflect.Descriptor instead.
func (x *ExampleOrReference) GetExample() *Example
func (m *ExampleOrReference) GetOneof() isExampleOrReference_Oneof
func (x *ExampleOrReference) GetReference() *Reference
func (*ExampleOrReference) ProtoMessage()
func (x *ExampleOrReference) ProtoReflect() protoreflect.Message
func (x *ExampleOrReference) Reset()
func (m *ExampleOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ExampleOrReference objects.
func (x *ExampleOrReference) String() string
func (m *ExampleOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ExampleOrReference suitable for JSON or YAML export.
type ExampleOrReference_Example struct {
Example *Example `protobuf:"bytes,1,opt,name=example,proto3,oneof"`
}
type ExampleOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use ExamplesOrReferences.ProtoReflect.Descriptor instead.
func (x *ExamplesOrReferences) GetAdditionalProperties() []*NamedExampleOrReference
func (*ExamplesOrReferences) ProtoMessage()
func (x *ExamplesOrReferences) ProtoReflect() protoreflect.Message
func (x *ExamplesOrReferences) Reset()
func (m *ExamplesOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ExamplesOrReferences objects.
func (x *ExamplesOrReferences) String() string
func (m *ExamplesOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ExamplesOrReferences suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use Expression.ProtoReflect.Descriptor instead.
func (x *Expression) GetAdditionalProperties() []*NamedAny
func (*Expression) ProtoMessage()
func (x *Expression) ProtoReflect() protoreflect.Message
func (x *Expression) Reset()
func (m *Expression) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Expression objects.
func (x *Expression) String() string
func (m *Expression) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Expression suitable for JSON or YAML export.
Allows referencing an external resource for extended documentation.
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 `protobuf:"bytes,3,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use ExternalDocs.ProtoReflect.Descriptor instead.
func (x *ExternalDocs) GetDescription() string
func (x *ExternalDocs) GetSpecificationExtension() []*NamedAny
func (x *ExternalDocs) GetUrl() string
func (*ExternalDocs) ProtoMessage()
func (x *ExternalDocs) ProtoReflect() protoreflect.Message
func (x *ExternalDocs) Reset()
func (m *ExternalDocs) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ExternalDocs objects.
func (x *ExternalDocs) String() string
func (m *ExternalDocs) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ExternalDocs suitable for JSON or YAML export.
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`).
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 `protobuf:"bytes,12,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Header.ProtoReflect.Descriptor instead.
func (x *Header) GetAllowEmptyValue() bool
func (x *Header) GetAllowReserved() bool
func (x *Header) GetContent() *MediaTypes
func (x *Header) GetDeprecated() bool
func (x *Header) GetDescription() string
func (x *Header) GetExample() *Any
func (x *Header) GetExamples() *ExamplesOrReferences
func (x *Header) GetExplode() bool
func (x *Header) GetRequired() bool
func (x *Header) GetSchema() *SchemaOrReference
func (x *Header) GetSpecificationExtension() []*NamedAny
func (x *Header) GetStyle() string
func (*Header) ProtoMessage()
func (x *Header) ProtoReflect() protoreflect.Message
func (x *Header) Reset()
func (m *Header) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Header objects.
func (x *Header) String() string
func (m *Header) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Header suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use HeaderOrReference.ProtoReflect.Descriptor instead.
func (x *HeaderOrReference) GetHeader() *Header
func (m *HeaderOrReference) GetOneof() isHeaderOrReference_Oneof
func (x *HeaderOrReference) GetReference() *Reference
func (*HeaderOrReference) ProtoMessage()
func (x *HeaderOrReference) ProtoReflect() protoreflect.Message
func (x *HeaderOrReference) Reset()
func (m *HeaderOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside HeaderOrReference objects.
func (x *HeaderOrReference) String() string
func (m *HeaderOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of HeaderOrReference suitable for JSON or YAML export.
type HeaderOrReference_Header struct {
Header *Header `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}
type HeaderOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use HeadersOrReferences.ProtoReflect.Descriptor instead.
func (x *HeadersOrReferences) GetAdditionalProperties() []*NamedHeaderOrReference
func (*HeadersOrReferences) ProtoMessage()
func (x *HeadersOrReferences) ProtoReflect() protoreflect.Message
func (x *HeadersOrReferences) Reset()
func (m *HeadersOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside HeadersOrReferences objects.
func (x *HeadersOrReferences) String() string
func (m *HeadersOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of HeadersOrReferences suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,7,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
Summary string `protobuf:"bytes,8,opt,name=summary,proto3" json:"summary,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Info.ProtoReflect.Descriptor instead.
func (x *Info) GetContact() *Contact
func (x *Info) GetDescription() string
func (x *Info) GetLicense() *License
func (x *Info) GetSpecificationExtension() []*NamedAny
func (x *Info) GetSummary() string
func (x *Info) GetTermsOfService() string
func (x *Info) GetTitle() string
func (x *Info) GetVersion() string
func (*Info) ProtoMessage()
func (x *Info) ProtoReflect() protoreflect.Message
func (x *Info) Reset()
func (m *Info) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Info objects.
func (x *Info) String() string
func (m *Info) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Info suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ItemsItem.ProtoReflect.Descriptor instead.
func (x *ItemsItem) GetSchemaOrReference() []*SchemaOrReference
func (*ItemsItem) ProtoMessage()
func (x *ItemsItem) ProtoReflect() protoreflect.Message
func (x *ItemsItem) Reset()
func (m *ItemsItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ItemsItem objects.
func (x *ItemsItem) String() string
func (m *ItemsItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ItemsItem suitable for JSON or YAML export.
License information for the exposed API.
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 `protobuf:"bytes,3,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use License.ProtoReflect.Descriptor instead.
func (x *License) GetName() string
func (x *License) GetSpecificationExtension() []*NamedAny
func (x *License) GetUrl() string
func (*License) ProtoMessage()
func (x *License) ProtoReflect() protoreflect.Message
func (x *License) Reset()
func (m *License) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside License objects.
func (x *License) String() string
func (m *License) ToRawInfo() *yaml.Node
ToRawInfo returns a description of License suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,7,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Link.ProtoReflect.Descriptor instead.
func (x *Link) GetDescription() string
func (x *Link) GetOperationId() string
func (x *Link) GetOperationRef() string
func (x *Link) GetParameters() *AnyOrExpression
func (x *Link) GetRequestBody() *AnyOrExpression
func (x *Link) GetServer() *Server
func (x *Link) GetSpecificationExtension() []*NamedAny
func (*Link) ProtoMessage()
func (x *Link) ProtoReflect() protoreflect.Message
func (x *Link) Reset()
func (m *Link) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Link objects.
func (x *Link) String() string
func (m *Link) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Link suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use LinkOrReference.ProtoReflect.Descriptor instead.
func (x *LinkOrReference) GetLink() *Link
func (m *LinkOrReference) GetOneof() isLinkOrReference_Oneof
func (x *LinkOrReference) GetReference() *Reference
func (*LinkOrReference) ProtoMessage()
func (x *LinkOrReference) ProtoReflect() protoreflect.Message
func (x *LinkOrReference) Reset()
func (m *LinkOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside LinkOrReference objects.
func (x *LinkOrReference) String() string
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 struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use LinksOrReferences.ProtoReflect.Descriptor instead.
func (x *LinksOrReferences) GetAdditionalProperties() []*NamedLinkOrReference
func (*LinksOrReferences) ProtoMessage()
func (x *LinksOrReferences) ProtoReflect() protoreflect.Message
func (x *LinksOrReferences) Reset()
func (m *LinksOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside LinksOrReferences objects.
func (x *LinksOrReferences) String() string
func (m *LinksOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of LinksOrReferences suitable for JSON or YAML export.
Each Media Type Object provides schema and examples for the media type identified by its key.
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 `protobuf:"bytes,5,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use MediaType.ProtoReflect.Descriptor instead.
func (x *MediaType) GetEncoding() *Encodings
func (x *MediaType) GetExample() *Any
func (x *MediaType) GetExamples() *ExamplesOrReferences
func (x *MediaType) GetSchema() *SchemaOrReference
func (x *MediaType) GetSpecificationExtension() []*NamedAny
func (*MediaType) ProtoMessage()
func (x *MediaType) ProtoReflect() protoreflect.Message
func (x *MediaType) Reset()
func (m *MediaType) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside MediaType objects.
func (x *MediaType) String() string
func (m *MediaType) ToRawInfo() *yaml.Node
ToRawInfo returns a description of MediaType suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use MediaTypes.ProtoReflect.Descriptor instead.
func (x *MediaTypes) GetAdditionalProperties() []*NamedMediaType
func (*MediaTypes) ProtoMessage()
func (x *MediaTypes) ProtoReflect() protoreflect.Message
func (x *MediaTypes) Reset()
func (m *MediaTypes) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside MediaTypes objects.
func (x *MediaTypes) String() string
func (m *MediaTypes) ToRawInfo() *yaml.Node
ToRawInfo returns a description of MediaTypes suitable for JSON or YAML export.
Automatically-generated message used to represent maps of Any as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedAny.ProtoReflect.Descriptor instead.
func (x *NamedAny) GetName() string
func (x *NamedAny) GetValue() *Any
func (*NamedAny) ProtoMessage()
func (x *NamedAny) ProtoReflect() protoreflect.Message
func (x *NamedAny) Reset()
func (m *NamedAny) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedAny objects.
func (x *NamedAny) String() string
func (m *NamedAny) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedAny suitable for JSON or YAML export.
Automatically-generated message used to represent maps of CallbackOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedCallbackOrReference.ProtoReflect.Descriptor instead.
func (x *NamedCallbackOrReference) GetName() string
func (x *NamedCallbackOrReference) GetValue() *CallbackOrReference
func (*NamedCallbackOrReference) ProtoMessage()
func (x *NamedCallbackOrReference) ProtoReflect() protoreflect.Message
func (x *NamedCallbackOrReference) Reset()
func (m *NamedCallbackOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedCallbackOrReference objects.
func (x *NamedCallbackOrReference) String() string
func (m *NamedCallbackOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedCallbackOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of Encoding as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedEncoding.ProtoReflect.Descriptor instead.
func (x *NamedEncoding) GetName() string
func (x *NamedEncoding) GetValue() *Encoding
func (*NamedEncoding) ProtoMessage()
func (x *NamedEncoding) ProtoReflect() protoreflect.Message
func (x *NamedEncoding) Reset()
func (m *NamedEncoding) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedEncoding objects.
func (x *NamedEncoding) String() string
func (m *NamedEncoding) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedEncoding suitable for JSON or YAML export.
Automatically-generated message used to represent maps of ExampleOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedExampleOrReference.ProtoReflect.Descriptor instead.
func (x *NamedExampleOrReference) GetName() string
func (x *NamedExampleOrReference) GetValue() *ExampleOrReference
func (*NamedExampleOrReference) ProtoMessage()
func (x *NamedExampleOrReference) ProtoReflect() protoreflect.Message
func (x *NamedExampleOrReference) Reset()
func (m *NamedExampleOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedExampleOrReference objects.
func (x *NamedExampleOrReference) String() string
func (m *NamedExampleOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedExampleOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of HeaderOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedHeaderOrReference.ProtoReflect.Descriptor instead.
func (x *NamedHeaderOrReference) GetName() string
func (x *NamedHeaderOrReference) GetValue() *HeaderOrReference
func (*NamedHeaderOrReference) ProtoMessage()
func (x *NamedHeaderOrReference) ProtoReflect() protoreflect.Message
func (x *NamedHeaderOrReference) Reset()
func (m *NamedHeaderOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedHeaderOrReference objects.
func (x *NamedHeaderOrReference) String() string
func (m *NamedHeaderOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedHeaderOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of LinkOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedLinkOrReference.ProtoReflect.Descriptor instead.
func (x *NamedLinkOrReference) GetName() string
func (x *NamedLinkOrReference) GetValue() *LinkOrReference
func (*NamedLinkOrReference) ProtoMessage()
func (x *NamedLinkOrReference) ProtoReflect() protoreflect.Message
func (x *NamedLinkOrReference) Reset()
func (m *NamedLinkOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedLinkOrReference objects.
func (x *NamedLinkOrReference) String() string
func (m *NamedLinkOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedLinkOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of MediaType as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedMediaType.ProtoReflect.Descriptor instead.
func (x *NamedMediaType) GetName() string
func (x *NamedMediaType) GetValue() *MediaType
func (*NamedMediaType) ProtoMessage()
func (x *NamedMediaType) ProtoReflect() protoreflect.Message
func (x *NamedMediaType) Reset()
func (m *NamedMediaType) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedMediaType objects.
func (x *NamedMediaType) String() string
func (m *NamedMediaType) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedMediaType suitable for JSON or YAML export.
Automatically-generated message used to represent maps of ParameterOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedParameterOrReference.ProtoReflect.Descriptor instead.
func (x *NamedParameterOrReference) GetName() string
func (x *NamedParameterOrReference) GetValue() *ParameterOrReference
func (*NamedParameterOrReference) ProtoMessage()
func (x *NamedParameterOrReference) ProtoReflect() protoreflect.Message
func (x *NamedParameterOrReference) Reset()
func (m *NamedParameterOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedParameterOrReference objects.
func (x *NamedParameterOrReference) String() string
func (m *NamedParameterOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedParameterOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of PathItem as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedPathItem.ProtoReflect.Descriptor instead.
func (x *NamedPathItem) GetName() string
func (x *NamedPathItem) GetValue() *PathItem
func (*NamedPathItem) ProtoMessage()
func (x *NamedPathItem) ProtoReflect() protoreflect.Message
func (x *NamedPathItem) Reset()
func (m *NamedPathItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedPathItem objects.
func (x *NamedPathItem) String() string
func (m *NamedPathItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedPathItem suitable for JSON or YAML export.
Automatically-generated message used to represent maps of RequestBodyOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedRequestBodyOrReference.ProtoReflect.Descriptor instead.
func (x *NamedRequestBodyOrReference) GetName() string
func (x *NamedRequestBodyOrReference) GetValue() *RequestBodyOrReference
func (*NamedRequestBodyOrReference) ProtoMessage()
func (x *NamedRequestBodyOrReference) ProtoReflect() protoreflect.Message
func (x *NamedRequestBodyOrReference) Reset()
func (m *NamedRequestBodyOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedRequestBodyOrReference objects.
func (x *NamedRequestBodyOrReference) String() string
func (m *NamedRequestBodyOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedRequestBodyOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of ResponseOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedResponseOrReference.ProtoReflect.Descriptor instead.
func (x *NamedResponseOrReference) GetName() string
func (x *NamedResponseOrReference) GetValue() *ResponseOrReference
func (*NamedResponseOrReference) ProtoMessage()
func (x *NamedResponseOrReference) ProtoReflect() protoreflect.Message
func (x *NamedResponseOrReference) Reset()
func (m *NamedResponseOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedResponseOrReference objects.
func (x *NamedResponseOrReference) String() string
func (m *NamedResponseOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedResponseOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of SchemaOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedSchemaOrReference.ProtoReflect.Descriptor instead.
func (x *NamedSchemaOrReference) GetName() string
func (x *NamedSchemaOrReference) GetValue() *SchemaOrReference
func (*NamedSchemaOrReference) ProtoMessage()
func (x *NamedSchemaOrReference) ProtoReflect() protoreflect.Message
func (x *NamedSchemaOrReference) Reset()
func (m *NamedSchemaOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedSchemaOrReference objects.
func (x *NamedSchemaOrReference) String() string
func (m *NamedSchemaOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedSchemaOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of SecuritySchemeOrReference as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedSecuritySchemeOrReference.ProtoReflect.Descriptor instead.
func (x *NamedSecuritySchemeOrReference) GetName() string
func (x *NamedSecuritySchemeOrReference) GetValue() *SecuritySchemeOrReference
func (*NamedSecuritySchemeOrReference) ProtoMessage()
func (x *NamedSecuritySchemeOrReference) ProtoReflect() protoreflect.Message
func (x *NamedSecuritySchemeOrReference) Reset()
func (m *NamedSecuritySchemeOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedSecuritySchemeOrReference objects.
func (x *NamedSecuritySchemeOrReference) String() string
func (m *NamedSecuritySchemeOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedSecuritySchemeOrReference suitable for JSON or YAML export.
Automatically-generated message used to represent maps of ServerVariable as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedServerVariable.ProtoReflect.Descriptor instead.
func (x *NamedServerVariable) GetName() string
func (x *NamedServerVariable) GetValue() *ServerVariable
func (*NamedServerVariable) ProtoMessage()
func (x *NamedServerVariable) ProtoReflect() protoreflect.Message
func (x *NamedServerVariable) Reset()
func (m *NamedServerVariable) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedServerVariable objects.
func (x *NamedServerVariable) String() string
func (m *NamedServerVariable) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedServerVariable suitable for JSON or YAML export.
Automatically-generated message used to represent maps of string as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedString.ProtoReflect.Descriptor instead.
func (x *NamedString) GetName() string
func (x *NamedString) GetValue() string
func (*NamedString) ProtoMessage()
func (x *NamedString) ProtoReflect() protoreflect.Message
func (x *NamedString) Reset()
func (m *NamedString) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedString objects.
func (x *NamedString) String() string
func (m *NamedString) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedString suitable for JSON or YAML export.
Automatically-generated message used to represent maps of StringArray as ordered (name,value) pairs.
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
}
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() ([]byte, []int)
Deprecated: Use NamedStringArray.ProtoReflect.Descriptor instead.
func (x *NamedStringArray) GetName() string
func (x *NamedStringArray) GetValue() *StringArray
func (*NamedStringArray) ProtoMessage()
func (x *NamedStringArray) ProtoReflect() protoreflect.Message
func (x *NamedStringArray) Reset()
func (m *NamedStringArray) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedStringArray objects.
func (x *NamedStringArray) String() string
func (m *NamedStringArray) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedStringArray suitable for JSON or YAML export.
Configuration details for a supported OAuth Flow
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 `protobuf:"bytes,5,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use OauthFlow.ProtoReflect.Descriptor instead.
func (x *OauthFlow) GetAuthorizationUrl() string
func (x *OauthFlow) GetRefreshUrl() string
func (x *OauthFlow) GetScopes() *Strings
func (x *OauthFlow) GetSpecificationExtension() []*NamedAny
func (x *OauthFlow) GetTokenUrl() string
func (*OauthFlow) ProtoMessage()
func (x *OauthFlow) ProtoReflect() protoreflect.Message
func (x *OauthFlow) Reset()
func (m *OauthFlow) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside OauthFlow objects.
func (x *OauthFlow) String() string
func (m *OauthFlow) ToRawInfo() *yaml.Node
ToRawInfo returns a description of OauthFlow suitable for JSON or YAML export.
Allows configuration of the supported OAuth Flows.
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 `protobuf:"bytes,5,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use OauthFlows.ProtoReflect.Descriptor instead.
func (x *OauthFlows) GetAuthorizationCode() *OauthFlow
func (x *OauthFlows) GetClientCredentials() *OauthFlow
func (x *OauthFlows) GetImplicit() *OauthFlow
func (x *OauthFlows) GetPassword() *OauthFlow
func (x *OauthFlows) GetSpecificationExtension() []*NamedAny
func (*OauthFlows) ProtoMessage()
func (x *OauthFlows) ProtoReflect() protoreflect.Message
func (x *OauthFlows) Reset()
func (m *OauthFlows) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside OauthFlows objects.
func (x *OauthFlows) String() string
func (m *OauthFlows) ToRawInfo() *yaml.Node
ToRawInfo returns a description of OauthFlows suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use Object.ProtoReflect.Descriptor instead.
func (x *Object) GetAdditionalProperties() []*NamedAny
func (*Object) ProtoMessage()
func (x *Object) ProtoReflect() protoreflect.Message
func (x *Object) Reset()
func (m *Object) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Object objects.
func (x *Object) String() string
func (m *Object) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Object suitable for JSON or YAML export.
Describes a single API operation on a path.
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 `protobuf:"bytes,13,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Operation.ProtoReflect.Descriptor instead.
func (x *Operation) GetCallbacks() *CallbacksOrReferences
func (x *Operation) GetDeprecated() bool
func (x *Operation) GetDescription() string
func (x *Operation) GetExternalDocs() *ExternalDocs
func (x *Operation) GetOperationId() string
func (x *Operation) GetParameters() []*ParameterOrReference
func (x *Operation) GetRequestBody() *RequestBodyOrReference
func (x *Operation) GetResponses() *Responses
func (x *Operation) GetSecurity() []*SecurityRequirement
func (x *Operation) GetServers() []*Server
func (x *Operation) GetSpecificationExtension() []*NamedAny
func (x *Operation) GetSummary() string
func (x *Operation) GetTags() []string
func (*Operation) ProtoMessage()
func (x *Operation) ProtoReflect() protoreflect.Message
func (x *Operation) Reset()
func (m *Operation) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Operation objects.
func (x *Operation) String() string
func (m *Operation) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Operation suitable for JSON or YAML export.
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
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 `protobuf:"bytes,14,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Parameter.ProtoReflect.Descriptor instead.
func (x *Parameter) GetAllowEmptyValue() bool
func (x *Parameter) GetAllowReserved() bool
func (x *Parameter) GetContent() *MediaTypes
func (x *Parameter) GetDeprecated() bool
func (x *Parameter) GetDescription() string
func (x *Parameter) GetExample() *Any
func (x *Parameter) GetExamples() *ExamplesOrReferences
func (x *Parameter) GetExplode() bool
func (x *Parameter) GetIn() string
func (x *Parameter) GetName() string
func (x *Parameter) GetRequired() bool
func (x *Parameter) GetSchema() *SchemaOrReference
func (x *Parameter) GetSpecificationExtension() []*NamedAny
func (x *Parameter) GetStyle() string
func (*Parameter) ProtoMessage()
func (x *Parameter) ProtoReflect() protoreflect.Message
func (x *Parameter) Reset()
func (m *Parameter) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Parameter objects.
func (x *Parameter) String() string
func (m *Parameter) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Parameter suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ParameterOrReference.ProtoReflect.Descriptor instead.
func (m *ParameterOrReference) GetOneof() isParameterOrReference_Oneof
func (x *ParameterOrReference) GetParameter() *Parameter
func (x *ParameterOrReference) GetReference() *Reference
func (*ParameterOrReference) ProtoMessage()
func (x *ParameterOrReference) ProtoReflect() protoreflect.Message
func (x *ParameterOrReference) Reset()
func (m *ParameterOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ParameterOrReference objects.
func (x *ParameterOrReference) String() string
func (m *ParameterOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ParameterOrReference suitable for JSON or YAML export.
type ParameterOrReference_Parameter struct {
Parameter *Parameter `protobuf:"bytes,1,opt,name=parameter,proto3,oneof"`
}
type ParameterOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use ParametersOrReferences.ProtoReflect.Descriptor instead.
func (x *ParametersOrReferences) GetAdditionalProperties() []*NamedParameterOrReference
func (*ParametersOrReferences) ProtoMessage()
func (x *ParametersOrReferences) ProtoReflect() protoreflect.Message
func (x *ParametersOrReferences) Reset()
func (m *ParametersOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ParametersOrReferences objects.
func (x *ParametersOrReferences) String() string
func (m *ParametersOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ParametersOrReferences suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,14,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use PathItem.ProtoReflect.Descriptor instead.
func (x *PathItem) GetDelete() *Operation
func (x *PathItem) GetDescription() string
func (x *PathItem) GetGet() *Operation
func (x *PathItem) GetHead() *Operation
func (x *PathItem) GetOptions() *Operation
func (x *PathItem) GetParameters() []*ParameterOrReference
func (x *PathItem) GetPatch() *Operation
func (x *PathItem) GetPost() *Operation
func (x *PathItem) GetPut() *Operation
func (x *PathItem) GetServers() []*Server
func (x *PathItem) GetSpecificationExtension() []*NamedAny
func (x *PathItem) GetSummary() string
func (x *PathItem) GetTrace() *Operation
func (x *PathItem) GetXRef() string
func (*PathItem) ProtoMessage()
func (x *PathItem) ProtoReflect() protoreflect.Message
func (x *PathItem) Reset()
func (m *PathItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside PathItem objects.
func (x *PathItem) String() string
func (m *PathItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of PathItem suitable for JSON or YAML export.
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.
type Paths struct {
Path []*NamedPathItem `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"`
SpecificationExtension []*NamedAny `protobuf:"bytes,2,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Paths.ProtoReflect.Descriptor instead.
func (x *Paths) GetPath() []*NamedPathItem
func (x *Paths) GetSpecificationExtension() []*NamedAny
func (*Paths) ProtoMessage()
func (x *Paths) ProtoReflect() protoreflect.Message
func (x *Paths) Reset()
func (m *Paths) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Paths objects.
func (x *Paths) String() string
func (m *Paths) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Paths suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use Properties.ProtoReflect.Descriptor instead.
func (x *Properties) GetAdditionalProperties() []*NamedSchemaOrReference
func (*Properties) ProtoMessage()
func (x *Properties) ProtoReflect() protoreflect.Message
func (x *Properties) Reset()
func (m *Properties) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Properties objects.
func (x *Properties) String() string
func (m *Properties) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Properties suitable for JSON or YAML export.
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.
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
}
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() ([]byte, []int)
Deprecated: Use Reference.ProtoReflect.Descriptor instead.
func (x *Reference) GetDescription() string
func (x *Reference) GetSummary() string
func (x *Reference) GetXRef() string
func (*Reference) ProtoMessage()
func (x *Reference) ProtoReflect() protoreflect.Message
func (x *Reference) Reset()
func (m *Reference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Reference objects.
func (x *Reference) String() string
func (m *Reference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Reference suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use RequestBodiesOrReferences.ProtoReflect.Descriptor instead.
func (x *RequestBodiesOrReferences) GetAdditionalProperties() []*NamedRequestBodyOrReference
func (*RequestBodiesOrReferences) ProtoMessage()
func (x *RequestBodiesOrReferences) ProtoReflect() protoreflect.Message
func (x *RequestBodiesOrReferences) Reset()
func (m *RequestBodiesOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside RequestBodiesOrReferences objects.
func (x *RequestBodiesOrReferences) String() string
func (m *RequestBodiesOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of RequestBodiesOrReferences suitable for JSON or YAML export.
Describes a single request body.
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 `protobuf:"bytes,4,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use RequestBody.ProtoReflect.Descriptor instead.
func (x *RequestBody) GetContent() *MediaTypes
func (x *RequestBody) GetDescription() string
func (x *RequestBody) GetRequired() bool
func (x *RequestBody) GetSpecificationExtension() []*NamedAny
func (*RequestBody) ProtoMessage()
func (x *RequestBody) ProtoReflect() protoreflect.Message
func (x *RequestBody) Reset()
func (m *RequestBody) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside RequestBody objects.
func (x *RequestBody) String() string
func (m *RequestBody) ToRawInfo() *yaml.Node
ToRawInfo returns a description of RequestBody suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use RequestBodyOrReference.ProtoReflect.Descriptor instead.
func (m *RequestBodyOrReference) GetOneof() isRequestBodyOrReference_Oneof
func (x *RequestBodyOrReference) GetReference() *Reference
func (x *RequestBodyOrReference) GetRequestBody() *RequestBody
func (*RequestBodyOrReference) ProtoMessage()
func (x *RequestBodyOrReference) ProtoReflect() protoreflect.Message
func (x *RequestBodyOrReference) Reset()
func (m *RequestBodyOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside RequestBodyOrReference objects.
func (x *RequestBodyOrReference) String() string
func (m *RequestBodyOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of RequestBodyOrReference suitable for JSON or YAML export.
type RequestBodyOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
type RequestBodyOrReference_RequestBody struct {
RequestBody *RequestBody `protobuf:"bytes,1,opt,name=request_body,json=requestBody,proto3,oneof"`
}
Describes a single response from an API Operation, including design-time, static `links` to operations based on the 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 `protobuf:"bytes,5,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Response.ProtoReflect.Descriptor instead.
func (x *Response) GetContent() *MediaTypes
func (x *Response) GetDescription() string
func (x *Response) GetHeaders() *HeadersOrReferences
func (x *Response) GetLinks() *LinksOrReferences
func (x *Response) GetSpecificationExtension() []*NamedAny
func (*Response) ProtoMessage()
func (x *Response) ProtoReflect() protoreflect.Message
func (x *Response) Reset()
func (m *Response) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Response objects.
func (x *Response) String() string
func (m *Response) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Response suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ResponseOrReference.ProtoReflect.Descriptor instead.
func (m *ResponseOrReference) GetOneof() isResponseOrReference_Oneof
func (x *ResponseOrReference) GetReference() *Reference
func (x *ResponseOrReference) GetResponse() *Response
func (*ResponseOrReference) ProtoMessage()
func (x *ResponseOrReference) ProtoReflect() protoreflect.Message
func (x *ResponseOrReference) Reset()
func (m *ResponseOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ResponseOrReference objects.
func (x *ResponseOrReference) String() string
func (m *ResponseOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ResponseOrReference suitable for JSON or YAML export.
type ResponseOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
type ResponseOrReference_Response struct {
Response *Response `protobuf:"bytes,1,opt,name=response,proto3,oneof"`
}
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.
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 `protobuf:"bytes,3,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Responses.ProtoReflect.Descriptor instead.
func (x *Responses) GetDefault() *ResponseOrReference
func (x *Responses) GetResponseOrReference() []*NamedResponseOrReference
func (x *Responses) GetSpecificationExtension() []*NamedAny
func (*Responses) ProtoMessage()
func (x *Responses) ProtoReflect() protoreflect.Message
func (x *Responses) Reset()
func (m *Responses) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Responses objects.
func (x *Responses) String() string
func (m *Responses) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Responses suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ResponsesOrReferences.ProtoReflect.Descriptor instead.
func (x *ResponsesOrReferences) GetAdditionalProperties() []*NamedResponseOrReference
func (*ResponsesOrReferences) ProtoMessage()
func (x *ResponsesOrReferences) ProtoReflect() protoreflect.Message
func (x *ResponsesOrReferences) Reset()
func (m *ResponsesOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ResponsesOrReferences objects.
func (x *ResponsesOrReferences) String() string
func (m *ResponsesOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ResponsesOrReferences suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,36,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Schema.ProtoReflect.Descriptor instead.
func (x *Schema) GetAdditionalProperties() *AdditionalPropertiesItem
func (x *Schema) GetAllOf() []*SchemaOrReference
func (x *Schema) GetAnyOf() []*SchemaOrReference
func (x *Schema) GetDefault() *DefaultType
func (x *Schema) GetDeprecated() bool
func (x *Schema) GetDescription() string
func (x *Schema) GetDiscriminator() *Discriminator
func (x *Schema) GetEnum() []*Any
func (x *Schema) GetExample() *Any
func (x *Schema) GetExclusiveMaximum() bool
func (x *Schema) GetExclusiveMinimum() bool
func (x *Schema) GetExternalDocs() *ExternalDocs
func (x *Schema) GetFormat() string
func (x *Schema) GetItems() *ItemsItem
func (x *Schema) GetMaxItems() int64
func (x *Schema) GetMaxLength() int64
func (x *Schema) GetMaxProperties() int64
func (x *Schema) GetMaximum() float64
func (x *Schema) GetMinItems() int64
func (x *Schema) GetMinLength() int64
func (x *Schema) GetMinProperties() int64
func (x *Schema) GetMinimum() float64
func (x *Schema) GetMultipleOf() float64
func (x *Schema) GetNot() *Schema
func (x *Schema) GetNullable() bool
func (x *Schema) GetOneOf() []*SchemaOrReference
func (x *Schema) GetPattern() string
func (x *Schema) GetProperties() *Properties
func (x *Schema) GetReadOnly() bool
func (x *Schema) GetRequired() []string
func (x *Schema) GetSpecificationExtension() []*NamedAny
func (x *Schema) GetTitle() string
func (x *Schema) GetType() string
func (x *Schema) GetUniqueItems() bool
func (x *Schema) GetWriteOnly() bool
func (x *Schema) GetXml() *Xml
func (*Schema) ProtoMessage()
func (x *Schema) ProtoReflect() protoreflect.Message
func (x *Schema) Reset()
func (m *Schema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Schema objects.
func (x *Schema) String() string
func (m *Schema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Schema suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use SchemaOrReference.ProtoReflect.Descriptor instead.
func (m *SchemaOrReference) GetOneof() isSchemaOrReference_Oneof
func (x *SchemaOrReference) GetReference() *Reference
func (x *SchemaOrReference) GetSchema() *Schema
func (*SchemaOrReference) ProtoMessage()
func (x *SchemaOrReference) ProtoReflect() protoreflect.Message
func (x *SchemaOrReference) Reset()
func (m *SchemaOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SchemaOrReference objects.
func (x *SchemaOrReference) String() string
func (m *SchemaOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SchemaOrReference suitable for JSON or YAML export.
type SchemaOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
type SchemaOrReference_Schema struct {
Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use SchemasOrReferences.ProtoReflect.Descriptor instead.
func (x *SchemasOrReferences) GetAdditionalProperties() []*NamedSchemaOrReference
func (*SchemasOrReferences) ProtoMessage()
func (x *SchemasOrReferences) ProtoReflect() protoreflect.Message
func (x *SchemasOrReferences) Reset()
func (m *SchemasOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SchemasOrReferences objects.
func (x *SchemasOrReferences) String() string
func (m *SchemasOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SchemasOrReferences suitable for JSON or YAML export.
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.
type SecurityRequirement struct {
AdditionalProperties []*NamedStringArray `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use SecurityRequirement.ProtoReflect.Descriptor instead.
func (x *SecurityRequirement) GetAdditionalProperties() []*NamedStringArray
func (*SecurityRequirement) ProtoMessage()
func (x *SecurityRequirement) ProtoReflect() protoreflect.Message
func (x *SecurityRequirement) Reset()
func (m *SecurityRequirement) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecurityRequirement objects.
func (x *SecurityRequirement) String() string
func (m *SecurityRequirement) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecurityRequirement suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,9,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use SecurityScheme.ProtoReflect.Descriptor instead.
func (x *SecurityScheme) GetBearerFormat() string
func (x *SecurityScheme) GetDescription() string
func (x *SecurityScheme) GetFlows() *OauthFlows
func (x *SecurityScheme) GetIn() string
func (x *SecurityScheme) GetName() string
func (x *SecurityScheme) GetOpenIdConnectUrl() string
func (x *SecurityScheme) GetScheme() string
func (x *SecurityScheme) GetSpecificationExtension() []*NamedAny
func (x *SecurityScheme) GetType() string
func (*SecurityScheme) ProtoMessage()
func (x *SecurityScheme) ProtoReflect() protoreflect.Message
func (x *SecurityScheme) Reset()
func (m *SecurityScheme) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecurityScheme objects.
func (x *SecurityScheme) String() string
func (m *SecurityScheme) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecurityScheme suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use SecuritySchemeOrReference.ProtoReflect.Descriptor instead.
func (m *SecuritySchemeOrReference) GetOneof() isSecuritySchemeOrReference_Oneof
func (x *SecuritySchemeOrReference) GetReference() *Reference
func (x *SecuritySchemeOrReference) GetSecurityScheme() *SecurityScheme
func (*SecuritySchemeOrReference) ProtoMessage()
func (x *SecuritySchemeOrReference) ProtoReflect() protoreflect.Message
func (x *SecuritySchemeOrReference) Reset()
func (m *SecuritySchemeOrReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecuritySchemeOrReference objects.
func (x *SecuritySchemeOrReference) String() string
func (m *SecuritySchemeOrReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecuritySchemeOrReference suitable for JSON or YAML export.
type SecuritySchemeOrReference_Reference struct {
Reference *Reference `protobuf:"bytes,2,opt,name=reference,proto3,oneof"`
}
type SecuritySchemeOrReference_SecurityScheme struct {
SecurityScheme *SecurityScheme `protobuf:"bytes,1,opt,name=security_scheme,json=securityScheme,proto3,oneof"`
}
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(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() ([]byte, []int)
Deprecated: Use SecuritySchemesOrReferences.ProtoReflect.Descriptor instead.
func (x *SecuritySchemesOrReferences) GetAdditionalProperties() []*NamedSecuritySchemeOrReference
func (*SecuritySchemesOrReferences) ProtoMessage()
func (x *SecuritySchemesOrReferences) ProtoReflect() protoreflect.Message
func (x *SecuritySchemesOrReferences) Reset()
func (m *SecuritySchemesOrReferences) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecuritySchemesOrReferences objects.
func (x *SecuritySchemesOrReferences) String() string
func (m *SecuritySchemesOrReferences) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecuritySchemesOrReferences suitable for JSON or YAML export.
An object representing a 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 `protobuf:"bytes,4,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Server.ProtoReflect.Descriptor instead.
func (x *Server) GetDescription() string
func (x *Server) GetSpecificationExtension() []*NamedAny
func (x *Server) GetUrl() string
func (x *Server) GetVariables() *ServerVariables
func (*Server) ProtoMessage()
func (x *Server) ProtoReflect() protoreflect.Message
func (x *Server) Reset()
func (m *Server) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Server objects.
func (x *Server) String() string
func (m *Server) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Server suitable for JSON or YAML export.
An object representing a Server Variable for server URL template substitution.
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 `protobuf:"bytes,4,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use ServerVariable.ProtoReflect.Descriptor instead.
func (x *ServerVariable) GetDefault() string
func (x *ServerVariable) GetDescription() string
func (x *ServerVariable) GetEnum() []string
func (x *ServerVariable) GetSpecificationExtension() []*NamedAny
func (*ServerVariable) ProtoMessage()
func (x *ServerVariable) ProtoReflect() protoreflect.Message
func (x *ServerVariable) Reset()
func (m *ServerVariable) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ServerVariable objects.
func (x *ServerVariable) String() string
func (m *ServerVariable) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ServerVariable suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use ServerVariables.ProtoReflect.Descriptor instead.
func (x *ServerVariables) GetAdditionalProperties() []*NamedServerVariable
func (*ServerVariables) ProtoMessage()
func (x *ServerVariables) ProtoReflect() protoreflect.Message
func (x *ServerVariables) Reset()
func (m *ServerVariables) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ServerVariables objects.
func (x *ServerVariables) String() string
func (m *ServerVariables) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ServerVariables suitable for JSON or YAML export.
Any property starting with x- is valid.
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
}
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() ([]byte, []int)
Deprecated: Use SpecificationExtension.ProtoReflect.Descriptor instead.
func (x *SpecificationExtension) GetBoolean() bool
func (x *SpecificationExtension) GetNumber() float64
func (m *SpecificationExtension) GetOneof() isSpecificationExtension_Oneof
func (x *SpecificationExtension) GetString_() string
func (*SpecificationExtension) ProtoMessage()
func (x *SpecificationExtension) ProtoReflect() protoreflect.Message
func (x *SpecificationExtension) Reset()
func (m *SpecificationExtension) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SpecificationExtension objects.
func (x *SpecificationExtension) String() string
func (m *SpecificationExtension) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SpecificationExtension suitable for JSON or YAML export.
type SpecificationExtension_Boolean struct {
Boolean bool `protobuf:"varint,2,opt,name=boolean,proto3,oneof"`
}
type SpecificationExtension_Number struct {
Number float64 `protobuf:"fixed64,1,opt,name=number,proto3,oneof"`
}
type SpecificationExtension_String_ struct {
String_ string `protobuf:"bytes,3,opt,name=string,proto3,oneof"`
}
type StringArray struct {
Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use StringArray.ProtoReflect.Descriptor instead.
func (x *StringArray) GetValue() []string
func (*StringArray) ProtoMessage()
func (x *StringArray) ProtoReflect() protoreflect.Message
func (x *StringArray) Reset()
func (m *StringArray) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside StringArray objects.
func (x *StringArray) String() string
func (m *StringArray) ToRawInfo() *yaml.Node
ToRawInfo returns a description of StringArray suitable for JSON or YAML export.
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(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() ([]byte, []int)
Deprecated: Use Strings.ProtoReflect.Descriptor instead.
func (x *Strings) GetAdditionalProperties() []*NamedString
func (*Strings) ProtoMessage()
func (x *Strings) ProtoReflect() protoreflect.Message
func (x *Strings) Reset()
func (m *Strings) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Strings objects.
func (x *Strings) String() string
func (m *Strings) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Strings suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,4,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Tag.ProtoReflect.Descriptor instead.
func (x *Tag) GetDescription() string
func (x *Tag) GetExternalDocs() *ExternalDocs
func (x *Tag) GetName() string
func (x *Tag) GetSpecificationExtension() []*NamedAny
func (*Tag) ProtoMessage()
func (x *Tag) ProtoReflect() protoreflect.Message
func (x *Tag) Reset()
func (m *Tag) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Tag objects.
func (x *Tag) String() string
func (m *Tag) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Tag suitable for JSON or YAML export.
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.
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 `protobuf:"bytes,6,rep,name=specification_extension,json=specificationExtension,proto3" json:"specification_extension,omitempty"`
// contains filtered or unexported fields
}
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() ([]byte, []int)
Deprecated: Use Xml.ProtoReflect.Descriptor instead.
func (x *Xml) GetAttribute() bool
func (x *Xml) GetName() string
func (x *Xml) GetNamespace() string
func (x *Xml) GetPrefix() string
func (x *Xml) GetSpecificationExtension() []*NamedAny
func (x *Xml) GetWrapped() bool
func (*Xml) ProtoMessage()
func (x *Xml) ProtoReflect() protoreflect.Message
func (x *Xml) Reset()
func (m *Xml) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Xml objects.
func (x *Xml) String() string
func (m *Xml) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Xml suitable for JSON or YAML export.