Skip to content
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

feat(specs): add /schedule endpoint #3350

Merged
merged 5 commits into from
Aug 20, 2024

Conversation

febeck
Copy link
Contributor

@febeck febeck commented Jul 11, 2024

🧭 What and Why

Add documentation for newly added /schedule endpoint

🎟 JIRA Ticket: OPTIM-1160

Changes included:

  • Add new endpoint to the list
  • Add new parameter scheduledAt
  • Add new response payload

🧪 Test

Added new test file with sample

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 11, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 16113585711a9b39ed0368978dce7de0976d36bb
🍃 Generated commit 67383d0cfb894b639d6e65e50cb630557a124c57
🌲 Generated branch generated/feat/abtests/add_schedule_api_endpoint
📊 Benchmark results

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

Language Rate
javascript 1366
php 1319
csharp 1191
java 914
ruby 874
swift 748
python 717
kotlin 492
go 450

@febeck febeck changed the title feat(abtesting): add documentation for /schedule endpoint docs(abtesting): add documentation for /schedule endpoint Jul 11, 2024
@febeck febeck added the Specs Issue related to the REST API specs label Jul 11, 2024
@shortcuts
Copy link
Member

Hey, for that new endpoint, you need to add a test file (see docs) here https://github.com/algolia/api-clients-automation/tree/main/tests/CTS/requests/abtesting with the name of the operation

@febeck febeck force-pushed the feat/abtests/add_schedule_api_endpoint branch from f9619b0 to 8a19933 Compare July 11, 2024 15:23
Copy link

github-actions bot commented Jul 11, 2024

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

this looks really good thanks for the contribution !

specs/abtesting/common/parameters.yml Outdated Show resolved Hide resolved
specs/abtesting/paths/scheduleABTest.yml Outdated Show resolved Hide resolved
@shortcuts shortcuts changed the title docs(abtesting): add documentation for /schedule endpoint feat(abtesting): add /schedule endpoint Jul 12, 2024
@shortcuts shortcuts changed the title feat(abtesting): add /schedule endpoint feat(specs): add /schedule endpoint Jul 12, 2024
@millotp
Copy link
Collaborator

millotp commented Jul 12, 2024

Hey @febeck, is this ready to be merged or is the API not ready yet ?

@febeck
Copy link
Contributor Author

febeck commented Jul 19, 2024

Hey @febeck, is this ready to be merged or is the API not ready yet ?

Hey @millotp this is not yet to be merged as there is still some work to be done around this endpoint. It will probably stay here in draft for still a couple of weeks at least.

Don't worry about rebasing or checking on this. I'll put at is as "ready for review" when it's actually ready to be merged.

I am sorry if this has disturbed your workflow, I should have noted it when opening the PR

@febeck febeck force-pushed the feat/abtests/add_schedule_api_endpoint branch from d2c0765 to 473ffe8 Compare August 19, 2024 16:19
@febeck
Copy link
Contributor Author

febeck commented Aug 19, 2024

@millotp and @shortcuts this is finally ready to be merged.

I have CI failing but I don't really get what the issue is. Could one of you help me with that, please ?

@febeck febeck marked this pull request as ready for review August 19, 2024 16:25
@febeck febeck requested a review from a team as a code owner August 19, 2024 16:25
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

small question, looks good otherwise !

specs/abtesting/common/schemas/ScheduledABTestResponse.yml Outdated Show resolved Hide resolved
@febeck febeck requested a review from millotp August 20, 2024 08:58
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

perfect !

@shortcuts shortcuts merged commit d53060d into main Aug 20, 2024
21 checks passed
@shortcuts shortcuts deleted the feat/abtests/add_schedule_api_endpoint branch August 20, 2024 09:44
@shortcuts
Copy link
Member

Hey, this feature will be available in the next minor of the API clients, later today :)

algolia-bot added a commit that referenced this pull request Aug 20, 2024
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Aug 20, 2024
algolia/api-clients-automation#3350

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Fernando Beck <fe.beck25@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Specs Issue related to the REST API specs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants