Skip to content
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.

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

Add pagination feature for v0.30.0 #392

Merged

Conversation

alallema
Copy link
Contributor

@alallema alallema commented Dec 5, 2022

Adds the new page selection component

TODO:

  • Add HitsPerPage
  • Add two new search parameters: Page and HitsPerPage
  • Add 4 new search responses: Page, HitsPerPage, TotalHits, TotalPages
  • Add tests

Response:

  • limit is now optional
  • offset is now optional
  • estimatedTotalHits is now optional
  • new page is optional
  • new hitsPerPage is optional
  • new totalPages is optional
  • new totalHits is optional

Tests

  • add tests for new search parameters: page and hitsPerPage check totalHits, totalPages in the response.

@alallema alallema requested a review from brunoocasali December 5, 2022 15:35
@alallema alallema force-pushed the add_pagination_feature_for_v0.30.0 branch from 654d517 to df1c6a7 Compare December 5, 2022 17:05
Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

simple and effective!

@alallema alallema force-pushed the add_pagination_feature_for_v0.30.0 branch from df1c6a7 to 6e97a76 Compare December 7, 2022 11:13
@alallema alallema merged commit 9189a95 into bump-meilisearch-v0.30.0 Dec 7, 2022
@alallema alallema deleted the add_pagination_feature_for_v0.30.0 branch December 7, 2022 11:19
@alallema alallema added the enhancement New feature or request label Dec 7, 2022
bors bot added a commit that referenced this pull request Dec 14, 2022
382: Changes related to the next Meilisearch release (v0.30.0) r=alallema a=meili-bot

Related to this issue: meilisearch/integration-guides#221

This PR:
- gathers the changes related to the next Meilisearch release (v0.30.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v0.30.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.30.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/main/resources/pre-release-week.md) purpose._

Done:
- #390
- #392
- #395
- #396
- #397

Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Amélie <alallema@users.noreply.github.com>
Co-authored-by: alallema <amelie@meilisearch.com>
bors bot added a commit that referenced this pull request Dec 15, 2022
398: Update version for the next release (0.22.0) r=alallema a=alallema

This version makes this package compatible with Meilisearch v0.30.0 🎉
Check out the changelog of [Meilisearch v0.30.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0) for more information on the changes.

## 🚀 Enhancements

- New `pagination` strategy with the search parameters `Page` and `HitsPerPage` #392
- New filters on `GetTasks`: `UID`, `BeforeEnqueuedAt`, `AfterEnqueuedAt`, ... see #390 
- New `client.CancelTasks` method that lets you cancel `enqueued` and `processing` tasks #395
- New `client.DeleteTasks` method that lets you delete tasks #396 
- New `client.SwapIndexes` method that lets you swap two indexes #397
- New fields on `Task.Details` #395

## ⚠️ Breaking change

- Parameters on `GetTasks` name changes: #390
   - `Status` -> `Statuses`
   - `IndexUID` -> `IndexUIDS`
   - `Type` -> `Types`


Co-authored-by: alallema <amelie@meilisearch.com>
Co-authored-by: Amélie <alallema@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants