From fed5324ce505c3725472af23757cd6659bb7139c Mon Sep 17 00:00:00 2001
From: Chris <ccbrown112@gmail.com>
Date: Thu, 2 Nov 2017 16:23:41 -0500
Subject: Add some plugin docs (#7757)

* add some plugin docs

* one more comment

* spacing

* example simplification
---
 plugin/api.go | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'plugin/api.go')

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.
-- 
cgit v1.2.3-1-g7c22