Skip to content

Commit be060a0

Browse files
authored
fix(specs): remove cross-references of analytics (#3414)
1 parent 316e90a commit be060a0

28 files changed

+111
-118
lines changed

specs/abtesting/common/schemas/Variant.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ variant:
9595
example: 86269
9696
- type: 'null'
9797
trackedSearchCount:
98-
$ref: '../../../analytics/common/parameters.yml#/trackedSearchCount'
98+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
9999
trafficPercentage:
100100
$ref: '../parameters.yml#/trafficPercentage'
101101
userCount:

specs/abtesting/paths/abtest.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ get:
1313
description: OK
1414
headers:
1515
x-ratelimit-limit:
16-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
16+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
1717
x-ratelimit-remaining:
18-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
18+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
1919
x-ratelimit-reset:
20-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
20+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2121
content:
2222
application/json:
2323
schema:
@@ -46,11 +46,11 @@ delete:
4646
description: OK
4747
headers:
4848
x-ratelimit-limit:
49-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
49+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
5050
x-ratelimit-remaining:
51-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
51+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
5252
x-ratelimit-reset:
53-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
53+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
5454
content:
5555
application/json:
5656
schema:

specs/abtesting/paths/abtests.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ post:
3535
description: OK
3636
headers:
3737
x-ratelimit-limit:
38-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
38+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
3939
x-ratelimit-remaining:
40-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
40+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
4141
x-ratelimit-reset:
42-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
42+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
4343
content:
4444
application/json:
4545
schema:
@@ -81,11 +81,11 @@ get:
8181
description: OK
8282
headers:
8383
x-ratelimit-limit:
84-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
84+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
8585
x-ratelimit-remaining:
86-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
86+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
8787
x-ratelimit-reset:
88-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
88+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
8989
content:
9090
application/json:
9191
schema:

specs/abtesting/paths/stopABTest.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ post:
1616
description: OK
1717
headers:
1818
x-ratelimit-limit:
19-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
19+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2020
x-ratelimit-remaining:
21-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
21+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2222
x-ratelimit-reset:
23-
$ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
23+
$ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2424
content:
2525
application/json:
2626
schema:

specs/analytics/common/parameters.yml

-24
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,6 @@ count:
6767
type: integer
6868
example: 504
6969

70-
trackedSearchCount:
71-
type: integer
72-
example: 2
73-
default: 0
74-
description: Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
75-
7670
noResultCount:
7771
description: Number of searches without any results.
7872
type: integer
@@ -302,21 +296,3 @@ withFilterCount:
302296
example: 5
303297
minimum: 0
304298
default: 0
305-
306-
x-ratelimit-limit:
307-
description: Number of allowed requests per one minute.
308-
example: 100
309-
schema:
310-
type: integer
311-
312-
x-ratelimit-remaining:
313-
description: Number of remaining requests in the current period.
314-
example: 99
315-
schema:
316-
type: integer
317-
318-
x-ratelimit-reset:
319-
description: Timstamp when the rate limit will reset, measured in seconds since the Unix epoch.
320-
example: 1710682486
321-
schema:
322-
type: integer

specs/analytics/common/schemas/getTopHits.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ topHitsResponseWithAnalytics:
5353
conversionRate:
5454
$ref: '../parameters.yml#/conversionRate'
5555
trackedHitCount:
56-
$ref: '../parameters.yml#/trackedSearchCount'
56+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
5757
clickCount:
5858
$ref: '../parameters.yml#/clickCount'
5959
conversionCount:
@@ -96,7 +96,7 @@ topHitsResponseWithRevenueAnalytics:
9696
conversionRate:
9797
$ref: '../parameters.yml#/conversionRate'
9898
trackedHitCount:
99-
$ref: '../parameters.yml#/trackedSearchCount'
99+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
100100
clickCount:
101101
$ref: '../parameters.yml#/clickCount'
102102
conversionCount:

specs/analytics/common/schemas/getTopSearches.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ topSearchesResponseWithAnalytics:
6363
conversionRate:
6464
$ref: '../parameters.yml#/conversionRate'
6565
trackedSearchCount:
66-
$ref: '../parameters.yml#/trackedSearchCount'
66+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6767
clickCount:
6868
$ref: '../parameters.yml#/clickCount'
6969
conversionCount:
@@ -115,7 +115,7 @@ topSearchesResponseWithRevenueAnalytics:
115115
conversionRate:
116116
$ref: '../parameters.yml#/conversionRate'
117117
trackedSearchCount:
118-
$ref: '../parameters.yml#/trackedSearchCount'
118+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
119119
clickCount:
120120
$ref: '../parameters.yml#/clickCount'
121121
conversionCount:

specs/analytics/paths/click/getAddToCartRate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:
@@ -39,7 +39,7 @@ get:
3939
rate:
4040
$ref: '../../common/parameters.yml#/addToCartRate'
4141
trackedSearchCount:
42-
$ref: '../../common/parameters.yml#/trackedSearchCount'
42+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
4343
addToCartCount:
4444
$ref: '../../common/parameters.yml#/addToCartCount'
4545
dates:
@@ -58,7 +58,7 @@ get:
5858
rate:
5959
$ref: '../../common/parameters.yml#/addToCartRate'
6060
trackedSearchCount:
61-
$ref: '../../common/parameters.yml#/trackedSearchCount'
61+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6262
addToCartCount:
6363
$ref: '../../common/parameters.yml#/addToCartCount'
6464
date:

specs/analytics/paths/click/getAverageClickPosition.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ get:
2121
description: OK
2222
headers:
2323
x-ratelimit-limit:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2525
x-ratelimit-remaining:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2727
x-ratelimit-reset:
28-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
28+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2929
content:
3030
application/json:
3131
schema:

specs/analytics/paths/click/getClickPositions.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:

specs/analytics/paths/click/getClickThroughRate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:
@@ -41,7 +41,7 @@ get:
4141
clickCount:
4242
$ref: '../../common/parameters.yml#/clickCount'
4343
trackedSearchCount:
44-
$ref: '../../common/parameters.yml#/trackedSearchCount'
44+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
4545
dates:
4646
type: array
4747
description: Daily click-through rates.
@@ -60,7 +60,7 @@ get:
6060
clickCount:
6161
$ref: '../../common/parameters.yml#/clickCount'
6262
trackedSearchCount:
63-
$ref: '../../common/parameters.yml#/trackedSearchCount'
63+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6464
date:
6565
$ref: '../../common/parameters.yml#/date'
6666
'400':

specs/analytics/paths/click/getConversionRate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:
@@ -39,7 +39,7 @@ get:
3939
rate:
4040
$ref: '../../common/parameters.yml#/conversionRate'
4141
trackedSearchCount:
42-
$ref: '../../common/parameters.yml#/trackedSearchCount'
42+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
4343
conversionCount:
4444
$ref: '../../common/parameters.yml#/conversionCount'
4545
dates:
@@ -58,7 +58,7 @@ get:
5858
rate:
5959
$ref: '../../common/parameters.yml#/conversionRate'
6060
trackedSearchCount:
61-
$ref: '../../common/parameters.yml#/trackedSearchCount'
61+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6262
conversionCount:
6363
$ref: '../../common/parameters.yml#/conversionCount'
6464
date:

specs/analytics/paths/click/getPurchaseRate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:
@@ -39,7 +39,7 @@ get:
3939
rate:
4040
$ref: '../../common/parameters.yml#/purchaseRate'
4141
trackedSearchCount:
42-
$ref: '../../common/parameters.yml#/trackedSearchCount'
42+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
4343
purchaseCount:
4444
$ref: '../../common/parameters.yml#/purchaseCount'
4545
dates:
@@ -58,7 +58,7 @@ get:
5858
rate:
5959
$ref: '../../common/parameters.yml#/purchaseRate'
6060
trackedSearchCount:
61-
$ref: '../../common/parameters.yml#/trackedSearchCount'
61+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6262
purchaseCount:
6363
$ref: '../../common/parameters.yml#/purchaseCount'
6464
date:

specs/analytics/paths/search/getNoClickRate.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:
@@ -39,7 +39,7 @@ get:
3939
rate:
4040
$ref: '../../common/parameters.yml#/noClickRate'
4141
count:
42-
$ref: '../../common/parameters.yml#/trackedSearchCount'
42+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
4343
noClickCount:
4444
$ref: '../../common/parameters.yml#/noClickCount'
4545
dates:
@@ -58,7 +58,7 @@ get:
5858
rate:
5959
$ref: '../../common/parameters.yml#/noClickRate'
6060
count:
61-
$ref: '../../common/parameters.yml#/trackedSearchCount'
61+
$ref: '../../../common/parameters.yml#/trackedSearchCount'
6262
noClickCount:
6363
$ref: '../../common/parameters.yml#/noClickCount'
6464
date:

specs/analytics/paths/search/getNoResultsRate.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:

specs/analytics/paths/search/getSearchesCount.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ get:
1919
description: OK
2020
headers:
2121
x-ratelimit-limit:
22-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
22+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2323
x-ratelimit-remaining:
24-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
24+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2525
x-ratelimit-reset:
26-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
26+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2727
content:
2828
application/json:
2929
schema:

specs/analytics/paths/search/getSearchesNoClicks.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ get:
1818
description: OK
1919
headers:
2020
x-ratelimit-limit:
21-
$ref: '../../common/parameters.yml#/x-ratelimit-limit'
21+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-limit'
2222
x-ratelimit-remaining:
23-
$ref: '../../common/parameters.yml#/x-ratelimit-remaining'
23+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
2424
x-ratelimit-reset:
25-
$ref: '../../common/parameters.yml#/x-ratelimit-reset'
25+
$ref: '../../../common/responses/rateLimit.yml#/x-ratelimit-reset'
2626
content:
2727
application/json:
2828
schema:

0 commit comments

Comments
 (0)