From be060a0600b6e32a69604e6ba45552fca9a2ebdc Mon Sep 17 00:00:00 2001 From: Pierre Millot Date: Wed, 24 Jul 2024 17:07:08 +0200 Subject: [PATCH] fix(specs): remove cross-references of analytics (#3414) --- specs/abtesting/common/schemas/Variant.yml | 2 +- specs/abtesting/paths/abtest.yml | 12 +++++----- specs/abtesting/paths/abtests.yml | 12 +++++----- specs/abtesting/paths/stopABTest.yml | 6 ++--- specs/analytics/common/parameters.yml | 24 ------------------- specs/analytics/common/schemas/getTopHits.yml | 4 ++-- .../common/schemas/getTopSearches.yml | 4 ++-- .../paths/click/getAddToCartRate.yml | 10 ++++---- .../paths/click/getAverageClickPosition.yml | 6 ++--- .../paths/click/getClickPositions.yml | 6 ++--- .../paths/click/getClickThroughRate.yml | 10 ++++---- .../paths/click/getConversionRate.yml | 10 ++++---- .../analytics/paths/click/getPurchaseRate.yml | 10 ++++---- .../analytics/paths/search/getNoClickRate.yml | 10 ++++---- .../paths/search/getNoResultsRate.yml | 6 ++--- .../paths/search/getSearchesCount.yml | 6 ++--- .../paths/search/getSearchesNoClicks.yml | 6 ++--- .../paths/search/getSearchesNoResults.yml | 6 ++--- .../paths/search/getTopCountries.yml | 6 ++--- .../paths/search/getTopFilterAttributes.yml | 6 ++--- .../paths/search/getTopFilterForAttribute.yml | 6 ++--- .../paths/search/getTopFiltersNoResults.yml | 6 ++--- specs/analytics/paths/search/getTopHits.yml | 6 ++--- .../analytics/paths/search/getTopSearches.yml | 6 ++--- .../analytics/paths/search/getUsersCount.yml | 6 ++--- specs/common/parameters.yml | 7 ++++++ specs/common/responses/rateLimit.yml | 17 +++++++++++++ specs/insights/paths/deleteUserToken.yml | 13 +++------- 28 files changed, 111 insertions(+), 118 deletions(-) create mode 100644 specs/common/responses/rateLimit.yml diff --git a/specs/abtesting/common/schemas/Variant.yml b/specs/abtesting/common/schemas/Variant.yml index d7c6d2a11d..4439348d6b 100644 --- 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 index 96123b77f1..1e2bf89611 100644 --- 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 index 1fd151f676..8696cdd9f2 100644 --- 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 index 2628bc36af..1542f05339 100644 --- 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 index b993f83e7e..3beb43443b 100644 --- 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 index 36183aa209..bca8bccfe7 100644 --- 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 index a0a9805dd7..cd9570a264 100644 --- 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 index 932b81c81a..ef40031ac8 100644 --- 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 index 9dbdcc532c..7c5295368f 100644 --- 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 index fa3bbc34a3..e5cc9a741b 100644 --- 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 index a42a1f2c5c..cbff729cef 100644 --- 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 index 1f09865dc3..cdb804eec9 100644 --- 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 index 8cbc07be27..a7ac4da873 100644 --- 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 index 3bbd61e434..2c761ef00f 100644 --- 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 index 954ce480c0..bbc775a846 100644 --- 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 index 55a858d086..108ef3f632 100644 --- 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 index 2aa26f6e18..97c190d50f 100644 --- 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: diff --git a/specs/analytics/paths/search/getSearchesNoResults.yml b/specs/analytics/paths/search/getSearchesNoResults.yml index 664b20c930..9078b73122 100644 --- a/specs/analytics/paths/search/getSearchesNoResults.yml +++ b/specs/analytics/paths/search/getSearchesNoResults.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: diff --git a/specs/analytics/paths/search/getTopCountries.yml b/specs/analytics/paths/search/getTopCountries.yml index d01c5c972b..ae5d846582 100644 --- a/specs/analytics/paths/search/getTopCountries.yml +++ b/specs/analytics/paths/search/getTopCountries.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: diff --git a/specs/analytics/paths/search/getTopFilterAttributes.yml b/specs/analytics/paths/search/getTopFilterAttributes.yml index d2b509d473..87087f4a59 100644 --- a/specs/analytics/paths/search/getTopFilterAttributes.yml +++ b/specs/analytics/paths/search/getTopFilterAttributes.yml @@ -22,11 +22,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/getTopFilterForAttribute.yml b/specs/analytics/paths/search/getTopFilterForAttribute.yml index dd31245f9a..e4e93993ef 100644 --- a/specs/analytics/paths/search/getTopFilterForAttribute.yml +++ b/specs/analytics/paths/search/getTopFilterForAttribute.yml @@ -23,11 +23,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/getTopFiltersNoResults.yml b/specs/analytics/paths/search/getTopFiltersNoResults.yml index dd955d3117..43fa59489e 100644 --- a/specs/analytics/paths/search/getTopFiltersNoResults.yml +++ b/specs/analytics/paths/search/getTopFiltersNoResults.yml @@ -22,11 +22,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/getTopHits.yml b/specs/analytics/paths/search/getTopHits.yml index 2b712a1942..1273ba8066 100644 --- a/specs/analytics/paths/search/getTopHits.yml +++ b/specs/analytics/paths/search/getTopHits.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/search/getTopSearches.yml b/specs/analytics/paths/search/getTopSearches.yml index 2e84fa54cb..bb79aa926c 100644 --- a/specs/analytics/paths/search/getTopSearches.yml +++ b/specs/analytics/paths/search/getTopSearches.yml @@ -22,11 +22,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/getUsersCount.yml b/specs/analytics/paths/search/getUsersCount.yml index 3f8f361968..9fe50b1066 100644 --- a/specs/analytics/paths/search/getUsersCount.yml +++ b/specs/analytics/paths/search/getUsersCount.yml @@ -26,11 +26,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/common/parameters.yml b/specs/common/parameters.yml index b365992523..5bcd2f91f3 100644 --- a/specs/common/parameters.yml +++ b/specs/common/parameters.yml @@ -165,3 +165,10 @@ count: description: Number of occurrences. example: 2 type: integer + +# analytics +trackedSearchCount: + type: integer + example: 2 + default: 0 + description: Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/specs/common/responses/rateLimit.yml b/specs/common/responses/rateLimit.yml new file mode 100644 index 0000000000..7606db17e1 --- /dev/null +++ b/specs/common/responses/rateLimit.yml @@ -0,0 +1,17 @@ +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/insights/paths/deleteUserToken.yml b/specs/insights/paths/deleteUserToken.yml index 00ce808c40..d52c483ab2 100644 --- a/specs/insights/paths/deleteUserToken.yml +++ b/specs/insights/paths/deleteUserToken.yml @@ -18,18 +18,11 @@ delete: description: No content. headers: x-ratelimit-limit: - description: Maximum number of requests you can make to this endpoint. - schema: - type: integer + $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit' x-ratelimit-remaining: - description: Number of remaining API requests you can make to this endpoint before reaching the rate limit. - schema: - type: integer + $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining' x-ratelimit-reset: - description: Timestamp in Unix epoch time when the rate limit will reset. - schema: - type: integer - + $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset' '422': description: Unprocessable Entity. content: