Apply documents changes #481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bidoubiwa
reviewed
Jun 22, 2022
bidoubiwa
reviewed
Jun 22, 2022
bors bot
added a commit
that referenced
this pull request
Jul 11, 2022
472: Changes related to the next Meilisearch release (v0.28.0) r=alallema a=meili-bot Related to this issue: meilisearch/integration-guides#205 This PR: - gathers the changes related to the next Meilisearch release (v0.28.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.28.0 is out.⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.28.0) is out. _This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._ Done: - #474 - #475 - #476 - #477 - #478 - #479 - #481 - #484 - #489 Co-authored-by: meili-bot <[email protected]> Co-authored-by: Clémentine Urquizar <[email protected]> Co-authored-by: Amélie <[email protected]> Co-authored-by: alallema <[email protected]>
bors bot
added a commit
that referenced
this pull request
Jul 11, 2022
493: Update version for the next release (v0.19.0) r=alallema a=alallema This version makes this package compatible with Meilisearch v0.28.0 🎉 Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes. ## 💥 Breaking changes - `update_key()` can update **only** `name` and `description` fields. #477 - `get_tasks()` has additional parameters for filtering:: `type`, `status` and `indexUid`. #476 - `client.get_tasks(...)` and `index.get_tasks()` now returns the following fields: `results`, `limit`, `from`, `next`.#476 - `index.search` changes in the response `fields`: #478 - `nbHits` replaced with `estimatedTotalHits` - `exhaustiveNbHits` is deleted - `exhaustiveFacetsCount` is deleted - `matches` renamed `showMatchesPosition` - `facetsDistribution` response parameter is renamed `facetDistribution`. - `index.search` changes in the request parameters: #478 - `matches` renamed `showMatchesPosition` - `facetsDistribution` request parameter is renamed `facets`. - `index.get_documents()` request parameters: #481 - `attributesToRetrieve` replaced with `fields`. - `client.get_indexes` and `client.get_raw_indexes` now return the following fields: `results`, `limit`, `offset`, `total`. #478 - `index.get_documents` and `client.get_documents` now return the following fields: `results`, `limit`, `offset`, `total`. #481 - `index.get_documents` query parameter `attributesToRetrieve` is now called `fields` #481 - `client.get_dump_status` and `wait_for_dump_creation` have been removed #479 - `client.create_dump()` now returns tasks, similar to what add_documents or create_index returns #479 - `client.generate_tenant_token(api_key_uid, search_rules, expires_at)` has now a mandatory `api_key_uid` parameter which should contain the uid of a specific API key. #484 ## 🚀 Enhancements - `index.get_tasks` and `client.get_tasks` accept pagination metadata, added `limit` (default: 20), `from`. #476 - `client.get_indexes` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #478 - `client.get_keys` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #477 - `client.get_key(key_or_uid)` can now also find keys based on their key uid. #477 - `client.create_key(options)` lets you specify a custom uid (optionally) to create a new Key. #477 - `index.get_documents` now accepts pagination parameters: `limit` (default: 20) and `offset` (default: 0). #481 Co-authored-by: alallema <[email protected]> Co-authored-by: Amélie <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Related to: meilisearch/integration-guides#205
What does this PR do?
Breaking because enforces the users to use Meilisearch v0.28.0
GET /documents/:uid,GET /documentsAdd the possibility to reduce the body payload by using a query parameter calledfields(previously calledattributesToRetrieve), check the issue and the spec for the entire behavior.results