From ee20ac8f698a5f7bf18a0841013af9bc49b0f698 Mon Sep 17 00:00:00 2001
From: Devin Binnie <52460000+devinbinnie@users.noreply.github.com>
Date: Fri, 1 Nov 2024 11:06:34 -0400
Subject: [PATCH] [MM-59396] Update API docs to show common parameters, added
 per_page docs (#29035)

---
 api/v4/source/introduction.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/api/v4/source/introduction.yaml b/api/v4/source/introduction.yaml
index dede6a3867..f3b109e0ae 100644
--- a/api/v4/source/introduction.yaml
+++ b/api/v4/source/introduction.yaml
@@ -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