From fb9544cc242dc74632c71088ce8bd79b23663563 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 14 Oct 2024 15:50:16 +0000 Subject: [PATCH] fix(specs): Add context to hitsPerPage (generated) https://github.com/algolia/api-clients-automation/pull/3969 Co-authored-by: algolia-bot --- .../client/model/recommend/SearchRecommendRulesParams.kt | 8 ++++---- .../model/search/SearchDictionaryEntriesResponse.kt | 4 ++-- .../com/algolia/client/model/search/SearchRulesParams.kt | 8 ++++---- .../algolia/client/model/search/SearchUserIdsResponse.kt | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt index db604781a..1dd1fb9af 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchRecommendRulesParams.kt +++ b/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/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt index 07a1fa5cc..ee1c6cfc8 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchDictionaryEntriesResponse.kt +++ b/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/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt b/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt index b4a1f756b..b3f38455d 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchRulesParams.kt +++ b/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/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt index 51ff180ef..38161df22 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/search/SearchUserIdsResponse.kt +++ b/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. */