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

fix(specs): rename search method #514

Merged
merged 1 commit into from
May 19, 2022
Merged

fix(specs): rename search method #514

merged 1 commit into from
May 19, 2022

Conversation

shortcuts
Copy link
Member

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-485

Changes included:

To reduce the number of breaking changes, we've decided to rename search methods:

  • search (single index search) is now called searchSingleIndex
  • multipleQueries (multi index search) is now called search

Updates:

  • specs
  • docs
  • snippets
  • playground

🧪 Test

CI :D

@shortcuts shortcuts self-assigned this May 19, 2022
@netlify
Copy link

netlify bot commented May 19, 2022

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 90f5125
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/628614dfb8679300080c9771
😎 Deploy Preview https://deploy-preview-514--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented May 19, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the last generated commit.

@shortcuts shortcuts requested review from a team, eunjae-lee and millotp and removed request for a team May 19, 2022 10:11
@shortcuts shortcuts marked this pull request as ready for review May 19, 2022 10:11
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.

Looking really good ! I feel like git is not helping when file are renamed or swapped, the diff is huge

query: '<YOUR_QUERY>',
filters: 'actor:Scarlett Johansson',
},
requests: [
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you merge the two calls and use an array like before ? it makes sense now

Copy link
Member Author

Choose a reason for hiding this comment

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

I did not wanted to go too deep in the doc changes, just the usage. I have an other task that aims at improving the guides/examples so I will do it in it

## Using the client

<Tabs
Copy link
Collaborator

Choose a reason for hiding this comment

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

do you know if there is a plugin or something to ease the writing of those files ? like either having a separate file for each language, or write the file with sections...

Copy link
Member Author

Choose a reason for hiding this comment

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

I personally set the syntax to markdown so I can collapse sections, but I believe there might be plugins indeed

@shortcuts
Copy link
Member Author

Looking really good ! I feel like git is not helping when file are renamed or swapped, the diff is huge

Yep definitely, especially here where there is in fact really small changes

@shortcuts shortcuts merged commit 0d23c52 into main May 19, 2022
@shortcuts shortcuts deleted the feat/spec-rename-search branch May 19, 2022 13:41
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.

3 participants