Ben Schumacher
ea183fab48
* MM-67157: Remove unused format flag from /license/client endpoint The `format` query parameter on the `/license/client` (and local variant) endpoint was effectively dead: it was required but only ever accepted the single value `old`, returning an error otherwise. This mirrors the earlier removal of the same flag from `/config/client`, where the server now ignores the parameter while clients continue to send `format=old` for compatibility with pre-v11 servers. The server no longer inspects the `format` parameter, so requests with no format, `format=old`, or any other value all succeed. The unused i18n string and the parameter/response documentation in the OpenAPI spec are removed accordingly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Audz4JLNQN5SJxcPwyQBd * MM-67157: document format=old retention in webapp client Mirror the getClientConfig comment so the format=old query param on getClientLicenseOld is not mistakenly removed; clients keep sending it for compatibility with pre-v11 servers even though current servers now ignore it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Audz4JLNQN5SJxcPwyQBd * MM-67157: stop sending format=old from webapp client Now that the server ignores the format parameter on /license/client, drop format=old from the @mattermost/client getClientLicenseOld call and update the e2e intercepts/helpers that matched the old query string. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Audz4JLNQN5SJxcPwyQBd * Drop unneeded wildcard from license/client cy.intercept path The format query param is gone from GET /license/client requests, so the trailing * used to match it is no longer needed. --------- Co-authored-by: Claude <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.