v0.24.0 π
This version makes this package only compatible with Meilisearch v0.28.0 π
Check out the changelog of Meilisearch v0.28.0 for more information on the changes.
π₯ Breaking changes
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) @brunoocasaliMeiliSearch\Client->getIndexes
method now return a object typeIndexesResults
. (#341), (#345) @brunoocasaliMeiliSearch\Client->generateTenantToken
now require aString apiKeyUid
which is theuid
of theKey
instance used to sign the token. (#343) @brunoocasaliMeiliSearch\Client->createDump
now responds withTask
object. (#336, #337) @brunoocasaliMeiliSearch\Client->getKeys
method now return a object typeKeysResults
. (#343), (#338) @brunoocasaliMeiliSearch\Client->updateKey
now can just update adescription
and/orname
, if there are other key/value will be silently ignored. (#343), (#338) @brunoocasaliMeiliSearch\Client->getTasks
method now return a object typeTasksResults
. (#337), (#346) @brunoocasaliMeiliSearch\Index->getTasks
method now return a object typeTasksResults
. (#337), (#346) @brunoocasaliMeiliSearch\Index->search
facetsDistribution
is nowfacets
(#332) @curquizaMeiliSearch\Index->search
matches
is nowshowMatchesPosition
(#332) @curquizaMeiliSearch\Index->getDocuments
method now return a object typeDocumentsResults
.MeiliSearch\Index->getDocuments
method now accepts a object as a parameter andoffset
,limit
,attributesToRetrieve
were not longer accepted.exhaustiveNbHits
,facetsDistribution
,exhaustiveFacetsCount
were removed fromSearchResult
. (#332) @curquiza
π Enhancements
MeiliSearch\Client->getIndexes
accepts a objectIndexesQuery
to filter and paginate the results.MeiliSearch\Client->getKeys
accepts a objectKeysQuery
to filter and paginate the results. (#343), (#338) @brunoocasaliMeiliSearch\Client->getKey
accepts both aKey#uid
orKey#key
value. (#343), (#338) @brunoocasaliMeiliSearch\Client->getTasks
accepts a objectTasksQuery
to filter and paginate the results. (#337), (#346) @brunoocasaliMeiliSearch\Index->getTasks
accepts a objectTasksQuery
to filter and paginate the results. (#337), (#346) @brunoocasaliMeiliSearch\Client->createKey
can specify auid
(optionally) to create a newKey
. (#343), (#338) @brunoocasaliMeiliSearch\Index->getDocument
accepts afields
list to compact the remap the response. (#340), (#344) @brunoocasaliMeiliSearch\Index->getDocuments
accepts a objectDocumentsQuery
to filter and paginate the results. (#340), (#344) @brunoocasaliKey
has now aname
anduid
string fields. (#343), (#338) @brunoocasaliestimatedTotalHits
,facetDistribution
were added toSearchResult
(#332) @curquizanbHits
is still defined and will contain the same value asestimatedTotalHits
.
- Sending a invalid
uid
orapiKey
will raiseInvalidApiKeyException
. (#343) @brunoocasali
Thanks again to @brunoocasali, @curquiza! π