mattermost-api-reference's Introduction

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

Mattermost API version 4 is an active and in-progress project. We're looking for contributors to code server endpoints, build drivers and write documentation. If you're interested please join our Mattermost instance and join the APIv4 channel.

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 v3/source and v4/source directories. APIv3 documentation is in the v3 directory, and APIv4 documentation is in the v4 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. 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.

mattermost-api-reference's People