Skip to content

Commit 085364d

Browse files
authored
feat(specs): deprecates /2 abtests endpoints (#6921)
1 parent d30a53d commit 085364d

5 files changed

Lines changed: 44 additions & 6 deletions

File tree

โ€Žspecs/abtesting/paths/abtest.ymlโ€Ž

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@ get:
22
tags:
33
- abtest
44
operationId: getABTest
5+
deprecated: true
56
x-acl:
67
- analytics
78
summary: Retrieve A/B test details
8-
description: Retrieves the details for an A/B test by its ID.
9+
description: |
10+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
11+
12+
Replaced by `GET /3/abtests/{id}`.
13+
14+
Retrieves the details for an A/B test by its ID.
915
parameters:
1016
- $ref: '../common/parameters.yml#/ID'
1117
responses:
@@ -35,10 +41,16 @@ delete:
3541
tags:
3642
- abtest
3743
operationId: deleteABTest
44+
deprecated: true
3845
x-acl:
3946
- editSettings
4047
summary: Delete an A/B test
41-
description: Deletes an A/B test by its ID.
48+
description: |
49+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
50+
51+
Replaced by `DELETE /3/abtests/{id}`.
52+
53+
Deletes an A/B test by its ID.
4254
parameters:
4355
- $ref: '../common/parameters.yml#/ID'
4456
responses:

โ€Žspecs/abtesting/paths/abtests.ymlโ€Ž

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@ post:
22
tags:
33
- abtest
44
operationId: addABTests
5+
deprecated: true
56
x-acl:
67
- editSettings
78
summary: Create an A/B test
8-
description: Creates a new A/B test.
9+
description: |
10+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
11+
12+
Replaced by `POST /3/abtests`.
13+
14+
Creates a new A/B test.
915
requestBody:
1016
required: true
1117
content:
@@ -57,11 +63,17 @@ get:
5763
tags:
5864
- abtest
5965
operationId: listABTests
66+
deprecated: true
6067
x-mcp-tool: true
6168
x-acl:
6269
- analytics
6370
summary: List all A/B tests
64-
description: Lists all A/B tests you configured for this application.
71+
description: |
72+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
73+
74+
Replaced by `GET /3/abtests`.
75+
76+
Lists all A/B tests you configured for this application.
6577
parameters:
6678
- name: offset
6779
in: query

โ€Žspecs/abtesting/paths/estimate.ymlโ€Ž

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@ post:
22
tags:
33
- abtest
44
operationId: estimateABTest
5+
deprecated: true
56
x-acl:
67
- analytics
78
summary: Estimate the sample size and duration of an A/B test
8-
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.
9+
description: |
10+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
11+
12+
Replaced by `POST /3/abtests/estimate`.
13+
14+
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.
915
requestBody:
1016
required: true
1117
content:

โ€Žspecs/abtesting/paths/stopABTest.ymlโ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@ post:
22
tags:
33
- abtest
44
operationId: stopABTest
5+
deprecated: true
56
x-acl:
67
- editSettings
78
summary: Stop an A/B test
89
description: |
10+
This endpoint is deprecated. Use the A/B Testing API v3 instead.
11+
12+
Replaced by `POST /3/abtests/{id}/stop`.
13+
914
Stops an A/B test by its ID.
1015
1116
You can't restart stopped A/B tests.

โ€Žspecs/abtesting/spec.ymlโ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ info:
5151
5252
## Version
5353
54-
The current version of the A/B Testing API is version 2, indicated by the `/2/` in each endpoint's URL.
54+
Version 2 of the A/B Testing API, indicated by the `/2/` in each endpoint's URL, is deprecated.
55+
Use [version 3](https://www.algolia.com/doc/rest-api/abtesting-v3) instead.
5556
version: 2.0.0
5657
components:
5758
securitySchemes:
@@ -79,6 +80,8 @@ tags:
7980
Manage A/B tests.
8081
8182
A/B tests are configurations one or more indices, usually your production index and an index with different settings that you want to test.
83+
84+
These operations are **deprecated**. Use the A/B Testing API v3 (`/3/abtests`) instead.
8285
x-tagGroups:
8386
- name: General
8487
tags:

0 commit comments

Comments
ย (0)