Apply search changes #306
Merged
Apply search changes #306
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 11, 2022
304: 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: - #306 - #305 - #310 - #311 - #312 - #313 - #314 - #315 - #317 - #321 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
324: Update version for the next release (v0.20.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 - `Index.Search` changes in the response fields: #306 - `nbHits` replaced with `estimatedTotalHits` - `exhaustiveNbHits` is deleted - `exhaustiveFacetsCount` is deleted - `facetsDistribution` response parameter is renamed `facetDistribution`. - `Index.Search` changes in the request parameters: #306 - `matches` renamed `showMatchesPosition` - `facetsDistribution` request parameter is renamed `facets`. - `Index.GetDocuments()` and `Index.GetDocument()` request parameters: #314 - `attributesToRetrieve` replaced with `fields`. - `Index.GetTasks()` has additional parameters for filtering: `type`, `status` and `indexUid`. #310 - All asynchronous methods now return a struct`TaskInfo` instead of 'Task' like `AddDocuments` or `CreateIndex`. #310 - `Index.GetTasks` and `Client.GetTasks` accept pagination metadata, added `limit` (default: 20), `from`. #310 - `Client.GetAllIndexes` and `Client.GetAllRawIndexes` now returns an `IndexesResults` struct containing the following fields: `Results`, `Limit`, `Offset`, `Total`. #312 - `Client.GetAllIndexes` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #312 - The `IndexUid` field in both `TaskInfo` and `Task` can be nil Update tasks routes #313 - `Index.GetDocuments` and `Client.GetDocuments` now returns an `DocumentsResults` struct containing the following fields: `Results`, `Limit`, `Offset`, `Total`. #314 - `Client.GetDumpStatus` has been removed #311 - `Client.CreateDump()` now returns an `TaskInfo` #321 - `Client.GenerateTenantToken(APIKeyUID string, SearchRules map[string]interface{}, Options *TenantTokenOptions)` has now a mandatory `APIKeyUID` parameter which should contain the uid of a specific API key. #315 - `Index.GetDocuments` now accepts pagination parameters: `limit` (default: 20) and `offset` (default: 0). #314 - `Client.GetKeys` accept pagination metadata, added `limit` (default: 20) and `offset` (default: 0). #313 - `Client.UpdateKey` now can just update the `Description` and/or the `Name`. #313 - `Key` now has an additional `Name` field. #313 ## 🚀 Enhancements - `Client.GetKeys(param *KeysQuery)` can now also find keys based on their key uid. #313 - `Client.CreateKey(request *Key)` lets you specify a custom uid (optionally) to create a new Key. #313 Thanks again to `@alallema` ! 🎉 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.
nbHitsresponse parameter toestimatedTotalHits.exhaustiveNbHitsresponse parameter.exhaustiveFacetsCountresponse parameter.matchesrequest parameter is renamedshowMatchesPosition.facetsDistributionrequest parameter is renamedfacets.facetsDistributionresponse parameter is renamedfacetDistribution.