Mattermost API Documentation
This respository holds the API reference available at https://api.mattermost.com.
All documentation is available under the terms of a Creative Commons License.
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.
- When adding a new route, please add it to the correct file. For example, a channel route will go in channels.yaml.
- To add a new tag, please do so in introduction.yaml
- Definitions should be added to definitions.yaml
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.
To test locally, run
make run and navigate to
http://127.0.0.1:8080. For any updates to the source files, re-run the same commands.
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.