Mattermost API reference documentation.
Switch branches/tags
Clone or download
lisakycho and cpanato /users/stats api endpoint documentation. (#375)
* /users/stats api endpoint documentation.

* Changes as requested
Latest commit 87a2f9b Nov 27, 2018

README.md

Mattermost API Documentation

This respository holds the API reference available at https://api.mattermost.com.

The Mattermost API reference uses the OpenAPI standard and the ReDoc document generator.

All documentation is available under the terms of a Creative Commons License.

Contributing

We're accepting pull requests! See something that could be documented better or is missing documentation? Make a PR and we'll gladly accept it.

All the documentation is written in YAML and found in the v4/source directories. APIv4 documentation is in the v4 directory.

There is no strict style guide but please try to follow the example of the existing documentation.

To build the full YAML, run make build and it will be output to html/static/mattermost-openapi.yaml. This will also check syntax using swagger-cli.

Deployment

Deployment is handled automatically by our Jenkins CLI machine. When a pull request is merged it will automatically be deployed to https://api.mattermost.com.