[MM-57966]Centralize the 200 maximum page size cap for the per_page parameter and remove individual mentions from API endpoint documentation (#26859)

This commit is contained in:
Kunal Acharya
2024-04-25 21:18:25 +05:30
committed by GitHub
parent 173ff52e18
commit 5f1a357845
6 changed files with 13 additions and 13 deletions

View File

@@ -60,8 +60,7 @@
default: 0
- name: per_page
in: query
description: The number of users per page. There is a maximum limit of 200 users
per page.
description: The number of users per page.
schema:
type: integer
default: 60

View File

@@ -1307,7 +1307,7 @@
default: 0
- name: per_page
in: query
description: The number of members per page. There is a maximum limit of 200 members.
description: The number of members per page.
schema:
type: integer
default: 60

View File

@@ -93,7 +93,7 @@
default: 0
- name: per_page
in: query
description: The number of policies per page. There is a maximum limit of 200 per page.
description: The number of policies per page.
schema:
type: integer
default: 60
@@ -301,7 +301,7 @@
default: 0
- name: per_page
in: query
description: The number of teams per page. There is a maximum limit of 200 per page.
description: The number of teams per page.
schema:
type: integer
default: 60
@@ -495,7 +495,7 @@
default: 0
- name: per_page
in: query
description: The number of channels per page. There is a maximum limit of 200 per page.
description: The number of channels per page.
schema:
type: integer
default: 60

View File

@@ -49,6 +49,9 @@ tags:
When using endpoints that require a user id, the string `me` can be used in place of the user id to indicate the action is to be taken for the logged in user.
For all endpoints that implement pagination via the `per_page` parameter, 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.
- name: drivers
description: >
The easiest way to interact with the Mattermost Web Service API is through

View File

@@ -71,7 +71,7 @@
default: 0
- name: per_page
in: query
description: The number of users per page. There is a maximum limit of 200 users
description: The number of users per page.
per page.
schema:
type: integer

View File

@@ -195,8 +195,7 @@
default: 0
- name: per_page
in: query
description: The number of users per page. There is a maximum limit of 200 users
per page.
description: The number of users per page.
schema:
type: integer
default: 60
@@ -3140,7 +3139,7 @@
default: 0
- name: per_page
in: query
description: The number of policies per page. There is a maximum limit of 200 per page.
description: The number of policies per page.
schema:
type: integer
default: 60
@@ -3190,7 +3189,7 @@
default: 0
- name: per_page
in: query
description: The number of policies per page. There is a maximum limit of 200 per page.
description: The number of policies per page.
schema:
type: integer
default: 60
@@ -3233,8 +3232,7 @@
default: 0
- name: per_page
in: query
description: The number of users per page. There is a maximum limit of 200 users
per page.
description: The number of users per page.
schema:
type: integer
default: 60