Skip to content

Commit 54334b9

Browse files
committed
fix(specs): Add context to hitsPerPage (generated)
algolia/api-clients-automation#3969 Co-authored-by: algolia-bot <[email protected]>
1 parent 0f0ad43 commit 54334b9

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

lib/algolia/models/recommend/search_recommend_rules_params.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ class SearchRecommendRulesParams
1313
# Only search for rules with matching context.
1414
attr_accessor :context
1515

16-
# Requested page of the API response.
16+
# 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.
1717
attr_accessor :page
1818

19-
# Maximum number of hits per page.
19+
# 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.
2020
attr_accessor :hits_per_page
2121

2222
# 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.

lib/algolia/models/search/search_dictionary_entries_response.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class SearchDictionaryEntriesResponse
99
# Dictionary entries matching the search criteria.
1010
attr_accessor :hits
1111

12-
# Requested page of the API response.
12+
# 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.
1313
attr_accessor :page
1414

1515
# Number of results (hits).

lib/algolia/models/search/search_rules_params.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ class SearchRulesParams
1515
# Only return rules that match the context (exact match).
1616
attr_accessor :context
1717

18-
# Requested page of the API response.
18+
# 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.
1919
attr_accessor :page
2020

21-
# Maximum number of hits per page.
21+
# 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.
2222
attr_accessor :hits_per_page
2323

2424
# If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.

lib/algolia/models/search/search_user_ids_response.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class SearchUserIdsResponse
1616
# Page of search results to retrieve.
1717
attr_accessor :page
1818

19-
# Maximum number of hits per page.
19+
# 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.
2020
attr_accessor :hits_per_page
2121

2222
# Date and time when the object was updated, in RFC 3339 format.

0 commit comments

Comments
 (0)