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 info and link about indexing rate limits #4136

Merged
merged 5 commits into from
Nov 20, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Nov 19, 2024

🧭 What and Why

The old API client method pages for indexing operations had a note about rate limits.
This PR adds a minimal version to the API specs with a link to the to avoid duplicating information.

🎟 JIRA Ticket:

Changes included:

  • Add a sentence with a link to support article to indexing operations in the Search API and to the Records tag description
  • Change the summary for deleteBy to "Delete records matching a filter" as you can't pass a search query to this method, so it's misleading.

🧪 Test

@algolia-bot
Copy link
Collaborator

algolia-bot commented Nov 19, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 00899238ec56c73807bbbcfdfd635bfb695942cd
🍃 Generated commit c84234f0ca7a721b09559774a2154daf6f8f8484
🌲 Generated branch generated/docs/rate-limits
📊 Benchmark results

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

Language Req/s
go 1627
javascript 1626
php 1563
csharp 1276
java 1130
python 1052
ruby 891
swift 781

@kai687 kai687 marked this pull request as ready for review November 20, 2024 07:54
@kai687 kai687 requested a review from a team as a code owner November 20, 2024 07:54
@kai687 kai687 requested review from Fluf22 and shortcuts November 20, 2024 07:54
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

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

@shortcuts shortcuts merged commit 068fdac into main Nov 20, 2024
28 checks passed
@shortcuts shortcuts deleted the docs/rate-limits branch November 20, 2024 10:10
algolia-bot added a commit that referenced this pull request Nov 20, 2024
…nerated) [skip ci]

Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Nov 20, 2024
algolia/api-clients-automation#4136

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
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