Apply search changes #282
Merged
Apply search changes #282
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
curquiza
added
the
breaking-change
bors bot
added a commit
that referenced
this pull request
Jul 28, 2022
281: Changes related to the next Meilisearch release (v0.28.0) r=brunoocasali 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: - #282 - #286 - #287 - #288 - #289 - #290 - #291 - #292 - #293 - #298 Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.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
Aug 1, 2022
305: Update version for the next release (v0.11.0) r=alallema a=brunoocasali 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 - `MeilisearchClient#GetKeysAsync` now returns a `ResourceResults<Key>`. (#291) `@alallema` - `MeilisearchClient#GetAllIndexesAsync` now returns a `ResourceResults<Index>` (#289) `@alallema` - `MeilisearchClient#GetAllRawIndexesAsync` now returns a json object. (#289) `@alallema` - `MeilisearchClient#CreateDumpAsync` now responds with a `TaskInfo` object. (#292) `@alallema` - `MeilisearchClient#GetDumpStatusAsync` was removed. Use the `MeilisearchClient#GetTasksAsync` or `MeilisearchClient#GetTaskAsync` instead. (#288) `@alallema` - `DumpStatus` type was removed (#292) `@alallema.` - `SearchQuery` changes (#282) `@curqui` - Renamed `FacetsDistribution` field to `Facets`. - Renamed `Matches` field to `ShowMatchesPosition`. - `SearchResult` changes (#282) `@curqui` - Renamed `NbHits` field to `EstimatedTotalHits`. - Removed `ExhaustiveFacetsCount` field. - Removed `ExhaustiveNbHits` field. - `Index#GetDocumentsAsync<T>` now returns an object `ResourceResults<IEnumerable<T>>` (#290) `@alallema` - `MeilisearchClient#GetTasksAsync` and `Index#GetTasksAsync` now returns an object `TasksResults<IEnumerable<TaskResource>>` (#290) `@alallema` - `AddDocumentsAsync<T>`, `CreateDumpAsync`, `UpdateSettingsAsync` and other methods that "creates" a new task, now responds with a `TaskInfo` and therefore they have a `TaskUid` instead of `Uid` (#288), (#341) `@alallema` - `MeilisearchClient#GenerateTenantToken` now requires a `api key uid` to generate tenant tokens as the first positional attribute. (#298) `@alallema` ## 🐛 Enhancements - Add support to `PATCH` requests (#286), (#293) `@alallema` - Add `MeilisearchClient#UpdateKeyAsync` method to update keys (#304) `@brunoocasali` - `MeilisearchClient#GetAllIndexesAsync` now accepts an object with pagination `IndexesQuery`. (#289) `@alallema` - `MeilisearchClient#GetDocumentsAsync<T>` now accepts an object with pagination `DocumentsQuery`. (#290) `@alallema` - `MeilisearchClient#GetDocumentAsync<T>` now accepts a param called `fields` which takes an array of strings to remap the response. (#290) `@alallema` - `MeilisearchClient#CreateKeyAsync` and `MeilisearchClient#DeleteKeyAsync` accepts both `api key` or `api key uid`. (#291) `@alallema` - `MeilisearchClient#CreateKeyAsync` can optionally specify a `uid:` to generate deterministic API keys. (#291) `@alallema` Thanks again to `@alallema` and `@brunoocasali!` 🎉 Co-authored-by: Bruno Casali <brunoocasali@gmail.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
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.
Breaking because enforces the users to use Meilisearch v0.28.0
nbHitsresponse parameter toestimatedTotalHits.exhaustiveNbHitsresponse parameter.exhaustiveFacetsCountresponse parameter.matchesrequest parameter is renamedshowMatchesPosition._matchesInforesponse parameter is renamed_matchesPosition.facetsDistributionrequest parameter is renamedfacets.facetsDistributionresponse parameter is renamedfacetDistribution.