From 8e9f969dd0a85f3d249ee785fcb301902997c91b Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 14 Oct 2024 15:46:52 +0000 Subject: [PATCH] fix(specs): Add context to hitsPerPage (#3969) (generated) [skip ci] Co-authored-by: gazconroy Co-authored-by: Gary Conroy Co-authored-by: Pierre Millot --- .../Recommend/SearchRecommendRulesParams.cs | 8 ++-- .../Search/SearchDictionaryEntriesResponse.cs | 6 +-- .../Models/Search/SearchRulesParams.cs | 8 ++-- .../Models/Search/SearchUserIdsResponse.cs | 6 +-- .../model/search_recommend_rules_params.dart | 4 +- .../search_dictionary_entries_response.dart | 2 +- .../lib/src/model/search_rules_params.dart | 4 +- .../src/model/search_user_ids_response.dart | 2 +- .../model_search_recommend_rules_params.go | 4 +- ...odel_search_dictionary_entries_response.go | 2 +- .../search/model_search_rules_params.go | 4 +- .../search/model_search_user_ids_response.go | 2 +- .../recommend/SearchRecommendRulesParams.java | 22 +++++++++- .../SearchDictionaryEntriesResponse.java | 11 ++++- .../model/search/SearchRulesParams.java | 22 +++++++++- .../model/search/SearchUserIdsResponse.java | 11 ++++- .../model/searchDictionaryEntriesResponse.ts | 2 +- .../client-search/model/searchRulesParams.ts | 4 +- .../model/searchUserIdsResponse.ts | 2 +- .../model/searchRecommendRulesParams.ts | 4 +- .../recommend/SearchRecommendRulesParams.kt | 8 ++-- .../search/SearchDictionaryEntriesResponse.kt | 4 +- .../client/model/search/SearchRulesParams.kt | 8 ++-- .../model/search/SearchUserIdsResponse.kt | 4 +- .../lib/Api/RecommendClient.php | 4 +- .../lib/Api/SearchClient.php | 4 +- .../Recommend/SearchRecommendRulesParams.php | 4 +- .../SearchDictionaryEntriesResponse.php | 2 +- .../lib/Model/Search/SearchRulesParams.php | 4 +- .../Model/Search/SearchUserIdsResponse.php | 2 +- .../models/search_recommend_rules_params.py | 4 +- .../search_dictionary_entries_response.py | 2 +- .../search/models/search_rules_params.py | 4 +- .../search/models/search_user_ids_response.py | 2 +- .../search_recommend_rules_params.rb | 4 +- .../search_dictionary_entries_response.rb | 2 +- .../models/search/search_rules_params.rb | 4 +- .../models/search/search_user_ids_response.rb | 2 +- .../SearchRecommendRulesParams.scala | 14 ++++++- .../SearchDictionaryEntriesResponse.scala | 7 +++- .../search/SearchRulesParams.scala | 14 ++++++- .../search/SearchUserIdsResponse.scala | 7 +++- .../Models/SearchRecommendRulesParams.swift | 16 +++++++- .../SearchDictionaryEntriesResponse.swift | 8 +++- .../Search/Models/SearchRulesParams.swift | 16 +++++++- .../Search/Models/SearchUserIdsResponse.swift | 8 +++- specs/bundled/recommend.doc.yml | 40 ++++++++++++++++++- specs/bundled/recommend.yml | 40 ++++++++++++++++++- specs/bundled/search.doc.yml | 40 ++++++++++++++++++- specs/bundled/search.yml | 40 ++++++++++++++++++- 50 files changed, 356 insertions(+), 92 deletions(-) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/SearchRecommendRulesParams.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/SearchRecommendRulesParams.cs index be289446d5..e34705c1ce 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/SearchRecommendRulesParams.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/SearchRecommendRulesParams.cs @@ -38,16 +38,16 @@ public SearchRecommendRulesParams() public string Context { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("page")] public int? Page { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("hitsPerPage")] public int? HitsPerPage { get; set; } diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs index 5ad3750118..7b8a99443a 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs @@ -25,7 +25,7 @@ public SearchDictionaryEntriesResponse() { } /// Initializes a new instance of the SearchDictionaryEntriesResponse class. /// /// Dictionary entries matching the search criteria. (required). - /// Requested page of the API response. (required). + /// 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. (required). /// Number of results (hits). (required). /// Number of pages of results. (required). public SearchDictionaryEntriesResponse(List hits, int page, int nbHits, int nbPages) @@ -44,9 +44,9 @@ public SearchDictionaryEntriesResponse(List hits, int page, int public List Hits { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("page")] public int Page { get; set; } diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchRulesParams.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchRulesParams.cs index 276fa52c7d..579bdd48d7 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchRulesParams.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchRulesParams.cs @@ -44,16 +44,16 @@ public SearchRulesParams() public string Context { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("page")] public int? Page { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("hitsPerPage")] public int? HitsPerPage { get; set; } diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs index 373f75749b..f6afc7f4f8 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs @@ -27,7 +27,7 @@ public SearchUserIdsResponse() { } /// User objects that match the query. (required). /// Number of results (hits). (required). /// Page of search results to retrieve. (required) (default to 0). - /// Maximum number of hits per page. (required) (default to 20). + /// 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. (required) (default to 20). /// Date and time when the object was updated, in RFC 3339 format. (required). public SearchUserIdsResponse(List hits, int nbHits, int page, int hitsPerPage, string updatedAt) { @@ -60,9 +60,9 @@ public SearchUserIdsResponse(List hits, int nbHits, int page, int hitsP public int Page { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("hitsPerPage")] public int HitsPerPage { get; set; } diff --git a/clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart b/clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart index f74c127f9f..2008fa8013 100644 --- a/clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/search_recommend_rules_params.dart +++ b/clients/algoliasearch-client-dart/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/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_dictionary_entries_response.dart b/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_dictionary_entries_response.dart index 140d4caa0c..22d5d9345d 100644 --- a/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_dictionary_entries_response.dart +++ b/clients/algoliasearch-client-dart/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/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_rules_params.dart b/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_rules_params.dart index 2deeb5576f..ff651c9874 100644 --- a/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_rules_params.dart +++ b/clients/algoliasearch-client-dart/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/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_user_ids_response.dart b/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_user_ids_response.dart index f78c420b13..614f188f3d 100644 --- a/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/search_user_ids_response.dart +++ b/clients/algoliasearch-client-dart/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') diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_search_recommend_rules_params.go b/clients/algoliasearch-client-go/algolia/recommend/model_search_recommend_rules_params.go index cd4cafc2f9..fa522fc09d 100644 --- a/clients/algoliasearch-client-go/algolia/recommend/model_search_recommend_rules_params.go +++ b/clients/algoliasearch-client-go/algolia/recommend/model_search_recommend_rules_params.go @@ -12,9 +12,9 @@ type SearchRecommendRulesParams struct { Query *string `json:"query,omitempty"` // Only search for rules with matching context. Context *string `json:"context,omitempty"` - // 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 *int32 `json:"page,omitempty"` - // 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 *int32 `json:"hitsPerPage,omitempty"` // Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. Enabled *bool `json:"enabled,omitempty"` diff --git a/clients/algoliasearch-client-go/algolia/search/model_search_dictionary_entries_response.go b/clients/algoliasearch-client-go/algolia/search/model_search_dictionary_entries_response.go index b70a23b732..91fffe369a 100644 --- a/clients/algoliasearch-client-go/algolia/search/model_search_dictionary_entries_response.go +++ b/clients/algoliasearch-client-go/algolia/search/model_search_dictionary_entries_response.go @@ -10,7 +10,7 @@ import ( type SearchDictionaryEntriesResponse struct { // Dictionary entries matching the search criteria. Hits []DictionaryEntry `json:"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. Page int32 `json:"page"` // Number of results (hits). NbHits int32 `json:"nbHits"` diff --git a/clients/algoliasearch-client-go/algolia/search/model_search_rules_params.go b/clients/algoliasearch-client-go/algolia/search/model_search_rules_params.go index 7b6487beed..2f8a20c39d 100644 --- a/clients/algoliasearch-client-go/algolia/search/model_search_rules_params.go +++ b/clients/algoliasearch-client-go/algolia/search/model_search_rules_params.go @@ -15,9 +15,9 @@ type SearchRulesParams struct { Anchoring *Anchoring `json:"anchoring,omitempty"` // Only return rules that match the context (exact match). Context *string `json:"context,omitempty"` - // 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 *int32 `json:"page,omitempty"` - // 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 *int32 `json:"hitsPerPage,omitempty"` // If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. Enabled utils.Nullable[bool] `json:"enabled,omitempty"` diff --git a/clients/algoliasearch-client-go/algolia/search/model_search_user_ids_response.go b/clients/algoliasearch-client-go/algolia/search/model_search_user_ids_response.go index f26ba3814c..e35acdb5c8 100644 --- a/clients/algoliasearch-client-go/algolia/search/model_search_user_ids_response.go +++ b/clients/algoliasearch-client-go/algolia/search/model_search_user_ids_response.go @@ -14,7 +14,7 @@ type SearchUserIdsResponse struct { NbHits int32 `json:"nbHits"` // Page of search results to retrieve. Page int32 `json:"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. HitsPerPage int32 `json:"hitsPerPage"` // Date and time when the object was updated, in RFC 3339 format. UpdatedAt string `json:"updatedAt"` diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchRecommendRulesParams.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchRecommendRulesParams.java index fb009c44b5..4b56af34ba 100644 --- a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchRecommendRulesParams.java +++ b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/SearchRecommendRulesParams.java @@ -63,7 +63,16 @@ public SearchRecommendRulesParams setPage(Integer page) { return this; } - /** Requested page of the API response. minimum: 0 */ + /** + * 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 + */ @javax.annotation.Nullable public Integer getPage() { return page; @@ -74,7 +83,16 @@ public SearchRecommendRulesParams setHitsPerPage(Integer hitsPerPage) { return this; } - /** Maximum number of hits per page. minimum: 1 maximum: 1000 */ + /** + * 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 + */ @javax.annotation.Nullable public Integer getHitsPerPage() { return hitsPerPage; diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchDictionaryEntriesResponse.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchDictionaryEntriesResponse.java index 85041bb374..23d5eafdf4 100644 --- a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchDictionaryEntriesResponse.java +++ b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchDictionaryEntriesResponse.java @@ -45,7 +45,16 @@ public SearchDictionaryEntriesResponse setPage(Integer page) { return this; } - /** Requested page of the API response. minimum: 0 */ + /** + * 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 + */ @javax.annotation.Nonnull public Integer getPage() { return page; diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchRulesParams.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchRulesParams.java index 7cbc0b543b..f2b87fd623 100644 --- a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchRulesParams.java +++ b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchRulesParams.java @@ -66,7 +66,16 @@ public SearchRulesParams setPage(Integer page) { return this; } - /** Requested page of the API response. minimum: 0 */ + /** + * 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 + */ @javax.annotation.Nullable public Integer getPage() { return page; @@ -77,7 +86,16 @@ public SearchRulesParams setHitsPerPage(Integer hitsPerPage) { return this; } - /** Maximum number of hits per page. minimum: 1 maximum: 1000 */ + /** + * 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 + */ @javax.annotation.Nullable public Integer getHitsPerPage() { return hitsPerPage; diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchUserIdsResponse.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchUserIdsResponse.java index 19adf963ca..cc8f25cb42 100644 --- a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchUserIdsResponse.java +++ b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchUserIdsResponse.java @@ -70,7 +70,16 @@ public SearchUserIdsResponse setHitsPerPage(Integer hitsPerPage) { return this; } - /** Maximum number of hits per page. minimum: 1 maximum: 1000 */ + /** + * 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 + */ @javax.annotation.Nonnull public Integer getHitsPerPage() { return hitsPerPage; diff --git a/clients/algoliasearch-client-javascript/packages/client-search/model/searchDictionaryEntriesResponse.ts b/clients/algoliasearch-client-javascript/packages/client-search/model/searchDictionaryEntriesResponse.ts index 744cd61ebc..f29bc8664e 100644 --- a/clients/algoliasearch-client-javascript/packages/client-search/model/searchDictionaryEntriesResponse.ts +++ b/clients/algoliasearch-client-javascript/packages/client-search/model/searchDictionaryEntriesResponse.ts @@ -9,7 +9,7 @@ export type SearchDictionaryEntriesResponse = { hits: Array; /** - * 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; diff --git a/clients/algoliasearch-client-javascript/packages/client-search/model/searchRulesParams.ts b/clients/algoliasearch-client-javascript/packages/client-search/model/searchRulesParams.ts index f95752470e..10a71bbece 100644 --- a/clients/algoliasearch-client-javascript/packages/client-search/model/searchRulesParams.ts +++ b/clients/algoliasearch-client-javascript/packages/client-search/model/searchRulesParams.ts @@ -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; diff --git a/clients/algoliasearch-client-javascript/packages/client-search/model/searchUserIdsResponse.ts b/clients/algoliasearch-client-javascript/packages/client-search/model/searchUserIdsResponse.ts index 7d2c934c7c..498a185d55 100644 --- a/clients/algoliasearch-client-javascript/packages/client-search/model/searchUserIdsResponse.ts +++ b/clients/algoliasearch-client-javascript/packages/client-search/model/searchUserIdsResponse.ts @@ -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; diff --git a/clients/algoliasearch-client-javascript/packages/recommend/model/searchRecommendRulesParams.ts b/clients/algoliasearch-client-javascript/packages/recommend/model/searchRecommendRulesParams.ts index 1d485b586e..cee2044ae1 100644 --- a/clients/algoliasearch-client-javascript/packages/recommend/model/searchRecommendRulesParams.ts +++ b/clients/algoliasearch-client-javascript/packages/recommend/model/searchRecommendRulesParams.ts @@ -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; diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt index db604781a1..1dd1fb9af2 100644 --- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt +++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt @@ -9,8 +9,8 @@ import kotlinx.serialization.json.* * * @param query Search query. * @param context Only search for rules with matching context. - * @param page Requested page of the API response. - * @param hitsPerPage Maximum number of hits per page. + * @param page 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. + * @param hitsPerPage 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. * @param enabled Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. * @param filters Filter expression. This only searches for rules matching the filter expression. * @param facets Include facets and facet values in the response. Use `['*']` to include all facets. @@ -25,10 +25,10 @@ public data class SearchRecommendRulesParams( /** Only search for rules with matching context. */ @SerialName(value = "context") val context: String? = null, - /** 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. */ @SerialName(value = "page") val page: Int? = null, - /** 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. */ @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null, /** Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. */ diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt index 07a1fa5cc0..ee1c6cfc81 100644 --- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt +++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt @@ -8,7 +8,7 @@ import kotlinx.serialization.json.* * SearchDictionaryEntriesResponse * * @param hits Dictionary entries matching the search criteria. - * @param page Requested page of the API response. + * @param page 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. * @param nbHits Number of results (hits). * @param nbPages Number of pages of results. */ @@ -18,7 +18,7 @@ public data class SearchDictionaryEntriesResponse( /** Dictionary entries matching the search criteria. */ @SerialName(value = "hits") val hits: List, - /** 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. */ @SerialName(value = "page") val page: Int, /** Number of results (hits). */ diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt index b4a1f756bb..b3f38455db 100644 --- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt +++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt @@ -10,8 +10,8 @@ import kotlinx.serialization.json.* * @param query Search query for rules. * @param anchoring * @param context Only return rules that match the context (exact match). - * @param page Requested page of the API response. - * @param hitsPerPage Maximum number of hits per page. + * @param page 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. + * @param hitsPerPage 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. * @param enabled If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. */ @Serializable @@ -25,10 +25,10 @@ public data class SearchRulesParams( /** Only return rules that match the context (exact match). */ @SerialName(value = "context") val context: String? = null, - /** 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. */ @SerialName(value = "page") val page: Int? = null, - /** 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. */ @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null, /** If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. */ diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt index 51ff180ef3..38161df225 100644 --- a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt +++ b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt @@ -10,7 +10,7 @@ import kotlinx.serialization.json.* * @param hits User objects that match the query. * @param nbHits Number of results (hits). * @param page Page of search results to retrieve. - * @param hitsPerPage Maximum number of hits per page. + * @param hitsPerPage 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. * @param updatedAt Date and time when the object was updated, in RFC 3339 format. */ @Serializable @@ -25,7 +25,7 @@ public data class SearchUserIdsResponse( /** Page of search results to retrieve. */ @SerialName(value = "page") val page: Int, - /** 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. */ @SerialName(value = "hitsPerPage") val hitsPerPage: Int, /** Date and time when the object was updated, in RFC 3339 format. */ diff --git a/clients/algoliasearch-client-php/lib/Api/RecommendClient.php b/clients/algoliasearch-client-php/lib/Api/RecommendClient.php index 42992d0dbd..5fc2e7e7eb 100644 --- a/clients/algoliasearch-client-php/lib/Api/RecommendClient.php +++ b/clients/algoliasearch-client-php/lib/Api/RecommendClient.php @@ -571,8 +571,8 @@ public function getRecommendations($getRecommendationsParams, $requestOptions = * @param array $searchRecommendRulesParams searchRecommendRulesParams (optional) * - $searchRecommendRulesParams['query'] => (string) Search query. * - $searchRecommendRulesParams['context'] => (string) Only search for rules with matching context. - * - $searchRecommendRulesParams['page'] => (int) Requested page of the API response. - * - $searchRecommendRulesParams['hitsPerPage'] => (int) Maximum number of hits per page. + * - $searchRecommendRulesParams['page'] => (int) 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. + * - $searchRecommendRulesParams['hitsPerPage'] => (int) 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. * - $searchRecommendRulesParams['enabled'] => (bool) Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. * - $searchRecommendRulesParams['filters'] => (string) Filter expression. This only searches for rules matching the filter expression. * - $searchRecommendRulesParams['facets'] => (array) Include facets and facet values in the response. Use `['*']` to include all facets. diff --git a/clients/algoliasearch-client-php/lib/Api/SearchClient.php b/clients/algoliasearch-client-php/lib/Api/SearchClient.php index 8a0a908d1d..a40bc4f76a 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchClient.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchClient.php @@ -2443,8 +2443,8 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu * - $searchRulesParams['query'] => (string) Search query for rules. * - $searchRulesParams['anchoring'] => (array) * - $searchRulesParams['context'] => (string) Only return rules that match the context (exact match). - * - $searchRulesParams['page'] => (int) Requested page of the API response. - * - $searchRulesParams['hitsPerPage'] => (int) Maximum number of hits per page. + * - $searchRulesParams['page'] => (int) 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. + * - $searchRulesParams['hitsPerPage'] => (int) 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. * - $searchRulesParams['enabled'] => (bool) If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. * * @see SearchRulesParams diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/SearchRecommendRulesParams.php b/clients/algoliasearch-client-php/lib/Model/Recommend/SearchRecommendRulesParams.php index 7016de9019..8caef5f052 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/SearchRecommendRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/SearchRecommendRulesParams.php @@ -270,7 +270,7 @@ public function getPage() /** * Sets page. * - * @param null|int $page requested page of the API response + * @param null|int $page 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. * * @return self */ @@ -294,7 +294,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage. * - * @param null|int $hitsPerPage maximum number of hits per page + * @param null|int $hitsPerPage 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. * * @return self */ diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesResponse.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesResponse.php index 9c4acef1d5..9ee5cc28f7 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesResponse.php @@ -227,7 +227,7 @@ public function getPage() /** * Sets page. * - * @param int $page requested page of the API response + * @param int $page 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. * * @return self */ diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchRulesParams.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchRulesParams.php index 4123f657b6..6cea81c250 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchRulesParams.php @@ -278,7 +278,7 @@ public function getPage() /** * Sets page. * - * @param null|int $page requested page of the API response + * @param null|int $page 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. * * @return self */ @@ -302,7 +302,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage. * - * @param null|int $hitsPerPage maximum number of hits per page + * @param null|int $hitsPerPage 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. * * @return self */ diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchUserIdsResponse.php index b531f18682..993e2768d6 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchUserIdsResponse.php @@ -288,7 +288,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage. * - * @param int $hitsPerPage maximum number of hits per page + * @param int $hitsPerPage 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. * * @return self */ diff --git a/clients/algoliasearch-client-python/algoliasearch/recommend/models/search_recommend_rules_params.py b/clients/algoliasearch-client-python/algoliasearch/recommend/models/search_recommend_rules_params.py index 01580299c4..4bf02cef41 100644 --- a/clients/algoliasearch-client-python/algoliasearch/recommend/models/search_recommend_rules_params.py +++ b/clients/algoliasearch-client-python/algoliasearch/recommend/models/search_recommend_rules_params.py @@ -44,9 +44,9 @@ class SearchRecommendRulesParams(BaseModel): context: Optional[str] = None """ Only search for rules with matching context. """ page: Optional[int] = None - """ 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. """ hits_per_page: Optional[int] = None - """ 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. """ enabled: Optional[bool] = None """ Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. """ filters: Optional[str] = None diff --git a/clients/algoliasearch-client-python/algoliasearch/search/models/search_dictionary_entries_response.py b/clients/algoliasearch-client-python/algoliasearch/search/models/search_dictionary_entries_response.py index 20803514d6..06dd577933 100644 --- a/clients/algoliasearch-client-python/algoliasearch/search/models/search_dictionary_entries_response.py +++ b/clients/algoliasearch-client-python/algoliasearch/search/models/search_dictionary_entries_response.py @@ -40,7 +40,7 @@ class SearchDictionaryEntriesResponse(BaseModel): hits: List[DictionaryEntry] """ Dictionary entries matching the search criteria. """ page: int - """ 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. """ nb_hits: int """ Number of results (hits). """ nb_pages: int diff --git a/clients/algoliasearch-client-python/algoliasearch/search/models/search_rules_params.py b/clients/algoliasearch-client-python/algoliasearch/search/models/search_rules_params.py index 478354f027..aa0a8c11bc 100644 --- a/clients/algoliasearch-client-python/algoliasearch/search/models/search_rules_params.py +++ b/clients/algoliasearch-client-python/algoliasearch/search/models/search_rules_params.py @@ -45,9 +45,9 @@ class SearchRulesParams(BaseModel): context: Optional[str] = None """ Only return rules that match the context (exact match). """ page: Optional[int] = None - """ 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. """ hits_per_page: Optional[int] = None - """ 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. """ enabled: Optional[bool] = None """ If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. """ diff --git a/clients/algoliasearch-client-python/algoliasearch/search/models/search_user_ids_response.py b/clients/algoliasearch-client-python/algoliasearch/search/models/search_user_ids_response.py index 1ebcbc8f54..5cc5865c78 100644 --- a/clients/algoliasearch-client-python/algoliasearch/search/models/search_user_ids_response.py +++ b/clients/algoliasearch-client-python/algoliasearch/search/models/search_user_ids_response.py @@ -45,7 +45,7 @@ class SearchUserIdsResponse(BaseModel): page: int """ Page of search results to retrieve. """ hits_per_page: int - """ 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. """ updated_at: str """ Date and time when the object was updated, in RFC 3339 format. """ diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/recommend/search_recommend_rules_params.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/recommend/search_recommend_rules_params.rb index 27ca9531ac..efc9ca6f4c 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/models/recommend/search_recommend_rules_params.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/models/recommend/search_recommend_rules_params.rb @@ -13,10 +13,10 @@ class SearchRecommendRulesParams # Only search for rules with matching context. attr_accessor :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. attr_accessor :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. attr_accessor :hits_per_page # Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property. diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_dictionary_entries_response.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_dictionary_entries_response.rb index c4c09d88a1..1ec5615146 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_dictionary_entries_response.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_dictionary_entries_response.rb @@ -9,7 +9,7 @@ class SearchDictionaryEntriesResponse # Dictionary entries matching the search criteria. attr_accessor :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. attr_accessor :page # Number of results (hits). diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_rules_params.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_rules_params.rb index 214d9b1912..251d67c960 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_rules_params.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_rules_params.rb @@ -15,10 +15,10 @@ class SearchRulesParams # Only return rules that match the context (exact match). attr_accessor :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. attr_accessor :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. attr_accessor :hits_per_page # If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned. diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_user_ids_response.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_user_ids_response.rb index c9b712d505..1f7fc8f9a9 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_user_ids_response.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/models/search/search_user_ids_response.rb @@ -16,7 +16,7 @@ class SearchUserIdsResponse # Page of search results to retrieve. attr_accessor :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. attr_accessor :hits_per_page # Date and time when the object was updated, in RFC 3339 format. diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/recommend/SearchRecommendRulesParams.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/recommend/SearchRecommendRulesParams.scala index de251b1cb7..618932796f 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/recommend/SearchRecommendRulesParams.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/recommend/SearchRecommendRulesParams.scala @@ -36,9 +36,19 @@ package algoliasearch.recommend * @param context * Only search for rules with matching context. * @param page - * 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. * @param hitsPerPage - * 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. * @param enabled * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all * rules, regardless of their `enabled` property. diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchDictionaryEntriesResponse.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchDictionaryEntriesResponse.scala index 2f28417600..20692244dd 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchDictionaryEntriesResponse.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchDictionaryEntriesResponse.scala @@ -38,7 +38,12 @@ package algoliasearch.search * @param hits * Dictionary entries matching the search criteria. * @param page - * 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. * @param nbHits * Number of results (hits). * @param nbPages diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchRulesParams.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchRulesParams.scala index 41928da13e..b4de4f4930 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchRulesParams.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchRulesParams.scala @@ -42,9 +42,19 @@ import algoliasearch.search.Anchoring._ * @param context * Only return rules that match the context (exact match). * @param page - * 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. * @param hitsPerPage - * 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. * @param enabled * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are * returned. diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchUserIdsResponse.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchUserIdsResponse.scala index 686a7aba50..5c9f1080a8 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchUserIdsResponse.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/SearchUserIdsResponse.scala @@ -42,7 +42,12 @@ package algoliasearch.search * @param page * Page of search results to retrieve. * @param hitsPerPage - * 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. * @param updatedAt * Date and time when the object was updated, in RFC 3339 format. */ diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/SearchRecommendRulesParams.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/SearchRecommendRulesParams.swift index 104cd2db06..9073933ca0 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/SearchRecommendRulesParams.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/SearchRecommendRulesParams.swift @@ -12,9 +12,21 @@ public struct SearchRecommendRulesParams: Codable, JSONEncodable { public var query: String? /// Only search for rules with matching context. public var 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. public var page: Int? - /// 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. public var hitsPerPage: Int? /// Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show /// all rules, regardless of their `enabled` property. diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDictionaryEntriesResponse.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDictionaryEntriesResponse.swift index e021801c82..b6a6f8c454 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDictionaryEntriesResponse.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDictionaryEntriesResponse.swift @@ -9,7 +9,13 @@ import Foundation public struct SearchDictionaryEntriesResponse: Codable, JSONEncodable { /// Dictionary entries matching the search criteria. public var hits: [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. public var page: Int /// Number of results (hits). public var nbHits: Int diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRulesParams.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRulesParams.swift index 6e0683eb4b..cb90a22502 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRulesParams.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRulesParams.swift @@ -13,9 +13,21 @@ public struct SearchRulesParams: Codable, JSONEncodable { public var anchoring: SearchAnchoring? /// Only return rules that match the context (exact match). public var 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. public var page: Int? - /// 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. public var hitsPerPage: Int? /// If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are /// returned. diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchUserIdsResponse.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchUserIdsResponse.swift index 3d645f2a80..740fae9772 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchUserIdsResponse.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchUserIdsResponse.swift @@ -14,7 +14,13 @@ public struct SearchUserIdsResponse: Codable, JSONEncodable { public var nbHits: Int /// Page of search results to retrieve. public var page: Int - /// 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. public var hitsPerPage: Int /// Date and time when the object was updated, in RFC 3339 format. public var updatedAt: String diff --git a/specs/bundled/recommend.doc.yml b/specs/bundled/recommend.doc.yml index adb936e0b9..763c3bf072 100644 --- a/specs/bundled/recommend.doc.yml +++ b/specs/bundled/recommend.doc.yml @@ -5860,13 +5860,49 @@ components: parameters_page: type: integer minimum: 0 - description: Requested page of the API response. + description: > + 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. parameters_hitsPerPage: type: integer default: 20 minimum: 1 maximum: 1000 - description: Maximum number of hits per page. + description: > + 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. recommendUpdatedAtResponse: type: object description: Response, taskID, and update timestamp. diff --git a/specs/bundled/recommend.yml b/specs/bundled/recommend.yml index ece3f164dc..1ba0420695 100644 --- a/specs/bundled/recommend.yml +++ b/specs/bundled/recommend.yml @@ -3766,13 +3766,49 @@ components: parameters_page: type: integer minimum: 0 - description: Requested page of the API response. + description: > + 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. parameters_hitsPerPage: type: integer default: 20 minimum: 1 maximum: 1000 - description: Maximum number of hits per page. + description: > + 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. recommendUpdatedAtResponse: type: object description: Response, taskID, and update timestamp. diff --git a/specs/bundled/search.doc.yml b/specs/bundled/search.doc.yml index 03681c4fdb..fec769bfa0 100644 --- a/specs/bundled/search.doc.yml +++ b/specs/bundled/search.doc.yml @@ -20335,13 +20335,49 @@ components: parameters_page: type: integer minimum: 0 - description: Requested page of the API response. + description: > + 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. parameters_hitsPerPage: type: integer default: 20 minimum: 1 maximum: 1000 - description: Maximum number of hits per page. + description: > + 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. dictionaryType: type: string enum: diff --git a/specs/bundled/search.yml b/specs/bundled/search.yml index 5ce652b49d..e92a96ab72 100644 --- a/specs/bundled/search.yml +++ b/specs/bundled/search.yml @@ -7374,13 +7374,49 @@ components: parameters_page: type: integer minimum: 0 - description: Requested page of the API response. + description: > + 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. parameters_hitsPerPage: type: integer default: 20 minimum: 1 maximum: 1000 - description: Maximum number of hits per page. + description: > + 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. dictionaryType: type: string enum: