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.
We're accepting pull requests! Specifically we're looking for documenation on routes defined here.
All the documentation is written in YAML and found in the source directory.
- 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. To check for syntax, you can copy the contents of that into http://editor.swagger.io/ or you can look into using a commandline or ESLint-based syntax checker.
Currently, deployment is handled manually and can be done by running make build and deploying the full /html directory to the hosted sited.