spi

Documentation

Index

• type InputExample
• type InterfaceSpec
  • func DecodeInterfaceSpec(s string) InterfaceSpec
  • func (i InterfaceSpec) Encode() string
• type Vendor
• type VendorInfo

Types

type InputExample

type InputExample interface {

	// ExampleProperties returns an example JSON raw message that the vendor plugin understands.
	// This is an example of what the user will configure and what will be used as the opaque
	// blob in all the plugin methods where raw JSON messages are referenced.
	ExampleProperties() *types.Any
}

InputExample interface is an optional interface implemented by the plugin that will provide example input struct to document the vendor-specific api of the plugin. An example of this is to provide a sample JSON for all the Properties field in the plugin API.

type InterfaceSpec

type InterfaceSpec types.InterfaceSpec

InterfaceSpec is metadata about an API.

func DecodeInterfaceSpec

func DecodeInterfaceSpec(s string) InterfaceSpec

DecodeInterfaceSpec takes a string and returns the struct

func (InterfaceSpec) Encode

func (i InterfaceSpec) Encode() string

Encode encodes a struct form to string

type Vendor

type Vendor interface {
	// VendorInfo returns a vendor-defined interface spec
	VendorInfo() *VendorInfo
}

Vendor is an optional interface that has vendor-specific information methods

type VendorInfo

type VendorInfo struct {
	InterfaceSpec // vendor-defined name / version

	// URL is the informational url for the plugin. It can container help and docs, etc.
	URL string
}

VendorInfo provides vendor-specific information