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

algolia/api-clients-automation#3969

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

Author: algolia-bot

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.

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

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.

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