Client side API for communicating with a mattermost server in Haskell
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jonathan Daugherty 2b3f4e4f5f Bump version, update changelog 2 lat temu
examples Add offset/limit parameters to fixes #27, fixes #28 2 lat temu
src/Network API: postRootId is now a Maybe PostId 2 lat temu
test Fix capitalization to read Mattermost. 2 lat temu
.gitignore Added _darcs to .gitignore. 2 lat temu
.travis.yml Use cabal.project.travis to enable -Werror when building on travis 2 lat temu
CHANGELOG.md Bump version, update changelog 2 lat temu
LICENSE initial commit 3 lat temu
README.md Fix capitalization for mattermost in README 2 lat temu
RELEASES.md Fix capitalization to read Mattermost. 2 lat temu
Setup.hs initial commit 3 lat temu
cabal.project.travis Use cabal.project.travis to enable -Werror when building on travis 2 lat temu
mattermost-api.cabal Bump version, update changelog 2 lat temu

README.md

Build
Status

mattermost-api

Client side API for communicating with a Mattermost server, in Haskell.

Testing

We use the MaterMost docker image for detecting changes in the API. See .travis.yml or the Mattermost docs for the details.

If you are testing your changes locally during development, you will want to run the script ./test/local_test_mm.sh.

Note: The local_test_mm.sh script will stop and remove a docker container named mattermost-preview.

Note: The tests can only be run once against a given Mattermost instance. This is because the scripts currently assume they can create an initial admin user.

Note: The scripts assume the instance is reachable on localhost:8065 over plain HTTP.

For use in production we use TLS, but for testing purposes we avoid the certificate setup.

Our Versioning Scheme

This library uses the same versioning scheme as matterhorn, see Our Versioning Scheme. The short version is that in ABBCC.X.Y, the ABBCC corresponds to Mattermost server version A.BB.CC and the X.Y portion of the version string corresponds to the version of mattermost-api package releases.