Harshil SharmaandClaude Opus 5
0019ecc531
* Added server and client side frameowkr for configuring settings * Type fixes * Added test mocks * Review fixes * Restored gotool go modules * CI * (2) - Post tracking audit event implementation (#37919) * Initial implementation for generating delivery tracking * Initial implementation for generating delivery tracking * Some performance improvements * Some performance improvements * Record list.Posts instead of list.Order * Fixed email batch delivery recording * Fixed a couple of pending delivery mechanisms * Caching fixes * another few fixes * Stub DeliveryTracking in store mocks used by cache purge InvalidateAllCachesSkipSend now also clears the delivery tracking store's caches. The partial store mocks in these tests mirror the store list that function touches, so the added call panicked with an unexpected DeliveryTracking() during test cleanup. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Recorded post delivery event after JSON encoding succeeds * Updated decisionmkaing point in email delivery tracking * Plugin hook handling * Added the Learn More button on delivery tracking section * Added in inline code comment for explaining a decision * Restored go modules * Updated indirect status of a go dependency * Removed learn more button * fixed a test --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Mattermost API Documentation
This repository holds the API reference documentation for Mattermost available at https://developers.mattermost.com/api-reference.
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 Github Actions. When a pull request is merged, it will automatically be deployed to https://developers.mattermost.com/api-reference.