Skip to content

Commit 466cfc5

Browse files
fix(specs): clarify maxHitsPerQuery is a per-page limit (generated)
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>
1 parent 10b58b5 commit 466cfc5

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎packages/algoliasearch/lite/model/apiKey.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export type ApiKey = {
2222
indexes?: Array<string> | undefined;
2323

2424
/**
25-
* Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
25+
* Maximum number of hits this API key can retrieve per page. If you set this to 0, the maximum allowed value (1,000) applies. If you also set `hitsPerPage` on the index, the engine uses the lower of the two values.
2626
*/
2727
maxHitsPerQuery?: number | undefined;
2828

‎packages/client-search/model/apiKey.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export type ApiKey = {
2222
indexes?: Array<string> | undefined;
2323

2424
/**
25-
* Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
25+
* Maximum number of hits this API key can retrieve per page. If you set this to 0, the maximum allowed value (1,000) applies. If you also set `hitsPerPage` on the index, the engine uses the lower of the two values.
2626
*/
2727
maxHitsPerQuery?: number | undefined;
2828

0 commit comments

Comments
 (0)