Skip to content

Commit 7f199a8

Browse files
committed
chore: rename and change spec
1 parent 30ed903 commit 7f199a8

File tree

4 files changed

+22
-25
lines changed

4 files changed

+22
-25
lines changed

specs/abtesting/common/parameters.yml

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -137,22 +137,3 @@ filterEffects:
137137
type: integer
138138
description: Number of tracked searches removed from the A/B test.
139139
example: 237
140-
141-
minimumDetectableEffect:
142-
type: object
143-
properties:
144-
durationDays:
145-
type: number
146-
format: int64
147-
description: Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.
148-
example: 21
149-
controlSampleSize:
150-
type: number
151-
format: int64
152-
description: Number of tracked searches needed to be able to detect the configured effect for the control variant.
153-
example: 23415
154-
experimentSampleSize:
155-
type: number
156-
format: int64
157-
description: Number of tracked searches needed to be able to detect the configured effect for the experiment variant.
158-
example: 23415
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
EstimateABTestResponse:
2+
type: object
3+
properties:
4+
durationDays:
5+
type: number
6+
format: int64
7+
description: Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.
8+
example: 21
9+
controlSampleSize:
10+
type: number
11+
format: int64
12+
description: Number of tracked searches needed to be able to detect the configured effect for the control variant.
13+
example: 23415
14+
experimentSampleSize:
15+
type: number
16+
format: int64
17+
description: Number of tracked searches needed to be able to detect the configured effect for the experiment variant.
18+
example: 23415

specs/abtesting/common/schemas/EstimateResponse.yml

Lines changed: 0 additions & 2 deletions
This file was deleted.

specs/abtesting/paths/estimate.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ post:
1111
content:
1212
application/json:
1313
schema:
14-
title: estimateRequest
14+
title: estimateABTestRequest
1515
type: object
1616
additionalProperties: false
1717
properties:
1818
configuration:
19-
title: configuration
19+
title: estimateConfiguration
2020
type: object
21-
description: A/B test configuration.
21+
description: A/B test configuration for estimating the sample size and duration using minimum detectable effect.
2222
properties:
2323
outliers:
2424
$ref: '../common/schemas/ABTest.yml#/Outliers'
@@ -51,7 +51,7 @@ post:
5151
content:
5252
application/json:
5353
schema:
54-
$ref: '../common/schemas/EstimateResponse.yml#/EstimateResponse'
54+
$ref: '../common/schemas/EstimateABTestResponse.yml#/EstimateABTestResponse'
5555
'400':
5656
$ref: '../../common/responses/BadRequest.yml'
5757
'402':

0 commit comments

Comments
 (0)