Documentation
¶
Index ¶
- Variables
- func RegisterPluginServiceServer(s *grpc.Server, srv PluginServiceServer)
- type Empty
- type MenuItem
- func (*MenuItem) Descriptor() ([]byte, []int)deprecated
- func (x *MenuItem) GetName() string
- func (x *MenuItem) GetPath() string
- func (x *MenuItem) GetSubitems() []*MenuItem
- func (*MenuItem) ProtoMessage()
- func (x *MenuItem) ProtoReflect() protoreflect.Message
- func (x *MenuItem) Reset()
- func (x *MenuItem) String() string
- type Plugin
- func (*Plugin) Descriptor() ([]byte, []int)deprecated
- func (x *Plugin) GetExtension() string
- func (x *Plugin) GetMenus() []*MenuItem
- func (x *Plugin) GetName() string
- func (x *Plugin) GetPaths() []string
- func (*Plugin) ProtoMessage()
- func (x *Plugin) ProtoReflect() protoreflect.Message
- func (x *Plugin) Reset()
- func (x *Plugin) String() string
- type PluginServiceClient
- type PluginServiceServer
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetAuthToken() string
- func (x *Request) GetBody() string
- func (x *Request) GetMethod() string
- func (x *Request) GetPath() string
- func (x *Request) GetPathParams() map[string]string
- func (x *Request) GetRoute() string
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetBody() string
- func (x *Response) GetHeaders() map[string]string
- func (x *Response) GetRaw() bool
- func (x *Response) GetStatusCode() int32
- func (x *Response) GetTitle() string
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type UnimplementedPluginServiceServer
- type UnsafePluginServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_plugin_protos_webui_plugin_proto protoreflect.FileDescriptor
Functions ¶
func RegisterPluginServiceServer ¶
func RegisterPluginServiceServer(s *grpc.Server, srv PluginServiceServer)
Types ¶
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type MenuItem ¶
type MenuItem struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` Subitems []*MenuItem `protobuf:"bytes,3,rep,name=subitems,proto3" json:"subitems,omitempty"` // contains filtered or unexported fields }
func (*MenuItem) ProtoReflect ¶
func (x *MenuItem) ProtoReflect() protoreflect.Message
type Plugin ¶
type Plugin struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // a human-friendly identifier (name) for the extension Extension string `protobuf:"bytes,2,opt,name=extension,proto3" json:"extension,omitempty"` // the domain/path of the extension Paths []string `protobuf:"bytes,10,rep,name=paths,proto3" json:"paths,omitempty"` Menus []*MenuItem `protobuf:"bytes,11,rep,name=menus,proto3" json:"menus,omitempty"` // contains filtered or unexported fields }
func (*Plugin) ProtoReflect ¶
func (x *Plugin) ProtoReflect() protoreflect.Message
type PluginServiceClient ¶
type PluginServiceClient interface { Settings(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Plugin, error) HandleRequest(ctx context.Context, in *Request, opts ...grpc.CallOption) (*Response, error) }
PluginServiceClient is the client API for PluginService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewPluginServiceClient ¶
func NewPluginServiceClient(cc grpc.ClientConnInterface) PluginServiceClient
type PluginServiceServer ¶
type PluginServiceServer interface { Settings(context.Context, *Empty) (*Plugin, error) HandleRequest(context.Context, *Request) (*Response, error) // contains filtered or unexported methods }
PluginServiceServer is the server API for PluginService service. All implementations must embed UnimplementedPluginServiceServer for forward compatibility
type Request ¶
type Request struct { Route string `protobuf:"bytes,1,opt,name=route,proto3" json:"route,omitempty"` Method string `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"` Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"` PathParams map[string]string `` /* 179-byte string literal not displayed */ // map<string, string> headers = 5; Body string `protobuf:"bytes,6,opt,name=body,proto3" json:"body,omitempty"` AuthToken string `protobuf:"bytes,7,opt,name=auth_token,json=authToken,proto3" json:"auth_token,omitempty"` // contains filtered or unexported fields }
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶
type Response struct { StatusCode int32 `protobuf:"varint,1,opt,name=status_code,json=statusCode,proto3" json:"status_code,omitempty"` Headers map[string]string `` /* 155-byte string literal not displayed */ Body string `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"` // response body, will be rendered in the standard page template unless raw = true Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"` // title of the HTML page Raw bool `protobuf:"varint,5,opt,name=raw,proto3" json:"raw,omitempty"` // disables wrapping the body in the page template, the raw body value will be returned to the client // contains filtered or unexported fields }
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type UnimplementedPluginServiceServer ¶
type UnimplementedPluginServiceServer struct { }
UnimplementedPluginServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedPluginServiceServer) HandleRequest ¶
type UnsafePluginServiceServer ¶
type UnsafePluginServiceServer interface {
// contains filtered or unexported methods
}
UnsafePluginServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PluginServiceServer will result in compilation errors.
Source Files
¶
- webui-plugin.pb.go
- webui-plugin_grpc.pb.go