Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jul 24, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specs/abtesting/common/schemas/Variant.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions specs/abtesting/paths/abtest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions specs/abtesting/paths/abtests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/abtesting/paths/stopABTest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
24 changes: 0 additions & 24 deletions specs/analytics/common/parameters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions specs/analytics/common/schemas/getTopHits.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions specs/analytics/common/schemas/getTopSearches.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions specs/analytics/paths/click/getAddToCartRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/analytics/paths/click/getAverageClickPosition.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/analytics/paths/click/getClickPositions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions specs/analytics/paths/click/getClickThroughRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -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':
Expand Down
10 changes: 5 additions & 5 deletions specs/analytics/paths/click/getConversionRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions specs/analytics/paths/click/getPurchaseRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions specs/analytics/paths/search/getNoClickRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/analytics/paths/search/getNoResultsRate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/analytics/paths/search/getSearchesCount.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions specs/analytics/paths/search/getSearchesNoClicks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading
Loading