var File_openapiv2_OpenAPIv2_proto protoreflect.FileDescriptor
func Version() string
Version returns the package name (and OpenAPI version).
type AdditionalPropertiesItem struct {
// Types that are assignable to Oneof:
// *AdditionalPropertiesItem_Schema
// *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) GetSchema() *Schema
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_Schema struct {
Schema *Schema `protobuf:"bytes,1,opt,name=schema,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 ApiKeySecurity struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
In string `protobuf:"bytes,3,opt,name=in,proto3" json:"in,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,5,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewApiKeySecurity(in *yaml.Node, context *compiler.Context) (*ApiKeySecurity, error)
NewApiKeySecurity creates an object of type ApiKeySecurity if possible, returning an error if not.
func (*ApiKeySecurity) Descriptor() ([]byte, []int)
Deprecated: Use ApiKeySecurity.ProtoReflect.Descriptor instead.
func (x *ApiKeySecurity) GetDescription() string
func (x *ApiKeySecurity) GetIn() string
func (x *ApiKeySecurity) GetName() string
func (x *ApiKeySecurity) GetType() string
func (x *ApiKeySecurity) GetVendorExtension() []*NamedAny
func (*ApiKeySecurity) ProtoMessage()
func (x *ApiKeySecurity) ProtoReflect() protoreflect.Message
func (x *ApiKeySecurity) Reset()
func (m *ApiKeySecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ApiKeySecurity objects.
func (x *ApiKeySecurity) String() string
func (m *ApiKeySecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ApiKeySecurity suitable for JSON or YAML export.
type BasicAuthenticationSecurity 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"`
VendorExtension []*NamedAny `protobuf:"bytes,3,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewBasicAuthenticationSecurity(in *yaml.Node, context *compiler.Context) (*BasicAuthenticationSecurity, error)
NewBasicAuthenticationSecurity creates an object of type BasicAuthenticationSecurity if possible, returning an error if not.
func (*BasicAuthenticationSecurity) Descriptor() ([]byte, []int)
Deprecated: Use BasicAuthenticationSecurity.ProtoReflect.Descriptor instead.
func (x *BasicAuthenticationSecurity) GetDescription() string
func (x *BasicAuthenticationSecurity) GetType() string
func (x *BasicAuthenticationSecurity) GetVendorExtension() []*NamedAny
func (*BasicAuthenticationSecurity) ProtoMessage()
func (x *BasicAuthenticationSecurity) ProtoReflect() protoreflect.Message
func (x *BasicAuthenticationSecurity) Reset()
func (m *BasicAuthenticationSecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside BasicAuthenticationSecurity objects.
func (x *BasicAuthenticationSecurity) String() string
func (m *BasicAuthenticationSecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of BasicAuthenticationSecurity suitable for JSON or YAML export.
type BodyParameter struct {
// A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// The name of the parameter.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Determines the location of the parameter.
In string `protobuf:"bytes,3,opt,name=in,proto3" json:"in,omitempty"`
// Determines whether or not this parameter is required or optional.
Required bool `protobuf:"varint,4,opt,name=required,proto3" json:"required,omitempty"`
Schema *Schema `protobuf:"bytes,5,opt,name=schema,proto3" json:"schema,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,6,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewBodyParameter(in *yaml.Node, context *compiler.Context) (*BodyParameter, error)
NewBodyParameter creates an object of type BodyParameter if possible, returning an error if not.
func (*BodyParameter) Descriptor() ([]byte, []int)
Deprecated: Use BodyParameter.ProtoReflect.Descriptor instead.
func (x *BodyParameter) GetDescription() string
func (x *BodyParameter) GetIn() string
func (x *BodyParameter) GetName() string
func (x *BodyParameter) GetRequired() bool
func (x *BodyParameter) GetSchema() *Schema
func (x *BodyParameter) GetVendorExtension() []*NamedAny
func (*BodyParameter) ProtoMessage()
func (x *BodyParameter) ProtoReflect() protoreflect.Message
func (x *BodyParameter) Reset()
func (m *BodyParameter) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside BodyParameter objects.
func (x *BodyParameter) String() string
func (m *BodyParameter) ToRawInfo() *yaml.Node
ToRawInfo returns a description of BodyParameter suitable for JSON or YAML export.
Contact information for the owners of the API.
type Contact struct {
// The identifying name of the contact person/organization.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The URL pointing to the contact information.
Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
// The email address of the contact person/organization.
Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,4,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetUrl() string
func (x *Contact) GetVendorExtension() []*NamedAny
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 Default struct {
AdditionalProperties []*NamedAny `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewDefault(in *yaml.Node, context *compiler.Context) (*Default, error)
NewDefault creates an object of type Default if possible, returning an error if not.
func (*Default) Descriptor() ([]byte, []int)
Deprecated: Use Default.ProtoReflect.Descriptor instead.
func (x *Default) GetAdditionalProperties() []*NamedAny
func (*Default) ProtoMessage()
func (x *Default) ProtoReflect() protoreflect.Message
func (x *Default) Reset()
func (m *Default) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Default objects.
func (x *Default) String() string
func (m *Default) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Default suitable for JSON or YAML export.
One or more JSON objects describing the schemas being consumed and produced by the API.
type Definitions struct {
AdditionalProperties []*NamedSchema `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewDefinitions(in *yaml.Node, context *compiler.Context) (*Definitions, error)
NewDefinitions creates an object of type Definitions if possible, returning an error if not.
func (*Definitions) Descriptor() ([]byte, []int)
Deprecated: Use Definitions.ProtoReflect.Descriptor instead.
func (x *Definitions) GetAdditionalProperties() []*NamedSchema
func (*Definitions) ProtoMessage()
func (x *Definitions) ProtoReflect() protoreflect.Message
func (x *Definitions) Reset()
func (m *Definitions) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Definitions objects.
func (x *Definitions) String() string
func (m *Definitions) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Definitions suitable for JSON or YAML export.
type Document struct {
// The Swagger version of this document.
Swagger string `protobuf:"bytes,1,opt,name=swagger,proto3" json:"swagger,omitempty"`
Info *Info `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
// The host (name or ip) of the API. Example: 'swagger.io'
Host string `protobuf:"bytes,3,opt,name=host,proto3" json:"host,omitempty"`
// The base path to the API. Example: '/api'.
BasePath string `protobuf:"bytes,4,opt,name=base_path,json=basePath,proto3" json:"base_path,omitempty"`
// The transfer protocol of the API.
Schemes []string `protobuf:"bytes,5,rep,name=schemes,proto3" json:"schemes,omitempty"`
// A list of MIME types accepted by the API.
Consumes []string `protobuf:"bytes,6,rep,name=consumes,proto3" json:"consumes,omitempty"`
// A list of MIME types the API can produce.
Produces []string `protobuf:"bytes,7,rep,name=produces,proto3" json:"produces,omitempty"`
Paths *Paths `protobuf:"bytes,8,opt,name=paths,proto3" json:"paths,omitempty"`
Definitions *Definitions `protobuf:"bytes,9,opt,name=definitions,proto3" json:"definitions,omitempty"`
Parameters *ParameterDefinitions `protobuf:"bytes,10,opt,name=parameters,proto3" json:"parameters,omitempty"`
Responses *ResponseDefinitions `protobuf:"bytes,11,opt,name=responses,proto3" json:"responses,omitempty"`
Security []*SecurityRequirement `protobuf:"bytes,12,rep,name=security,proto3" json:"security,omitempty"`
SecurityDefinitions *SecurityDefinitions `protobuf:"bytes,13,opt,name=security_definitions,json=securityDefinitions,proto3" json:"security_definitions,omitempty"`
Tags []*Tag `protobuf:"bytes,14,rep,name=tags,proto3" json:"tags,omitempty"`
ExternalDocs *ExternalDocs `protobuf:"bytes,15,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,16,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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 v2 description from a YAML/JSON representation.
func (*Document) Descriptor() ([]byte, []int)
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (x *Document) GetBasePath() string
func (x *Document) GetConsumes() []string
func (x *Document) GetDefinitions() *Definitions
func (x *Document) GetExternalDocs() *ExternalDocs
func (x *Document) GetHost() string
func (x *Document) GetInfo() *Info
func (x *Document) GetParameters() *ParameterDefinitions
func (x *Document) GetPaths() *Paths
func (x *Document) GetProduces() []string
func (x *Document) GetResponses() *ResponseDefinitions
func (x *Document) GetSchemes() []string
func (x *Document) GetSecurity() []*SecurityRequirement
func (x *Document) GetSecurityDefinitions() *SecurityDefinitions
func (x *Document) GetSwagger() string
func (x *Document) GetTags() []*Tag
func (x *Document) GetVendorExtension() []*NamedAny
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.
type Examples struct {
AdditionalProperties []*NamedAny `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewExamples(in *yaml.Node, context *compiler.Context) (*Examples, error)
NewExamples creates an object of type Examples if possible, returning an error if not.
func (*Examples) Descriptor() ([]byte, []int)
Deprecated: Use Examples.ProtoReflect.Descriptor instead.
func (x *Examples) GetAdditionalProperties() []*NamedAny
func (*Examples) ProtoMessage()
func (x *Examples) ProtoReflect() protoreflect.Message
func (x *Examples) Reset()
func (m *Examples) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Examples objects.
func (x *Examples) String() string
func (m *Examples) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Examples suitable for JSON or YAML export.
information about external 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"`
VendorExtension []*NamedAny `protobuf:"bytes,3,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetUrl() string
func (x *ExternalDocs) GetVendorExtension() []*NamedAny
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.
A deterministic version of a JSON Schema object.
type FileSchema struct {
Format string `protobuf:"bytes,1,opt,name=format,proto3" json:"format,omitempty"`
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Default *Any `protobuf:"bytes,4,opt,name=default,proto3" json:"default,omitempty"`
Required []string `protobuf:"bytes,5,rep,name=required,proto3" json:"required,omitempty"`
Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
ReadOnly bool `protobuf:"varint,7,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
ExternalDocs *ExternalDocs `protobuf:"bytes,8,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
Example *Any `protobuf:"bytes,9,opt,name=example,proto3" json:"example,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,10,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewFileSchema(in *yaml.Node, context *compiler.Context) (*FileSchema, error)
NewFileSchema creates an object of type FileSchema if possible, returning an error if not.
func (*FileSchema) Descriptor() ([]byte, []int)
Deprecated: Use FileSchema.ProtoReflect.Descriptor instead.
func (x *FileSchema) GetDefault() *Any
func (x *FileSchema) GetDescription() string
func (x *FileSchema) GetExample() *Any
func (x *FileSchema) GetExternalDocs() *ExternalDocs
func (x *FileSchema) GetFormat() string
func (x *FileSchema) GetReadOnly() bool
func (x *FileSchema) GetRequired() []string
func (x *FileSchema) GetTitle() string
func (x *FileSchema) GetType() string
func (x *FileSchema) GetVendorExtension() []*NamedAny
func (*FileSchema) ProtoMessage()
func (x *FileSchema) ProtoReflect() protoreflect.Message
func (x *FileSchema) Reset()
func (m *FileSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside FileSchema objects.
func (x *FileSchema) String() string
func (m *FileSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of FileSchema suitable for JSON or YAML export.
type FormDataParameterSubSchema struct {
// Determines whether or not this parameter is required or optional.
Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
// Determines the location of the parameter.
In string `protobuf:"bytes,2,opt,name=in,proto3" json:"in,omitempty"`
// A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The name of the parameter.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// allows sending a parameter by name only or with an empty value.
AllowEmptyValue bool `protobuf:"varint,5,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,7,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,8,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,9,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,10,opt,name=default,proto3" json:"default,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"`
Enum []*Any `protobuf:"bytes,21,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,22,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,23,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewFormDataParameterSubSchema(in *yaml.Node, context *compiler.Context) (*FormDataParameterSubSchema, error)
NewFormDataParameterSubSchema creates an object of type FormDataParameterSubSchema if possible, returning an error if not.
func (*FormDataParameterSubSchema) Descriptor() ([]byte, []int)
Deprecated: Use FormDataParameterSubSchema.ProtoReflect.Descriptor instead.
func (x *FormDataParameterSubSchema) GetAllowEmptyValue() bool
func (x *FormDataParameterSubSchema) GetCollectionFormat() string
func (x *FormDataParameterSubSchema) GetDefault() *Any
func (x *FormDataParameterSubSchema) GetDescription() string
func (x *FormDataParameterSubSchema) GetEnum() []*Any
func (x *FormDataParameterSubSchema) GetExclusiveMaximum() bool
func (x *FormDataParameterSubSchema) GetExclusiveMinimum() bool
func (x *FormDataParameterSubSchema) GetFormat() string
func (x *FormDataParameterSubSchema) GetIn() string
func (x *FormDataParameterSubSchema) GetItems() *PrimitivesItems
func (x *FormDataParameterSubSchema) GetMaxItems() int64
func (x *FormDataParameterSubSchema) GetMaxLength() int64
func (x *FormDataParameterSubSchema) GetMaximum() float64
func (x *FormDataParameterSubSchema) GetMinItems() int64
func (x *FormDataParameterSubSchema) GetMinLength() int64
func (x *FormDataParameterSubSchema) GetMinimum() float64
func (x *FormDataParameterSubSchema) GetMultipleOf() float64
func (x *FormDataParameterSubSchema) GetName() string
func (x *FormDataParameterSubSchema) GetPattern() string
func (x *FormDataParameterSubSchema) GetRequired() bool
func (x *FormDataParameterSubSchema) GetType() string
func (x *FormDataParameterSubSchema) GetUniqueItems() bool
func (x *FormDataParameterSubSchema) GetVendorExtension() []*NamedAny
func (*FormDataParameterSubSchema) ProtoMessage()
func (x *FormDataParameterSubSchema) ProtoReflect() protoreflect.Message
func (x *FormDataParameterSubSchema) Reset()
func (m *FormDataParameterSubSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside FormDataParameterSubSchema objects.
func (x *FormDataParameterSubSchema) String() string
func (m *FormDataParameterSubSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of FormDataParameterSubSchema suitable for JSON or YAML export.
type Header struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,3,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,4,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`
Maximum float64 `protobuf:"fixed64,6,opt,name=maximum,proto3" json:"maximum,omitempty"`
ExclusiveMaximum bool `protobuf:"varint,7,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
Minimum float64 `protobuf:"fixed64,8,opt,name=minimum,proto3" json:"minimum,omitempty"`
ExclusiveMinimum bool `protobuf:"varint,9,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
MaxLength int64 `protobuf:"varint,10,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
MinLength int64 `protobuf:"varint,11,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
Pattern string `protobuf:"bytes,12,opt,name=pattern,proto3" json:"pattern,omitempty"`
MaxItems int64 `protobuf:"varint,13,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
MinItems int64 `protobuf:"varint,14,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
UniqueItems bool `protobuf:"varint,15,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
Enum []*Any `protobuf:"bytes,16,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,17,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
Description string `protobuf:"bytes,18,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,19,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetCollectionFormat() string
func (x *Header) GetDefault() *Any
func (x *Header) GetDescription() string
func (x *Header) GetEnum() []*Any
func (x *Header) GetExclusiveMaximum() bool
func (x *Header) GetExclusiveMinimum() bool
func (x *Header) GetFormat() string
func (x *Header) GetItems() *PrimitivesItems
func (x *Header) GetMaxItems() int64
func (x *Header) GetMaxLength() int64
func (x *Header) GetMaximum() float64
func (x *Header) GetMinItems() int64
func (x *Header) GetMinLength() int64
func (x *Header) GetMinimum() float64
func (x *Header) GetMultipleOf() float64
func (x *Header) GetPattern() string
func (x *Header) GetType() string
func (x *Header) GetUniqueItems() bool
func (x *Header) GetVendorExtension() []*NamedAny
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 HeaderParameterSubSchema struct {
// Determines whether or not this parameter is required or optional.
Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
// Determines the location of the parameter.
In string `protobuf:"bytes,2,opt,name=in,proto3" json:"in,omitempty"`
// A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The name of the parameter.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
Type string `protobuf:"bytes,5,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,6,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,7,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,8,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,9,opt,name=default,proto3" json:"default,omitempty"`
Maximum float64 `protobuf:"fixed64,10,opt,name=maximum,proto3" json:"maximum,omitempty"`
ExclusiveMaximum bool `protobuf:"varint,11,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
Minimum float64 `protobuf:"fixed64,12,opt,name=minimum,proto3" json:"minimum,omitempty"`
ExclusiveMinimum bool `protobuf:"varint,13,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
MaxLength int64 `protobuf:"varint,14,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
MinLength int64 `protobuf:"varint,15,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
Pattern string `protobuf:"bytes,16,opt,name=pattern,proto3" json:"pattern,omitempty"`
MaxItems int64 `protobuf:"varint,17,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
MinItems int64 `protobuf:"varint,18,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
UniqueItems bool `protobuf:"varint,19,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
Enum []*Any `protobuf:"bytes,20,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,21,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,22,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewHeaderParameterSubSchema(in *yaml.Node, context *compiler.Context) (*HeaderParameterSubSchema, error)
NewHeaderParameterSubSchema creates an object of type HeaderParameterSubSchema if possible, returning an error if not.
func (*HeaderParameterSubSchema) Descriptor() ([]byte, []int)
Deprecated: Use HeaderParameterSubSchema.ProtoReflect.Descriptor instead.
func (x *HeaderParameterSubSchema) GetCollectionFormat() string
func (x *HeaderParameterSubSchema) GetDefault() *Any
func (x *HeaderParameterSubSchema) GetDescription() string
func (x *HeaderParameterSubSchema) GetEnum() []*Any
func (x *HeaderParameterSubSchema) GetExclusiveMaximum() bool
func (x *HeaderParameterSubSchema) GetExclusiveMinimum() bool
func (x *HeaderParameterSubSchema) GetFormat() string
func (x *HeaderParameterSubSchema) GetIn() string
func (x *HeaderParameterSubSchema) GetItems() *PrimitivesItems
func (x *HeaderParameterSubSchema) GetMaxItems() int64
func (x *HeaderParameterSubSchema) GetMaxLength() int64
func (x *HeaderParameterSubSchema) GetMaximum() float64
func (x *HeaderParameterSubSchema) GetMinItems() int64
func (x *HeaderParameterSubSchema) GetMinLength() int64
func (x *HeaderParameterSubSchema) GetMinimum() float64
func (x *HeaderParameterSubSchema) GetMultipleOf() float64
func (x *HeaderParameterSubSchema) GetName() string
func (x *HeaderParameterSubSchema) GetPattern() string
func (x *HeaderParameterSubSchema) GetRequired() bool
func (x *HeaderParameterSubSchema) GetType() string
func (x *HeaderParameterSubSchema) GetUniqueItems() bool
func (x *HeaderParameterSubSchema) GetVendorExtension() []*NamedAny
func (*HeaderParameterSubSchema) ProtoMessage()
func (x *HeaderParameterSubSchema) ProtoReflect() protoreflect.Message
func (x *HeaderParameterSubSchema) Reset()
func (m *HeaderParameterSubSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside HeaderParameterSubSchema objects.
func (x *HeaderParameterSubSchema) String() string
func (m *HeaderParameterSubSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of HeaderParameterSubSchema suitable for JSON or YAML export.
type Headers struct {
AdditionalProperties []*NamedHeader `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewHeaders(in *yaml.Node, context *compiler.Context) (*Headers, error)
NewHeaders creates an object of type Headers if possible, returning an error if not.
func (*Headers) Descriptor() ([]byte, []int)
Deprecated: Use Headers.ProtoReflect.Descriptor instead.
func (x *Headers) GetAdditionalProperties() []*NamedHeader
func (*Headers) ProtoMessage()
func (x *Headers) ProtoReflect() protoreflect.Message
func (x *Headers) Reset()
func (m *Headers) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Headers objects.
func (x *Headers) String() string
func (m *Headers) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Headers suitable for JSON or YAML export.
General information about the API.
type Info struct {
// A unique and precise title of the API.
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
// A semantic version number of the API.
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The terms of service for the API.
TermsOfService string `protobuf:"bytes,4,opt,name=terms_of_service,json=termsOfService,proto3" json:"terms_of_service,omitempty"`
Contact *Contact `protobuf:"bytes,5,opt,name=contact,proto3" json:"contact,omitempty"`
License *License `protobuf:"bytes,6,opt,name=license,proto3" json:"license,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,7,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,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) GetTermsOfService() string
func (x *Info) GetTitle() string
func (x *Info) GetVendorExtension() []*NamedAny
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 {
Schema []*Schema `protobuf:"bytes,1,rep,name=schema,proto3" json:"schema,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) GetSchema() []*Schema
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.
type JsonReference struct {
XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func NewJsonReference(in *yaml.Node, context *compiler.Context) (*JsonReference, error)
NewJsonReference creates an object of type JsonReference if possible, returning an error if not.
func (*JsonReference) Descriptor() ([]byte, []int)
Deprecated: Use JsonReference.ProtoReflect.Descriptor instead.
func (x *JsonReference) GetDescription() string
func (x *JsonReference) GetXRef() string
func (*JsonReference) ProtoMessage()
func (x *JsonReference) ProtoReflect() protoreflect.Message
func (x *JsonReference) Reset()
func (m *JsonReference) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside JsonReference objects.
func (x *JsonReference) String() string
func (m *JsonReference) ToRawInfo() *yaml.Node
ToRawInfo returns a description of JsonReference suitable for JSON or YAML export.
type License struct {
// The name of the license type. It's encouraged to use an OSI compatible license.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The URL pointing to the license.
Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,3,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetUrl() string
func (x *License) GetVendorExtension() []*NamedAny
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.
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 Header as ordered (name,value) pairs.
type NamedHeader struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Header `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedHeader(in *yaml.Node, context *compiler.Context) (*NamedHeader, error)
NewNamedHeader creates an object of type NamedHeader if possible, returning an error if not.
func (*NamedHeader) Descriptor() ([]byte, []int)
Deprecated: Use NamedHeader.ProtoReflect.Descriptor instead.
func (x *NamedHeader) GetName() string
func (x *NamedHeader) GetValue() *Header
func (*NamedHeader) ProtoMessage()
func (x *NamedHeader) ProtoReflect() protoreflect.Message
func (x *NamedHeader) Reset()
func (m *NamedHeader) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedHeader objects.
func (x *NamedHeader) String() string
func (m *NamedHeader) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedHeader suitable for JSON or YAML export.
Automatically-generated message used to represent maps of Parameter as ordered (name,value) pairs.
type NamedParameter struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Parameter `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedParameter(in *yaml.Node, context *compiler.Context) (*NamedParameter, error)
NewNamedParameter creates an object of type NamedParameter if possible, returning an error if not.
func (*NamedParameter) Descriptor() ([]byte, []int)
Deprecated: Use NamedParameter.ProtoReflect.Descriptor instead.
func (x *NamedParameter) GetName() string
func (x *NamedParameter) GetValue() *Parameter
func (*NamedParameter) ProtoMessage()
func (x *NamedParameter) ProtoReflect() protoreflect.Message
func (x *NamedParameter) Reset()
func (m *NamedParameter) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedParameter objects.
func (x *NamedParameter) String() string
func (m *NamedParameter) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedParameter 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 Response as ordered (name,value) pairs.
type NamedResponse struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Response `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedResponse(in *yaml.Node, context *compiler.Context) (*NamedResponse, error)
NewNamedResponse creates an object of type NamedResponse if possible, returning an error if not.
func (*NamedResponse) Descriptor() ([]byte, []int)
Deprecated: Use NamedResponse.ProtoReflect.Descriptor instead.
func (x *NamedResponse) GetName() string
func (x *NamedResponse) GetValue() *Response
func (*NamedResponse) ProtoMessage()
func (x *NamedResponse) ProtoReflect() protoreflect.Message
func (x *NamedResponse) Reset()
func (m *NamedResponse) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedResponse objects.
func (x *NamedResponse) String() string
func (m *NamedResponse) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedResponse suitable for JSON or YAML export.
Automatically-generated message used to represent maps of ResponseValue as ordered (name,value) pairs.
type NamedResponseValue struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *ResponseValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedResponseValue(in *yaml.Node, context *compiler.Context) (*NamedResponseValue, error)
NewNamedResponseValue creates an object of type NamedResponseValue if possible, returning an error if not.
func (*NamedResponseValue) Descriptor() ([]byte, []int)
Deprecated: Use NamedResponseValue.ProtoReflect.Descriptor instead.
func (x *NamedResponseValue) GetName() string
func (x *NamedResponseValue) GetValue() *ResponseValue
func (*NamedResponseValue) ProtoMessage()
func (x *NamedResponseValue) ProtoReflect() protoreflect.Message
func (x *NamedResponseValue) Reset()
func (m *NamedResponseValue) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedResponseValue objects.
func (x *NamedResponseValue) String() string
func (m *NamedResponseValue) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedResponseValue suitable for JSON or YAML export.
Automatically-generated message used to represent maps of Schema as ordered (name,value) pairs.
type NamedSchema struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Schema `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedSchema(in *yaml.Node, context *compiler.Context) (*NamedSchema, error)
NewNamedSchema creates an object of type NamedSchema if possible, returning an error if not.
func (*NamedSchema) Descriptor() ([]byte, []int)
Deprecated: Use NamedSchema.ProtoReflect.Descriptor instead.
func (x *NamedSchema) GetName() string
func (x *NamedSchema) GetValue() *Schema
func (*NamedSchema) ProtoMessage()
func (x *NamedSchema) ProtoReflect() protoreflect.Message
func (x *NamedSchema) Reset()
func (m *NamedSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedSchema objects.
func (x *NamedSchema) String() string
func (m *NamedSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedSchema suitable for JSON or YAML export.
Automatically-generated message used to represent maps of SecurityDefinitionsItem as ordered (name,value) pairs.
type NamedSecurityDefinitionsItem struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *SecurityDefinitionsItem `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedSecurityDefinitionsItem(in *yaml.Node, context *compiler.Context) (*NamedSecurityDefinitionsItem, error)
NewNamedSecurityDefinitionsItem creates an object of type NamedSecurityDefinitionsItem if possible, returning an error if not.
func (*NamedSecurityDefinitionsItem) Descriptor() ([]byte, []int)
Deprecated: Use NamedSecurityDefinitionsItem.ProtoReflect.Descriptor instead.
func (x *NamedSecurityDefinitionsItem) GetName() string
func (x *NamedSecurityDefinitionsItem) GetValue() *SecurityDefinitionsItem
func (*NamedSecurityDefinitionsItem) ProtoMessage()
func (x *NamedSecurityDefinitionsItem) ProtoReflect() protoreflect.Message
func (x *NamedSecurityDefinitionsItem) Reset()
func (m *NamedSecurityDefinitionsItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedSecurityDefinitionsItem objects.
func (x *NamedSecurityDefinitionsItem) String() string
func (m *NamedSecurityDefinitionsItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedSecurityDefinitionsItem 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.
type NonBodyParameter struct {
// Types that are assignable to Oneof:
// *NonBodyParameter_HeaderParameterSubSchema
// *NonBodyParameter_FormDataParameterSubSchema
// *NonBodyParameter_QueryParameterSubSchema
// *NonBodyParameter_PathParameterSubSchema
Oneof isNonBodyParameter_Oneof `protobuf_oneof:"oneof"`
// contains filtered or unexported fields
}
func NewNonBodyParameter(in *yaml.Node, context *compiler.Context) (*NonBodyParameter, error)
NewNonBodyParameter creates an object of type NonBodyParameter if possible, returning an error if not.
func (*NonBodyParameter) Descriptor() ([]byte, []int)
Deprecated: Use NonBodyParameter.ProtoReflect.Descriptor instead.
func (x *NonBodyParameter) GetFormDataParameterSubSchema() *FormDataParameterSubSchema
func (x *NonBodyParameter) GetHeaderParameterSubSchema() *HeaderParameterSubSchema
func (m *NonBodyParameter) GetOneof() isNonBodyParameter_Oneof
func (x *NonBodyParameter) GetPathParameterSubSchema() *PathParameterSubSchema
func (x *NonBodyParameter) GetQueryParameterSubSchema() *QueryParameterSubSchema
func (*NonBodyParameter) ProtoMessage()
func (x *NonBodyParameter) ProtoReflect() protoreflect.Message
func (x *NonBodyParameter) Reset()
func (m *NonBodyParameter) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NonBodyParameter objects.
func (x *NonBodyParameter) String() string
func (m *NonBodyParameter) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NonBodyParameter suitable for JSON or YAML export.
type NonBodyParameter_FormDataParameterSubSchema struct {
FormDataParameterSubSchema *FormDataParameterSubSchema `protobuf:"bytes,2,opt,name=form_data_parameter_sub_schema,json=formDataParameterSubSchema,proto3,oneof"`
}
type NonBodyParameter_HeaderParameterSubSchema struct {
HeaderParameterSubSchema *HeaderParameterSubSchema `protobuf:"bytes,1,opt,name=header_parameter_sub_schema,json=headerParameterSubSchema,proto3,oneof"`
}
type NonBodyParameter_PathParameterSubSchema struct {
PathParameterSubSchema *PathParameterSubSchema `protobuf:"bytes,4,opt,name=path_parameter_sub_schema,json=pathParameterSubSchema,proto3,oneof"`
}
type NonBodyParameter_QueryParameterSubSchema struct {
QueryParameterSubSchema *QueryParameterSubSchema `protobuf:"bytes,3,opt,name=query_parameter_sub_schema,json=queryParameterSubSchema,proto3,oneof"`
}
type Oauth2AccessCodeSecurity struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Flow string `protobuf:"bytes,2,opt,name=flow,proto3" json:"flow,omitempty"`
Scopes *Oauth2Scopes `protobuf:"bytes,3,opt,name=scopes,proto3" json:"scopes,omitempty"`
AuthorizationUrl string `protobuf:"bytes,4,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"`
TokenUrl string `protobuf:"bytes,5,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`
Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,7,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2AccessCodeSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2AccessCodeSecurity, error)
NewOauth2AccessCodeSecurity creates an object of type Oauth2AccessCodeSecurity if possible, returning an error if not.
func (*Oauth2AccessCodeSecurity) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2AccessCodeSecurity.ProtoReflect.Descriptor instead.
func (x *Oauth2AccessCodeSecurity) GetAuthorizationUrl() string
func (x *Oauth2AccessCodeSecurity) GetDescription() string
func (x *Oauth2AccessCodeSecurity) GetFlow() string
func (x *Oauth2AccessCodeSecurity) GetScopes() *Oauth2Scopes
func (x *Oauth2AccessCodeSecurity) GetTokenUrl() string
func (x *Oauth2AccessCodeSecurity) GetType() string
func (x *Oauth2AccessCodeSecurity) GetVendorExtension() []*NamedAny
func (*Oauth2AccessCodeSecurity) ProtoMessage()
func (x *Oauth2AccessCodeSecurity) ProtoReflect() protoreflect.Message
func (x *Oauth2AccessCodeSecurity) Reset()
func (m *Oauth2AccessCodeSecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2AccessCodeSecurity objects.
func (x *Oauth2AccessCodeSecurity) String() string
func (m *Oauth2AccessCodeSecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2AccessCodeSecurity suitable for JSON or YAML export.
type Oauth2ApplicationSecurity struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Flow string `protobuf:"bytes,2,opt,name=flow,proto3" json:"flow,omitempty"`
Scopes *Oauth2Scopes `protobuf:"bytes,3,opt,name=scopes,proto3" json:"scopes,omitempty"`
TokenUrl string `protobuf:"bytes,4,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,6,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2ApplicationSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2ApplicationSecurity, error)
NewOauth2ApplicationSecurity creates an object of type Oauth2ApplicationSecurity if possible, returning an error if not.
func (*Oauth2ApplicationSecurity) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2ApplicationSecurity.ProtoReflect.Descriptor instead.
func (x *Oauth2ApplicationSecurity) GetDescription() string
func (x *Oauth2ApplicationSecurity) GetFlow() string
func (x *Oauth2ApplicationSecurity) GetScopes() *Oauth2Scopes
func (x *Oauth2ApplicationSecurity) GetTokenUrl() string
func (x *Oauth2ApplicationSecurity) GetType() string
func (x *Oauth2ApplicationSecurity) GetVendorExtension() []*NamedAny
func (*Oauth2ApplicationSecurity) ProtoMessage()
func (x *Oauth2ApplicationSecurity) ProtoReflect() protoreflect.Message
func (x *Oauth2ApplicationSecurity) Reset()
func (m *Oauth2ApplicationSecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2ApplicationSecurity objects.
func (x *Oauth2ApplicationSecurity) String() string
func (m *Oauth2ApplicationSecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2ApplicationSecurity suitable for JSON or YAML export.
type Oauth2ImplicitSecurity struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Flow string `protobuf:"bytes,2,opt,name=flow,proto3" json:"flow,omitempty"`
Scopes *Oauth2Scopes `protobuf:"bytes,3,opt,name=scopes,proto3" json:"scopes,omitempty"`
AuthorizationUrl string `protobuf:"bytes,4,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"`
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,6,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2ImplicitSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2ImplicitSecurity, error)
NewOauth2ImplicitSecurity creates an object of type Oauth2ImplicitSecurity if possible, returning an error if not.
func (*Oauth2ImplicitSecurity) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2ImplicitSecurity.ProtoReflect.Descriptor instead.
func (x *Oauth2ImplicitSecurity) GetAuthorizationUrl() string
func (x *Oauth2ImplicitSecurity) GetDescription() string
func (x *Oauth2ImplicitSecurity) GetFlow() string
func (x *Oauth2ImplicitSecurity) GetScopes() *Oauth2Scopes
func (x *Oauth2ImplicitSecurity) GetType() string
func (x *Oauth2ImplicitSecurity) GetVendorExtension() []*NamedAny
func (*Oauth2ImplicitSecurity) ProtoMessage()
func (x *Oauth2ImplicitSecurity) ProtoReflect() protoreflect.Message
func (x *Oauth2ImplicitSecurity) Reset()
func (m *Oauth2ImplicitSecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2ImplicitSecurity objects.
func (x *Oauth2ImplicitSecurity) String() string
func (m *Oauth2ImplicitSecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2ImplicitSecurity suitable for JSON or YAML export.
type Oauth2PasswordSecurity struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Flow string `protobuf:"bytes,2,opt,name=flow,proto3" json:"flow,omitempty"`
Scopes *Oauth2Scopes `protobuf:"bytes,3,opt,name=scopes,proto3" json:"scopes,omitempty"`
TokenUrl string `protobuf:"bytes,4,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,6,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2PasswordSecurity(in *yaml.Node, context *compiler.Context) (*Oauth2PasswordSecurity, error)
NewOauth2PasswordSecurity creates an object of type Oauth2PasswordSecurity if possible, returning an error if not.
func (*Oauth2PasswordSecurity) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2PasswordSecurity.ProtoReflect.Descriptor instead.
func (x *Oauth2PasswordSecurity) GetDescription() string
func (x *Oauth2PasswordSecurity) GetFlow() string
func (x *Oauth2PasswordSecurity) GetScopes() *Oauth2Scopes
func (x *Oauth2PasswordSecurity) GetTokenUrl() string
func (x *Oauth2PasswordSecurity) GetType() string
func (x *Oauth2PasswordSecurity) GetVendorExtension() []*NamedAny
func (*Oauth2PasswordSecurity) ProtoMessage()
func (x *Oauth2PasswordSecurity) ProtoReflect() protoreflect.Message
func (x *Oauth2PasswordSecurity) Reset()
func (m *Oauth2PasswordSecurity) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2PasswordSecurity objects.
func (x *Oauth2PasswordSecurity) String() string
func (m *Oauth2PasswordSecurity) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2PasswordSecurity suitable for JSON or YAML export.
type Oauth2Scopes struct {
AdditionalProperties []*NamedString `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2Scopes(in *yaml.Node, context *compiler.Context) (*Oauth2Scopes, error)
NewOauth2Scopes creates an object of type Oauth2Scopes if possible, returning an error if not.
func (*Oauth2Scopes) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2Scopes.ProtoReflect.Descriptor instead.
func (x *Oauth2Scopes) GetAdditionalProperties() []*NamedString
func (*Oauth2Scopes) ProtoMessage()
func (x *Oauth2Scopes) ProtoReflect() protoreflect.Message
func (x *Oauth2Scopes) Reset()
func (m *Oauth2Scopes) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2Scopes objects.
func (x *Oauth2Scopes) String() string
func (m *Oauth2Scopes) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2Scopes suitable for JSON or YAML export.
type Operation struct {
Tags []string `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
// A brief summary of the operation.
Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
// A longer description of the operation, GitHub Flavored Markdown is allowed.
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"`
// A unique identifier of the operation.
OperationId string `protobuf:"bytes,5,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
// A list of MIME types the API can produce.
Produces []string `protobuf:"bytes,6,rep,name=produces,proto3" json:"produces,omitempty"`
// A list of MIME types the API can consume.
Consumes []string `protobuf:"bytes,7,rep,name=consumes,proto3" json:"consumes,omitempty"`
// The parameters needed to send a valid API call.
Parameters []*ParametersItem `protobuf:"bytes,8,rep,name=parameters,proto3" json:"parameters,omitempty"`
Responses *Responses `protobuf:"bytes,9,opt,name=responses,proto3" json:"responses,omitempty"`
// The transfer protocol of the API.
Schemes []string `protobuf:"bytes,10,rep,name=schemes,proto3" json:"schemes,omitempty"`
Deprecated bool `protobuf:"varint,11,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
Security []*SecurityRequirement `protobuf:"bytes,12,rep,name=security,proto3" json:"security,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,13,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetConsumes() []string
func (x *Operation) GetDeprecated() bool
func (x *Operation) GetDescription() string
func (x *Operation) GetExternalDocs() *ExternalDocs
func (x *Operation) GetOperationId() string
func (x *Operation) GetParameters() []*ParametersItem
func (x *Operation) GetProduces() []string
func (x *Operation) GetResponses() *Responses
func (x *Operation) GetSchemes() []string
func (x *Operation) GetSecurity() []*SecurityRequirement
func (x *Operation) GetSummary() string
func (x *Operation) GetTags() []string
func (x *Operation) GetVendorExtension() []*NamedAny
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.
type Parameter struct {
// Types that are assignable to Oneof:
// *Parameter_BodyParameter
// *Parameter_NonBodyParameter
Oneof isParameter_Oneof `protobuf_oneof:"oneof"`
// 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) GetBodyParameter() *BodyParameter
func (x *Parameter) GetNonBodyParameter() *NonBodyParameter
func (m *Parameter) GetOneof() isParameter_Oneof
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.
One or more JSON representations for parameters
type ParameterDefinitions struct {
AdditionalProperties []*NamedParameter `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewParameterDefinitions(in *yaml.Node, context *compiler.Context) (*ParameterDefinitions, error)
NewParameterDefinitions creates an object of type ParameterDefinitions if possible, returning an error if not.
func (*ParameterDefinitions) Descriptor() ([]byte, []int)
Deprecated: Use ParameterDefinitions.ProtoReflect.Descriptor instead.
func (x *ParameterDefinitions) GetAdditionalProperties() []*NamedParameter
func (*ParameterDefinitions) ProtoMessage()
func (x *ParameterDefinitions) ProtoReflect() protoreflect.Message
func (x *ParameterDefinitions) Reset()
func (m *ParameterDefinitions) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ParameterDefinitions objects.
func (x *ParameterDefinitions) String() string
func (m *ParameterDefinitions) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ParameterDefinitions suitable for JSON or YAML export.
type Parameter_BodyParameter struct {
BodyParameter *BodyParameter `protobuf:"bytes,1,opt,name=body_parameter,json=bodyParameter,proto3,oneof"`
}
type Parameter_NonBodyParameter struct {
NonBodyParameter *NonBodyParameter `protobuf:"bytes,2,opt,name=non_body_parameter,json=nonBodyParameter,proto3,oneof"`
}
type ParametersItem struct {
// Types that are assignable to Oneof:
// *ParametersItem_Parameter
// *ParametersItem_JsonReference
Oneof isParametersItem_Oneof `protobuf_oneof:"oneof"`
// contains filtered or unexported fields
}
func NewParametersItem(in *yaml.Node, context *compiler.Context) (*ParametersItem, error)
NewParametersItem creates an object of type ParametersItem if possible, returning an error if not.
func (*ParametersItem) Descriptor() ([]byte, []int)
Deprecated: Use ParametersItem.ProtoReflect.Descriptor instead.
func (x *ParametersItem) GetJsonReference() *JsonReference
func (m *ParametersItem) GetOneof() isParametersItem_Oneof
func (x *ParametersItem) GetParameter() *Parameter
func (*ParametersItem) ProtoMessage()
func (x *ParametersItem) ProtoReflect() protoreflect.Message
func (x *ParametersItem) Reset()
func (m *ParametersItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ParametersItem objects.
func (x *ParametersItem) String() string
func (m *ParametersItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ParametersItem suitable for JSON or YAML export.
type ParametersItem_JsonReference struct {
JsonReference *JsonReference `protobuf:"bytes,2,opt,name=json_reference,json=jsonReference,proto3,oneof"`
}
type ParametersItem_Parameter struct {
Parameter *Parameter `protobuf:"bytes,1,opt,name=parameter,proto3,oneof"`
}
type PathItem struct {
XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
Get *Operation `protobuf:"bytes,2,opt,name=get,proto3" json:"get,omitempty"`
Put *Operation `protobuf:"bytes,3,opt,name=put,proto3" json:"put,omitempty"`
Post *Operation `protobuf:"bytes,4,opt,name=post,proto3" json:"post,omitempty"`
Delete *Operation `protobuf:"bytes,5,opt,name=delete,proto3" json:"delete,omitempty"`
Options *Operation `protobuf:"bytes,6,opt,name=options,proto3" json:"options,omitempty"`
Head *Operation `protobuf:"bytes,7,opt,name=head,proto3" json:"head,omitempty"`
Patch *Operation `protobuf:"bytes,8,opt,name=patch,proto3" json:"patch,omitempty"`
// The parameters needed to send a valid API call.
Parameters []*ParametersItem `protobuf:"bytes,9,rep,name=parameters,proto3" json:"parameters,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,10,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetGet() *Operation
func (x *PathItem) GetHead() *Operation
func (x *PathItem) GetOptions() *Operation
func (x *PathItem) GetParameters() []*ParametersItem
func (x *PathItem) GetPatch() *Operation
func (x *PathItem) GetPost() *Operation
func (x *PathItem) GetPut() *Operation
func (x *PathItem) GetVendorExtension() []*NamedAny
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.
type PathParameterSubSchema struct {
// Determines whether or not this parameter is required or optional.
Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
// Determines the location of the parameter.
In string `protobuf:"bytes,2,opt,name=in,proto3" json:"in,omitempty"`
// A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The name of the parameter.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
Type string `protobuf:"bytes,5,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,6,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,7,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,8,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,9,opt,name=default,proto3" json:"default,omitempty"`
Maximum float64 `protobuf:"fixed64,10,opt,name=maximum,proto3" json:"maximum,omitempty"`
ExclusiveMaximum bool `protobuf:"varint,11,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
Minimum float64 `protobuf:"fixed64,12,opt,name=minimum,proto3" json:"minimum,omitempty"`
ExclusiveMinimum bool `protobuf:"varint,13,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
MaxLength int64 `protobuf:"varint,14,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
MinLength int64 `protobuf:"varint,15,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
Pattern string `protobuf:"bytes,16,opt,name=pattern,proto3" json:"pattern,omitempty"`
MaxItems int64 `protobuf:"varint,17,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
MinItems int64 `protobuf:"varint,18,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
UniqueItems bool `protobuf:"varint,19,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
Enum []*Any `protobuf:"bytes,20,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,21,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,22,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewPathParameterSubSchema(in *yaml.Node, context *compiler.Context) (*PathParameterSubSchema, error)
NewPathParameterSubSchema creates an object of type PathParameterSubSchema if possible, returning an error if not.
func (*PathParameterSubSchema) Descriptor() ([]byte, []int)
Deprecated: Use PathParameterSubSchema.ProtoReflect.Descriptor instead.
func (x *PathParameterSubSchema) GetCollectionFormat() string
func (x *PathParameterSubSchema) GetDefault() *Any
func (x *PathParameterSubSchema) GetDescription() string
func (x *PathParameterSubSchema) GetEnum() []*Any
func (x *PathParameterSubSchema) GetExclusiveMaximum() bool
func (x *PathParameterSubSchema) GetExclusiveMinimum() bool
func (x *PathParameterSubSchema) GetFormat() string
func (x *PathParameterSubSchema) GetIn() string
func (x *PathParameterSubSchema) GetItems() *PrimitivesItems
func (x *PathParameterSubSchema) GetMaxItems() int64
func (x *PathParameterSubSchema) GetMaxLength() int64
func (x *PathParameterSubSchema) GetMaximum() float64
func (x *PathParameterSubSchema) GetMinItems() int64
func (x *PathParameterSubSchema) GetMinLength() int64
func (x *PathParameterSubSchema) GetMinimum() float64
func (x *PathParameterSubSchema) GetMultipleOf() float64
func (x *PathParameterSubSchema) GetName() string
func (x *PathParameterSubSchema) GetPattern() string
func (x *PathParameterSubSchema) GetRequired() bool
func (x *PathParameterSubSchema) GetType() string
func (x *PathParameterSubSchema) GetUniqueItems() bool
func (x *PathParameterSubSchema) GetVendorExtension() []*NamedAny
func (*PathParameterSubSchema) ProtoMessage()
func (x *PathParameterSubSchema) ProtoReflect() protoreflect.Message
func (x *PathParameterSubSchema) Reset()
func (m *PathParameterSubSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside PathParameterSubSchema objects.
func (x *PathParameterSubSchema) String() string
func (m *PathParameterSubSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of PathParameterSubSchema suitable for JSON or YAML export.
Relative paths to the individual endpoints. They must be relative to the 'basePath'.
type Paths struct {
VendorExtension []*NamedAny `protobuf:"bytes,1,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
Path []*NamedPathItem `protobuf:"bytes,2,rep,name=path,proto3" json:"path,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) GetVendorExtension() []*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 PrimitivesItems struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,3,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,4,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`
Maximum float64 `protobuf:"fixed64,6,opt,name=maximum,proto3" json:"maximum,omitempty"`
ExclusiveMaximum bool `protobuf:"varint,7,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
Minimum float64 `protobuf:"fixed64,8,opt,name=minimum,proto3" json:"minimum,omitempty"`
ExclusiveMinimum bool `protobuf:"varint,9,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
MaxLength int64 `protobuf:"varint,10,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
MinLength int64 `protobuf:"varint,11,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
Pattern string `protobuf:"bytes,12,opt,name=pattern,proto3" json:"pattern,omitempty"`
MaxItems int64 `protobuf:"varint,13,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
MinItems int64 `protobuf:"varint,14,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
UniqueItems bool `protobuf:"varint,15,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
Enum []*Any `protobuf:"bytes,16,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,17,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,18,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewPrimitivesItems(in *yaml.Node, context *compiler.Context) (*PrimitivesItems, error)
NewPrimitivesItems creates an object of type PrimitivesItems if possible, returning an error if not.
func (*PrimitivesItems) Descriptor() ([]byte, []int)
Deprecated: Use PrimitivesItems.ProtoReflect.Descriptor instead.
func (x *PrimitivesItems) GetCollectionFormat() string
func (x *PrimitivesItems) GetDefault() *Any
func (x *PrimitivesItems) GetEnum() []*Any
func (x *PrimitivesItems) GetExclusiveMaximum() bool
func (x *PrimitivesItems) GetExclusiveMinimum() bool
func (x *PrimitivesItems) GetFormat() string
func (x *PrimitivesItems) GetItems() *PrimitivesItems
func (x *PrimitivesItems) GetMaxItems() int64
func (x *PrimitivesItems) GetMaxLength() int64
func (x *PrimitivesItems) GetMaximum() float64
func (x *PrimitivesItems) GetMinItems() int64
func (x *PrimitivesItems) GetMinLength() int64
func (x *PrimitivesItems) GetMinimum() float64
func (x *PrimitivesItems) GetMultipleOf() float64
func (x *PrimitivesItems) GetPattern() string
func (x *PrimitivesItems) GetType() string
func (x *PrimitivesItems) GetUniqueItems() bool
func (x *PrimitivesItems) GetVendorExtension() []*NamedAny
func (*PrimitivesItems) ProtoMessage()
func (x *PrimitivesItems) ProtoReflect() protoreflect.Message
func (x *PrimitivesItems) Reset()
func (m *PrimitivesItems) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside PrimitivesItems objects.
func (x *PrimitivesItems) String() string
func (m *PrimitivesItems) ToRawInfo() *yaml.Node
ToRawInfo returns a description of PrimitivesItems suitable for JSON or YAML export.
type Properties struct {
AdditionalProperties []*NamedSchema `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() []*NamedSchema
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.
type QueryParameterSubSchema struct {
// Determines whether or not this parameter is required or optional.
Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
// Determines the location of the parameter.
In string `protobuf:"bytes,2,opt,name=in,proto3" json:"in,omitempty"`
// A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The name of the parameter.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// allows sending a parameter by name only or with an empty value.
AllowEmptyValue bool `protobuf:"varint,5,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
Format string `protobuf:"bytes,7,opt,name=format,proto3" json:"format,omitempty"`
Items *PrimitivesItems `protobuf:"bytes,8,opt,name=items,proto3" json:"items,omitempty"`
CollectionFormat string `protobuf:"bytes,9,opt,name=collection_format,json=collectionFormat,proto3" json:"collection_format,omitempty"`
Default *Any `protobuf:"bytes,10,opt,name=default,proto3" json:"default,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"`
Enum []*Any `protobuf:"bytes,21,rep,name=enum,proto3" json:"enum,omitempty"`
MultipleOf float64 `protobuf:"fixed64,22,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,23,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_extension,omitempty"`
// contains filtered or unexported fields
}
func NewQueryParameterSubSchema(in *yaml.Node, context *compiler.Context) (*QueryParameterSubSchema, error)
NewQueryParameterSubSchema creates an object of type QueryParameterSubSchema if possible, returning an error if not.
func (*QueryParameterSubSchema) Descriptor() ([]byte, []int)
Deprecated: Use QueryParameterSubSchema.ProtoReflect.Descriptor instead.
func (x *QueryParameterSubSchema) GetAllowEmptyValue() bool
func (x *QueryParameterSubSchema) GetCollectionFormat() string
func (x *QueryParameterSubSchema) GetDefault() *Any
func (x *QueryParameterSubSchema) GetDescription() string
func (x *QueryParameterSubSchema) GetEnum() []*Any
func (x *QueryParameterSubSchema) GetExclusiveMaximum() bool
func (x *QueryParameterSubSchema) GetExclusiveMinimum() bool
func (x *QueryParameterSubSchema) GetFormat() string
func (x *QueryParameterSubSchema) GetIn() string
func (x *QueryParameterSubSchema) GetItems() *PrimitivesItems
func (x *QueryParameterSubSchema) GetMaxItems() int64
func (x *QueryParameterSubSchema) GetMaxLength() int64
func (x *QueryParameterSubSchema) GetMaximum() float64
func (x *QueryParameterSubSchema) GetMinItems() int64
func (x *QueryParameterSubSchema) GetMinLength() int64
func (x *QueryParameterSubSchema) GetMinimum() float64
func (x *QueryParameterSubSchema) GetMultipleOf() float64
func (x *QueryParameterSubSchema) GetName() string
func (x *QueryParameterSubSchema) GetPattern() string
func (x *QueryParameterSubSchema) GetRequired() bool
func (x *QueryParameterSubSchema) GetType() string
func (x *QueryParameterSubSchema) GetUniqueItems() bool
func (x *QueryParameterSubSchema) GetVendorExtension() []*NamedAny
func (*QueryParameterSubSchema) ProtoMessage()
func (x *QueryParameterSubSchema) ProtoReflect() protoreflect.Message
func (x *QueryParameterSubSchema) Reset()
func (m *QueryParameterSubSchema) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside QueryParameterSubSchema objects.
func (x *QueryParameterSubSchema) String() string
func (m *QueryParameterSubSchema) ToRawInfo() *yaml.Node
ToRawInfo returns a description of QueryParameterSubSchema suitable for JSON or YAML export.
type Response struct {
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
Schema *SchemaItem `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
Headers *Headers `protobuf:"bytes,3,opt,name=headers,proto3" json:"headers,omitempty"`
Examples *Examples `protobuf:"bytes,4,opt,name=examples,proto3" json:"examples,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,5,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetDescription() string
func (x *Response) GetExamples() *Examples
func (x *Response) GetHeaders() *Headers
func (x *Response) GetSchema() *SchemaItem
func (x *Response) GetVendorExtension() []*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.
One or more JSON representations for responses
type ResponseDefinitions struct {
AdditionalProperties []*NamedResponse `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewResponseDefinitions(in *yaml.Node, context *compiler.Context) (*ResponseDefinitions, error)
NewResponseDefinitions creates an object of type ResponseDefinitions if possible, returning an error if not.
func (*ResponseDefinitions) Descriptor() ([]byte, []int)
Deprecated: Use ResponseDefinitions.ProtoReflect.Descriptor instead.
func (x *ResponseDefinitions) GetAdditionalProperties() []*NamedResponse
func (*ResponseDefinitions) ProtoMessage()
func (x *ResponseDefinitions) ProtoReflect() protoreflect.Message
func (x *ResponseDefinitions) Reset()
func (m *ResponseDefinitions) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ResponseDefinitions objects.
func (x *ResponseDefinitions) String() string
func (m *ResponseDefinitions) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ResponseDefinitions suitable for JSON or YAML export.
type ResponseValue struct {
// Types that are assignable to Oneof:
// *ResponseValue_Response
// *ResponseValue_JsonReference
Oneof isResponseValue_Oneof `protobuf_oneof:"oneof"`
// contains filtered or unexported fields
}
func NewResponseValue(in *yaml.Node, context *compiler.Context) (*ResponseValue, error)
NewResponseValue creates an object of type ResponseValue if possible, returning an error if not.
func (*ResponseValue) Descriptor() ([]byte, []int)
Deprecated: Use ResponseValue.ProtoReflect.Descriptor instead.
func (x *ResponseValue) GetJsonReference() *JsonReference
func (m *ResponseValue) GetOneof() isResponseValue_Oneof
func (x *ResponseValue) GetResponse() *Response
func (*ResponseValue) ProtoMessage()
func (x *ResponseValue) ProtoReflect() protoreflect.Message
func (x *ResponseValue) Reset()
func (m *ResponseValue) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside ResponseValue objects.
func (x *ResponseValue) String() string
func (m *ResponseValue) ToRawInfo() *yaml.Node
ToRawInfo returns a description of ResponseValue suitable for JSON or YAML export.
type ResponseValue_JsonReference struct {
JsonReference *JsonReference `protobuf:"bytes,2,opt,name=json_reference,json=jsonReference,proto3,oneof"`
}
type ResponseValue_Response struct {
Response *Response `protobuf:"bytes,1,opt,name=response,proto3,oneof"`
}
Response objects names can either be any valid HTTP status code or 'default'.
type Responses struct {
ResponseCode []*NamedResponseValue `protobuf:"bytes,1,rep,name=response_code,json=responseCode,proto3" json:"response_code,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,2,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetResponseCode() []*NamedResponseValue
func (x *Responses) GetVendorExtension() []*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.
A deterministic version of a JSON Schema object.
type Schema struct {
XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
Default *Any `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`
MultipleOf float64 `protobuf:"fixed64,6,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
Maximum float64 `protobuf:"fixed64,7,opt,name=maximum,proto3" json:"maximum,omitempty"`
ExclusiveMaximum bool `protobuf:"varint,8,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
Minimum float64 `protobuf:"fixed64,9,opt,name=minimum,proto3" json:"minimum,omitempty"`
ExclusiveMinimum bool `protobuf:"varint,10,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
MaxLength int64 `protobuf:"varint,11,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
MinLength int64 `protobuf:"varint,12,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
Pattern string `protobuf:"bytes,13,opt,name=pattern,proto3" json:"pattern,omitempty"`
MaxItems int64 `protobuf:"varint,14,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
MinItems int64 `protobuf:"varint,15,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
UniqueItems bool `protobuf:"varint,16,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
MaxProperties int64 `protobuf:"varint,17,opt,name=max_properties,json=maxProperties,proto3" json:"max_properties,omitempty"`
MinProperties int64 `protobuf:"varint,18,opt,name=min_properties,json=minProperties,proto3" json:"min_properties,omitempty"`
Required []string `protobuf:"bytes,19,rep,name=required,proto3" json:"required,omitempty"`
Enum []*Any `protobuf:"bytes,20,rep,name=enum,proto3" json:"enum,omitempty"`
AdditionalProperties *AdditionalPropertiesItem `protobuf:"bytes,21,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
Type *TypeItem `protobuf:"bytes,22,opt,name=type,proto3" json:"type,omitempty"`
Items *ItemsItem `protobuf:"bytes,23,opt,name=items,proto3" json:"items,omitempty"`
AllOf []*Schema `protobuf:"bytes,24,rep,name=all_of,json=allOf,proto3" json:"all_of,omitempty"`
Properties *Properties `protobuf:"bytes,25,opt,name=properties,proto3" json:"properties,omitempty"`
Discriminator string `protobuf:"bytes,26,opt,name=discriminator,proto3" json:"discriminator,omitempty"`
ReadOnly bool `protobuf:"varint,27,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
Xml *Xml `protobuf:"bytes,28,opt,name=xml,proto3" json:"xml,omitempty"`
ExternalDocs *ExternalDocs `protobuf:"bytes,29,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
Example *Any `protobuf:"bytes,30,opt,name=example,proto3" json:"example,omitempty"`
VendorExtension []*NamedAny `protobuf:"bytes,31,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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() []*Schema
func (x *Schema) GetDefault() *Any
func (x *Schema) GetDescription() string
func (x *Schema) GetDiscriminator() string
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) GetPattern() string
func (x *Schema) GetProperties() *Properties
func (x *Schema) GetReadOnly() bool
func (x *Schema) GetRequired() []string
func (x *Schema) GetTitle() string
func (x *Schema) GetType() *TypeItem
func (x *Schema) GetUniqueItems() bool
func (x *Schema) GetVendorExtension() []*NamedAny
func (x *Schema) GetXRef() string
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 SchemaItem struct {
// Types that are assignable to Oneof:
// *SchemaItem_Schema
// *SchemaItem_FileSchema
Oneof isSchemaItem_Oneof `protobuf_oneof:"oneof"`
// contains filtered or unexported fields
}
func NewSchemaItem(in *yaml.Node, context *compiler.Context) (*SchemaItem, error)
NewSchemaItem creates an object of type SchemaItem if possible, returning an error if not.
func (*SchemaItem) Descriptor() ([]byte, []int)
Deprecated: Use SchemaItem.ProtoReflect.Descriptor instead.
func (x *SchemaItem) GetFileSchema() *FileSchema
func (m *SchemaItem) GetOneof() isSchemaItem_Oneof
func (x *SchemaItem) GetSchema() *Schema
func (*SchemaItem) ProtoMessage()
func (x *SchemaItem) ProtoReflect() protoreflect.Message
func (x *SchemaItem) Reset()
func (m *SchemaItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SchemaItem objects.
func (x *SchemaItem) String() string
func (m *SchemaItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SchemaItem suitable for JSON or YAML export.
type SchemaItem_FileSchema struct {
FileSchema *FileSchema `protobuf:"bytes,2,opt,name=file_schema,json=fileSchema,proto3,oneof"`
}
type SchemaItem_Schema struct {
Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3,oneof"`
}
type SecurityDefinitions struct {
AdditionalProperties []*NamedSecurityDefinitionsItem `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewSecurityDefinitions(in *yaml.Node, context *compiler.Context) (*SecurityDefinitions, error)
NewSecurityDefinitions creates an object of type SecurityDefinitions if possible, returning an error if not.
func (*SecurityDefinitions) Descriptor() ([]byte, []int)
Deprecated: Use SecurityDefinitions.ProtoReflect.Descriptor instead.
func (x *SecurityDefinitions) GetAdditionalProperties() []*NamedSecurityDefinitionsItem
func (*SecurityDefinitions) ProtoMessage()
func (x *SecurityDefinitions) ProtoReflect() protoreflect.Message
func (x *SecurityDefinitions) Reset()
func (m *SecurityDefinitions) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecurityDefinitions objects.
func (x *SecurityDefinitions) String() string
func (m *SecurityDefinitions) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecurityDefinitions suitable for JSON or YAML export.
type SecurityDefinitionsItem struct {
// Types that are assignable to Oneof:
// *SecurityDefinitionsItem_BasicAuthenticationSecurity
// *SecurityDefinitionsItem_ApiKeySecurity
// *SecurityDefinitionsItem_Oauth2ImplicitSecurity
// *SecurityDefinitionsItem_Oauth2PasswordSecurity
// *SecurityDefinitionsItem_Oauth2ApplicationSecurity
// *SecurityDefinitionsItem_Oauth2AccessCodeSecurity
Oneof isSecurityDefinitionsItem_Oneof `protobuf_oneof:"oneof"`
// contains filtered or unexported fields
}
func NewSecurityDefinitionsItem(in *yaml.Node, context *compiler.Context) (*SecurityDefinitionsItem, error)
NewSecurityDefinitionsItem creates an object of type SecurityDefinitionsItem if possible, returning an error if not.
func (*SecurityDefinitionsItem) Descriptor() ([]byte, []int)
Deprecated: Use SecurityDefinitionsItem.ProtoReflect.Descriptor instead.
func (x *SecurityDefinitionsItem) GetApiKeySecurity() *ApiKeySecurity
func (x *SecurityDefinitionsItem) GetBasicAuthenticationSecurity() *BasicAuthenticationSecurity
func (x *SecurityDefinitionsItem) GetOauth2AccessCodeSecurity() *Oauth2AccessCodeSecurity
func (x *SecurityDefinitionsItem) GetOauth2ApplicationSecurity() *Oauth2ApplicationSecurity
func (x *SecurityDefinitionsItem) GetOauth2ImplicitSecurity() *Oauth2ImplicitSecurity
func (x *SecurityDefinitionsItem) GetOauth2PasswordSecurity() *Oauth2PasswordSecurity
func (m *SecurityDefinitionsItem) GetOneof() isSecurityDefinitionsItem_Oneof
func (*SecurityDefinitionsItem) ProtoMessage()
func (x *SecurityDefinitionsItem) ProtoReflect() protoreflect.Message
func (x *SecurityDefinitionsItem) Reset()
func (m *SecurityDefinitionsItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside SecurityDefinitionsItem objects.
func (x *SecurityDefinitionsItem) String() string
func (m *SecurityDefinitionsItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of SecurityDefinitionsItem suitable for JSON or YAML export.
type SecurityDefinitionsItem_ApiKeySecurity struct {
ApiKeySecurity *ApiKeySecurity `protobuf:"bytes,2,opt,name=api_key_security,json=apiKeySecurity,proto3,oneof"`
}
type SecurityDefinitionsItem_BasicAuthenticationSecurity struct {
BasicAuthenticationSecurity *BasicAuthenticationSecurity `protobuf:"bytes,1,opt,name=basic_authentication_security,json=basicAuthenticationSecurity,proto3,oneof"`
}
type SecurityDefinitionsItem_Oauth2AccessCodeSecurity struct {
Oauth2AccessCodeSecurity *Oauth2AccessCodeSecurity `protobuf:"bytes,6,opt,name=oauth2_access_code_security,json=oauth2AccessCodeSecurity,proto3,oneof"`
}
type SecurityDefinitionsItem_Oauth2ApplicationSecurity struct {
Oauth2ApplicationSecurity *Oauth2ApplicationSecurity `protobuf:"bytes,5,opt,name=oauth2_application_security,json=oauth2ApplicationSecurity,proto3,oneof"`
}
type SecurityDefinitionsItem_Oauth2ImplicitSecurity struct {
Oauth2ImplicitSecurity *Oauth2ImplicitSecurity `protobuf:"bytes,3,opt,name=oauth2_implicit_security,json=oauth2ImplicitSecurity,proto3,oneof"`
}
type SecurityDefinitionsItem_Oauth2PasswordSecurity struct {
Oauth2PasswordSecurity *Oauth2PasswordSecurity `protobuf:"bytes,4,opt,name=oauth2_password_security,json=oauth2PasswordSecurity,proto3,oneof"`
}
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.
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 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"`
VendorExtension []*NamedAny `protobuf:"bytes,4,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetVendorExtension() []*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.
type TypeItem struct {
Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewTypeItem(in *yaml.Node, context *compiler.Context) (*TypeItem, error)
NewTypeItem creates an object of type TypeItem if possible, returning an error if not.
func (*TypeItem) Descriptor() ([]byte, []int)
Deprecated: Use TypeItem.ProtoReflect.Descriptor instead.
func (x *TypeItem) GetValue() []string
func (*TypeItem) ProtoMessage()
func (x *TypeItem) ProtoReflect() protoreflect.Message
func (x *TypeItem) Reset()
func (m *TypeItem) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside TypeItem objects.
func (x *TypeItem) String() string
func (m *TypeItem) ToRawInfo() *yaml.Node
ToRawInfo returns a description of TypeItem suitable for JSON or YAML export.
Any property starting with x- is valid.
type VendorExtension struct {
AdditionalProperties []*NamedAny `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewVendorExtension(in *yaml.Node, context *compiler.Context) (*VendorExtension, error)
NewVendorExtension creates an object of type VendorExtension if possible, returning an error if not.
func (*VendorExtension) Descriptor() ([]byte, []int)
Deprecated: Use VendorExtension.ProtoReflect.Descriptor instead.
func (x *VendorExtension) GetAdditionalProperties() []*NamedAny
func (*VendorExtension) ProtoMessage()
func (x *VendorExtension) ProtoReflect() protoreflect.Message
func (x *VendorExtension) Reset()
func (m *VendorExtension) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside VendorExtension objects.
func (x *VendorExtension) String() string
func (m *VendorExtension) ToRawInfo() *yaml.Node
ToRawInfo returns a description of VendorExtension suitable for JSON or YAML export.
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"`
VendorExtension []*NamedAny `protobuf:"bytes,6,rep,name=vendor_extension,json=vendorExtension,proto3" json:"vendor_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) GetVendorExtension() []*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.