chore(customers): CUST-3623 update get customers api docs based on co…

…mments
bigcommerce · Jan 24, 2025 · 2c0acf1 · 2c0acf1
1 parent 68bdbf6
commit 2c0acf1
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/reference/customers.v3.yml b/reference/customers.v3.yml
@@ -52,7 +52,7 @@ paths:
       parameters:
         - name: page
           in: query
-          description: Page number. `page` would be ignored when `before` or `after` is provided in the request. `page=1`
+          description: Page number (`page` will be ignored if `before` or `after` is provided in the request). For example `page=1`.
           schema:
             type: integer
         - in: query
@@ -210,12 +210,12 @@ paths:
               - 'date_modified:desc'
         - name: after
           in: query
-          description: 'Use the `end_cursor` value from the previous response for the next page. For example `after=eyJpZCI6MjA0fQ`. `end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`.'
+          description: 'The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the previous response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJpZCI6MjA0fQ`. '
           schema:
             type: string
         - name: before
           in: query
-          description: 'Use the `start_cursor` value from the previous response for the previous page. For example `before=eyJpZCI6MjA1fQ`. `start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`.'
+          description: 'The cursor reference of the first entry for the next page. Use the `start_cursor` value from the previous response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJpZCI6MjA1fQ`.'
           schema:
             type: string
       responses:
@@ -1462,7 +1462,7 @@ paths:
             default: application/json
         - name: page
           in: query
-          description: Page number. `page` would be ignored when `before` or `after` is provided in the request. `page=1`
+          description: Page number (`page` will be ignored if `before` or `after` is provided in the request). For example `page=1`.
           schema:
             type: integer
         - in: query
@@ -1510,12 +1510,12 @@ paths:
               - picklist
         - name: after
           in: query
-          description: 'Use the `end_cursor` value from the previous response for the next page. For example `after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0`. `end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`.'
+          description: 'The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the previous response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0`. '
           schema:
             type: string
         - name: before
           in: query
-          description: 'Use the `start_cursor` value from the previous response for the previous page. For example `before=eyJzZXNzaW9uSWQiOjgsImZpZWxkSWQiOjMxfQ`. `start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`.'
+          description: 'The cursor reference of the first entry for the next page. Use the `start_cursor` value from the previous response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJzZXNzaW9uSWQiOjgsImZpZWxkSWQiOjMxfQ`.'
           schema:
             type: string
     put: