Skip to content

Commit 42e54ee

Browse files
committed
fix(specs): Add context to hitsPerPage (generated)
algolia/api-clients-automation#3969 Co-authored-by: algolia-bot <[email protected]>
1 parent 10b707c commit 42e54ee

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

packages/client_recommend/lib/src/model/search_recommend_rules_params.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ final class SearchRecommendRulesParams {
2727
@JsonKey(name: r'context')
2828
final String? context;
2929

30-
/// Requested page of the API response.
30+
/// 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.
3131
// minimum: 0
3232
@JsonKey(name: r'page')
3333
final int? page;
3434

35-
/// Maximum number of hits per page.
35+
/// 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.
3636
// minimum: 1
3737
// maximum: 1000
3838
@JsonKey(name: r'hitsPerPage')

packages/client_search/lib/src/model/search_dictionary_entries_response.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ final class SearchDictionaryEntriesResponse {
2020
@JsonKey(name: r'hits')
2121
final List<DictionaryEntry> hits;
2222

23-
/// Requested page of the API response.
23+
/// 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.
2424
// minimum: 0
2525
@JsonKey(name: r'page')
2626
final int page;

packages/client_search/lib/src/model/search_rules_params.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ final class SearchRulesParams {
2929
@JsonKey(name: r'context')
3030
final String? context;
3131

32-
/// Requested page of the API response.
32+
/// 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.
3333
// minimum: 0
3434
@JsonKey(name: r'page')
3535
final int? page;
3636

37-
/// Maximum number of hits per page.
37+
/// 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.
3838
// minimum: 1
3939
// maximum: 1000
4040
@JsonKey(name: r'hitsPerPage')

packages/client_search/lib/src/model/search_user_ids_response.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ final class SearchUserIdsResponse {
3030
@JsonKey(name: r'page')
3131
final int page;
3232

33-
/// Maximum number of hits per page.
33+
/// 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.
3434
// minimum: 1
3535
// maximum: 1000
3636
@JsonKey(name: r'hitsPerPage')

0 commit comments

Comments
 (0)