Skip to content

fix(specs): abtest v3 naming conflict with Metric type#5090

Merged
shortcuts merged 5 commits intomainfrom
fix/abtests/spec
Jul 15, 2025
Merged

fix(specs): abtest v3 naming conflict with Metric type#5090
shortcuts merged 5 commits intomainfrom
fix/abtests/spec

Conversation

@cdhawke
Copy link
Copy Markdown
Contributor

@cdhawke cdhawke commented Jul 10, 2025

🧭 What and Why

image

The typescript types being generated for the v3 abtesting client don't match the object definitions in the openapi spec file. We think this is due to a naming collision when generating the types - Metric is defined elsewhere and being reused improperly.

Changes included:

  • rename the object reference in the spec

🧪 Test

N/A

@cdhawke cdhawke requested a review from leonardogavaudan July 10, 2025 17:20
@cdhawke cdhawke self-assigned this Jul 10, 2025
@cdhawke cdhawke requested a review from a team as a code owner July 10, 2025 17:20
@cdhawke cdhawke requested review from Fluf22 and shortcuts July 10, 2025 17:20
@algolia-bot
Copy link
Copy Markdown
Collaborator

algolia-bot commented Jul 10, 2025 •
edited
Loading

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@17' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by 090b2544c0c20f5fcce3ed9f0b354717d1869744
🍃 Generated commit 0bf012b708c0f41c9dd17e831a8efddf2e9f6e1d
🌲 Generated branch generated/fix/abtests/spec
📊 Benchmark results

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

Language Req/s
go 1736
javascript 1675
php 1489
csharp 1347
java 1087
python 1085
ruby 810
swift 370
scala 23

@cdhawke cdhawke changed the title fix(spec): abtest v3 naming conflict with Metric type fix(specs): abtest v3 naming conflict with Metric type Jul 10, 2025
@shortcuts
Copy link
Copy Markdown
Member

shortcuts commented Jul 10, 2025

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@17' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by b4f302a691b431393a1e582399aa478c49b59f44
🍃 Generated commit 10e13eb58930f9ad332a8ecea8ee8cb80343463b
🌲 Generated branch generated/fix/abtests/spec
📊 Benchmark results

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

Language Req/s
go 1774
javascript 1663
php 1476
csharp 1304
python 1071
java 1057
ruby 773
swift 662
scala 23

@cdhawke does the generation looks correct here?

@cdhawke
Copy link
Copy Markdown
Contributor Author

cdhawke commented Jul 10, 2025

@shortcuts - no, looks like it was still reusing one of the names inadvertently. I'm trying to give them distinct names to map better and avoid the collisions. let's see after this next run

@cdhawke
Copy link
Copy Markdown
Contributor Author

cdhawke commented Jul 14, 2025

@shortcuts I think it looks okay now...

@cdhawke cdhawke requested a review from leonardogavaudan July 14, 2025 12:04
leonardogavaudan
leonardogavaudan approved these changes Jul 15, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@leonardogavaudan leonardogavaudan left a comment

Choose a reason for hiding this comment

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

LGTM

shortcuts
shortcuts approved these changes Jul 15, 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.

indeed good catch!

@shortcuts shortcuts enabled auto-merge (squash) July 15, 2025 08:21
@shortcuts shortcuts merged commit fe3312f into main Jul 15, 2025
29 checks passed
@shortcuts shortcuts deleted the fix/abtests/spec branch July 15, 2025 08:51
algolia-bot added a commit that referenced this pull request Jul 15, 2025
@algolia-bot @cdhawke @shortcuts
fix(specs): abtest v3 naming conflict with Metric type (#5090) (gener…
712cf0b 
…ated) [skip ci]

Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Jul 15, 2025
@algolia-bot @cdhawke @shortcuts
fix(specs): abtest v3 naming conflict with Metric type (generated)
398a235 
algolia/api-clients-automation#5090

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.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

@leonardogavaudan leonardogavaudan leonardogavaudan approved these changes

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

Assignees

@cdhawke cdhawke

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@cdhawke @algolia-bot @shortcuts @leonardogavaudan