fix(specs): remove cross-references of analytics (#3414)

algolia · Jul 24, 2024 · be060a0 · be060a0
1 parent 316e90a
commit be060a0
Show file tree

Hide file tree

Showing 28 changed files with 111 additions and 118 deletions.
diff --git a/specs/abtesting/common/schemas/Variant.yml b/specs/abtesting/common/schemas/Variant.yml
@@ -95,7 +95,7 @@ variant:
           example: 86269
         - type: 'null'
     trackedSearchCount:
-      $ref: '../../../analytics/common/parameters.yml#/trackedSearchCount'
+      $ref: '../../../common/parameters.yml#/trackedSearchCount'
     trafficPercentage:
       $ref: '../parameters.yml#/trafficPercentage'
     userCount:

diff --git a/specs/abtesting/paths/abtest.yml b/specs/abtesting/paths/abtest.yml
@@ -13,11 +13,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -46,11 +46,11 @@ delete:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/abtesting/paths/abtests.yml b/specs/abtesting/paths/abtests.yml
@@ -35,11 +35,11 @@ post:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -81,11 +81,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/abtesting/paths/stopABTest.yml b/specs/abtesting/paths/stopABTest.yml
@@ -16,11 +16,11 @@ post:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/analytics/common/parameters.yml b/specs/analytics/common/parameters.yml
@@ -67,12 +67,6 @@ count:
   type: integer
   example: 504
 
-trackedSearchCount:
-  type: integer
-  example: 2
-  default: 0
-  description: Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-
 noResultCount:
   description: Number of searches without any results.
   type: integer
@@ -302,21 +296,3 @@ withFilterCount:
   example: 5
   minimum: 0
   default: 0
-
-x-ratelimit-limit:
-  description: Number of allowed requests per one minute.
-  example: 100
-  schema:
-    type: integer
-
-x-ratelimit-remaining:
-  description: Number of remaining requests in the current period.
-  example: 99
-  schema:
-    type: integer
-
-x-ratelimit-reset:
-  description: Timstamp when the rate limit will reset, measured in seconds since the Unix epoch.
-  example: 1710682486
-  schema:
-    type: integer
diff --git a/specs/analytics/common/schemas/getTopHits.yml b/specs/analytics/common/schemas/getTopHits.yml
@@ -53,7 +53,7 @@ topHitsResponseWithAnalytics:
           conversionRate:
             $ref: '../parameters.yml#/conversionRate'
           trackedHitCount:
-            $ref: '../parameters.yml#/trackedSearchCount'
+            $ref: '../../../common/parameters.yml#/trackedSearchCount'
           clickCount:
             $ref: '../parameters.yml#/clickCount'
           conversionCount:
@@ -96,7 +96,7 @@ topHitsResponseWithRevenueAnalytics:
           conversionRate:
             $ref: '../parameters.yml#/conversionRate'
           trackedHitCount:
-            $ref: '../parameters.yml#/trackedSearchCount'
+            $ref: '../../../common/parameters.yml#/trackedSearchCount'
           clickCount:
             $ref: '../parameters.yml#/clickCount'
           conversionCount:

diff --git a/specs/analytics/common/schemas/getTopSearches.yml b/specs/analytics/common/schemas/getTopSearches.yml
@@ -63,7 +63,7 @@ topSearchesResponseWithAnalytics:
           conversionRate:
             $ref: '../parameters.yml#/conversionRate'
           trackedSearchCount:
-            $ref: '../parameters.yml#/trackedSearchCount'
+            $ref: '../../../common/parameters.yml#/trackedSearchCount'
           clickCount:
             $ref: '../parameters.yml#/clickCount'
           conversionCount:
@@ -115,7 +115,7 @@ topSearchesResponseWithRevenueAnalytics:
           conversionRate:
             $ref: '../parameters.yml#/conversionRate'
           trackedSearchCount:
-            $ref: '../parameters.yml#/trackedSearchCount'
+            $ref: '../../../common/parameters.yml#/trackedSearchCount'
           clickCount:
             $ref: '../parameters.yml#/clickCount'
           conversionCount:

diff --git a/specs/analytics/paths/click/getAddToCartRate.yml b/specs/analytics/paths/click/getAddToCartRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -39,7 +39,7 @@ get:
               rate:
                 $ref: '../../common/parameters.yml#/addToCartRate'
               trackedSearchCount:
-                $ref: '../../common/parameters.yml#/trackedSearchCount'
+                $ref: '../../../common/parameters.yml#/trackedSearchCount'
               addToCartCount:
                 $ref: '../../common/parameters.yml#/addToCartCount'
               dates:
@@ -58,7 +58,7 @@ get:
                     rate:
                       $ref: '../../common/parameters.yml#/addToCartRate'
                     trackedSearchCount:
-                      $ref: '../../common/parameters.yml#/trackedSearchCount'
+                      $ref: '../../../common/parameters.yml#/trackedSearchCount'
                     addToCartCount:
                       $ref: '../../common/parameters.yml#/addToCartCount'
                     date:

diff --git a/specs/analytics/paths/click/getAverageClickPosition.yml b/specs/analytics/paths/click/getAverageClickPosition.yml
@@ -21,11 +21,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/analytics/paths/click/getClickPositions.yml b/specs/analytics/paths/click/getClickPositions.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/analytics/paths/click/getClickThroughRate.yml b/specs/analytics/paths/click/getClickThroughRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -41,7 +41,7 @@ get:
               clickCount:
                 $ref: '../../common/parameters.yml#/clickCount'
               trackedSearchCount:
-                $ref: '../../common/parameters.yml#/trackedSearchCount'
+                $ref: '../../../common/parameters.yml#/trackedSearchCount'
               dates:
                 type: array
                 description: Daily click-through rates.
@@ -60,7 +60,7 @@ get:
                     clickCount:
                       $ref: '../../common/parameters.yml#/clickCount'
                     trackedSearchCount:
-                      $ref: '../../common/parameters.yml#/trackedSearchCount'
+                      $ref: '../../../common/parameters.yml#/trackedSearchCount'
                     date:
                       $ref: '../../common/parameters.yml#/date'
     '400':

diff --git a/specs/analytics/paths/click/getConversionRate.yml b/specs/analytics/paths/click/getConversionRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -39,7 +39,7 @@ get:
               rate:
                 $ref: '../../common/parameters.yml#/conversionRate'
               trackedSearchCount:
-                $ref: '../../common/parameters.yml#/trackedSearchCount'
+                $ref: '../../../common/parameters.yml#/trackedSearchCount'
               conversionCount:
                 $ref: '../../common/parameters.yml#/conversionCount'
               dates:
@@ -58,7 +58,7 @@ get:
                     rate:
                       $ref: '../../common/parameters.yml#/conversionRate'
                     trackedSearchCount:
-                      $ref: '../../common/parameters.yml#/trackedSearchCount'
+                      $ref: '../../../common/parameters.yml#/trackedSearchCount'
                     conversionCount:
                       $ref: '../../common/parameters.yml#/conversionCount'
                     date:

diff --git a/specs/analytics/paths/click/getPurchaseRate.yml b/specs/analytics/paths/click/getPurchaseRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -39,7 +39,7 @@ get:
               rate:
                 $ref: '../../common/parameters.yml#/purchaseRate'
               trackedSearchCount:
-                $ref: '../../common/parameters.yml#/trackedSearchCount'
+                $ref: '../../../common/parameters.yml#/trackedSearchCount'
               purchaseCount:
                 $ref: '../../common/parameters.yml#/purchaseCount'
               dates:
@@ -58,7 +58,7 @@ get:
                     rate:
                       $ref: '../../common/parameters.yml#/purchaseRate'
                     trackedSearchCount:
-                      $ref: '../../common/parameters.yml#/trackedSearchCount'
+                      $ref: '../../../common/parameters.yml#/trackedSearchCount'
                     purchaseCount:
                       $ref: '../../common/parameters.yml#/purchaseCount'
                     date:

diff --git a/specs/analytics/paths/search/getNoClickRate.yml b/specs/analytics/paths/search/getNoClickRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:
@@ -39,7 +39,7 @@ get:
               rate:
                 $ref: '../../common/parameters.yml#/noClickRate'
               count:
-                $ref: '../../common/parameters.yml#/trackedSearchCount'
+                $ref: '../../../common/parameters.yml#/trackedSearchCount'
               noClickCount:
                 $ref: '../../common/parameters.yml#/noClickCount'
               dates:
@@ -58,7 +58,7 @@ get:
                     rate:
                       $ref: '../../common/parameters.yml#/noClickRate'
                     count:
-                      $ref: '../../common/parameters.yml#/trackedSearchCount'
+                      $ref: '../../../common/parameters.yml#/trackedSearchCount'
                     noClickCount:
                       $ref: '../../common/parameters.yml#/noClickCount'
                     date:

diff --git a/specs/analytics/paths/search/getNoResultsRate.yml b/specs/analytics/paths/search/getNoResultsRate.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/analytics/paths/search/getSearchesCount.yml b/specs/analytics/paths/search/getSearchesCount.yml
@@ -19,11 +19,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema:

diff --git a/specs/analytics/paths/search/getSearchesNoClicks.yml b/specs/analytics/paths/search/getSearchesNoClicks.yml
@@ -18,11 +18,11 @@ get:
       description: OK
       headers:
         x-ratelimit-limit:
-          $ref: '../../common/parameters.yml#/x-ratelimit-limit'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
         x-ratelimit-remaining:
-          $ref: '../../common/parameters.yml#/x-ratelimit-remaining'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
         x-ratelimit-reset:
-          $ref: '../../common/parameters.yml#/x-ratelimit-reset'
+          $ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
       content:
         application/json:
           schema: