Update version for the next release (v0.27.0) #1294
Merged
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.
This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of Meilisearch v0.28.0 for more information on the changes.
💥 Breaking changes
client.updateKey(key: string, options: KeyPayload): Promise<Key>
now can just update thedescription
and/or the name. Update key management v0.28 #1266EnqueuedTask
now returns antaskUid
instead of anuid
client.getTasks(...)
andindex.getTasks()
now returns a TasksResults type containing the following fields:results
,limit
,from
,next
Add pagination system on resources for v0.28.0 #1269index.search
changes in the response parameters: Update search method v0.28 #1263nbHits
replaced withestimatedTotalHits
exhaustiveNbHits
is deletedexhaustiveFacetsCount
is deletedindex.search
changes in the request parameters: Update search method v0.28 #1263matches
renamedshowMatchesPosition
_matchesInfo
response parameter is renamed_matchesPosition
facetsDistribution
request parameter is renamedfacets
.facetsDistribution
response parameter is renamedfacetDistribution
.Index
type and returnedIndexObject
does not contain aname
field anymoreclient.getIndexes
andclient.getRawIndexes
now returns anIndexesResults
type containing the following fields:results
,limit
,offset
,total
Add pagination system on resources for v0.28.0 #1269index.getDocuments
andclient.getDocuments
now returns anDocumentsResults
type containing the following fields:results
,limit
,offset
,total
Add pagination system on resources for v0.28.0 #1269index.getDocuments
andindex.getDocument
query parameterattributesToRetrieve
is now calledfields
Update documents method v0.28 #1264client.getDumpStatus
has been removed Update dumps method v0.28 #1267client.createDump()
now returns anEnqueuedTask
Update dumps method v0.28 #1267client.generateTenantToken(apiKeyUid, searchRules, options)
has now a mandatoryapiKeyUid
parameter which should contain the uid of a specific API key. Update token creation v0.28.0 #1268🚀 Enhancements
client.getKeys(parameters: KeysQuery = {})
now accepts pagination parameters:limit
,offset
Add pagination system on resources for v0.28.0 #1269client.getKey(keyOrUid: string)
can now also find keys based on their key uid. Update key management v0.28 #1266client.createKey(options: KeyCreation)
lets you specify a custom uid (optionally) to create a new Key Add pagination system on resources for v0.28.0 #1269Key
now has an additionalname
anduid
string fields. Update key management v0.28 #1266indexUid
field in bothEnqueuedTask
andTask
can be null Update tasks routes #1259client.getTasks(parameters: TasksQuery = {})
andindex.getTasks(parameters: TasksQuery)
now accepts pagination parameters:limit
,from
,next
and filters parameters:type
,status
,indexUid
(same forindex.getTasks
) Add pagination system on resources for v0.28.0 #1269client.getIndexes
andclient.getRawIndexes
now accepts pagination parameters:limit
,offset
Add pagination system on resources for v0.28.0 #1269index.getDocuments
now accepts pagination parameters:limit
,offset
Add pagination system on resources for v0.28.0 #1269new MeiliSearch({ host, apiKey, headers, clientAgents })
now accept a new parameterclientAgents
that should contain the agent from which the library is used. Add client header with package information #1272Analytics is enabled by default in the server, but you can disable them by following this guide
Also, of course, every analytics data we collect are ANONYMOUS read the guide for more information.
Thanks again to @bidoubiwa ! 🎉