7b0b0d8609
* enforce strict opengraph cache entry size limit * move json marshalling and error checking into parsOpenGraphMetadata fn * fix linting * fix potential nil deref * Revert "fix potential nil deref" This reverts commit 095bcd496e9b8d97ca63d3a99e2e46eec58ef7ae. * Revert "fix linting" This reverts commit f3e1f7b27634ca0567fd0fef01ac23f5e39009a7. * Revert "move json marshalling and error checking into parsOpenGraphMetadata fn" This reverts commit ba9a1e13b0fb9d4579077b7b37666e950a5fb6ed. * Revert "enforce strict opengraph cache entry size limit" This reverts commit d1de4a8fa40e58ac85c85f66de27ec5aca884b18. * remove /opengraph api endpoint * i18n * removing unneeded action and reducer
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.