fff6089a82
* MM 65084 server-side (#33861) (#34006) Automatic Merge * Add missing changes for API layer (Run `make app-layers` from server directory before finalizing Cherry pick in the future) * Fix opentraceing issues. * More missing channels/store files from not running make store-layers * Update the opentracing_layer.go.tmpl file to import correct paths. There is an issue where, at least up until 10.5, we had a `make app-layers` command that gets run on CI in the PR, this uses this go.tmpl file to create api_iface.go (and possibly others). If this file doesn't match what has been committed, it errors out. As the .tmpl file has these missing imports, it generates bad paths, which then cause other errors. So I need to fix the .tmpl file as well. * Missing model import * Using correct path for i18n in opentracing_layer --------- Co-authored-by: Mattermost Build <[email protected]>
Mattermost API Documentation
This repository 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. APIs for Playbooks are retrieved from GitHub at build time and integrated into the final YAML file.
- 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 v4/html/static/mattermost-openapi-v4.yaml. This will also check syntax using swagger-cli.
To test locally, run make build, make run and navigate to http://127.0.0.1:8080. For any updates to the source files, re-run the same commands.
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.