Skip to content

Commit

Permalink
fix(specs): Add context to hitsPerPage (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3969

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
  • Loading branch information
algolia-bot committed Oct 14, 2024
1 parent 0f0ad43 commit 54334b9
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions lib/algolia/models/recommend/search_recommend_rules_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ class SearchRecommendRulesParams
# Only search for rules with matching context.
attr_accessor :context

# 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.
attr_accessor :page

# 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.
attr_accessor :hits_per_page

# 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class SearchDictionaryEntriesResponse
# Dictionary entries matching the search criteria.
attr_accessor :hits

# 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.
attr_accessor :page

# Number of results (hits).
Expand Down
4 changes: 2 additions & 2 deletions lib/algolia/models/search/search_rules_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ class SearchRulesParams
# Only return rules that match the context (exact match).
attr_accessor :context

# 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.
attr_accessor :page

# 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.
attr_accessor :hits_per_page

# If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
Expand Down
2 changes: 1 addition & 1 deletion lib/algolia/models/search/search_user_ids_response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class SearchUserIdsResponse
# Page of search results to retrieve.
attr_accessor :page

# 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.
attr_accessor :hits_per_page

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

0 comments on commit 54334b9

Please sign in to comment.