Skip to content

fix(specs): clarify maxHitsPerQuery is a per-page limit - #7210

Merged
kai687 merged 1 commit into
mainfrom
fix/max-hits-per-query
Oct 30, 2026
Merged

kai687 merged 1 commit into
mainfrom
fix/max-hits-per-query

Conversation

@kai687

@kai687 kai687 commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

🧭 What and Why

🎟 JIRA Ticket: CR-12372

The maxHitsPerQuery API key restriction is misleadingly named. It limits the number of records per page for the API key, not per query. Customers expect a cap on the total records they can retrieve, which the parameter doesn't provide.

Clarification from @alejandrouda:

Related changes:

Changes included:

  • Update the maxHitsPerQuery description in specs/search/paths/keys/common/schemas.yml
  • The parameter name and default value (0) stay unchanged, since renaming would break the API contract
  • Regenerated specs/bundled/search.yml is produced by CI

πŸ§ͺ Test

  • yarn cli build specs search passes (lint and bundle)
  • Description-only change, so no CTS change

@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

βœ”οΈ Code generated!

Name Link
πŸͺ“ Triggered by 5d2f13a95f4c941f97707957e95c69b762f66309
πŸƒ Generated commit e43d35f4c29dd845919b576152a30d4891a21981
🌲 Generated branch generated/fix/max-hits-per-query
πŸ“Š Benchmark results

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

Language Req/s
csharp 2649
javascript 2219
go 1806
python 1644
php 1579
java 1354
ruby 959
scala 637
swift 485

@kai687
kai687 marked this pull request as ready for review October 30, 2026 10:46
@kai687
kai687 requested a review from a team as a code owner October 30, 2026 10:46
@kai687
kai687 requested review from Fluf22 and eric-zaharia October 30, 2026 10:46
@kai687
kai687 enabled auto-merge (squash) October 30, 2026 10:54
@kai687
kai687 merged commit e6933da into main Oct 30, 2026
40 checks passed
@kai687
kai687 deleted the fix/max-hits-per-query branch October 30, 2026 11:00
algolia-api-clients-automation-bot Bot added a commit that referenced this pull request Oct 30, 2026
…rated) [skip ci]

Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Oct 30, 2026
algolia/api-clients-automation#7210

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.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.

2 participants