diff options
| author | Chris <ccbrown112@gmail.com> | 2017-11-02 16:23:41 -0500 |
|---|---|---|
| committer | Joram Wilander <jwawilander@gmail.com> | 2017-11-02 17:23:41 -0400 |
| commit | fed5324ce505c3725472af23757cd6659bb7139c (patch) | |
| tree | c2ad489c627d99e30ed55e25a9f0058a7068a13a /plugin/api.go | |
| parent | 8e81ded9ba425971bafdb8ad6bbe4b23c7420335 (diff) | |
| download | chat-fed5324ce505c3725472af23757cd6659bb7139c.tar.gz chat-fed5324ce505c3725472af23757cd6659bb7139c.tar.bz2 chat-fed5324ce505c3725472af23757cd6659bb7139c.zip | |
Add some plugin docs (#7757)
* add some plugin docs
* one more comment
* spacing
* example simplification
Diffstat (limited to 'plugin/api.go')
| -rw-r--r-- | plugin/api.go | 2 |
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. |