Skip to content

matterhorn-chat/mattermost-api-reference

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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.

About

Mattermost API reference documentation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Makefile 62.3%
  • HTML 37.7%