meilisearch/meilisearch-go v0.20.0

v0.20.0 🐹

on GitHub

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

• 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 structTaskInfo 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 ! 🎉