fix(specs): Add context to hitsPerPage (generated)

algolia-bot · algolia-bot · commit b2f3fdb3b4f4 · 2024-10-14T15:50:17.000Z
algolia/api-clients-automation#3969 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
diff --git a/lib/Api/RecommendClient.php b/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/lib/Api/SearchClient.php b/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/lib/Model/Recommend/SearchRecommendRulesParams.php b/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/lib/Model/Search/SearchDictionaryEntriesResponse.php b/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/lib/Model/Search/SearchRulesParams.php b/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/lib/Model/Search/SearchUserIdsResponse.php b/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
      */

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ public function getPage()`
`270`	`270`	`/**`
`271`	`271`	`* Sets page.`
`272`	`272`	`*`
`273`		`- * @param null\|int $page requested page of the API response`
	`273`	+ * @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.
`274`	`274`	`*`
`275`	`275`	`* @return self`
`276`	`276`	`*/`
`@@ -294,7 +294,7 @@ public function getHitsPerPage()`
`294`	`294`	`/**`
`295`	`295`	`* Sets hitsPerPage.`
`296`	`296`	`*`
`297`		`- * @param null\|int $hitsPerPage maximum number of hits per page`
	`297`	+ * @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.
`298`	`298`	`*`
`299`	`299`	`* @return self`
`300`	`300`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -227,7 +227,7 @@ public function getPage()`
`227`	`227`	`/**`
`228`	`228`	`* Sets page.`
`229`	`229`	`*`
`230`		`- * @param int $page requested page of the API response`
	`230`	+ * @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.
`231`	`231`	`*`
`232`	`232`	`* @return self`
`233`	`233`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -278,7 +278,7 @@ public function getPage()`
`278`	`278`	`/**`
`279`	`279`	`* Sets page.`
`280`	`280`	`*`
`281`		`- * @param null\|int $page requested page of the API response`
	`281`	+ * @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.
`282`	`282`	`*`
`283`	`283`	`* @return self`
`284`	`284`	`*/`
`@@ -302,7 +302,7 @@ public function getHitsPerPage()`
`302`	`302`	`/**`
`303`	`303`	`* Sets hitsPerPage.`
`304`	`304`	`*`
`305`		`- * @param null\|int $hitsPerPage maximum number of hits per page`
	`305`	+ * @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.
`306`	`306`	`*`
`307`	`307`	`* @return self`
`308`	`308`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -288,7 +288,7 @@ public function getHitsPerPage()`
`288`	`288`	`/**`
`289`	`289`	`* Sets hitsPerPage.`
`290`	`290`	`*`
`291`		`- * @param int $hitsPerPage maximum number of hits per page`
	`291`	+ * @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.
`292`	`292`	`*`
`293`	`293`	`* @return self`
`294`	`294`	`*/`