feat: add estimate path and responses

Author: cdhawke

specs/abtesting/common/parameters.yml

@@ -137,3 +137,22 @@ filterEffects:
           type: integer
           description: Number of tracked searches removed from the A/B test.
           example: 237
+
+minimumDetectableEffect:
+  type: object
+  properties:
+    durationDays:
+      type: number
+      format: int64
+      description: Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.
+      example: 21
+    controlSampleSize:
+      type: number
+      format: int64
+      description: Number of tracked searches needed to be able to detect the configured effect for the control variant.
+      example: 23415
+    experimentSampleSize:
+      type: number
+      format: int64
+      description: Number of tracked searches needed to be able to detect the configured effect for the experiment variant.
+      example: 23415

specs/abtesting/common/schemas/EstimateResponse.yml

@@ -0,0 +1,2 @@
+EstimateResponse:
+  $ref: '../parameters.yml#/minimumDetectableEffect'

specs/abtesting/paths/estimate.yml

@@ -0,0 +1,51 @@
+post:
+  tags:
+    - abtest
+  operationId: estimateABTest
+  x-acl:
+    - analytics
+  summary: Estimate the sample size and duration of an A/B test
+  description: Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          title: estimateABTestRequest
+          type: object
+          additionalProperties: false
+          properties:
+            configuration:
+              $ref: '../common/schemas/ABTest.yml#/ABTestConfiguration'
+            variants:
+              type: array
+              description: A/B test variants.
+              minItems: 2
+              maxItems: 2
+              items:
+                $ref: '../common/schemas/AddABTestsVariant.yml#/AddABTestsVariant'
+          required:
+            - configuration
+            - variants
+  responses:
+    '200':
+      description: OK
+      headers:
+        x-ratelimit-limit:
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-limit'
+        x-ratelimit-remaining:
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-remaining'
+        x-ratelimit-reset:
+          $ref: '../../common/responses/rateLimit.yml#/x-ratelimit-reset'
+      content:
+        application/json:
+          schema:
+            $ref: '../common/schemas/EstimateResponse.yml#/EstimateResponse'
+    '400':
+      $ref: '../../common/responses/BadRequest.yml'
+    '402':
+      $ref: '../../common/responses/FeatureNotEnabled.yml'
+    '403':
+      $ref: '../../common/responses/MethodNotAllowed.yml'
+    '404':
+      $ref: '../../common/responses/IndexNotFound.yml'