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

algolia/api-clients-automation#3969

Co-authored-by: algolia-bot <[email protected]>

Author: algolia-bot

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.

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

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.

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.
   */