Apply search changes #332
Merged
Apply search changes #332
Conversation
This file contains hidden or 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
brunoocasali
requested changes
Jun 15, 2022
Member
There was a problem hiding this comment.
@curquiza no need to change anything, I would like to do this scout workaround :)
Thanks for the PR! 🎉
| ], | ||
| "offset": 0, | ||
| "limit": 20, | ||
| "nbHits": 1, |
Member
There was a problem hiding this comment.
Just to remind myself, but we need to deal with the nbHits in the meilisearch-php to prevent the breaking in the laravel/scout!
Member
Author
There was a problem hiding this comment.
I completely forgot to change this despite I discussed this with you 😄
You can indeed take my branch!
brunoocasali
force-pushed
the
search-changes
branch
from
d61f991 to
bbcfbaf
Compare
brunoocasali
force-pushed
the
bump-meilisearch-v0.28.0
branch
from
cb73a68 to
d4d4a07
Compare
brunoocasali
force-pushed
the
search-changes
branch
from
bbcfbaf to
4b4c067
Compare
Member
|
Add a patch fix to the result from In scout, they call So to prevent a breaking change there, I added this line: |
Merged
bors bot
added a commit
that referenced
this pull request
Jul 11, 2022
350: Update version for the next release (v0.24.0) r=brunoocasali 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 :warning: Small disclaimer: The `rawSearch` (and other `raw*` functions) are a direct connection between your PHP application and Meilisearch, you may find changes that are not present in this section. - `MeiliSearch\Client->getDumpStatus` method was removed. (#336) `@brunoocasali` - `MeiliSearch\Client->getIndexes` method now return a object type `IndexesResults`. (#341), (#345) `@brunoocasali` - `MeiliSearch\Client->generateTenantToken` now require a `String apiKeyUid` which is the `uid` of the `Key` instance used to sign the token. (#343) `@brunoocasali` - `MeiliSearch\Client->createDump` now responds with `Task` object. (#336, #337) `@brunoocasali` - `MeiliSearch\Client->getKeys` method now return a object type `KeysResults`. (#343), (#338) `@brunoocasali` - `MeiliSearch\Client->updateKey` now can just update a `description` and/or `name`, if there are other key/value will be silently ignored. (#343), (#338) `@brunoocasali` - `MeiliSearch\Client->getTasks` method now return a object type `TasksResults`. (#337), (#346) `@brunoocasali` - `MeiliSearch\Index->getTasks` method now return a object type `TasksResults`. (#337), (#346) `@brunoocasali` - `MeiliSearch\Index->search` `facetsDistribution` is now `facets` (#332) `@curquiza` - `MeiliSearch\Index->search` `matches` is now `showMatchesPosition` (#332) `@curquiza` - `MeiliSearch\Index->getDocuments` method now return a object type `DocumentsResults`. - `MeiliSearch\Index->getDocuments` method now accepts a object as a parameter and `offset`, `limit`, `attributesToRetrieve` were not longer accepted. - `exhaustiveNbHits`, `facetsDistribution`, `exhaustiveFacetsCount` were removed from `SearchResult`. (#332) `@curquiza` ## 🚀 Enhancements - `MeiliSearch\Client->getIndexes` accepts a object `IndexesQuery` to filter and paginate the results. - `MeiliSearch\Client->getKeys` accepts a object `KeysQuery` to filter and paginate the results. (#343), (#338) `@brunoocasali` - `MeiliSearch\Client->getKey` accepts both a `Key#uid` or `Key#key` value. (#343), (#338) `@brunoocasali` - `MeiliSearch\Client->getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#337), (#346) `@brunoocasali` - `MeiliSearch\Index->getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#337), (#346) `@brunoocasali` - `MeiliSearch\Client->createKey` can specify a `uid` (optionally) to create a new `Key`. (#343), (#338) `@brunoocasali` - `MeiliSearch\Index->getDocument` accepts a `fields` list to compact the remap the response. (#340), (#344) `@brunoocasali` - `MeiliSearch\Index->getDocuments` accepts a object `DocumentsQuery` to filter and paginate the results. (#340), (#344) `@brunoocasali` - `Key` has now a `name` and `uid` string fields. (#343), (#338) `@brunoocasali` - `estimatedTotalHits`, `facetDistribution` were added to `SearchResult` (#332) `@curquiza` - `nbHits` is still defined and will contain the same value as `estimatedTotalHits`. - Sending a invalid `uid` or `apiKey` will raise `InvalidApiKeyException`. (#343) `@brunoocasali` Thanks again to `@brunoocasali,` `@curquiza!` 🎉 Co-authored-by: Bruno Casali <[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._matchesInforesponse parameter is renamed_matchesPosition.facetsDistributionrequest parameter is renamedfacets.facetsDistributionresponse parameter is renamedfacetDistribution.transformFacetsDistributionintotransformFacetDistributionestimatedTotalHitstonbHits.