fix(specs): update analytics and abtesting max pagination query limit (…

…#3696) Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia · Oct 3, 2024 · ad8e3d2 · ad8e3d2
1 parent 3a3b794
commit ad8e3d2
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 37 deletions.
diff --git a/specs/abtesting/paths/abtests.yml b/specs/abtesting/paths/abtests.yml
@@ -62,8 +62,21 @@ get:
   summary: List all A/B tests
   description: Lists all A/B tests you configured for this application.
   parameters:
-    - $ref: '../../common/parameters.yml#/Offset'
-    - $ref: '../../common/parameters.yml#/Limit'
+    - name: offset
+      in: query
+      description: Position of the first item to return.
+      required: false
+      schema:
+        type: integer
+        default: 0
+        minimum: 0
+    - name: limit
+      in: query
+      description: Number of items to return.
+      required: false
+      schema:
+        type: integer
+        default: 10
     - name: indexPrefix
       in: query
       description: Index name prefix. Only A/B tests for indices starting with this string are included in the response.

diff --git a/specs/analytics/common/parameters.yml b/specs/analytics/common/parameters.yml
@@ -19,6 +19,34 @@ OrderBy:
   schema:
     $ref: '#/orderBy'
 
+Offset:
+  in: query
+  name: offset
+  description: |
+    Position of the first item to return.
+
+    Combined with the `limit` parameter, only the first 1000 items can be retrieved.
+  required: false
+  schema:
+    type: integer
+    default: 0
+    minimum: 0
+    maximum: 1000
+
+Limit:
+  in: query
+  name: limit
+  description: |
+    Number of items to return.
+
+    Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+
+  required: false
+  schema:
+    type: integer
+    default: 10
+    maximum: 1000
+
 # private
 orderBy:
   type: string

diff --git a/specs/analytics/paths/search/getSearchesNoClicks.yml b/specs/analytics/paths/search/getSearchesNoClicks.yml
@@ -10,8 +10,8 @@ get:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getSearchesNoResults.yml b/specs/analytics/paths/search/getSearchesNoResults.yml
@@ -10,8 +10,8 @@ get:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopCountries.yml b/specs/analytics/paths/search/getTopCountries.yml
@@ -10,8 +10,8 @@ get:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopFilterAttributes.yml b/specs/analytics/paths/search/getTopFilterAttributes.yml
@@ -14,8 +14,8 @@ get:
     - $ref: '../../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopFilterForAttribute.yml b/specs/analytics/paths/search/getTopFilterForAttribute.yml
@@ -15,8 +15,8 @@ get:
     - $ref: '../../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopFiltersNoResults.yml b/specs/analytics/paths/search/getTopFiltersNoResults.yml
@@ -14,8 +14,8 @@ get:
     - $ref: '../../common/parameters.yml#/Search'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopHits.yml b/specs/analytics/paths/search/getTopHits.yml
@@ -13,8 +13,8 @@ get:
     - $ref: '../../common/parameters.yml#/RevenueAnalytics'
     - $ref: '../../../common/parameters.yml#/StartDate'
     - $ref: '../../../common/parameters.yml#/EndDate'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/analytics/paths/search/getTopSearches.yml b/specs/analytics/paths/search/getTopSearches.yml
@@ -14,8 +14,8 @@ get:
     - $ref: '../../../common/parameters.yml#/EndDate'
     - $ref: '../../common/parameters.yml#/OrderBy'
     - $ref: '../../common/parameters.yml#/Direction'
-    - $ref: '../../../common/parameters.yml#/Limit'
-    - $ref: '../../../common/parameters.yml#/Offset'
+    - $ref: '../../common/parameters.yml#/Limit'
+    - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Tags'
   responses:
     '200':

diff --git a/specs/common/parameters.yml b/specs/common/parameters.yml
@@ -104,25 +104,6 @@ HitsPerPage:
     type: integer
     default: 100
 
-Offset:
-  in: query
-  name: offset
-  description: Position of the first item to return.
-  required: false
-  schema:
-    type: integer
-    default: 0
-    minimum: 0
-
-Limit:
-  in: query
-  name: limit
-  description: Number of items to return.
-  required: false
-  schema:
-    type: integer
-    default: 10
-
 # misc
 objectID:
   type: string