[MM-59396] Update API docs to show common parameters, added per_page docs (#29035)
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
30076fcfcf
Коммит
ee20ac8f69
@@ -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).
|
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
|
- name: users
|
||||||
description: >
|
description: >
|
||||||
Endpoints for creating, getting and interacting with users.
|
Endpoints for creating, getting and interacting with users.
|
||||||
@@ -564,6 +571,7 @@ x-tagGroups:
|
|||||||
- errors
|
- errors
|
||||||
- rate limiting
|
- rate limiting
|
||||||
- WebSocket
|
- WebSocket
|
||||||
|
- common parameters
|
||||||
- name: Endpoints
|
- name: Endpoints
|
||||||
tags:
|
tags:
|
||||||
- users
|
- users
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user