Jesse Hallam
dd11197043
* MM-64807: Deprecate format parameter in client config endpoint - Remove requirement for format=old query parameter in /api/v4/config/client - Endpoint now returns client configuration by default without parameters - Maintain backward compatibility - format parameter is accepted but ignored - Replace GetOldClientConfig with GetClientConfig across all clients - Update API documentation to reflect simplified endpoint - Update webapp client to remove format parameter usage The endpoint previously returned HTTP 501 without format=old parameter. Now it returns the client configuration directly, making the API more intuitive while preserving compatibility with existing clients. * Update i18n strings after format parameter deprecation * Update E2E tests to use getClientConfig instead of getClientConfigOld - Replace getClientConfigOld calls in playwright test library - Aligns with format parameter deprecation in MM-64807 * Keep format=old parameter in webapp getClientConfig for pre-v11 compatibility
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.