api

package
v0.20.15 Latest Latest
Warning

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

 Go to latest Published: Aug 12, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthApi        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowApi          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupApi = fmt.Errorf("proto: unexpected end of group")
)

Functions

This section is empty.

Types

type Endpoint 

type Endpoint struct {
	// RPC Method e.g. Greeter.Hello
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description e.g what's this endpoint for
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// API Handler e.g rpc, proxy
	Handler string `protobuf:"bytes,3,opt,name=handler,proto3" json:"handler,omitempty"`
	// HTTP Host e.g example.com
	Host []string `protobuf:"bytes,4,rep,name=host,proto3" json:"host,omitempty"`
	// HTTP Methods e.g GET, POST
	Method []string `protobuf:"bytes,5,rep,name=method,proto3" json:"method,omitempty"`
	// HTTP Path e.g /greeter. Expect POSIX regex
	Path []string `protobuf:"bytes,6,rep,name=path,proto3" json:"path,omitempty"`
	// Body destination
	// "*" or "" - top level message value
	// "string" - inner message value
	Body string `protobuf:"bytes,7,opt,name=body,proto3" json:"body,omitempty"`
	// Stream flag
	Stream bool `protobuf:"varint,8,opt,name=stream,proto3" json:"stream,omitempty"`
}

Endpoint is a mapping between an RPC method and HTTP endpoint

func (*Endpoint) Descriptor 

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

func (*Endpoint) Marshal 

func (m *Endpoint) Marshal() (dAtA []byte, err error)

func (*Endpoint) MarshalTo 

func (m *Endpoint) MarshalTo(dAtA []byte) (int, error)

func (*Endpoint) MarshalToSizedBuffer 

func (m *Endpoint) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Endpoint) ProtoMessage 

func (*Endpoint) ProtoMessage()

func (*Endpoint) Reset 

func (m *Endpoint) Reset()

func (*Endpoint) String 

func (m *Endpoint) String() string

func (*Endpoint) Unmarshal 

func (m *Endpoint) Unmarshal(dAtA []byte) error

func (*Endpoint) XSize 

func (m *Endpoint) XSize() (n int)

func (*Endpoint) XXX_DiscardUnknown 

func (m *Endpoint) XXX_DiscardUnknown()

func (*Endpoint) XXX_Marshal 

func (m *Endpoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Endpoint) XXX_Merge 

func (m *Endpoint) XXX_Merge(src proto.Message)

func (*Endpoint) XXX_Size 

func (m *Endpoint) XXX_Size() int

func (*Endpoint) XXX_Unmarshal 

func (m *Endpoint) XXX_Unmarshal(b []byte) error

type Event 

type Event struct {
	// e.g login
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// uuid
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// unix timestamp of event
	Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// event headers
	Header map[string]*Pair `` /* 153-byte string literal not displayed */
	// the event data
	Data string `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
}

A HTTP event as RPC Forwarded by the event handler

func (*Event) Descriptor 

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

func (*Event) Marshal 

func (m *Event) Marshal() (dAtA []byte, err error)

func (*Event) MarshalTo 

func (m *Event) MarshalTo(dAtA []byte) (int, error)

func (*Event) MarshalToSizedBuffer 

func (m *Event) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) Reset 

func (m *Event) Reset()

func (*Event) String 

func (m *Event) String() string

func (*Event) Unmarshal 

func (m *Event) Unmarshal(dAtA []byte) error

func (*Event) XSize 

func (m *Event) XSize() (n int)

func (*Event) XXX_DiscardUnknown 

func (m *Event) XXX_DiscardUnknown()

func (*Event) XXX_Marshal 

func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Event) XXX_Merge 

func (m *Event) XXX_Merge(src proto.Message)

func (*Event) XXX_Size 

func (m *Event) XXX_Size() int

func (*Event) XXX_Unmarshal 

func (m *Event) XXX_Unmarshal(b []byte) error

type Pair 

type Pair struct {
	Key    string   `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
}

func (*Pair) Descriptor 

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

func (*Pair) Marshal 

func (m *Pair) Marshal() (dAtA []byte, err error)

func (*Pair) MarshalTo 

func (m *Pair) MarshalTo(dAtA []byte) (int, error)

func (*Pair) MarshalToSizedBuffer 

func (m *Pair) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Pair) ProtoMessage 

func (*Pair) ProtoMessage()

func (*Pair) Reset 

func (m *Pair) Reset()

func (*Pair) String 

func (m *Pair) String() string

func (*Pair) Unmarshal 

func (m *Pair) Unmarshal(dAtA []byte) error

func (*Pair) XSize 

func (m *Pair) XSize() (n int)

func (*Pair) XXX_DiscardUnknown 

func (m *Pair) XXX_DiscardUnknown()

func (*Pair) XXX_Marshal 

func (m *Pair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Pair) XXX_Merge 

func (m *Pair) XXX_Merge(src proto.Message)

func (*Pair) XXX_Size 

func (m *Pair) XXX_Size() int

func (*Pair) XXX_Unmarshal 

func (m *Pair) XXX_Unmarshal(b []byte) error

type Request 

type Request struct {
	Method string           `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	Path   string           `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	Header map[string]*Pair `` /* 153-byte string literal not displayed */
	Get    map[string]*Pair `` /* 147-byte string literal not displayed */
	Post   map[string]*Pair `` /* 149-byte string literal not displayed */
	Body   string           `protobuf:"bytes,6,opt,name=body,proto3" json:"body,omitempty"`
	Url    string           `protobuf:"bytes,7,opt,name=url,proto3" json:"url,omitempty"`
}

A HTTP request as RPC Forward by the api handler

func (*Request) Descriptor 

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

func (*Request) Marshal 

func (m *Request) Marshal() (dAtA []byte, err error)

func (*Request) MarshalTo 

func (m *Request) MarshalTo(dAtA []byte) (int, error)

func (*Request) MarshalToSizedBuffer 

func (m *Request) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Request) ProtoMessage 

func (*Request) ProtoMessage()

func (*Request) Reset 

func (m *Request) Reset()

func (*Request) String 

func (m *Request) String() string

func (*Request) Unmarshal 

func (m *Request) Unmarshal(dAtA []byte) error

func (*Request) XSize 

func (m *Request) XSize() (n int)

func (*Request) XXX_DiscardUnknown 

func (m *Request) XXX_DiscardUnknown()

func (*Request) XXX_Marshal 

func (m *Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Request) XXX_Merge 

func (m *Request) XXX_Merge(src proto.Message)

func (*Request) XXX_Size 

func (m *Request) XXX_Size() int

func (*Request) XXX_Unmarshal 

func (m *Request) XXX_Unmarshal(b []byte) error

type Response 

type Response struct {
	StatusCode int32            `protobuf:"varint,1,opt,name=statusCode,proto3" json:"statusCode,omitempty"`
	Header     map[string]*Pair `` /* 153-byte string literal not displayed */
	Body       string           `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
}

A HTTP response as RPC Expected response for the api handler

func (*Response) Descriptor 

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

func (*Response) Marshal 

func (m *Response) Marshal() (dAtA []byte, err error)

func (*Response) MarshalTo 

func (m *Response) MarshalTo(dAtA []byte) (int, error)

func (*Response) MarshalToSizedBuffer 

func (m *Response) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) Reset 

func (m *Response) Reset()

func (*Response) String 

func (m *Response) String() string

func (*Response) Unmarshal 

func (m *Response) Unmarshal(dAtA []byte) error

func (*Response) XSize 

func (m *Response) XSize() (n int)

func (*Response) XXX_DiscardUnknown 

func (m *Response) XXX_DiscardUnknown()

func (*Response) XXX_Marshal 

func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Response) XXX_Merge 

func (m *Response) XXX_Merge(src proto.Message)

func (*Response) XXX_Size 

func (m *Response) XXX_Size() int

func (*Response) XXX_Unmarshal 

func (m *Response) XXX_Unmarshal(b []byte) error

type Service 

type Service struct {
	// Name of service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The endpoint for this service
	Endpoint *Endpoint `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Versions of this service
	Services []*registry.Service `protobuf:"bytes,3,rep,name=services,proto3" json:"services,omitempty"`
}

Service represents an API service

func (*Service) Descriptor 

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

func (*Service) Marshal 

func (m *Service) Marshal() (dAtA []byte, err error)

func (*Service) MarshalTo 

func (m *Service) MarshalTo(dAtA []byte) (int, error)

func (*Service) MarshalToSizedBuffer 

func (m *Service) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Service) ProtoMessage 

func (*Service) ProtoMessage()

func (*Service) Reset 

func (m *Service) Reset()

func (*Service) String 

func (m *Service) String() string

func (*Service) Unmarshal 

func (m *Service) Unmarshal(dAtA []byte) error

func (*Service) XSize 

func (m *Service) XSize() (n int)

func (*Service) XXX_DiscardUnknown 

func (m *Service) XXX_DiscardUnknown()

func (*Service) XXX_Marshal 

func (m *Service) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Service) XXX_Merge 

func (m *Service) XXX_Merge(src proto.Message)

func (*Service) XXX_Size 

func (m *Service) XXX_Size() int

func (*Service) XXX_Unmarshal 

func (m *Service) XXX_Unmarshal(b []byte) error

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.