APIsListServiceURL is the URL for the Google APIs Discovery Service
const APIsListServiceURL = "https://www.googleapis.com/discovery/v1/apis"
var File_discovery_discovery_proto protoreflect.FileDescriptor
func FetchDocumentBytes(documentURL string) ([]byte, error)
FetchDocumentBytes downloads the bytes of a discovery document from a URL.
func FetchListBytes() ([]byte, error)
func Version() string
Version returns the package name (and OpenAPI version).
An API represents an API description returned by the apis/list API.
type API struct {
Kind string `json:"kind"`
ID string `json:"id"`
Name string `json:"name"`
Version string `json:"version"`
Title string `json:"title"`
Description string `json:"description"`
DiscoveryRestURL string `json:"discoveryRestUrl"`
DiscoveryLink string `json:"discoveryLink"`
Icons map[string]string `json:"icons"`
DocumentationLink string `json:"documentationLink"`
Labels []string `json:"labels"`
Preferred bool `json:"preferred"`
}
type Annotations struct {
Required []string `protobuf:"bytes,1,rep,name=required,proto3" json:"required,omitempty"`
// contains filtered or unexported fields
}
func NewAnnotations(in *yaml.Node, context *compiler.Context) (*Annotations, error)
NewAnnotations creates an object of type Annotations if possible, returning an error if not.
func (*Annotations) Descriptor() ([]byte, []int)
Deprecated: Use Annotations.ProtoReflect.Descriptor instead.
func (x *Annotations) GetRequired() []string
func (*Annotations) ProtoMessage()
func (x *Annotations) ProtoReflect() protoreflect.Message
func (x *Annotations) Reset()
func (m *Annotations) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Annotations objects.
func (x *Annotations) String() string
func (m *Annotations) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Annotations suitable for JSON or YAML export.
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 Auth struct {
Oauth2 *Oauth2 `protobuf:"bytes,1,opt,name=oauth2,proto3" json:"oauth2,omitempty"`
// contains filtered or unexported fields
}
func NewAuth(in *yaml.Node, context *compiler.Context) (*Auth, error)
NewAuth creates an object of type Auth if possible, returning an error if not.
func (*Auth) Descriptor() ([]byte, []int)
Deprecated: Use Auth.ProtoReflect.Descriptor instead.
func (x *Auth) GetOauth2() *Oauth2
func (*Auth) ProtoMessage()
func (x *Auth) ProtoReflect() protoreflect.Message
func (x *Auth) Reset()
func (m *Auth) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Auth objects.
func (x *Auth) String() string
func (m *Auth) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Auth suitable for JSON or YAML export.
type Document struct {
Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
DiscoveryVersion string `protobuf:"bytes,2,opt,name=discovery_version,json=discoveryVersion,proto3" json:"discovery_version,omitempty"`
Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
Revision string `protobuf:"bytes,6,opt,name=revision,proto3" json:"revision,omitempty"`
Title string `protobuf:"bytes,7,opt,name=title,proto3" json:"title,omitempty"`
Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
Icons *Icons `protobuf:"bytes,9,opt,name=icons,proto3" json:"icons,omitempty"`
DocumentationLink string `protobuf:"bytes,10,opt,name=documentation_link,json=documentationLink,proto3" json:"documentation_link,omitempty"`
Labels []string `protobuf:"bytes,11,rep,name=labels,proto3" json:"labels,omitempty"`
Protocol string `protobuf:"bytes,12,opt,name=protocol,proto3" json:"protocol,omitempty"`
BaseUrl string `protobuf:"bytes,13,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"`
BasePath string `protobuf:"bytes,14,opt,name=base_path,json=basePath,proto3" json:"base_path,omitempty"`
RootUrl string `protobuf:"bytes,15,opt,name=root_url,json=rootUrl,proto3" json:"root_url,omitempty"`
ServicePath string `protobuf:"bytes,16,opt,name=service_path,json=servicePath,proto3" json:"service_path,omitempty"`
BatchPath string `protobuf:"bytes,17,opt,name=batch_path,json=batchPath,proto3" json:"batch_path,omitempty"`
Parameters *Parameters `protobuf:"bytes,18,opt,name=parameters,proto3" json:"parameters,omitempty"`
Auth *Auth `protobuf:"bytes,19,opt,name=auth,proto3" json:"auth,omitempty"`
Features []string `protobuf:"bytes,20,rep,name=features,proto3" json:"features,omitempty"`
Schemas *Schemas `protobuf:"bytes,21,opt,name=schemas,proto3" json:"schemas,omitempty"`
Methods *Methods `protobuf:"bytes,22,opt,name=methods,proto3" json:"methods,omitempty"`
Resources *Resources `protobuf:"bytes,23,opt,name=resources,proto3" json:"resources,omitempty"`
Etag string `protobuf:"bytes,24,opt,name=etag,proto3" json:"etag,omitempty"`
OwnerDomain string `protobuf:"bytes,25,opt,name=owner_domain,json=ownerDomain,proto3" json:"owner_domain,omitempty"`
OwnerName string `protobuf:"bytes,26,opt,name=owner_name,json=ownerName,proto3" json:"owner_name,omitempty"`
VersionModule bool `protobuf:"varint,27,opt,name=version_module,json=versionModule,proto3" json:"version_module,omitempty"`
CanonicalName string `protobuf:"bytes,28,opt,name=canonical_name,json=canonicalName,proto3" json:"canonical_name,omitempty"`
FullyEncodeReservedExpansion bool `protobuf:"varint,29,opt,name=fully_encode_reserved_expansion,json=fullyEncodeReservedExpansion,proto3" json:"fully_encode_reserved_expansion,omitempty"`
PackagePath string `protobuf:"bytes,30,opt,name=package_path,json=packagePath,proto3" json:"package_path,omitempty"`
MtlsRootUrl string `protobuf:"bytes,31,opt,name=mtls_root_url,json=mtlsRootUrl,proto3" json:"mtls_root_url,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 a Discovery description from a YAML/JSON representation.
func (*Document) Descriptor() ([]byte, []int)
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (x *Document) GetAuth() *Auth
func (x *Document) GetBasePath() string
func (x *Document) GetBaseUrl() string
func (x *Document) GetBatchPath() string
func (x *Document) GetCanonicalName() string
func (x *Document) GetDescription() string
func (x *Document) GetDiscoveryVersion() string
func (x *Document) GetDocumentationLink() string
func (x *Document) GetEtag() string
func (x *Document) GetFeatures() []string
func (x *Document) GetFullyEncodeReservedExpansion() bool
func (x *Document) GetIcons() *Icons
func (x *Document) GetId() string
func (x *Document) GetKind() string
func (x *Document) GetLabels() []string
func (x *Document) GetMethods() *Methods
func (x *Document) GetMtlsRootUrl() string
func (x *Document) GetName() string
func (x *Document) GetOwnerDomain() string
func (x *Document) GetOwnerName() string
func (x *Document) GetPackagePath() string
func (x *Document) GetParameters() *Parameters
func (x *Document) GetProtocol() string
func (x *Document) GetResources() *Resources
func (x *Document) GetRevision() string
func (x *Document) GetRootUrl() string
func (x *Document) GetSchemas() *Schemas
func (x *Document) GetServicePath() string
func (x *Document) GetTitle() string
func (x *Document) GetVersion() string
func (x *Document) GetVersionModule() bool
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.
Icons that represent the API.
type Icons struct {
X16 string `protobuf:"bytes,1,opt,name=x16,proto3" json:"x16,omitempty"`
X32 string `protobuf:"bytes,2,opt,name=x32,proto3" json:"x32,omitempty"`
// contains filtered or unexported fields
}
func NewIcons(in *yaml.Node, context *compiler.Context) (*Icons, error)
NewIcons creates an object of type Icons if possible, returning an error if not.
func (*Icons) Descriptor() ([]byte, []int)
Deprecated: Use Icons.ProtoReflect.Descriptor instead.
func (x *Icons) GetX16() string
func (x *Icons) GetX32() string
func (*Icons) ProtoMessage()
func (x *Icons) ProtoReflect() protoreflect.Message
func (x *Icons) Reset()
func (m *Icons) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Icons objects.
func (x *Icons) String() string
func (m *Icons) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Icons suitable for JSON or YAML export.
A List represents the results of a call to the apis/list API. https://developers.google.com/discovery/v1/reference/apis/list
type List struct {
Kind string `json:"kind"`
DiscoveryVersion string `json:"discoveryVersion"`
APIs []*API `json:"items"`
}
func FetchList() (*List, error)
Read the list of APIs from the apis/list service.
func ParseList(bytes []byte) (*List, error)
ParseList unmarshals the bytes into a Document.
func (a *List) APIWithNameAndVersion(name string, version string) (*API, error)
APIWithNameAndVersion returns the API with a specified name and version. If version is the empty string, the API name must be unique.
type MediaUpload struct {
Accept []string `protobuf:"bytes,1,rep,name=accept,proto3" json:"accept,omitempty"`
MaxSize string `protobuf:"bytes,2,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
Protocols *Protocols `protobuf:"bytes,3,opt,name=protocols,proto3" json:"protocols,omitempty"`
SupportsSubscription bool `protobuf:"varint,4,opt,name=supports_subscription,json=supportsSubscription,proto3" json:"supports_subscription,omitempty"`
// contains filtered or unexported fields
}
func NewMediaUpload(in *yaml.Node, context *compiler.Context) (*MediaUpload, error)
NewMediaUpload creates an object of type MediaUpload if possible, returning an error if not.
func (*MediaUpload) Descriptor() ([]byte, []int)
Deprecated: Use MediaUpload.ProtoReflect.Descriptor instead.
func (x *MediaUpload) GetAccept() []string
func (x *MediaUpload) GetMaxSize() string
func (x *MediaUpload) GetProtocols() *Protocols
func (x *MediaUpload) GetSupportsSubscription() bool
func (*MediaUpload) ProtoMessage()
func (x *MediaUpload) ProtoReflect() protoreflect.Message
func (x *MediaUpload) Reset()
func (m *MediaUpload) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside MediaUpload objects.
func (x *MediaUpload) String() string
func (m *MediaUpload) ToRawInfo() *yaml.Node
ToRawInfo returns a description of MediaUpload suitable for JSON or YAML export.
type Method struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
HttpMethod string `protobuf:"bytes,3,opt,name=http_method,json=httpMethod,proto3" json:"http_method,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
Parameters *Parameters `protobuf:"bytes,5,opt,name=parameters,proto3" json:"parameters,omitempty"`
ParameterOrder []string `protobuf:"bytes,6,rep,name=parameter_order,json=parameterOrder,proto3" json:"parameter_order,omitempty"`
Request *Request `protobuf:"bytes,7,opt,name=request,proto3" json:"request,omitempty"`
Response *Response `protobuf:"bytes,8,opt,name=response,proto3" json:"response,omitempty"`
Scopes []string `protobuf:"bytes,9,rep,name=scopes,proto3" json:"scopes,omitempty"`
SupportsMediaDownload bool `protobuf:"varint,10,opt,name=supports_media_download,json=supportsMediaDownload,proto3" json:"supports_media_download,omitempty"`
SupportsMediaUpload bool `protobuf:"varint,11,opt,name=supports_media_upload,json=supportsMediaUpload,proto3" json:"supports_media_upload,omitempty"`
UseMediaDownloadService bool `protobuf:"varint,12,opt,name=use_media_download_service,json=useMediaDownloadService,proto3" json:"use_media_download_service,omitempty"`
MediaUpload *MediaUpload `protobuf:"bytes,13,opt,name=media_upload,json=mediaUpload,proto3" json:"media_upload,omitempty"`
SupportsSubscription bool `protobuf:"varint,14,opt,name=supports_subscription,json=supportsSubscription,proto3" json:"supports_subscription,omitempty"`
FlatPath string `protobuf:"bytes,15,opt,name=flat_path,json=flatPath,proto3" json:"flat_path,omitempty"`
EtagRequired bool `protobuf:"varint,16,opt,name=etag_required,json=etagRequired,proto3" json:"etag_required,omitempty"`
StreamingType string `protobuf:"bytes,17,opt,name=streaming_type,json=streamingType,proto3" json:"streaming_type,omitempty"`
// contains filtered or unexported fields
}
func NewMethod(in *yaml.Node, context *compiler.Context) (*Method, error)
NewMethod creates an object of type Method if possible, returning an error if not.
func (*Method) Descriptor() ([]byte, []int)
Deprecated: Use Method.ProtoReflect.Descriptor instead.
func (x *Method) GetDescription() string
func (x *Method) GetEtagRequired() bool
func (x *Method) GetFlatPath() string
func (x *Method) GetHttpMethod() string
func (x *Method) GetId() string
func (x *Method) GetMediaUpload() *MediaUpload
func (x *Method) GetParameterOrder() []string
func (x *Method) GetParameters() *Parameters
func (x *Method) GetPath() string
func (x *Method) GetRequest() *Request
func (x *Method) GetResponse() *Response
func (x *Method) GetScopes() []string
func (x *Method) GetStreamingType() string
func (x *Method) GetSupportsMediaDownload() bool
func (x *Method) GetSupportsMediaUpload() bool
func (x *Method) GetSupportsSubscription() bool
func (x *Method) GetUseMediaDownloadService() bool
func (*Method) ProtoMessage()
func (x *Method) ProtoReflect() protoreflect.Message
func (x *Method) Reset()
func (m *Method) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Method objects.
func (x *Method) String() string
func (m *Method) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Method suitable for JSON or YAML export.
type Methods struct {
AdditionalProperties []*NamedMethod `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewMethods(in *yaml.Node, context *compiler.Context) (*Methods, error)
NewMethods creates an object of type Methods if possible, returning an error if not.
func (*Methods) Descriptor() ([]byte, []int)
Deprecated: Use Methods.ProtoReflect.Descriptor instead.
func (x *Methods) GetAdditionalProperties() []*NamedMethod
func (*Methods) ProtoMessage()
func (x *Methods) ProtoReflect() protoreflect.Message
func (x *Methods) Reset()
func (m *Methods) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Methods objects.
func (x *Methods) String() string
func (m *Methods) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Methods suitable for JSON or YAML export.
Automatically-generated message used to represent maps of Method as ordered (name,value) pairs.
type NamedMethod struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Method `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedMethod(in *yaml.Node, context *compiler.Context) (*NamedMethod, error)
NewNamedMethod creates an object of type NamedMethod if possible, returning an error if not.
func (*NamedMethod) Descriptor() ([]byte, []int)
Deprecated: Use NamedMethod.ProtoReflect.Descriptor instead.
func (x *NamedMethod) GetName() string
func (x *NamedMethod) GetValue() *Method
func (*NamedMethod) ProtoMessage()
func (x *NamedMethod) ProtoReflect() protoreflect.Message
func (x *NamedMethod) Reset()
func (m *NamedMethod) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedMethod objects.
func (x *NamedMethod) String() string
func (m *NamedMethod) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedMethod 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 Resource as ordered (name,value) pairs.
type NamedResource struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Resource `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedResource(in *yaml.Node, context *compiler.Context) (*NamedResource, error)
NewNamedResource creates an object of type NamedResource if possible, returning an error if not.
func (*NamedResource) Descriptor() ([]byte, []int)
Deprecated: Use NamedResource.ProtoReflect.Descriptor instead.
func (x *NamedResource) GetName() string
func (x *NamedResource) GetValue() *Resource
func (*NamedResource) ProtoMessage()
func (x *NamedResource) ProtoReflect() protoreflect.Message
func (x *NamedResource) Reset()
func (m *NamedResource) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedResource objects.
func (x *NamedResource) String() string
func (m *NamedResource) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedResource 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 Scope as ordered (name,value) pairs.
type NamedScope struct {
// Map key
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Mapped value
Value *Scope `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func NewNamedScope(in *yaml.Node, context *compiler.Context) (*NamedScope, error)
NewNamedScope creates an object of type NamedScope if possible, returning an error if not.
func (*NamedScope) Descriptor() ([]byte, []int)
Deprecated: Use NamedScope.ProtoReflect.Descriptor instead.
func (x *NamedScope) GetName() string
func (x *NamedScope) GetValue() *Scope
func (*NamedScope) ProtoMessage()
func (x *NamedScope) ProtoReflect() protoreflect.Message
func (x *NamedScope) Reset()
func (m *NamedScope) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside NamedScope objects.
func (x *NamedScope) String() string
func (m *NamedScope) ToRawInfo() *yaml.Node
ToRawInfo returns a description of NamedScope suitable for JSON or YAML export.
type Oauth2 struct {
Scopes *Scopes `protobuf:"bytes,1,opt,name=scopes,proto3" json:"scopes,omitempty"`
// contains filtered or unexported fields
}
func NewOauth2(in *yaml.Node, context *compiler.Context) (*Oauth2, error)
NewOauth2 creates an object of type Oauth2 if possible, returning an error if not.
func (*Oauth2) Descriptor() ([]byte, []int)
Deprecated: Use Oauth2.ProtoReflect.Descriptor instead.
func (x *Oauth2) GetScopes() *Scopes
func (*Oauth2) ProtoMessage()
func (x *Oauth2) ProtoReflect() protoreflect.Message
func (x *Oauth2) Reset()
func (m *Oauth2) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Oauth2 objects.
func (x *Oauth2) String() string
func (m *Oauth2) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Oauth2 suitable for JSON or YAML export.
type Parameter struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
XRef string `protobuf:"bytes,3,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
Default string `protobuf:"bytes,5,opt,name=default,proto3" json:"default,omitempty"`
Required bool `protobuf:"varint,6,opt,name=required,proto3" json:"required,omitempty"`
Format string `protobuf:"bytes,7,opt,name=format,proto3" json:"format,omitempty"`
Pattern string `protobuf:"bytes,8,opt,name=pattern,proto3" json:"pattern,omitempty"`
Minimum string `protobuf:"bytes,9,opt,name=minimum,proto3" json:"minimum,omitempty"`
Maximum string `protobuf:"bytes,10,opt,name=maximum,proto3" json:"maximum,omitempty"`
Enum []string `protobuf:"bytes,11,rep,name=enum,proto3" json:"enum,omitempty"`
EnumDescriptions []string `protobuf:"bytes,12,rep,name=enum_descriptions,json=enumDescriptions,proto3" json:"enum_descriptions,omitempty"`
Repeated bool `protobuf:"varint,13,opt,name=repeated,proto3" json:"repeated,omitempty"`
Location string `protobuf:"bytes,14,opt,name=location,proto3" json:"location,omitempty"`
Properties *Schemas `protobuf:"bytes,15,opt,name=properties,proto3" json:"properties,omitempty"`
AdditionalProperties *Schema `protobuf:"bytes,16,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
Items *Schema `protobuf:"bytes,17,opt,name=items,proto3" json:"items,omitempty"`
Annotations *Annotations `protobuf:"bytes,18,opt,name=annotations,proto3" json:"annotations,omitempty"`
// contains filtered or unexported fields
}
func NewParameter(in *yaml.Node, context *compiler.Context) (*Parameter, error)
NewParameter creates an object of type Parameter if possible, returning an error if not.
func (*Parameter) Descriptor() ([]byte, []int)
Deprecated: Use Parameter.ProtoReflect.Descriptor instead.
func (x *Parameter) GetAdditionalProperties() *Schema
func (x *Parameter) GetAnnotations() *Annotations
func (x *Parameter) GetDefault() string
func (x *Parameter) GetDescription() string
func (x *Parameter) GetEnum() []string
func (x *Parameter) GetEnumDescriptions() []string
func (x *Parameter) GetFormat() string
func (x *Parameter) GetId() string
func (x *Parameter) GetItems() *Schema
func (x *Parameter) GetLocation() string
func (x *Parameter) GetMaximum() string
func (x *Parameter) GetMinimum() string
func (x *Parameter) GetPattern() string
func (x *Parameter) GetProperties() *Schemas
func (x *Parameter) GetRepeated() bool
func (x *Parameter) GetRequired() bool
func (x *Parameter) GetType() string
func (x *Parameter) GetXRef() string
func (*Parameter) ProtoMessage()
func (x *Parameter) ProtoReflect() protoreflect.Message
func (x *Parameter) Reset()
func (m *Parameter) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Parameter objects.
func (x *Parameter) String() string
func (m *Parameter) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Parameter suitable for JSON or YAML export.
type Parameters struct {
AdditionalProperties []*NamedParameter `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewParameters(in *yaml.Node, context *compiler.Context) (*Parameters, error)
NewParameters creates an object of type Parameters if possible, returning an error if not.
func (*Parameters) Descriptor() ([]byte, []int)
Deprecated: Use Parameters.ProtoReflect.Descriptor instead.
func (x *Parameters) GetAdditionalProperties() []*NamedParameter
func (*Parameters) ProtoMessage()
func (x *Parameters) ProtoReflect() protoreflect.Message
func (x *Parameters) Reset()
func (m *Parameters) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Parameters objects.
func (x *Parameters) String() string
func (m *Parameters) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Parameters suitable for JSON or YAML export.
type Protocols struct {
Simple *Simple `protobuf:"bytes,1,opt,name=simple,proto3" json:"simple,omitempty"`
Resumable *Resumable `protobuf:"bytes,2,opt,name=resumable,proto3" json:"resumable,omitempty"`
// contains filtered or unexported fields
}
func NewProtocols(in *yaml.Node, context *compiler.Context) (*Protocols, error)
NewProtocols creates an object of type Protocols if possible, returning an error if not.
func (*Protocols) Descriptor() ([]byte, []int)
Deprecated: Use Protocols.ProtoReflect.Descriptor instead.
func (x *Protocols) GetResumable() *Resumable
func (x *Protocols) GetSimple() *Simple
func (*Protocols) ProtoMessage()
func (x *Protocols) ProtoReflect() protoreflect.Message
func (x *Protocols) Reset()
func (m *Protocols) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Protocols objects.
func (x *Protocols) String() string
func (m *Protocols) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Protocols suitable for JSON or YAML export.
type Request struct {
XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
ParameterName string `protobuf:"bytes,2,opt,name=parameter_name,json=parameterName,proto3" json:"parameter_name,omitempty"`
// contains filtered or unexported fields
}
func NewRequest(in *yaml.Node, context *compiler.Context) (*Request, error)
NewRequest creates an object of type Request if possible, returning an error if not.
func (*Request) Descriptor() ([]byte, []int)
Deprecated: Use Request.ProtoReflect.Descriptor instead.
func (x *Request) GetParameterName() string
func (x *Request) GetXRef() string
func (*Request) ProtoMessage()
func (x *Request) ProtoReflect() protoreflect.Message
func (x *Request) Reset()
func (m *Request) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Request objects.
func (x *Request) String() string
func (m *Request) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Request suitable for JSON or YAML export.
type Resource struct {
Methods *Methods `protobuf:"bytes,1,opt,name=methods,proto3" json:"methods,omitempty"`
Resources *Resources `protobuf:"bytes,2,opt,name=resources,proto3" json:"resources,omitempty"`
// contains filtered or unexported fields
}
func NewResource(in *yaml.Node, context *compiler.Context) (*Resource, error)
NewResource creates an object of type Resource if possible, returning an error if not.
func (*Resource) Descriptor() ([]byte, []int)
Deprecated: Use Resource.ProtoReflect.Descriptor instead.
func (x *Resource) GetMethods() *Methods
func (x *Resource) GetResources() *Resources
func (*Resource) ProtoMessage()
func (x *Resource) ProtoReflect() protoreflect.Message
func (x *Resource) Reset()
func (m *Resource) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Resource objects.
func (x *Resource) String() string
func (m *Resource) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Resource suitable for JSON or YAML export.
type Resources struct {
AdditionalProperties []*NamedResource `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewResources(in *yaml.Node, context *compiler.Context) (*Resources, error)
NewResources creates an object of type Resources if possible, returning an error if not.
func (*Resources) Descriptor() ([]byte, []int)
Deprecated: Use Resources.ProtoReflect.Descriptor instead.
func (x *Resources) GetAdditionalProperties() []*NamedResource
func (*Resources) ProtoMessage()
func (x *Resources) ProtoReflect() protoreflect.Message
func (x *Resources) Reset()
func (m *Resources) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Resources objects.
func (x *Resources) String() string
func (m *Resources) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Resources suitable for JSON or YAML export.
type Response struct {
XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,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) GetXRef() string
func (*Response) ProtoMessage()
func (x *Response) ProtoReflect() protoreflect.Message
func (x *Response) Reset()
func (m *Response) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Response objects.
func (x *Response) String() string
func (m *Response) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Response suitable for JSON or YAML export.
type Resumable struct {
Multipart bool `protobuf:"varint,1,opt,name=multipart,proto3" json:"multipart,omitempty"`
Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func NewResumable(in *yaml.Node, context *compiler.Context) (*Resumable, error)
NewResumable creates an object of type Resumable if possible, returning an error if not.
func (*Resumable) Descriptor() ([]byte, []int)
Deprecated: Use Resumable.ProtoReflect.Descriptor instead.
func (x *Resumable) GetMultipart() bool
func (x *Resumable) GetPath() string
func (*Resumable) ProtoMessage()
func (x *Resumable) ProtoReflect() protoreflect.Message
func (x *Resumable) Reset()
func (m *Resumable) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Resumable objects.
func (x *Resumable) String() string
func (m *Resumable) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Resumable suitable for JSON or YAML export.
type Schema struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Default string `protobuf:"bytes,4,opt,name=default,proto3" json:"default,omitempty"`
Required bool `protobuf:"varint,5,opt,name=required,proto3" json:"required,omitempty"`
Format string `protobuf:"bytes,6,opt,name=format,proto3" json:"format,omitempty"`
Pattern string `protobuf:"bytes,7,opt,name=pattern,proto3" json:"pattern,omitempty"`
Minimum string `protobuf:"bytes,8,opt,name=minimum,proto3" json:"minimum,omitempty"`
Maximum string `protobuf:"bytes,9,opt,name=maximum,proto3" json:"maximum,omitempty"`
Enum []string `protobuf:"bytes,10,rep,name=enum,proto3" json:"enum,omitempty"`
EnumDescriptions []string `protobuf:"bytes,11,rep,name=enum_descriptions,json=enumDescriptions,proto3" json:"enum_descriptions,omitempty"`
Repeated bool `protobuf:"varint,12,opt,name=repeated,proto3" json:"repeated,omitempty"`
Location string `protobuf:"bytes,13,opt,name=location,proto3" json:"location,omitempty"`
Properties *Schemas `protobuf:"bytes,14,opt,name=properties,proto3" json:"properties,omitempty"`
AdditionalProperties *Schema `protobuf:"bytes,15,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
Items *Schema `protobuf:"bytes,16,opt,name=items,proto3" json:"items,omitempty"`
XRef string `protobuf:"bytes,17,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
Annotations *Annotations `protobuf:"bytes,18,opt,name=annotations,proto3" json:"annotations,omitempty"`
ReadOnly bool `protobuf:"varint,19,opt,name=read_only,json=readOnly,proto3" json:"read_only,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() *Schema
func (x *Schema) GetAnnotations() *Annotations
func (x *Schema) GetDefault() string
func (x *Schema) GetDescription() string
func (x *Schema) GetEnum() []string
func (x *Schema) GetEnumDescriptions() []string
func (x *Schema) GetFormat() string
func (x *Schema) GetId() string
func (x *Schema) GetItems() *Schema
func (x *Schema) GetLocation() string
func (x *Schema) GetMaximum() string
func (x *Schema) GetMinimum() string
func (x *Schema) GetPattern() string
func (x *Schema) GetProperties() *Schemas
func (x *Schema) GetReadOnly() bool
func (x *Schema) GetRepeated() bool
func (x *Schema) GetRequired() bool
func (x *Schema) GetType() string
func (x *Schema) GetXRef() string
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 Schemas struct {
AdditionalProperties []*NamedSchema `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewSchemas(in *yaml.Node, context *compiler.Context) (*Schemas, error)
NewSchemas creates an object of type Schemas if possible, returning an error if not.
func (*Schemas) Descriptor() ([]byte, []int)
Deprecated: Use Schemas.ProtoReflect.Descriptor instead.
func (x *Schemas) GetAdditionalProperties() []*NamedSchema
func (*Schemas) ProtoMessage()
func (x *Schemas) ProtoReflect() protoreflect.Message
func (x *Schemas) Reset()
func (m *Schemas) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Schemas objects.
func (x *Schemas) String() string
func (m *Schemas) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Schemas suitable for JSON or YAML export.
type Scope struct {
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func NewScope(in *yaml.Node, context *compiler.Context) (*Scope, error)
NewScope creates an object of type Scope if possible, returning an error if not.
func (*Scope) Descriptor() ([]byte, []int)
Deprecated: Use Scope.ProtoReflect.Descriptor instead.
func (x *Scope) GetDescription() string
func (*Scope) ProtoMessage()
func (x *Scope) ProtoReflect() protoreflect.Message
func (x *Scope) Reset()
func (m *Scope) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Scope objects.
func (x *Scope) String() string
func (m *Scope) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Scope suitable for JSON or YAML export.
type Scopes struct {
AdditionalProperties []*NamedScope `protobuf:"bytes,1,rep,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// contains filtered or unexported fields
}
func NewScopes(in *yaml.Node, context *compiler.Context) (*Scopes, error)
NewScopes creates an object of type Scopes if possible, returning an error if not.
func (*Scopes) Descriptor() ([]byte, []int)
Deprecated: Use Scopes.ProtoReflect.Descriptor instead.
func (x *Scopes) GetAdditionalProperties() []*NamedScope
func (*Scopes) ProtoMessage()
func (x *Scopes) ProtoReflect() protoreflect.Message
func (x *Scopes) Reset()
func (m *Scopes) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Scopes objects.
func (x *Scopes) String() string
func (m *Scopes) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Scopes suitable for JSON or YAML export.
type Simple struct {
Multipart bool `protobuf:"varint,1,opt,name=multipart,proto3" json:"multipart,omitempty"`
Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func NewSimple(in *yaml.Node, context *compiler.Context) (*Simple, error)
NewSimple creates an object of type Simple if possible, returning an error if not.
func (*Simple) Descriptor() ([]byte, []int)
Deprecated: Use Simple.ProtoReflect.Descriptor instead.
func (x *Simple) GetMultipart() bool
func (x *Simple) GetPath() string
func (*Simple) ProtoMessage()
func (x *Simple) ProtoReflect() protoreflect.Message
func (x *Simple) Reset()
func (m *Simple) ResolveReferences(root string) (*yaml.Node, error)
ResolveReferences resolves references found inside Simple objects.
func (x *Simple) String() string
func (m *Simple) ToRawInfo() *yaml.Node
ToRawInfo returns a description of Simple 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.