discovery_v1

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: May 19, 2018 License: Apache-2.0 Imports: 8 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

Overview

Package discovery_v1 is a generated protocol buffer package.

It is generated from these files: 

discovery/discovery.proto

It has these top-level messages: 

Annotations
Any
Auth
Document
Icons
MediaUpload
Method
Methods
NamedMethod
NamedParameter
NamedResource
NamedSchema
NamedScope
Oauth2
Parameter
Parameters
Protocols
Request
Resource
Resources
Response
Resumable
Schema
Schemas
Scope
Scopes
Simple
StringArray

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Version 

func Version() string

Version returns the package name (and OpenAPI version).

Types

type Annotations 

type Annotations struct {
	Required []string `protobuf:"bytes,1,rep,name=required" json:"required,omitempty"`
}

func NewAnnotations 

func NewAnnotations(in interface{}, context *compiler.Context) (*Annotations, error)

NewAnnotations creates an object of type Annotations if possible, returning an error if not.

func (*Annotations) Descriptor 

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

func (*Annotations) GetRequired 

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

func (*Annotations) ProtoMessage 

func (*Annotations) ProtoMessage()

func (*Annotations) Reset 

func (m *Annotations) Reset()

func (*Annotations) ResolveReferences 

func (m *Annotations) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Annotations objects.

func (*Annotations) String 

func (m *Annotations) String() string

func (*Annotations) ToRawInfo 

func (m *Annotations) ToRawInfo() interface{}

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

type Any 

type Any struct {
	Value *google_protobuf.Any `protobuf:"bytes,1,opt,name=value" json:"value,omitempty"`
	Yaml  string               `protobuf:"bytes,2,opt,name=yaml" json:"yaml,omitempty"`
}

func NewAny 

func NewAny(in interface{}, context *compiler.Context) (*Any, error)

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

func (*Any) Descriptor 

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

func (*Any) GetValue 

func (m *Any) GetValue() *google_protobuf.Any

func (*Any) GetYaml 

func (m *Any) GetYaml() string

func (*Any) ProtoMessage 

func (*Any) ProtoMessage()

func (*Any) Reset 

func (m *Any) Reset()

func (*Any) ResolveReferences 

func (m *Any) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Any objects.

func (*Any) String 

func (m *Any) String() string

func (*Any) ToRawInfo 

func (m *Any) ToRawInfo() interface{}

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" json:"oauth2,omitempty"`
}

func NewAuth 

func NewAuth(in interface{}, context *compiler.Context) (*Auth, error)

NewAuth creates an object of type Auth if possible, returning an error if not.

func (*Auth) Descriptor 

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

func (*Auth) GetOauth2 

func (m *Auth) GetOauth2() *Oauth2

func (*Auth) ProtoMessage 

func (*Auth) ProtoMessage()

func (*Auth) Reset 

func (m *Auth) Reset()

func (*Auth) ResolveReferences 

func (m *Auth) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Auth objects.

func (*Auth) String 

func (m *Auth) String() string

func (*Auth) ToRawInfo 

func (m *Auth) ToRawInfo() interface{}

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" json:"kind,omitempty"`
	DiscoveryVersion             string      `protobuf:"bytes,2,opt,name=discovery_version,json=discoveryVersion" json:"discovery_version,omitempty"`
	Id                           string      `protobuf:"bytes,3,opt,name=id" json:"id,omitempty"`
	Name                         string      `protobuf:"bytes,4,opt,name=name" json:"name,omitempty"`
	Version                      string      `protobuf:"bytes,5,opt,name=version" json:"version,omitempty"`
	Revision                     string      `protobuf:"bytes,6,opt,name=revision" json:"revision,omitempty"`
	Title                        string      `protobuf:"bytes,7,opt,name=title" json:"title,omitempty"`
	Description                  string      `protobuf:"bytes,8,opt,name=description" json:"description,omitempty"`
	Icons                        *Icons      `protobuf:"bytes,9,opt,name=icons" json:"icons,omitempty"`
	DocumentationLink            string      `protobuf:"bytes,10,opt,name=documentation_link,json=documentationLink" json:"documentation_link,omitempty"`
	Labels                       []string    `protobuf:"bytes,11,rep,name=labels" json:"labels,omitempty"`
	Protocol                     string      `protobuf:"bytes,12,opt,name=protocol" json:"protocol,omitempty"`
	BaseUrl                      string      `protobuf:"bytes,13,opt,name=base_url,json=baseUrl" json:"base_url,omitempty"`
	BasePath                     string      `protobuf:"bytes,14,opt,name=base_path,json=basePath" json:"base_path,omitempty"`
	RootUrl                      string      `protobuf:"bytes,15,opt,name=root_url,json=rootUrl" json:"root_url,omitempty"`
	ServicePath                  string      `protobuf:"bytes,16,opt,name=service_path,json=servicePath" json:"service_path,omitempty"`
	BatchPath                    string      `protobuf:"bytes,17,opt,name=batch_path,json=batchPath" json:"batch_path,omitempty"`
	Parameters                   *Parameters `protobuf:"bytes,18,opt,name=parameters" json:"parameters,omitempty"`
	Auth                         *Auth       `protobuf:"bytes,19,opt,name=auth" json:"auth,omitempty"`
	Features                     []string    `protobuf:"bytes,20,rep,name=features" json:"features,omitempty"`
	Schemas                      *Schemas    `protobuf:"bytes,21,opt,name=schemas" json:"schemas,omitempty"`
	Methods                      *Methods    `protobuf:"bytes,22,opt,name=methods" json:"methods,omitempty"`
	Resources                    *Resources  `protobuf:"bytes,23,opt,name=resources" json:"resources,omitempty"`
	Etag                         string      `protobuf:"bytes,24,opt,name=etag" json:"etag,omitempty"`
	OwnerDomain                  string      `protobuf:"bytes,25,opt,name=owner_domain,json=ownerDomain" json:"owner_domain,omitempty"`
	OwnerName                    string      `protobuf:"bytes,26,opt,name=owner_name,json=ownerName" json:"owner_name,omitempty"`
	VersionModule                bool        `protobuf:"varint,27,opt,name=version_module,json=versionModule" json:"version_module,omitempty"`
	CanonicalName                string      `protobuf:"bytes,28,opt,name=canonical_name,json=canonicalName" json:"canonical_name,omitempty"`
	FullyEncodeReservedExpansion bool        `` /* 144-byte string literal not displayed */
	PackagePath                  string      `protobuf:"bytes,30,opt,name=package_path,json=packagePath" json:"package_path,omitempty"`
}

func NewDocument 

func NewDocument(in interface{}, context *compiler.Context) (*Document, error)

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

func (*Document) Descriptor 

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

func (*Document) GetAuth 

func (m *Document) GetAuth() *Auth

func (*Document) GetBasePath 

func (m *Document) GetBasePath() string

func (*Document) GetBaseUrl 

func (m *Document) GetBaseUrl() string

func (*Document) GetBatchPath 

func (m *Document) GetBatchPath() string

func (*Document) GetCanonicalName 

func (m *Document) GetCanonicalName() string

func (*Document) GetDescription 

func (m *Document) GetDescription() string

func (*Document) GetDiscoveryVersion 

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

func (*Document) GetEtag 

func (m *Document) GetEtag() string

func (*Document) GetFeatures 

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

func (*Document) GetFullyEncodeReservedExpansion 

func (m *Document) GetFullyEncodeReservedExpansion() bool

func (*Document) GetIcons 

func (m *Document) GetIcons() *Icons

func (*Document) GetId 

func (m *Document) GetId() string

func (*Document) GetKind 

func (m *Document) GetKind() string

func (*Document) GetLabels 

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

func (*Document) GetMethods 

func (m *Document) GetMethods() *Methods

func (*Document) GetName 

func (m *Document) GetName() string

func (*Document) GetOwnerDomain 

func (m *Document) GetOwnerDomain() string

func (*Document) GetOwnerName 

func (m *Document) GetOwnerName() string

func (*Document) GetPackagePath 

func (m *Document) GetPackagePath() string

func (*Document) GetParameters 

func (m *Document) GetParameters() *Parameters

func (*Document) GetProtocol 

func (m *Document) GetProtocol() string

func (*Document) GetResources 

func (m *Document) GetResources() *Resources

func (*Document) GetRevision 

func (m *Document) GetRevision() string

func (*Document) GetRootUrl 

func (m *Document) GetRootUrl() string

func (*Document) GetSchemas 

func (m *Document) GetSchemas() *Schemas

func (*Document) GetServicePath 

func (m *Document) GetServicePath() string

func (*Document) GetTitle 

func (m *Document) GetTitle() string

func (*Document) GetVersion 

func (m *Document) GetVersion() string

func (*Document) GetVersionModule 

func (m *Document) GetVersionModule() bool

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) Reset 

func (m *Document) Reset()

func (*Document) ResolveReferences 

func (m *Document) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Document objects.

func (*Document) String 

func (m *Document) String() string

func (*Document) ToRawInfo 

func (m *Document) ToRawInfo() interface{}

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" json:"x16,omitempty"`
	X32 string `protobuf:"bytes,2,opt,name=x32" json:"x32,omitempty"`
}

Icons that represent the API.

func NewIcons 

func NewIcons(in interface{}, context *compiler.Context) (*Icons, error)

NewIcons creates an object of type Icons if possible, returning an error if not.

func (*Icons) Descriptor 

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

func (*Icons) GetX16 

func (m *Icons) GetX16() string

func (*Icons) GetX32 

func (m *Icons) GetX32() string

func (*Icons) ProtoMessage 

func (*Icons) ProtoMessage()

func (*Icons) Reset 

func (m *Icons) Reset()

func (*Icons) ResolveReferences 

func (m *Icons) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Icons objects.

func (*Icons) String 

func (m *Icons) String() string

func (*Icons) ToRawInfo 

func (m *Icons) ToRawInfo() interface{}

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

type MediaUpload 

type MediaUpload struct {
	Accept               []string   `protobuf:"bytes,1,rep,name=accept" json:"accept,omitempty"`
	MaxSize              string     `protobuf:"bytes,2,opt,name=max_size,json=maxSize" json:"max_size,omitempty"`
	Protocols            *Protocols `protobuf:"bytes,3,opt,name=protocols" json:"protocols,omitempty"`
	SupportsSubscription bool       `protobuf:"varint,4,opt,name=supports_subscription,json=supportsSubscription" json:"supports_subscription,omitempty"`
}

func NewMediaUpload 

func NewMediaUpload(in interface{}, context *compiler.Context) (*MediaUpload, error)

NewMediaUpload creates an object of type MediaUpload if possible, returning an error if not.

func (*MediaUpload) Descriptor 

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

func (*MediaUpload) GetAccept 

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

func (*MediaUpload) GetMaxSize 

func (m *MediaUpload) GetMaxSize() string

func (*MediaUpload) GetProtocols 

func (m *MediaUpload) GetProtocols() *Protocols

func (*MediaUpload) GetSupportsSubscription 

func (m *MediaUpload) GetSupportsSubscription() bool

func (*MediaUpload) ProtoMessage 

func (*MediaUpload) ProtoMessage()

func (*MediaUpload) Reset 

func (m *MediaUpload) Reset()

func (*MediaUpload) ResolveReferences 

func (m *MediaUpload) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside MediaUpload objects.

func (*MediaUpload) String 

func (m *MediaUpload) String() string

func (*MediaUpload) ToRawInfo 

func (m *MediaUpload) ToRawInfo() interface{}

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" json:"id,omitempty"`
	Path                    string       `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
	HttpMethod              string       `protobuf:"bytes,3,opt,name=http_method,json=httpMethod" json:"http_method,omitempty"`
	Description             string       `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	Parameters              *Parameters  `protobuf:"bytes,5,opt,name=parameters" json:"parameters,omitempty"`
	ParameterOrder          []string     `protobuf:"bytes,6,rep,name=parameter_order,json=parameterOrder" json:"parameter_order,omitempty"`
	Request                 *Request     `protobuf:"bytes,7,opt,name=request" json:"request,omitempty"`
	Response                *Response    `protobuf:"bytes,8,opt,name=response" json:"response,omitempty"`
	Scopes                  []string     `protobuf:"bytes,9,rep,name=scopes" json:"scopes,omitempty"`
	SupportsMediaDownload   bool         `protobuf:"varint,10,opt,name=supports_media_download,json=supportsMediaDownload" json:"supports_media_download,omitempty"`
	SupportsMediaUpload     bool         `protobuf:"varint,11,opt,name=supports_media_upload,json=supportsMediaUpload" json:"supports_media_upload,omitempty"`
	UseMediaDownloadService bool         `` /* 129-byte string literal not displayed */
	MediaUpload             *MediaUpload `protobuf:"bytes,13,opt,name=media_upload,json=mediaUpload" json:"media_upload,omitempty"`
	SupportsSubscription    bool         `protobuf:"varint,14,opt,name=supports_subscription,json=supportsSubscription" json:"supports_subscription,omitempty"`
	FlatPath                string       `protobuf:"bytes,15,opt,name=flat_path,json=flatPath" json:"flat_path,omitempty"`
	EtagRequired            bool         `protobuf:"varint,16,opt,name=etag_required,json=etagRequired" json:"etag_required,omitempty"`
}

func NewMethod 

func NewMethod(in interface{}, context *compiler.Context) (*Method, error)

NewMethod creates an object of type Method if possible, returning an error if not.

func (*Method) Descriptor 

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

func (*Method) GetDescription 

func (m *Method) GetDescription() string

func (*Method) GetEtagRequired 

func (m *Method) GetEtagRequired() bool

func (*Method) GetFlatPath 

func (m *Method) GetFlatPath() string

func (*Method) GetHttpMethod 

func (m *Method) GetHttpMethod() string

func (*Method) GetId 

func (m *Method) GetId() string

func (*Method) GetMediaUpload 

func (m *Method) GetMediaUpload() *MediaUpload

func (*Method) GetParameterOrder 

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

func (*Method) GetParameters 

func (m *Method) GetParameters() *Parameters

func (*Method) GetPath 

func (m *Method) GetPath() string

func (*Method) GetRequest 

func (m *Method) GetRequest() *Request

func (*Method) GetResponse 

func (m *Method) GetResponse() *Response

func (*Method) GetScopes 

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

func (*Method) GetSupportsMediaDownload 

func (m *Method) GetSupportsMediaDownload() bool

func (*Method) GetSupportsMediaUpload 

func (m *Method) GetSupportsMediaUpload() bool

func (*Method) GetSupportsSubscription 

func (m *Method) GetSupportsSubscription() bool

func (*Method) GetUseMediaDownloadService 

func (m *Method) GetUseMediaDownloadService() bool

func (*Method) ProtoMessage 

func (*Method) ProtoMessage()

func (*Method) Reset 

func (m *Method) Reset()

func (*Method) ResolveReferences 

func (m *Method) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Method objects.

func (*Method) String 

func (m *Method) String() string

func (*Method) ToRawInfo 

func (m *Method) ToRawInfo() interface{}

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" json:"additional_properties,omitempty"`
}

func NewMethods 

func NewMethods(in interface{}, context *compiler.Context) (*Methods, error)

NewMethods creates an object of type Methods if possible, returning an error if not.

func (*Methods) Descriptor 

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

func (*Methods) GetAdditionalProperties 

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

func (*Methods) ProtoMessage 

func (*Methods) ProtoMessage()

func (*Methods) Reset 

func (m *Methods) Reset()

func (*Methods) ResolveReferences 

func (m *Methods) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Methods objects.

func (*Methods) String 

func (m *Methods) String() string

func (*Methods) ToRawInfo 

func (m *Methods) ToRawInfo() interface{}

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" json:"name,omitempty"`
	// Mapped value
	Value *Method `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

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

func NewNamedMethod 

func NewNamedMethod(in interface{}, context *compiler.Context) (*NamedMethod, error)

NewNamedMethod creates an object of type NamedMethod if possible, returning an error if not.

func (*NamedMethod) Descriptor 

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

func (*NamedMethod) GetName 

func (m *NamedMethod) GetName() string

func (*NamedMethod) GetValue 

func (m *NamedMethod) GetValue() *Method

func (*NamedMethod) ProtoMessage 

func (*NamedMethod) ProtoMessage()

func (*NamedMethod) Reset 

func (m *NamedMethod) Reset()

func (*NamedMethod) ResolveReferences 

func (m *NamedMethod) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside NamedMethod objects.

func (*NamedMethod) String 

func (m *NamedMethod) String() string

func (*NamedMethod) ToRawInfo 

func (m *NamedMethod) ToRawInfo() interface{}

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" json:"name,omitempty"`
	// Mapped value
	Value *Parameter `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

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

func NewNamedParameter 

func NewNamedParameter(in interface{}, context *compiler.Context) (*NamedParameter, error)

NewNamedParameter creates an object of type NamedParameter if possible, returning an error if not.

func (*NamedParameter) Descriptor 

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

func (*NamedParameter) GetName 

func (m *NamedParameter) GetName() string

func (*NamedParameter) GetValue 

func (m *NamedParameter) GetValue() *Parameter

func (*NamedParameter) ProtoMessage 

func (*NamedParameter) ProtoMessage()

func (*NamedParameter) Reset 

func (m *NamedParameter) Reset()

func (*NamedParameter) ResolveReferences 

func (m *NamedParameter) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside NamedParameter objects.

func (*NamedParameter) String 

func (m *NamedParameter) String() string

func (*NamedParameter) ToRawInfo 

func (m *NamedParameter) ToRawInfo() interface{}

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" json:"name,omitempty"`
	// Mapped value
	Value *Resource `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

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

func NewNamedResource 

func NewNamedResource(in interface{}, context *compiler.Context) (*NamedResource, error)

NewNamedResource creates an object of type NamedResource if possible, returning an error if not.

func (*NamedResource) Descriptor 

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

func (*NamedResource) GetName 

func (m *NamedResource) GetName() string

func (*NamedResource) GetValue 

func (m *NamedResource) GetValue() *Resource

func (*NamedResource) ProtoMessage 

func (*NamedResource) ProtoMessage()

func (*NamedResource) Reset 

func (m *NamedResource) Reset()

func (*NamedResource) ResolveReferences 

func (m *NamedResource) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside NamedResource objects.

func (*NamedResource) String 

func (m *NamedResource) String() string

func (*NamedResource) ToRawInfo 

func (m *NamedResource) ToRawInfo() interface{}

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" json:"name,omitempty"`
	// Mapped value
	Value *Schema `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

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

func NewNamedSchema 

func NewNamedSchema(in interface{}, context *compiler.Context) (*NamedSchema, error)

NewNamedSchema creates an object of type NamedSchema if possible, returning an error if not.

func (*NamedSchema) Descriptor 

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

func (*NamedSchema) GetName 

func (m *NamedSchema) GetName() string

func (*NamedSchema) GetValue 

func (m *NamedSchema) GetValue() *Schema

func (*NamedSchema) ProtoMessage 

func (*NamedSchema) ProtoMessage()

func (*NamedSchema) Reset 

func (m *NamedSchema) Reset()

func (*NamedSchema) ResolveReferences 

func (m *NamedSchema) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside NamedSchema objects.

func (*NamedSchema) String 

func (m *NamedSchema) String() string

func (*NamedSchema) ToRawInfo 

func (m *NamedSchema) ToRawInfo() interface{}

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" json:"name,omitempty"`
	// Mapped value
	Value *Scope `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

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

func NewNamedScope 

func NewNamedScope(in interface{}, context *compiler.Context) (*NamedScope, error)

NewNamedScope creates an object of type NamedScope if possible, returning an error if not.

func (*NamedScope) Descriptor 

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

func (*NamedScope) GetName 

func (m *NamedScope) GetName() string

func (*NamedScope) GetValue 

func (m *NamedScope) GetValue() *Scope

func (*NamedScope) ProtoMessage 

func (*NamedScope) ProtoMessage()

func (*NamedScope) Reset 

func (m *NamedScope) Reset()

func (*NamedScope) ResolveReferences 

func (m *NamedScope) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside NamedScope objects.

func (*NamedScope) String 

func (m *NamedScope) String() string

func (*NamedScope) ToRawInfo 

func (m *NamedScope) ToRawInfo() interface{}

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" json:"scopes,omitempty"`
}

func NewOauth2 

func NewOauth2(in interface{}, context *compiler.Context) (*Oauth2, error)

NewOauth2 creates an object of type Oauth2 if possible, returning an error if not.

func (*Oauth2) Descriptor 

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

func (*Oauth2) GetScopes 

func (m *Oauth2) GetScopes() *Scopes

func (*Oauth2) ProtoMessage 

func (*Oauth2) ProtoMessage()

func (*Oauth2) Reset 

func (m *Oauth2) Reset()

func (*Oauth2) ResolveReferences 

func (m *Oauth2) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Oauth2 objects.

func (*Oauth2) String 

func (m *Oauth2) String() string

func (*Oauth2) ToRawInfo 

func (m *Oauth2) ToRawInfo() interface{}

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" json:"id,omitempty"`
	Type                 string       `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
	XRef                 string       `protobuf:"bytes,3,opt,name=_ref,json=Ref" json:"_ref,omitempty"`
	Description          string       `protobuf:"bytes,4,opt,name=description" json:"description,omitempty"`
	Default              string       `protobuf:"bytes,5,opt,name=default" json:"default,omitempty"`
	Required             bool         `protobuf:"varint,6,opt,name=required" json:"required,omitempty"`
	Format               string       `protobuf:"bytes,7,opt,name=format" json:"format,omitempty"`
	Pattern              string       `protobuf:"bytes,8,opt,name=pattern" json:"pattern,omitempty"`
	Minimum              string       `protobuf:"bytes,9,opt,name=minimum" json:"minimum,omitempty"`
	Maximum              string       `protobuf:"bytes,10,opt,name=maximum" json:"maximum,omitempty"`
	Enum                 []string     `protobuf:"bytes,11,rep,name=enum" json:"enum,omitempty"`
	EnumDescriptions     []string     `protobuf:"bytes,12,rep,name=enum_descriptions,json=enumDescriptions" json:"enum_descriptions,omitempty"`
	Repeated             bool         `protobuf:"varint,13,opt,name=repeated" json:"repeated,omitempty"`
	Location             string       `protobuf:"bytes,14,opt,name=location" json:"location,omitempty"`
	Properties           *Schemas     `protobuf:"bytes,15,opt,name=properties" json:"properties,omitempty"`
	AdditionalProperties *Schema      `protobuf:"bytes,16,opt,name=additional_properties,json=additionalProperties" json:"additional_properties,omitempty"`
	Items                *Schema      `protobuf:"bytes,17,opt,name=items" json:"items,omitempty"`
	Annotations          *Annotations `protobuf:"bytes,18,opt,name=annotations" json:"annotations,omitempty"`
}

func NewParameter 

func NewParameter(in interface{}, context *compiler.Context) (*Parameter, error)

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

func (*Parameter) Descriptor 

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

func (*Parameter) GetAdditionalProperties 

func (m *Parameter) GetAdditionalProperties() *Schema

func (*Parameter) GetAnnotations 

func (m *Parameter) GetAnnotations() *Annotations

func (*Parameter) GetDefault 

func (m *Parameter) GetDefault() string

func (*Parameter) GetDescription 

func (m *Parameter) GetDescription() string

func (*Parameter) GetEnum 

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

func (*Parameter) GetEnumDescriptions 

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

func (*Parameter) GetFormat 

func (m *Parameter) GetFormat() string

func (*Parameter) GetId 

func (m *Parameter) GetId() string

func (*Parameter) GetItems 

func (m *Parameter) GetItems() *Schema

func (*Parameter) GetLocation 

func (m *Parameter) GetLocation() string

func (*Parameter) GetMaximum 

func (m *Parameter) GetMaximum() string

func (*Parameter) GetMinimum 

func (m *Parameter) GetMinimum() string

func (*Parameter) GetPattern 

func (m *Parameter) GetPattern() string

func (*Parameter) GetProperties 

func (m *Parameter) GetProperties() *Schemas

func (*Parameter) GetRepeated 

func (m *Parameter) GetRepeated() bool

func (*Parameter) GetRequired 

func (m *Parameter) GetRequired() bool

func (*Parameter) GetType 

func (m *Parameter) GetType() string

func (*Parameter) GetXRef 

func (m *Parameter) GetXRef() string

func (*Parameter) ProtoMessage 

func (*Parameter) ProtoMessage()

func (*Parameter) Reset 

func (m *Parameter) Reset()

func (*Parameter) ResolveReferences 

func (m *Parameter) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Parameter objects.

func (*Parameter) String 

func (m *Parameter) String() string

func (*Parameter) ToRawInfo 

func (m *Parameter) ToRawInfo() interface{}

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" json:"additional_properties,omitempty"`
}

func NewParameters 

func NewParameters(in interface{}, context *compiler.Context) (*Parameters, error)

NewParameters creates an object of type Parameters if possible, returning an error if not.

func (*Parameters) Descriptor 

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

func (*Parameters) GetAdditionalProperties 

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

func (*Parameters) ProtoMessage 

func (*Parameters) ProtoMessage()

func (*Parameters) Reset 

func (m *Parameters) Reset()

func (*Parameters) ResolveReferences 

func (m *Parameters) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Parameters objects.

func (*Parameters) String 

func (m *Parameters) String() string

func (*Parameters) ToRawInfo 

func (m *Parameters) ToRawInfo() interface{}

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" json:"simple,omitempty"`
	Resumable *Resumable `protobuf:"bytes,2,opt,name=resumable" json:"resumable,omitempty"`
}

func NewProtocols 

func NewProtocols(in interface{}, context *compiler.Context) (*Protocols, error)

NewProtocols creates an object of type Protocols if possible, returning an error if not.

func (*Protocols) Descriptor 

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

func (*Protocols) GetResumable 

func (m *Protocols) GetResumable() *Resumable

func (*Protocols) GetSimple 

func (m *Protocols) GetSimple() *Simple

func (*Protocols) ProtoMessage 

func (*Protocols) ProtoMessage()

func (*Protocols) Reset 

func (m *Protocols) Reset()

func (*Protocols) ResolveReferences 

func (m *Protocols) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Protocols objects.

func (*Protocols) String 

func (m *Protocols) String() string

func (*Protocols) ToRawInfo 

func (m *Protocols) ToRawInfo() interface{}

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" json:"_ref,omitempty"`
	ParameterName string `protobuf:"bytes,2,opt,name=parameter_name,json=parameterName" json:"parameter_name,omitempty"`
}

func NewRequest 

func NewRequest(in interface{}, context *compiler.Context) (*Request, error)

NewRequest creates an object of type Request if possible, returning an error if not.

func (*Request) Descriptor 

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

func (*Request) GetParameterName 

func (m *Request) GetParameterName() string

func (*Request) GetXRef 

func (m *Request) GetXRef() string

func (*Request) ProtoMessage 

func (*Request) ProtoMessage()

func (*Request) Reset 

func (m *Request) Reset()

func (*Request) ResolveReferences 

func (m *Request) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Request objects.

func (*Request) String 

func (m *Request) String() string

func (*Request) ToRawInfo 

func (m *Request) ToRawInfo() interface{}

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" json:"methods,omitempty"`
	Resources *Resources `protobuf:"bytes,2,opt,name=resources" json:"resources,omitempty"`
}

func NewResource 

func NewResource(in interface{}, context *compiler.Context) (*Resource, error)

NewResource creates an object of type Resource if possible, returning an error if not.

func (*Resource) Descriptor 

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

func (*Resource) GetMethods 

func (m *Resource) GetMethods() *Methods

func (*Resource) GetResources 

func (m *Resource) GetResources() *Resources

func (*Resource) ProtoMessage 

func (*Resource) ProtoMessage()

func (*Resource) Reset 

func (m *Resource) Reset()

func (*Resource) ResolveReferences 

func (m *Resource) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Resource objects.

func (*Resource) String 

func (m *Resource) String() string

func (*Resource) ToRawInfo 

func (m *Resource) ToRawInfo() interface{}

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" json:"additional_properties,omitempty"`
}

func NewResources 

func NewResources(in interface{}, context *compiler.Context) (*Resources, error)

NewResources creates an object of type Resources if possible, returning an error if not.

func (*Resources) Descriptor 

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

func (*Resources) GetAdditionalProperties 

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

func (*Resources) ProtoMessage 

func (*Resources) ProtoMessage()

func (*Resources) Reset 

func (m *Resources) Reset()

func (*Resources) ResolveReferences 

func (m *Resources) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Resources objects.

func (*Resources) String 

func (m *Resources) String() string

func (*Resources) ToRawInfo 

func (m *Resources) ToRawInfo() interface{}

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" json:"_ref,omitempty"`
}

func NewResponse 

func NewResponse(in interface{}, context *compiler.Context) (*Response, error)

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

func (*Response) Descriptor 

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

func (*Response) GetXRef 

func (m *Response) GetXRef() string

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) Reset 

func (m *Response) Reset()

func (*Response) ResolveReferences 

func (m *Response) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Response objects.

func (*Response) String 

func (m *Response) String() string

func (*Response) ToRawInfo 

func (m *Response) ToRawInfo() interface{}

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" json:"multipart,omitempty"`
	Path      string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
}

func NewResumable 

func NewResumable(in interface{}, context *compiler.Context) (*Resumable, error)

NewResumable creates an object of type Resumable if possible, returning an error if not.

func (*Resumable) Descriptor 

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

func (*Resumable) GetMultipart 

func (m *Resumable) GetMultipart() bool

func (*Resumable) GetPath 

func (m *Resumable) GetPath() string

func (*Resumable) ProtoMessage 

func (*Resumable) ProtoMessage()

func (*Resumable) Reset 

func (m *Resumable) Reset()

func (*Resumable) ResolveReferences 

func (m *Resumable) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Resumable objects.

func (*Resumable) String 

func (m *Resumable) String() string

func (*Resumable) ToRawInfo 

func (m *Resumable) ToRawInfo() interface{}

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" json:"id,omitempty"`
	Type                 string       `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
	Description          string       `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	Default              string       `protobuf:"bytes,4,opt,name=default" json:"default,omitempty"`
	Required             bool         `protobuf:"varint,5,opt,name=required" json:"required,omitempty"`
	Format               string       `protobuf:"bytes,6,opt,name=format" json:"format,omitempty"`
	Pattern              string       `protobuf:"bytes,7,opt,name=pattern" json:"pattern,omitempty"`
	Minimum              string       `protobuf:"bytes,8,opt,name=minimum" json:"minimum,omitempty"`
	Maximum              string       `protobuf:"bytes,9,opt,name=maximum" json:"maximum,omitempty"`
	Enum                 []string     `protobuf:"bytes,10,rep,name=enum" json:"enum,omitempty"`
	EnumDescriptions     []string     `protobuf:"bytes,11,rep,name=enum_descriptions,json=enumDescriptions" json:"enum_descriptions,omitempty"`
	Repeated             bool         `protobuf:"varint,12,opt,name=repeated" json:"repeated,omitempty"`
	Location             string       `protobuf:"bytes,13,opt,name=location" json:"location,omitempty"`
	Properties           *Schemas     `protobuf:"bytes,14,opt,name=properties" json:"properties,omitempty"`
	AdditionalProperties *Schema      `protobuf:"bytes,15,opt,name=additional_properties,json=additionalProperties" json:"additional_properties,omitempty"`
	Items                *Schema      `protobuf:"bytes,16,opt,name=items" json:"items,omitempty"`
	XRef                 string       `protobuf:"bytes,17,opt,name=_ref,json=Ref" json:"_ref,omitempty"`
	Annotations          *Annotations `protobuf:"bytes,18,opt,name=annotations" json:"annotations,omitempty"`
	ReadOnly             bool         `protobuf:"varint,19,opt,name=read_only,json=readOnly" json:"read_only,omitempty"`
}

func NewSchema 

func NewSchema(in interface{}, context *compiler.Context) (*Schema, error)

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

func (*Schema) Descriptor 

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

func (*Schema) GetAdditionalProperties 

func (m *Schema) GetAdditionalProperties() *Schema

func (*Schema) GetAnnotations 

func (m *Schema) GetAnnotations() *Annotations

func (*Schema) GetDefault 

func (m *Schema) GetDefault() string

func (*Schema) GetDescription 

func (m *Schema) GetDescription() string

func (*Schema) GetEnum 

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

func (*Schema) GetEnumDescriptions 

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

func (*Schema) GetFormat 

func (m *Schema) GetFormat() string

func (*Schema) GetId 

func (m *Schema) GetId() string

func (*Schema) GetItems 

func (m *Schema) GetItems() *Schema

func (*Schema) GetLocation 

func (m *Schema) GetLocation() string

func (*Schema) GetMaximum 

func (m *Schema) GetMaximum() string

func (*Schema) GetMinimum 

func (m *Schema) GetMinimum() string

func (*Schema) GetPattern 

func (m *Schema) GetPattern() string

func (*Schema) GetProperties 

func (m *Schema) GetProperties() *Schemas

func (*Schema) GetReadOnly 

func (m *Schema) GetReadOnly() bool

func (*Schema) GetRepeated 

func (m *Schema) GetRepeated() bool

func (*Schema) GetRequired 

func (m *Schema) GetRequired() bool

func (*Schema) GetType 

func (m *Schema) GetType() string

func (*Schema) GetXRef 

func (m *Schema) GetXRef() string

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) Reset 

func (m *Schema) Reset()

func (*Schema) ResolveReferences 

func (m *Schema) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Schema objects.

func (*Schema) String 

func (m *Schema) String() string

func (*Schema) ToRawInfo 

func (m *Schema) ToRawInfo() interface{}

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" json:"additional_properties,omitempty"`
}

func NewSchemas 

func NewSchemas(in interface{}, context *compiler.Context) (*Schemas, error)

NewSchemas creates an object of type Schemas if possible, returning an error if not.

func (*Schemas) Descriptor 

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

func (*Schemas) GetAdditionalProperties 

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

func (*Schemas) ProtoMessage 

func (*Schemas) ProtoMessage()

func (*Schemas) Reset 

func (m *Schemas) Reset()

func (*Schemas) ResolveReferences 

func (m *Schemas) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Schemas objects.

func (*Schemas) String 

func (m *Schemas) String() string

func (*Schemas) ToRawInfo 

func (m *Schemas) ToRawInfo() interface{}

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" json:"description,omitempty"`
}

func NewScope 

func NewScope(in interface{}, context *compiler.Context) (*Scope, error)

NewScope creates an object of type Scope if possible, returning an error if not.

func (*Scope) Descriptor 

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

func (*Scope) GetDescription 

func (m *Scope) GetDescription() string

func (*Scope) ProtoMessage 

func (*Scope) ProtoMessage()

func (*Scope) Reset 

func (m *Scope) Reset()

func (*Scope) ResolveReferences 

func (m *Scope) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Scope objects.

func (*Scope) String 

func (m *Scope) String() string

func (*Scope) ToRawInfo 

func (m *Scope) ToRawInfo() interface{}

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" json:"additional_properties,omitempty"`
}

func NewScopes 

func NewScopes(in interface{}, context *compiler.Context) (*Scopes, error)

NewScopes creates an object of type Scopes if possible, returning an error if not.

func (*Scopes) Descriptor 

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

func (*Scopes) GetAdditionalProperties 

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

func (*Scopes) ProtoMessage 

func (*Scopes) ProtoMessage()

func (*Scopes) Reset 

func (m *Scopes) Reset()

func (*Scopes) ResolveReferences 

func (m *Scopes) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Scopes objects.

func (*Scopes) String 

func (m *Scopes) String() string

func (*Scopes) ToRawInfo 

func (m *Scopes) ToRawInfo() interface{}

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" json:"multipart,omitempty"`
	Path      string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
}

func NewSimple 

func NewSimple(in interface{}, context *compiler.Context) (*Simple, error)

NewSimple creates an object of type Simple if possible, returning an error if not.

func (*Simple) Descriptor 

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

func (*Simple) GetMultipart 

func (m *Simple) GetMultipart() bool

func (*Simple) GetPath 

func (m *Simple) GetPath() string

func (*Simple) ProtoMessage 

func (*Simple) ProtoMessage()

func (*Simple) Reset 

func (m *Simple) Reset()

func (*Simple) ResolveReferences 

func (m *Simple) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside Simple objects.

func (*Simple) String 

func (m *Simple) String() string

func (*Simple) ToRawInfo 

func (m *Simple) ToRawInfo() interface{}

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" json:"value,omitempty"`
}

func NewStringArray 

func NewStringArray(in interface{}, context *compiler.Context) (*StringArray, error)

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

func (*StringArray) Descriptor 

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

func (*StringArray) GetValue 

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

func (*StringArray) ProtoMessage 

func (*StringArray) ProtoMessage()

func (*StringArray) Reset 

func (m *StringArray) Reset()

func (*StringArray) ResolveReferences 

func (m *StringArray) ResolveReferences(root string) (interface{}, error)

ResolveReferences resolves references found inside StringArray objects.

func (*StringArray) String 

func (m *StringArray) String() string

func (*StringArray) ToRawInfo 

func (m *StringArray) ToRawInfo() interface{}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.