Skip to content

Commit

Permalink
fix(specs): Add context to hitsPerPage (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3969

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
  • Loading branch information
algolia-bot committed Oct 14, 2024
1 parent e035c93 commit 404a190
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export type SearchDictionaryEntriesResponse = {
hits: Array<DictionaryEntry>;

/**
* Requested page of the API response.
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
page: number;

Expand Down
4 changes: 2 additions & 2 deletions packages/client-search/model/searchRulesParams.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ export type SearchRulesParams = {
context?: string;

/**
* Requested page of the API response.
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
page?: number;

/**
* Maximum number of hits per page.
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
hitsPerPage?: number;

Expand Down
2 changes: 1 addition & 1 deletion packages/client-search/model/searchUserIdsResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export type SearchUserIdsResponse = {
page: number;

/**
* Maximum number of hits per page.
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
hitsPerPage: number;

Expand Down
4 changes: 2 additions & 2 deletions packages/recommend/model/searchRecommendRulesParams.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ export type SearchRecommendRulesParams = {
context?: string;

/**
* Requested page of the API response.
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
page?: number;

/**
* Maximum number of hits per page.
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
*/
hitsPerPage?: number;

Expand Down

0 comments on commit 404a190

Please sign in to comment.