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: upgrade to newest API client version #449

Open
wants to merge 40 commits into
base: master
Choose a base branch
from
Open

Conversation

DevinCodes
Copy link
Contributor

Q A
Bug fix? no
New feature? yes
BC breaks? yes-ish
Related Issue Fix #447
Need Doc update yes

Describe your change

This upgrades the RoR client to support v3 of the Algolia API client. This introduces some breaking changes, mostly in responses when doing a search and some methods that are deprecated or change return types. I'll try to document these breaking changes as best as I can.

@DevinCodes DevinCodes changed the title WIP - feat: upgrade to newest API client version feat: upgrade to newest API client version Oct 14, 2024
Copy link

@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 is very helpful ! is there a way to edit the user agent with this library ?

parameters:
version: ['3.0', '3.1']
rails-version: ['7.0']
sequel-version: ['5.0']
Copy link

Choose a reason for hiding this comment

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

first time I'm seeing it written like it's pronounced

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haha, yes this is for a gem named sequel 😄

lib/algoliasearch-rails.rb Outdated Show resolved Hide resolved
lib/algoliasearch-rails.rb Show resolved Hide resolved
lib/algoliasearch-rails.rb Outdated Show resolved Hide resolved
@DevinCodes
Copy link
Contributor Author

DevinCodes commented Oct 14, 2024

is there a way to edit the user agent with this library ?

Oh good catch, this is not possible right now! It used to be possible, but we don't use this user agent in the new client, I'll add that!

millotp
millotp previously approved these changes Oct 17, 2024
Copy link

@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.

nothing to add !

@DevinCodes DevinCodes marked this pull request as ready for review October 18, 2024 09:33
Copy link

@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.

looks great ! The migration guide is very much appreciated 💯

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.

Upgrade algolia to v3
2 participants