diff --git a/api/v4/source/bots.yaml b/api/v4/source/bots.yaml index 0a0e3ccb51b..c30ccf8372c 100644 --- a/api/v4/source/bots.yaml +++ b/api/v4/source/bots.yaml @@ -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 diff --git a/api/v4/source/channels.yaml b/api/v4/source/channels.yaml index 093d50fd1d0..b01d9b8a6c8 100644 --- a/api/v4/source/channels.yaml +++ b/api/v4/source/channels.yaml @@ -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 diff --git a/api/v4/source/dataretention.yaml b/api/v4/source/dataretention.yaml index 2458164ea56..1ee7d85a7e4 100644 --- a/api/v4/source/dataretention.yaml +++ b/api/v4/source/dataretention.yaml @@ -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 diff --git a/api/v4/source/introduction.yaml b/api/v4/source/introduction.yaml index 8b87f6693f3..f0483662e57 100644 --- a/api/v4/source/introduction.yaml +++ b/api/v4/source/introduction.yaml @@ -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 diff --git a/api/v4/source/ldap.yaml b/api/v4/source/ldap.yaml index f1dce0da471..c44a4fe2d94 100644 --- a/api/v4/source/ldap.yaml +++ b/api/v4/source/ldap.yaml @@ -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 diff --git a/api/v4/source/users.yaml b/api/v4/source/users.yaml index 3543aa4d789..0e1e4f2485d 100644 --- a/api/v4/source/users.yaml +++ b/api/v4/source/users.yaml @@ -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