Skip to content

docs(abtests) v3 api #4394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

docs(abtests) v3 api #4394

wants to merge 14 commits into from

Conversation

Niamsy
Copy link

@Niamsy Niamsy commented Jan 24, 2025

🧭 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
Collaborator

algolia-bot commented Jan 24, 2025

✔️ Code generated!

Name Link
🪓 Triggered by 5366c01727199e9311554f4dffe61b22ad21fc37
🍃 Generated commit 887e639152b44884f35dad20727296e864561677
🌲 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
javascript 1672
go 1601
php 1500
csharp 1304
java 1088
python 1079
ruby 850
swift 848
scala 23

Copy link
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!

Niamsy and others added 7 commits January 28, 2025 14:51
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
@millotp
Copy link
Collaborator

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
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
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
cdhawke
cdhawke previously approved these changes Feb 4, 2025
@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
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 ?

shortcuts
shortcuts previously approved these changes Apr 24, 2025
Copy link
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

items:
$ref: "#/ABTest"
- type: "null"
description: No A/B tests are configured for this application.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: No A/B tests are configured for this application.

it will just represent the nullable attribute in the doc/clients, no descriptions are expected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants