From 42e54eef62abe3beaf6a8dea34850e2c33b95735 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 14 Oct 2024 15:50:10 +0000 Subject: [PATCH] fix(specs): Add context to hitsPerPage (generated) https://github.com/algolia/api-clients-automation/pull/3969 Co-authored-by: algolia-bot --- .../lib/src/model/search_recommend_rules_params.dart | 4 ++-- .../lib/src/model/search_dictionary_entries_response.dart | 2 +- packages/client_search/lib/src/model/search_rules_params.dart | 4 ++-- .../client_search/lib/src/model/search_user_ids_response.dart | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart b/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart index f74c127..2008fa8 100644 --- a/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart +++ b/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart @@ -27,12 +27,12 @@ final class SearchRecommendRulesParams { @JsonKey(name: r'context') final String? context; - /// 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. // minimum: 0 @JsonKey(name: r'page') final int? page; - /// 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. // minimum: 1 // maximum: 1000 @JsonKey(name: r'hitsPerPage') diff --git a/packages/client_search/lib/src/model/search_dictionary_entries_response.dart b/packages/client_search/lib/src/model/search_dictionary_entries_response.dart index 140d4ca..22d5d93 100644 --- a/packages/client_search/lib/src/model/search_dictionary_entries_response.dart +++ b/packages/client_search/lib/src/model/search_dictionary_entries_response.dart @@ -20,7 +20,7 @@ final class SearchDictionaryEntriesResponse { @JsonKey(name: r'hits') final List hits; - /// 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. // minimum: 0 @JsonKey(name: r'page') final int page; diff --git a/packages/client_search/lib/src/model/search_rules_params.dart b/packages/client_search/lib/src/model/search_rules_params.dart index 2deeb55..ff651c9 100644 --- a/packages/client_search/lib/src/model/search_rules_params.dart +++ b/packages/client_search/lib/src/model/search_rules_params.dart @@ -29,12 +29,12 @@ final class SearchRulesParams { @JsonKey(name: r'context') final String? context; - /// 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. // minimum: 0 @JsonKey(name: r'page') final int? page; - /// 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. // minimum: 1 // maximum: 1000 @JsonKey(name: r'hitsPerPage') diff --git a/packages/client_search/lib/src/model/search_user_ids_response.dart b/packages/client_search/lib/src/model/search_user_ids_response.dart index f78c420..614f188 100644 --- a/packages/client_search/lib/src/model/search_user_ids_response.dart +++ b/packages/client_search/lib/src/model/search_user_ids_response.dart @@ -30,7 +30,7 @@ final class SearchUserIdsResponse { @JsonKey(name: r'page') final int page; - /// 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. // minimum: 1 // maximum: 1000 @JsonKey(name: r'hitsPerPage')