feat(abtesting): add documentation for /schedule endpoint

Author: febeck

specs/abtesting/common/parameters.yml

@@ -18,6 +18,11 @@ abTestID:
   description: Unique A/B test identifier.
   example: 224
 
+abTestScheduleID:
+  type: integer
+  description: Unique scheduled A/B test identifier.
+  example: 224
+
 endAt:
   type: string
   description: End date and time of the A/B test, in RFC 3339 format.
@@ -33,6 +38,11 @@ updatedAt:
   description: Date and time when the A/B test was last updated, in RFC 3339 format.
   example: 2023-06-15T15:06:44.400601Z
 
+scheduledAt:
+  type: string
+  description: Date and time when the A/B test scheduled to start, in RFC 3339 format.
+  example: 2023-06-15T15:06:44.400601Z
+
 name:
   type: string
   description: A/B test name.

specs/abtesting/common/schemas/ScheduledABTestResponse.yml

@@ -0,0 +1,8 @@
+ScheduledABTestResponse:
+  type: object
+  additionalProperties: false
+  properties:
+    abTestScheduleID:
+      $ref: '../parameters.yml#/abTestScheduleID'
+  required:
+    - abTestScheduleID

specs/abtesting/paths/scheduleABTest.yml

@@ -0,0 +1,58 @@
+post:
+  tags:
+    - abtest
+  operationId: scheduleABTest
+  x-acl:
+    - editSettings
+  summary: Schedule an A/B test
+  description: |
+    Schedule an A/B test to be started at a later time.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          title: addABTestsRequest
+          type: object
+          additionalProperties: false
+          properties:
+            name:
+              $ref: '../common/parameters.yml#/name'
+            variants:
+              type: array
+              description: A/B test variants.
+              minItems: 2
+              maxItems: 2
+              items:
+                $ref: '../common/schemas/AddABTestsVariant.yml#/AddABTestsVariant'
+            scheduledAt:
+              $ref: '../common/parameters.yml#/scheduledAt'
+            endAt:
+              $ref: '../common/parameters.yml#/endAt'
+          required:
+            - name
+            - variants
+            - scheduledAt
+            - endAt
+  responses:
+    '200':
+      description: OK
+      headers:
+        x-ratelimit-limit:
+          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-limit'
+        x-ratelimit-remaining:
+          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-remaining'
+        x-ratelimit-reset:
+          $ref: '../../analytics/common/parameters.yml#/x-ratelimit-reset'
+      content:
+        application/json:
+          schema:
+            $ref: '../common/schemas/ScheduledABTestResponse.yml#/ScheduledABTestResponse'
+    '400':
+      $ref: '../../common/responses/BadRequest.yml'
+    '402':
+      $ref: '../../common/responses/FeatureNotEnabled.yml'
+    '403':
+      $ref: '../../common/responses/MethodNotAllowed.yml'
+    '404':
+      $ref: '../../common/responses/IndexNotFound.yml'

specs/abtesting/spec.yml

@@ -96,3 +96,5 @@ paths:
     $ref: 'paths/abtest.yml'
   /2/abtests/{id}/stop:
     $ref: 'paths/stopABTest.yml'
+  /2/abtests/schedule:
+    $ref: 'paths/scheduleABTest.yml'