Skip to content

docs(ai-perso): add ai-personalization spec file for documentation generation #4063

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

Merged
merged 9 commits into from
Nov 1, 2024

Conversation

writeens
Copy link
Contributor

@writeens writeens commented Oct 31, 2024

🧭 What and Why

This PR introduces the AI Personalization API spec to the API Clients repository with the aim of updating the API reference in the Algolia documentation to the new format.

Note

A subsequent PR will cover the generation of API clients for AI Personalization. This PR is focused on ensuring that the new spec is available via the AI Personalization API reference.

🎟 JIRA Ticket: PRED-3198

Changes included:

  • Introduced OpenAPI spec file for AI personalization matching the existing documentation

@writeens writeens self-assigned this Oct 31, 2024
@algolia-bot
Copy link
Collaborator

algolia-bot commented Oct 31, 2024

✔️ Code generated!

Name Link
🪓 Triggered by cd6e342d2662efc45bc37f75c45a1fd3f8f6b11d
🍃 Generated commit f31ab995eeffb6f7ba70295a9564b29a77fc46af
🌲 Generated branch generated/feat/ai-perso/add-ai-personalization-spec
📊 Benchmark results

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

Language Req/s
javascript 1670
go 1573
php 1470
csharp 1379
java 1121
python 1021
ruby 934
swift 750

@writeens writeens changed the title feat(ai-perso): add ai-personalization spec file docs(ai-perso): add ai-personalization spec file for documentation generation Oct 31, 2024
@shortcuts
Copy link
Member

Hey!! Thanks for adding the new spec :D

would you like to have a pre-release for the clients, or will you release a stable version right away?

@writeens
Copy link
Contributor Author

@shortcuts Thanks for the quick turnaround

would you like to have a pre-release for the clients, or will you release a stable version right away?

We're really more focused on just having the spec power the documentation for now. Can we hold off on making any release for the clients?

@shortcuts
Copy link
Member

shortcuts commented Oct 31, 2024

@shortcuts Thanks for the quick turnaround

would you like to have a pre-release for the clients, or will you release a stable version right away?

We're really more focused on just having the spec power the documentation for now. Can we hold off on making any release for the clients?

As long as it's not referenced in the API clients configuration, they won't get generated so all good! This spec will be forwarded to the docs at the next release of the API clients :)

@writeens
Copy link
Contributor Author

@shortcuts is there a release schedule in place for the API Clients? I'm not sure I found one.

@shortcuts
Copy link
Member

@shortcuts is there a release schedule in place for the API Clients? I'm not sure I found one.

we release when needed otherwise it's scheduled every tuesday morning, but we need to release later today anyway so we can wait for this pr to be merged!

@shortcuts
Copy link
Member

All good on our side, let me know when you are good to merge!

@writeens writeens marked this pull request as ready for review October 31, 2024 12:14
@writeens writeens requested a review from a team as a code owner October 31, 2024 12:14
bengreenbank
bengreenbank previously approved these changes Nov 1, 2024
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.

Thanks :)

@shortcuts shortcuts enabled auto-merge (squash) November 1, 2024 17:29
@shortcuts shortcuts merged commit 832e523 into main Nov 1, 2024
29 of 40 checks passed
@shortcuts shortcuts deleted the feat/ai-perso/add-ai-personalization-spec branch November 1, 2024 17:46
algolia-bot added a commit that referenced this pull request Nov 1, 2024
…neration (#4063) (generated) [skip ci]

Co-authored-by: Victor Adewusi <[email protected]>
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.

4 participants