summaryrefslogtreecommitdiffstats
path: root/plugin/api.go
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/api.go')
-rw-r--r--plugin/api.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/plugin/api.go b/plugin/api.go
index e9a2892fc..d7443d813 100644
--- a/plugin/api.go
+++ b/plugin/api.go
@@ -7,6 +7,8 @@ import (
"github.com/mattermost/mattermost-server/model"
)
+// API implementations can be used to retrieve data or perform actions on behalf of the plugin. Most
+// methods have direct counterparts in the REST API and very similar behavior.
type API interface {
// LoadPluginConfiguration loads the plugin's configuration. dest should be a pointer to a
// struct that the configuration JSON can be unmarshalled to.