Skip to content

Commit

Permalink
fix(specs): Add context to hitsPerPage (#3969) (generated) [skip ci]
Browse files Browse the repository at this point in the history
Co-authored-by: gazconroy <gazconroyster@gmail.com>
Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
algolia-bot committed Oct 14, 2024
1 parent 5866c29 commit 8e9f969
Show file tree
Hide file tree
Showing 50 changed files with 356 additions and 92 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ public SearchRecommendRulesParams()
public string Context { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Requested page of the API response.</value>
/// <value>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. </value>
[JsonPropertyName("page")]
public int? Page { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Maximum number of hits per page.</value>
/// <value>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. </value>
[JsonPropertyName("hitsPerPage")]
public int? HitsPerPage { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public SearchDictionaryEntriesResponse() { }
/// Initializes a new instance of the SearchDictionaryEntriesResponse class.
/// </summary>
/// <param name="hits">Dictionary entries matching the search criteria. (required).</param>
/// <param name="page">Requested page of the API response. (required).</param>
/// <param name="page">Requested page of the API response. Algolia uses &#x60;page&#x60; and &#x60;hitsPerPage&#x60; to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - &#x60;hitsPerPage&#x60;: sets the number of search results (_hits_) displayed per page. - &#x60;page&#x60;: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is &#x60;page&#x3D;0&#x60;, the second is &#x60;page&#x3D;1&#x60;, and so on. For example, to display 10 results per page starting from the third page, set &#x60;hitsPerPage&#x60; to 10 and &#x60;page&#x60; to 2. (required).</param>
/// <param name="nbHits">Number of results (hits). (required).</param>
/// <param name="nbPages">Number of pages of results. (required).</param>
public SearchDictionaryEntriesResponse(List<DictionaryEntry> hits, int page, int nbHits, int nbPages)
Expand All @@ -44,9 +44,9 @@ public SearchDictionaryEntriesResponse(List<DictionaryEntry> hits, int page, int
public List<DictionaryEntry> Hits { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Requested page of the API response.</value>
/// <value>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. </value>
[JsonPropertyName("page")]
public int Page { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ public SearchRulesParams()
public string Context { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Requested page of the API response.</value>
/// <value>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. </value>
[JsonPropertyName("page")]
public int? Page { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Maximum number of hits per page.</value>
/// <value>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. </value>
[JsonPropertyName("hitsPerPage")]
public int? HitsPerPage { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public SearchUserIdsResponse() { }
/// <param name="hits">User objects that match the query. (required).</param>
/// <param name="nbHits">Number of results (hits). (required).</param>
/// <param name="page">Page of search results to retrieve. (required) (default to 0).</param>
/// <param name="hitsPerPage">Maximum number of hits per page. (required) (default to 20).</param>
/// <param name="hitsPerPage">Maximum number of hits per page. Algolia uses &#x60;page&#x60; and &#x60;hitsPerPage&#x60; to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - &#x60;hitsPerPage&#x60;: sets the number of search results (_hits_) displayed per page. - &#x60;page&#x60;: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is &#x60;page&#x3D;0&#x60;, the second is &#x60;page&#x3D;1&#x60;, and so on. For example, to display 10 results per page starting from the third page, set &#x60;hitsPerPage&#x60; to 10 and &#x60;page&#x60; to 2. (required) (default to 20).</param>
/// <param name="updatedAt">Date and time when the object was updated, in RFC 3339 format. (required).</param>
public SearchUserIdsResponse(List<UserHit> hits, int nbHits, int page, int hitsPerPage, string updatedAt)
{
Expand Down Expand Up @@ -60,9 +60,9 @@ public SearchUserIdsResponse(List<UserHit> hits, int nbHits, int page, int hitsP
public int Page { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>Maximum number of hits per page.</value>
/// <value>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. </value>
[JsonPropertyName("hitsPerPage")]
public int HitsPerPage { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ final class SearchRecommendRulesParams {
@JsonKey(name: r'context')
final String? 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.
// minimum: 0
@JsonKey(name: r'page')
final int? 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.
// minimum: 1
// maximum: 1000
@JsonKey(name: r'hitsPerPage')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ final class SearchDictionaryEntriesResponse {
@JsonKey(name: r'hits')
final List<DictionaryEntry> 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.
// minimum: 0
@JsonKey(name: r'page')
final int page;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ final class SearchRulesParams {
@JsonKey(name: r'context')
final String? 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.
// minimum: 0
@JsonKey(name: r'page')
final int? 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.
// minimum: 1
// maximum: 1000
@JsonKey(name: r'hitsPerPage')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ final class SearchUserIdsResponse {
@JsonKey(name: r'page')
final int 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.
// minimum: 1
// maximum: 1000
@JsonKey(name: r'hitsPerPage')
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 8e9f969

Please sign in to comment.