api

Documentation

Index

• Variables
• type MetadataOutput
  • func (m MetadataOutput) Validate() error

Variables

var HandshakeConfig = plugin.HandshakeConfig{

	MagicCookieKey:   "BOTKUBE",
	MagicCookieValue: "52ca7b74-28eb-4fac-ae79-31a9cbda2454",
}

HandshakeConfig is common handshake config between Botkube and its plugins.

Types

type MetadataOutput

type MetadataOutput struct {
	// Version is a version of a given plugin. It should follow the SemVer syntax.
	Version string
	// Descriptions is a description of a given plugin.
	Description string
}

MetadataOutput contains the metadata of a given plugin.

func (MetadataOutput) Validate

func (m MetadataOutput) Validate() error

Validate validate the metadata fields and returns detected issues.