Skip to content

feat(specs): add abtests v3#4394

Merged
shortcuts merged 23 commits intomainfrom
docs/abtests/api-v3
Jul 4, 2025
Merged

feat(specs): add abtests v3#4394
shortcuts merged 23 commits intomainfrom
docs/abtests/api-v3

Conversation

@Niamsy
Copy link
Copy Markdown
Contributor

@Niamsy Niamsy commented Jan 24, 2025 •
edited by atlassian bot
Loading

🧭 What and Why

🎟 JIRA Ticket: OPTIM-1443
OPTIM-1456
OPTIM-1535

Changes included:

  • ADD abtests-v3 specs openapi
  • POST /3/abtests allows more than 2 variants, a configuration, and requires a set of metrics to be retrieved during the A/B Test
  • GET /3/abtests returns all the metrics requested during A/B test creation
  • GET /3/abtests/{id} idem

🧪 Test

@algolia-bot
Copy link
Copy Markdown
Collaborator

algolia-bot commented Jan 24, 2025 •
edited
Loading

✔️ Code generated!

Name Link
🪓 Triggered by f91137027a2fc1173f38204b8d779a768c5d2163
🍃 Generated commit 554adae9a563cb5bce2bf774e9cc4e76d533f425
🌲 Generated branch generated/docs/abtests/api-v3
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
go 1731
javascript 1661
php 1495
csharp 1269
python 1090
java 1081
ruby 765
swift 306
scala 23

cdhawke
cdhawke requested changes Jan 27, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@cdhawke cdhawke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a first pass - we can make adjustments after we get a base established too!

@millotp
Copy link
Copy Markdown
Contributor

millotp commented Jan 28, 2025

Hello @Niamsy, this is the first time that we have a new api version in the repo, how would like it to distribute it ?
Are you planning on supporting v2 as well ?
Do you want v3 to be in a different package on npm or just change the version of the existing one ?

@Niamsy
Copy link
Copy Markdown
Contributor Author

Niamsy commented Jan 28, 2025

Hello @millotp, we're planning to support both v2 and v3 in parallel. As for the distribution, I'm not sure, maybe @cdhawke has a better idea.
We're still in the development phase for the v3 api but we wanted to have an openApi spec somewhere so that's why there is this PR, but we're not planning on merging it right away

@cdhawke
Copy link
Copy Markdown
Contributor

cdhawke commented Jan 28, 2025

@millotp - you might know better how to separate these. We will support both versions, and the only thing changing outside of the request signatures/objects will be the /2 -> /3 in the url used to differentiate the version. Would you recommend keeping it separate? We might in the future try to transition off of v2, but there's no official timeline for that, as it will entail an EOL process. In this future scenario would it be better to have it as a separate package?

stevenMevans
stevenMevans previously approved these changes Feb 4, 2025
View reviewed changes
cdhawke
cdhawke previously approved these changes Feb 4, 2025
View reviewed changes
@Niamsy Niamsy dismissed stale reviews from cdhawke and stevenMevans via c5d5d83 April 10, 2025 12:57
@Niamsy Niamsy requested a review from stevenMevans April 14, 2025 09:06
@Niamsy
Copy link
Copy Markdown
Contributor Author

Niamsy commented Apr 14, 2025

Hi @millotp, we'll soon want to release abtests v3 and merge this PR. As mentioned previously, we will support both v2 and v3 in parallel. Can we just merge this PR when we're ready or do we need to do specific things before ?

stevenMevans
stevenMevans previously requested changes Apr 15, 2025
View reviewed changes
shortcuts
shortcuts previously approved these changes Apr 24, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonderful

@shortcuts shortcuts mentioned this pull request Apr 24, 2025
Merged
Niamsy and others added 14 commits July 4, 2025 11:53
@Niamsy @leonardogavaudan
docs(abtests) v3 api
90054e0
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/common/schemas/Variant.yml
f09e83e 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/common/schemas/Variant.yml
af3d013 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/common/schemas/Variant.yml
9f41334 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/paths/abtests.yml
ebb0a58 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/paths/scheduleABTest.yml
0a7faeb 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @cdhawke @leonardogavaudan
Update specs/abtesting-v3/paths/estimate.yml
b75ccfe 
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@Niamsy @leonardogavaudan
fix(abtests) remove significance from abtest
99a31a7
@Niamsy @leonardogavaudan
feat(abtests) move filterEffects in metadata + add description to pValue
92286d8
@Niamsy @leonardogavaudan
feat(abtests) add metadata into metric
a04ae8c
@Niamsy @leonardogavaudan
doc(abtests) add timeseries endpoint for v3 + add confidence interval…
9ca8fad 
… values in variant schema
@stevenMevans @leonardogavaudan
add confidence interval field descriptions
f2b99f0
@Niamsy @leonardogavaudan
fix(abtests) traffic percentage min and max + add migratedAbTestID to…
6c2f5e2 
… get/list responses
@Niamsy @leonardogavaudan
feat(abtests) add error correction to get/list endpoint for v3
b83e6de
@leonardogavaudan leonardogavaudan marked this pull request as ready for review July 4, 2025 10:18
@leonardogavaudan leonardogavaudan requested a review from a team as a code owner July 4, 2025 10:18
shortcuts
shortcuts previously approved these changes Jul 4, 2025
View reviewed changes
@shortcuts shortcuts changed the title docs(abtests) v3 api feat(specs): add abtests v3 Jul 4, 2025
@shortcuts shortcuts enabled auto-merge (squash) July 4, 2025 12:13
@shortcuts shortcuts disabled auto-merge July 4, 2025 12:25
@shortcuts shortcuts enabled auto-merge (squash) July 4, 2025 13:31
@shortcuts shortcuts disabled auto-merge July 4, 2025 13:31
@shortcuts shortcuts enabled auto-merge (squash) July 4, 2025 13:31
shortcuts
shortcuts approved these changes Jul 4, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@shortcuts shortcuts merged commit ff2f96a into main Jul 4, 2025
29 checks passed
@shortcuts shortcuts deleted the docs/abtests/api-v3 branch July 4, 2025 13:47
algolia-bot added a commit that referenced this pull request Jul 4, 2025
@algolia-bot @Niamsy
@cdhawke @stevenMevans @leonardogavaudan @shortcuts
feat(specs): add abtests v3 (#4394) (generated) [skip ci]
06124e7 
Co-authored-by: My Lan Aragon <mylan.aragon@algolia.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Steven Evans <steven.evans@algolia.com>
Co-authored-by: Leonardo Gavaudan <leonardogavaudan@gmail.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shortcuts shortcuts shortcuts approved these changes

@stevenMevans stevenMevans stevenMevans left review comments

@cdhawke cdhawke cdhawke left review comments

@millotp millotp Awaiting requested review from millotp millotp is a code owner automatically assigned from algolia/api-clients-automation

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Niamsy @algolia-bot @millotp @cdhawke @stevenMevans @shortcuts @leonardogavaudan