Skip to content

fix(specs): Add context to hitsPerPage #3969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2024
Merged

fix(specs): Add context to hitsPerPage #3969

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c14a80
fix(specs): Add context to hitsPerPage
Oct 14, 2024
2efdf30
Merge branch 'main' into fix/hits-per-page
millotp Oct 14, 2024
86603ec
Merge branch 'main' into fix/hits-per-page
millotp Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions specs/common/parameters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,15 @@ hitsPerPage:
default: 20
minimum: 1
maximum: 1000
description: Maximum number of hits per page.
description: |
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.

query:
type: string
Expand All @@ -140,7 +148,15 @@ query:
page:
type: integer
minimum: 0
description: Requested page of the API response.
description: |
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.

count:
description: Number of occurrences.
Expand Down
Loading