discovery_v1

package
v0.0.6 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

README

API Discovery Format

This directory contains a Protocol Buffer-language model and related code for supporting Google's API Discovery Format.

Gnostic applications and plugins can use Discovery.proto to generate Protocol Buffer support code for their preferred languages.

Discovery.go is used by Gnostic to read JSON and YAML Discovery descriptions into the Protocol Buffer-based datastructures generated from Discovery.proto.

Discovery.proto and Discovery.go are generated by the Gnostic compiler generator, and Discovery.pb.go is generated by protoc, the Protocol Buffer compiler, and protoc-gen-go, the Protocol Buffer Go code generation plugin.

Documentation

Index

Constants

View Source
const APIsListServiceURL = "https://www.googleapis.com/discovery/v1/apis"

APIsListServiceURL is the URL for the Google APIs Discovery Service

Variables

View Source
var File_discovery_discovery_proto protoreflect.FileDescriptor

Functions

func FetchDocumentBytes

func FetchDocumentBytes(documentURL string) ([]byte, error)

FetchDocumentBytes downloads the bytes of a discovery document from a URL.

func FetchListBytes

func FetchListBytes() ([]byte, error)

func Version

func Version() string

Version returns the package name (and OpenAPI version).

Types

type 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"`
}

An API represents an API description returned by the apis/list API.

type Annotations

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

func NewAnnotations

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 deprecated added in v0.0.3

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

Deprecated: Use Annotations.ProtoReflect.Descriptor instead.

func (*Annotations) GetRequired added in v0.0.3

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

func (*Annotations) ProtoMessage added in v0.0.3

func (*Annotations) ProtoMessage()

func (*Annotations) ProtoReflect added in v0.0.3

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

func (*Annotations) Reset added in v0.0.3

func (x *Annotations) Reset()

func (*Annotations) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Annotations objects.

func (*Annotations) String added in v0.0.3

func (x *Annotations) String() string

func (*Annotations) ToRawInfo added in v0.0.3

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

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

type Any

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

func NewAny

func NewAny(in *yaml.Node, context *compiler.Context) (*Any, error)

NewAny creates an object of type Any if possible, returning an error if not.

func (*Any) Descriptor deprecated added in v0.0.3

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

Deprecated: Use Any.ProtoReflect.Descriptor instead.

func (*Any) GetValue added in v0.0.3

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

func (*Any) GetYaml added in v0.0.3

func (x *Any) GetYaml() string

func (*Any) ProtoMessage added in v0.0.3

func (*Any) ProtoMessage()

func (*Any) ProtoReflect added in v0.0.3

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

func (*Any) Reset added in v0.0.3

func (x *Any) Reset()

func (*Any) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Any objects.

func (*Any) String added in v0.0.3

func (x *Any) String() string

func (*Any) ToRawInfo added in v0.0.3

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

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

type Auth

type Auth struct {
	Oauth2 *Oauth2 `protobuf:"bytes,1,opt,name=oauth2,proto3" json:"oauth2,omitempty"`
	// contains filtered or unexported fields
}

func NewAuth

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 deprecated added in v0.0.3

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

Deprecated: Use Auth.ProtoReflect.Descriptor instead.

func (*Auth) GetOauth2 added in v0.0.3

func (x *Auth) GetOauth2() *Oauth2

func (*Auth) ProtoMessage added in v0.0.3

func (*Auth) ProtoMessage()

func (*Auth) ProtoReflect added in v0.0.3

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

func (*Auth) Reset added in v0.0.3

func (x *Auth) Reset()

func (*Auth) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Auth objects.

func (*Auth) String added in v0.0.3

func (x *Auth) String() string

func (*Auth) ToRawInfo added in v0.0.3

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

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

type Document

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        `` /* 151-byte string literal not displayed */
	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

func NewDocument(in *yaml.Node, context *compiler.Context) (*Document, error)

NewDocument creates an object of type Document if possible, returning an error if not.

func ParseDocument

func ParseDocument(b []byte) (*Document, error)

ParseDocument reads a Discovery description from a YAML/JSON representation.

func (*Document) Descriptor deprecated added in v0.0.3

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetAuth added in v0.0.3

func (x *Document) GetAuth() *Auth

func (*Document) GetBasePath added in v0.0.3

func (x *Document) GetBasePath() string

func (*Document) GetBaseUrl added in v0.0.3

func (x *Document) GetBaseUrl() string

func (*Document) GetBatchPath added in v0.0.3

func (x *Document) GetBatchPath() string

func (*Document) GetCanonicalName added in v0.0.3

func (x *Document) GetCanonicalName() string

func (*Document) GetDescription added in v0.0.3

func (x *Document) GetDescription() string

func (*Document) GetDiscoveryVersion added in v0.0.3

func (x *Document) GetDiscoveryVersion() string
func (x *Document) GetDocumentationLink() string

func (*Document) GetEtag added in v0.0.3

func (x *Document) GetEtag() string

func (*Document) GetFeatures added in v0.0.3

func (x *Document) GetFeatures() []string

func (*Document) GetFullyEncodeReservedExpansion added in v0.0.3

func (x *Document) GetFullyEncodeReservedExpansion() bool

func (*Document) GetIcons added in v0.0.3

func (x *Document) GetIcons() *Icons

func (*Document) GetId added in v0.0.3

func (x *Document) GetId() string

func (*Document) GetKind added in v0.0.3

func (x *Document) GetKind() string

func (*Document) GetLabels added in v0.0.3

func (x *Document) GetLabels() []string

func (*Document) GetMethods added in v0.0.3

func (x *Document) GetMethods() *Methods

func (*Document) GetMtlsRootUrl added in v0.0.3

func (x *Document) GetMtlsRootUrl() string

func (*Document) GetName added in v0.0.3

func (x *Document) GetName() string

func (*Document) GetOwnerDomain added in v0.0.3

func (x *Document) GetOwnerDomain() string

func (*Document) GetOwnerName added in v0.0.3

func (x *Document) GetOwnerName() string

func (*Document) GetPackagePath added in v0.0.3

func (x *Document) GetPackagePath() string

func (*Document) GetParameters added in v0.0.3

func (x *Document) GetParameters() *Parameters

func (*Document) GetProtocol added in v0.0.3

func (x *Document) GetProtocol() string

func (*Document) GetResources added in v0.0.3

func (x *Document) GetResources() *Resources

func (*Document) GetRevision added in v0.0.3

func (x *Document) GetRevision() string

func (*Document) GetRootUrl added in v0.0.3

func (x *Document) GetRootUrl() string

func (*Document) GetSchemas added in v0.0.3

func (x *Document) GetSchemas() *Schemas

func (*Document) GetServicePath added in v0.0.3

func (x *Document) GetServicePath() string

func (*Document) GetTitle added in v0.0.3

func (x *Document) GetTitle() string

func (*Document) GetVersion added in v0.0.3

func (x *Document) GetVersion() string

func (*Document) GetVersionModule added in v0.0.3

func (x *Document) GetVersionModule() bool

func (*Document) ProtoMessage added in v0.0.3

func (*Document) ProtoMessage()

func (*Document) ProtoReflect added in v0.0.3

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

func (*Document) Reset added in v0.0.3

func (x *Document) Reset()

func (*Document) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Document objects.

func (*Document) String added in v0.0.3

func (x *Document) String() string

func (*Document) ToRawInfo added in v0.0.3

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

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

type Icons

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
}

Icons that represent the API.

func NewIcons

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 deprecated added in v0.0.3

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

Deprecated: Use Icons.ProtoReflect.Descriptor instead.

func (*Icons) GetX16 added in v0.0.3

func (x *Icons) GetX16() string

func (*Icons) GetX32 added in v0.0.3

func (x *Icons) GetX32() string

func (*Icons) ProtoMessage added in v0.0.3

func (*Icons) ProtoMessage()

func (*Icons) ProtoReflect added in v0.0.3

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

func (*Icons) Reset added in v0.0.3

func (x *Icons) Reset()

func (*Icons) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Icons objects.

func (*Icons) String added in v0.0.3

func (x *Icons) String() string

func (*Icons) ToRawInfo added in v0.0.3

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

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

type List

type List struct {
	Kind             string `json:"kind"`
	DiscoveryVersion string `json:"discoveryVersion"`
	APIs             []*API `json:"items"`
}

A List represents the results of a call to the apis/list API. https://developers.google.com/discovery/v1/reference/apis/list

func FetchList

func FetchList() (*List, error)

Read the list of APIs from the apis/list service.

func ParseList

func ParseList(bytes []byte) (*List, error)

ParseList unmarshals the bytes into a Document.

func (*List) APIWithNameAndVersion

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

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

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 deprecated added in v0.0.3

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

Deprecated: Use MediaUpload.ProtoReflect.Descriptor instead.

func (*MediaUpload) GetAccept added in v0.0.3

func (x *MediaUpload) GetAccept() []string

func (*MediaUpload) GetMaxSize added in v0.0.3

func (x *MediaUpload) GetMaxSize() string

func (*MediaUpload) GetProtocols added in v0.0.3

func (x *MediaUpload) GetProtocols() *Protocols

func (*MediaUpload) GetSupportsSubscription added in v0.0.3

func (x *MediaUpload) GetSupportsSubscription() bool

func (*MediaUpload) ProtoMessage added in v0.0.3

func (*MediaUpload) ProtoMessage()

func (*MediaUpload) ProtoReflect added in v0.0.3

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

func (*MediaUpload) Reset added in v0.0.3

func (x *MediaUpload) Reset()

func (*MediaUpload) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside MediaUpload objects.

func (*MediaUpload) String added in v0.0.3

func (x *MediaUpload) String() string

func (*MediaUpload) ToRawInfo added in v0.0.3

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

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

type Method

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         `` /* 128-byte string literal not displayed */
	SupportsMediaUpload     bool         `protobuf:"varint,11,opt,name=supports_media_upload,json=supportsMediaUpload,proto3" json:"supports_media_upload,omitempty"`
	UseMediaDownloadService bool         `` /* 136-byte string literal not displayed */
	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

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 deprecated added in v0.0.3

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

Deprecated: Use Method.ProtoReflect.Descriptor instead.

func (*Method) GetDescription added in v0.0.3

func (x *Method) GetDescription() string

func (*Method) GetEtagRequired added in v0.0.3

func (x *Method) GetEtagRequired() bool

func (*Method) GetFlatPath added in v0.0.3

func (x *Method) GetFlatPath() string

func (*Method) GetHttpMethod added in v0.0.3

func (x *Method) GetHttpMethod() string

func (*Method) GetId added in v0.0.3

func (x *Method) GetId() string

func (*Method) GetMediaUpload added in v0.0.3

func (x *Method) GetMediaUpload() *MediaUpload

func (*Method) GetParameterOrder added in v0.0.3

func (x *Method) GetParameterOrder() []string

func (*Method) GetParameters added in v0.0.3

func (x *Method) GetParameters() *Parameters

func (*Method) GetPath added in v0.0.3

func (x *Method) GetPath() string

func (*Method) GetRequest added in v0.0.3

func (x *Method) GetRequest() *Request

func (*Method) GetResponse added in v0.0.3

func (x *Method) GetResponse() *Response

func (*Method) GetScopes added in v0.0.3

func (x *Method) GetScopes() []string

func (*Method) GetStreamingType added in v0.0.3

func (x *Method) GetStreamingType() string

func (*Method) GetSupportsMediaDownload added in v0.0.3

func (x *Method) GetSupportsMediaDownload() bool

func (*Method) GetSupportsMediaUpload added in v0.0.3

func (x *Method) GetSupportsMediaUpload() bool

func (*Method) GetSupportsSubscription added in v0.0.3

func (x *Method) GetSupportsSubscription() bool

func (*Method) GetUseMediaDownloadService added in v0.0.3

func (x *Method) GetUseMediaDownloadService() bool

func (*Method) ProtoMessage added in v0.0.3

func (*Method) ProtoMessage()

func (*Method) ProtoReflect added in v0.0.3

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

func (*Method) Reset added in v0.0.3

func (x *Method) Reset()

func (*Method) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Method objects.

func (*Method) String added in v0.0.3

func (x *Method) String() string

func (*Method) ToRawInfo added in v0.0.3

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

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

type Methods

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

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 deprecated added in v0.0.3

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

Deprecated: Use Methods.ProtoReflect.Descriptor instead.

func (*Methods) GetAdditionalProperties added in v0.0.3

func (x *Methods) GetAdditionalProperties() []*NamedMethod

func (*Methods) ProtoMessage added in v0.0.3

func (*Methods) ProtoMessage()

func (*Methods) ProtoReflect added in v0.0.3

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

func (*Methods) Reset added in v0.0.3

func (x *Methods) Reset()

func (*Methods) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Methods objects.

func (*Methods) String added in v0.0.3

func (x *Methods) String() string

func (*Methods) ToRawInfo added in v0.0.3

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

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

type NamedMethod

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
}

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

func NewNamedMethod

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 deprecated added in v0.0.3

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

Deprecated: Use NamedMethod.ProtoReflect.Descriptor instead.

func (*NamedMethod) GetName added in v0.0.3

func (x *NamedMethod) GetName() string

func (*NamedMethod) GetValue added in v0.0.3

func (x *NamedMethod) GetValue() *Method

func (*NamedMethod) ProtoMessage added in v0.0.3

func (*NamedMethod) ProtoMessage()

func (*NamedMethod) ProtoReflect added in v0.0.3

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

func (*NamedMethod) Reset added in v0.0.3

func (x *NamedMethod) Reset()

func (*NamedMethod) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside NamedMethod objects.

func (*NamedMethod) String added in v0.0.3

func (x *NamedMethod) String() string

func (*NamedMethod) ToRawInfo added in v0.0.3

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

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

type NamedParameter

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
}

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

func NewNamedParameter

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 deprecated added in v0.0.3

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

Deprecated: Use NamedParameter.ProtoReflect.Descriptor instead.

func (*NamedParameter) GetName added in v0.0.3

func (x *NamedParameter) GetName() string

func (*NamedParameter) GetValue added in v0.0.3

func (x *NamedParameter) GetValue() *Parameter

func (*NamedParameter) ProtoMessage added in v0.0.3

func (*NamedParameter) ProtoMessage()

func (*NamedParameter) ProtoReflect added in v0.0.3

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

func (*NamedParameter) Reset added in v0.0.3

func (x *NamedParameter) Reset()

func (*NamedParameter) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside NamedParameter objects.

func (*NamedParameter) String added in v0.0.3

func (x *NamedParameter) String() string

func (*NamedParameter) ToRawInfo added in v0.0.3

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

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

type NamedResource

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
}

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

func NewNamedResource

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 deprecated added in v0.0.3

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

Deprecated: Use NamedResource.ProtoReflect.Descriptor instead.

func (*NamedResource) GetName added in v0.0.3

func (x *NamedResource) GetName() string

func (*NamedResource) GetValue added in v0.0.3

func (x *NamedResource) GetValue() *Resource

func (*NamedResource) ProtoMessage added in v0.0.3

func (*NamedResource) ProtoMessage()

func (*NamedResource) ProtoReflect added in v0.0.3

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

func (*NamedResource) Reset added in v0.0.3

func (x *NamedResource) Reset()

func (*NamedResource) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside NamedResource objects.

func (*NamedResource) String added in v0.0.3

func (x *NamedResource) String() string

func (*NamedResource) ToRawInfo added in v0.0.3

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

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

type NamedSchema

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
}

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

func NewNamedSchema

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 deprecated added in v0.0.3

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

Deprecated: Use NamedSchema.ProtoReflect.Descriptor instead.

func (*NamedSchema) GetName added in v0.0.3

func (x *NamedSchema) GetName() string

func (*NamedSchema) GetValue added in v0.0.3

func (x *NamedSchema) GetValue() *Schema

func (*NamedSchema) ProtoMessage added in v0.0.3

func (*NamedSchema) ProtoMessage()

func (*NamedSchema) ProtoReflect added in v0.0.3

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

func (*NamedSchema) Reset added in v0.0.3

func (x *NamedSchema) Reset()

func (*NamedSchema) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside NamedSchema objects.

func (*NamedSchema) String added in v0.0.3

func (x *NamedSchema) String() string

func (*NamedSchema) ToRawInfo added in v0.0.3

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

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

type NamedScope

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
}

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

func NewNamedScope

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 deprecated added in v0.0.3

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

Deprecated: Use NamedScope.ProtoReflect.Descriptor instead.

func (*NamedScope) GetName added in v0.0.3

func (x *NamedScope) GetName() string

func (*NamedScope) GetValue added in v0.0.3

func (x *NamedScope) GetValue() *Scope

func (*NamedScope) ProtoMessage added in v0.0.3

func (*NamedScope) ProtoMessage()

func (*NamedScope) ProtoReflect added in v0.0.3

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

func (*NamedScope) Reset added in v0.0.3

func (x *NamedScope) Reset()

func (*NamedScope) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside NamedScope objects.

func (*NamedScope) String added in v0.0.3

func (x *NamedScope) String() string

func (*NamedScope) ToRawInfo added in v0.0.3

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

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

type Oauth2

type Oauth2 struct {
	Scopes *Scopes `protobuf:"bytes,1,opt,name=scopes,proto3" json:"scopes,omitempty"`
	// contains filtered or unexported fields
}

func NewOauth2

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 deprecated added in v0.0.3

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

Deprecated: Use Oauth2.ProtoReflect.Descriptor instead.

func (*Oauth2) GetScopes added in v0.0.3

func (x *Oauth2) GetScopes() *Scopes

func (*Oauth2) ProtoMessage added in v0.0.3

func (*Oauth2) ProtoMessage()

func (*Oauth2) ProtoReflect added in v0.0.3

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

func (*Oauth2) Reset added in v0.0.3

func (x *Oauth2) Reset()

func (*Oauth2) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Oauth2 objects.

func (*Oauth2) String added in v0.0.3

func (x *Oauth2) String() string

func (*Oauth2) ToRawInfo added in v0.0.3

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

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

type Parameter

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

func NewParameter(in *yaml.Node, context *compiler.Context) (*Parameter, error)

NewParameter creates an object of type Parameter if possible, returning an error if not.

func (*Parameter) Descriptor deprecated added in v0.0.3

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

Deprecated: Use Parameter.ProtoReflect.Descriptor instead.

func (*Parameter) GetAdditionalProperties added in v0.0.3

func (x *Parameter) GetAdditionalProperties() *Schema

func (*Parameter) GetAnnotations added in v0.0.3

func (x *Parameter) GetAnnotations() *Annotations

func (*Parameter) GetDefault added in v0.0.3

func (x *Parameter) GetDefault() string

func (*Parameter) GetDescription added in v0.0.3

func (x *Parameter) GetDescription() string

func (*Parameter) GetEnum added in v0.0.3

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

func (*Parameter) GetEnumDescriptions added in v0.0.3

func (x *Parameter) GetEnumDescriptions() []string

func (*Parameter) GetFormat added in v0.0.3

func (x *Parameter) GetFormat() string

func (*Parameter) GetId added in v0.0.3

func (x *Parameter) GetId() string

func (*Parameter) GetItems added in v0.0.3

func (x *Parameter) GetItems() *Schema

func (*Parameter) GetLocation added in v0.0.3

func (x *Parameter) GetLocation() string

func (*Parameter) GetMaximum added in v0.0.3

func (x *Parameter) GetMaximum() string

func (*Parameter) GetMinimum added in v0.0.3

func (x *Parameter) GetMinimum() string

func (*Parameter) GetPattern added in v0.0.3

func (x *Parameter) GetPattern() string

func (*Parameter) GetProperties added in v0.0.3

func (x *Parameter) GetProperties() *Schemas

func (*Parameter) GetRepeated added in v0.0.3

func (x *Parameter) GetRepeated() bool

func (*Parameter) GetRequired added in v0.0.3

func (x *Parameter) GetRequired() bool

func (*Parameter) GetType added in v0.0.3

func (x *Parameter) GetType() string

func (*Parameter) GetXRef added in v0.0.3

func (x *Parameter) GetXRef() string

func (*Parameter) ProtoMessage added in v0.0.3

func (*Parameter) ProtoMessage()

func (*Parameter) ProtoReflect added in v0.0.3

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

func (*Parameter) Reset added in v0.0.3

func (x *Parameter) Reset()

func (*Parameter) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Parameter objects.

func (*Parameter) String added in v0.0.3

func (x *Parameter) String() string

func (*Parameter) ToRawInfo added in v0.0.3

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

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

type Parameters

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

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 deprecated added in v0.0.3

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

Deprecated: Use Parameters.ProtoReflect.Descriptor instead.

func (*Parameters) GetAdditionalProperties added in v0.0.3

func (x *Parameters) GetAdditionalProperties() []*NamedParameter

func (*Parameters) ProtoMessage added in v0.0.3

func (*Parameters) ProtoMessage()

func (*Parameters) ProtoReflect added in v0.0.3

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

func (*Parameters) Reset added in v0.0.3

func (x *Parameters) Reset()

func (*Parameters) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Parameters objects.

func (*Parameters) String added in v0.0.3

func (x *Parameters) String() string

func (*Parameters) ToRawInfo added in v0.0.3

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

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

type Protocols

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

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 deprecated added in v0.0.3

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

Deprecated: Use Protocols.ProtoReflect.Descriptor instead.

func (*Protocols) GetResumable added in v0.0.3

func (x *Protocols) GetResumable() *Resumable

func (*Protocols) GetSimple added in v0.0.3

func (x *Protocols) GetSimple() *Simple

func (*Protocols) ProtoMessage added in v0.0.3

func (*Protocols) ProtoMessage()

func (*Protocols) ProtoReflect added in v0.0.3

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

func (*Protocols) Reset added in v0.0.3

func (x *Protocols) Reset()

func (*Protocols) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Protocols objects.

func (*Protocols) String added in v0.0.3

func (x *Protocols) String() string

func (*Protocols) ToRawInfo added in v0.0.3

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

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

type Request

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

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 deprecated added in v0.0.3

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

Deprecated: Use Request.ProtoReflect.Descriptor instead.

func (*Request) GetParameterName added in v0.0.3

func (x *Request) GetParameterName() string

func (*Request) GetXRef added in v0.0.3

func (x *Request) GetXRef() string

func (*Request) ProtoMessage added in v0.0.3

func (*Request) ProtoMessage()

func (*Request) ProtoReflect added in v0.0.3

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

func (*Request) Reset added in v0.0.3

func (x *Request) Reset()

func (*Request) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Request objects.

func (*Request) String added in v0.0.3

func (x *Request) String() string

func (*Request) ToRawInfo added in v0.0.3

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

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

type Resource

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

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 deprecated added in v0.0.3

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetMethods added in v0.0.3

func (x *Resource) GetMethods() *Methods

func (*Resource) GetResources added in v0.0.3

func (x *Resource) GetResources() *Resources

func (*Resource) ProtoMessage added in v0.0.3

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect added in v0.0.3

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

func (*Resource) Reset added in v0.0.3

func (x *Resource) Reset()

func (*Resource) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Resource objects.

func (*Resource) String added in v0.0.3

func (x *Resource) String() string

func (*Resource) ToRawInfo added in v0.0.3

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

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

type Resources

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

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 deprecated added in v0.0.3

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

Deprecated: Use Resources.ProtoReflect.Descriptor instead.

func (*Resources) GetAdditionalProperties added in v0.0.3

func (x *Resources) GetAdditionalProperties() []*NamedResource

func (*Resources) ProtoMessage added in v0.0.3

func (*Resources) ProtoMessage()

func (*Resources) ProtoReflect added in v0.0.3

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

func (*Resources) Reset added in v0.0.3

func (x *Resources) Reset()

func (*Resources) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Resources objects.

func (*Resources) String added in v0.0.3

func (x *Resources) String() string

func (*Resources) ToRawInfo added in v0.0.3

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

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

type Response

type Response struct {
	XRef string `protobuf:"bytes,1,opt,name=_ref,json=Ref,proto3" json:"_ref,omitempty"`
	// contains filtered or unexported fields
}

func NewResponse

func NewResponse(in *yaml.Node, context *compiler.Context) (*Response, error)

NewResponse creates an object of type Response if possible, returning an error if not.

func (*Response) Descriptor deprecated added in v0.0.3

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetXRef added in v0.0.3

func (x *Response) GetXRef() string

func (*Response) ProtoMessage added in v0.0.3

func (*Response) ProtoMessage()

func (*Response) ProtoReflect added in v0.0.3

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

func (*Response) Reset added in v0.0.3

func (x *Response) Reset()

func (*Response) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Response objects.

func (*Response) String added in v0.0.3

func (x *Response) String() string

func (*Response) ToRawInfo added in v0.0.3

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

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

type Resumable

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

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 deprecated added in v0.0.3

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

Deprecated: Use Resumable.ProtoReflect.Descriptor instead.

func (*Resumable) GetMultipart added in v0.0.3

func (x *Resumable) GetMultipart() bool

func (*Resumable) GetPath added in v0.0.3

func (x *Resumable) GetPath() string

func (*Resumable) ProtoMessage added in v0.0.3

func (*Resumable) ProtoMessage()

func (*Resumable) ProtoReflect added in v0.0.3

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

func (*Resumable) Reset added in v0.0.3

func (x *Resumable) Reset()

func (*Resumable) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Resumable objects.

func (*Resumable) String added in v0.0.3

func (x *Resumable) String() string

func (*Resumable) ToRawInfo added in v0.0.3

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

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

type Schema

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

func NewSchema(in *yaml.Node, context *compiler.Context) (*Schema, error)

NewSchema creates an object of type Schema if possible, returning an error if not.

func (*Schema) Descriptor deprecated added in v0.0.3

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

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetAdditionalProperties added in v0.0.3

func (x *Schema) GetAdditionalProperties() *Schema

func (*Schema) GetAnnotations added in v0.0.3

func (x *Schema) GetAnnotations() *Annotations

func (*Schema) GetDefault added in v0.0.3

func (x *Schema) GetDefault() string

func (*Schema) GetDescription added in v0.0.3

func (x *Schema) GetDescription() string

func (*Schema) GetEnum added in v0.0.3

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

func (*Schema) GetEnumDescriptions added in v0.0.3

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

func (*Schema) GetFormat added in v0.0.3

func (x *Schema) GetFormat() string

func (*Schema) GetId added in v0.0.3

func (x *Schema) GetId() string

func (*Schema) GetItems added in v0.0.3

func (x *Schema) GetItems() *Schema

func (*Schema) GetLocation added in v0.0.3

func (x *Schema) GetLocation() string

func (*Schema) GetMaximum added in v0.0.3

func (x *Schema) GetMaximum() string

func (*Schema) GetMinimum added in v0.0.3

func (x *Schema) GetMinimum() string

func (*Schema) GetPattern added in v0.0.3

func (x *Schema) GetPattern() string

func (*Schema) GetProperties added in v0.0.3

func (x *Schema) GetProperties() *Schemas

func (*Schema) GetReadOnly added in v0.0.3

func (x *Schema) GetReadOnly() bool

func (*Schema) GetRepeated added in v0.0.3

func (x *Schema) GetRepeated() bool

func (*Schema) GetRequired added in v0.0.3

func (x *Schema) GetRequired() bool

func (*Schema) GetType added in v0.0.3

func (x *Schema) GetType() string

func (*Schema) GetXRef added in v0.0.3

func (x *Schema) GetXRef() string

func (*Schema) ProtoMessage added in v0.0.3

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect added in v0.0.3

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

func (*Schema) Reset added in v0.0.3

func (x *Schema) Reset()

func (*Schema) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Schema objects.

func (*Schema) String added in v0.0.3

func (x *Schema) String() string

func (*Schema) ToRawInfo added in v0.0.3

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

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

type Schemas

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

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 deprecated added in v0.0.3

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

Deprecated: Use Schemas.ProtoReflect.Descriptor instead.

func (*Schemas) GetAdditionalProperties added in v0.0.3

func (x *Schemas) GetAdditionalProperties() []*NamedSchema

func (*Schemas) ProtoMessage added in v0.0.3

func (*Schemas) ProtoMessage()

func (*Schemas) ProtoReflect added in v0.0.3

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

func (*Schemas) Reset added in v0.0.3

func (x *Schemas) Reset()

func (*Schemas) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Schemas objects.

func (*Schemas) String added in v0.0.3

func (x *Schemas) String() string

func (*Schemas) ToRawInfo added in v0.0.3

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

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

type Scope

type Scope struct {
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func NewScope

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 deprecated added in v0.0.3

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

Deprecated: Use Scope.ProtoReflect.Descriptor instead.

func (*Scope) GetDescription added in v0.0.3

func (x *Scope) GetDescription() string

func (*Scope) ProtoMessage added in v0.0.3

func (*Scope) ProtoMessage()

func (*Scope) ProtoReflect added in v0.0.3

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

func (*Scope) Reset added in v0.0.3

func (x *Scope) Reset()

func (*Scope) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Scope objects.

func (*Scope) String added in v0.0.3

func (x *Scope) String() string

func (*Scope) ToRawInfo added in v0.0.3

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

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

type Scopes

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

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 deprecated added in v0.0.3

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

Deprecated: Use Scopes.ProtoReflect.Descriptor instead.

func (*Scopes) GetAdditionalProperties added in v0.0.3

func (x *Scopes) GetAdditionalProperties() []*NamedScope

func (*Scopes) ProtoMessage added in v0.0.3

func (*Scopes) ProtoMessage()

func (*Scopes) ProtoReflect added in v0.0.3

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

func (*Scopes) Reset added in v0.0.3

func (x *Scopes) Reset()

func (*Scopes) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Scopes objects.

func (*Scopes) String added in v0.0.3

func (x *Scopes) String() string

func (*Scopes) ToRawInfo added in v0.0.3

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

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

type Simple

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

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 deprecated added in v0.0.3

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

Deprecated: Use Simple.ProtoReflect.Descriptor instead.

func (*Simple) GetMultipart added in v0.0.3

func (x *Simple) GetMultipart() bool

func (*Simple) GetPath added in v0.0.3

func (x *Simple) GetPath() string

func (*Simple) ProtoMessage added in v0.0.3

func (*Simple) ProtoMessage()

func (*Simple) ProtoReflect added in v0.0.3

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

func (*Simple) Reset added in v0.0.3

func (x *Simple) Reset()

func (*Simple) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside Simple objects.

func (*Simple) String added in v0.0.3

func (x *Simple) String() string

func (*Simple) ToRawInfo added in v0.0.3

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

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

type StringArray

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

func NewStringArray

func NewStringArray(in *yaml.Node, context *compiler.Context) (*StringArray, error)

NewStringArray creates an object of type StringArray if possible, returning an error if not.

func (*StringArray) Descriptor deprecated added in v0.0.3

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

Deprecated: Use StringArray.ProtoReflect.Descriptor instead.

func (*StringArray) GetValue added in v0.0.3

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

func (*StringArray) ProtoMessage added in v0.0.3

func (*StringArray) ProtoMessage()

func (*StringArray) ProtoReflect added in v0.0.3

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

func (*StringArray) Reset added in v0.0.3

func (x *StringArray) Reset()

func (*StringArray) ResolveReferences added in v0.0.3

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

ResolveReferences resolves references found inside StringArray objects.

func (*StringArray) String added in v0.0.3

func (x *StringArray) String() string

func (*StringArray) ToRawInfo added in v0.0.3

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL