Documentation
¶
Index ¶
Constants ¶
View Source
const (
// InfoURL is the well-known HTTP GET endpoint that retrieves description of the plugin's interfaces.
InfoURL = "/info/api.json"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handshake ¶ added in v0.3.0
type Handshake []spi.InterfaceSpec
Handshake is a simple RPC object for doing handshake
func (Handshake) Implements ¶ added in v0.3.0
func (h Handshake) Implements(_ *http.Request, req *ImplementsRequest, resp *ImplementsResponse) error
Implements responds to a request for the supported plugin interfaces.
type ImplementsRequest ¶ added in v0.3.0
type ImplementsRequest struct {
}
ImplementsRequest is the rpc wrapper for the Implements method args.
type ImplementsResponse ¶ added in v0.3.0
type ImplementsResponse struct {
APIs []spi.InterfaceSpec
}
ImplementsResponse is the rpc wrapper for the Implements return value.
type InputExample ¶
type InputExample interface {
// SetExampleProperties updates the parameter with example properties.
// The request param must be a pointer
SetExampleProperties(request interface{})
}
InputExample is the interface implemented by the rpc implementations for group, instance, and flavor to set example input using custom/ vendored data types.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.