[MM-59396] Update API docs to show common parameters, added per_page docs (#29035)

This commit is contained in:
Devin Binnie
2024-11-01 11:06:34 -04:00
committed by GitHub
parent 30076fcfcf
commit ee20ac8f69

View File

@@ -475,6 +475,13 @@ tags:
To see how these actions work, please refer to either the [Golang WebSocket driver](https://github.com/mattermost/mattermost/blob/master/server/public/model/websocket_client.go) or our [JavaScript WebSocket driver](https://github.com/mattermost/mattermost/blob/master/webapp/platform/client/src/websocket.ts).
- name: common parameters
description: >
- `per_page`: For paged APIs, the number of items to return per page.
The maximum number of items returned per request is capped at 200. If `per_page` exceeds 200, the list will be silently truncated to 200 items.
If a paged API requires a `per_page` parameter and it is not provided, the default value is 60.
- name: users
description: >
Endpoints for creating, getting and interacting with users.
@@ -564,6 +571,7 @@ x-tagGroups:
- errors
- rate limiting
- WebSocket
- common parameters
- name: Endpoints
tags:
- users