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

algolia/api-clients-automation#3969

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

Author: algolia-bot

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

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

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.  """
 

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. """