v0.9.0 ☕️

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

• SearchQuery changes (#505) @alallema
  • Renamed facetsDistribution field to facets
  • Renamed matches field to showMatchesPosition
• SearchResult changes (#505) @alallema
  • Renamed nbHits field to estimatedTotalHits
  • Removed exhaustiveFacetsCount field
  • Removed exhaustiveNbHits field
• Renamed Result class to plural Results (#508) @alallema
• Remove method client.getDumpStatus (#515) @alallema
• Method client.createDump now returns a TaskInfo object (#515) @alallema
• client.getTasks() now returns a TasksResults (#517) @alallema
• client.getIndexes() now returns a Results<Index> (#516) @alallema
• client.getRawIndexes() method return a String (#516) @alallema
• client.getKeys() now returns a Results<Key> (#517) @alallema
• client.getDocuments() now the method returns a Results<T> (#518) @alallema
• Create two separate methods for getDocument:
  • ` Results getDocument(String identifier, Class targetClass)
  • String getRawDocument(String identifier)
• Create two separate methods for getDocument:
  • <T> Results<T> getDocuments(Class<T> targetClass)
  • String getRawDocuments()
• Remove client.getRawIndex() method (#516) @alallema
• Add new :name and :uid attributes in Key class (#517) @alallema
• client.generateTenantToken method now waits for an apiKeyUid (Uid of a signing API key) as parameter.

🚀 Enhancements

• Developer experience enhancements (#502) @brunoocasali
• Creation of KeyUpdate class (#517) @alallema
• client.getTasks() now accepts an object with pagination TasksQuery (#510) @alallema
• client.getIndexes() now accepts an object with pagination IndexesQuery (#516) @alallema
• client.getKeys() now accepts an object with pagination KeysQuery (#517) @alallema

• client.getDocuments(), client.getDocument() Add the possibility to reduce the body payload by now accepting a query parameter called fields (previously called attributesToRetrieve) (#518) @alallema

• Add User-Agent header to have analytics in every http request (#503) @brunoocasali
  Analytics 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 @alallema, @brunoocasali ! 🎉

v0.8.0 ☕️

This version includes a major redesign of the SDK. (#425) @alallema

⚠️ Breaking changes

• Redesign of the client (#449) @alallema:
  • Use OkHttp library by default for the Meilisearch client
  • No interface for the creation of a Client disappearing of the class GenericServiceTemplate, ServiceTemplate, AbstractClient, ApacheClient, and DefaultHttpClient.
• Rename getAllIndexes method in getIndexes (#477) @alallema
• All parameters of the managers accessible in the client are now private: Config, IndexesHandler, InstanceHandler, TasksHandler, KeysHandler, JsonHandler.
• Factories for the answer and the response disappeared, those classes were removed: BasicRequestFactory, BasicHttpResponse, BasicHttpRequest, and MeilisearchHttpRequest.
• Rewriting of the JsonHandler
  • Offering the possibility to use Gson, Jackson or create your own handler.([#432]
  • Remove JsonbJsonHandler.
• Dump returns a Taskfrom v0.28.0 so the createDump method has been removed just as the DumpHandler class.
• Renaming class Details in TaskDetails
• All methods return now a MeilisearchException instead of a Exception.

🚀 Enhancements

• Replaced traditional getter setter by @Getter @Setter from Lombok library (#385) @ghousek1
• Improve Docker configuration in the package (#399)
• Add code-coverage tool (jacoco) (#422) @brunoocasali
• Refactoring:
  • Rewriting of the Error Handler (#438) @alallema
    • Like the other SDKs, this one now contains MeilisearchApiError, MeiliSearchCommunicationError, MeilisearchTimeoutError, JsonDecodingException as well as JsonEncodingException.
    • All methods return now a MeilisearchException instead of a Exception.
      (https://github.com/meilisearch/meilisearch-java/pull/432))  [@alallema](https://github.com/alallema)
  • Rewrite some missing method (#473) @alallema
    • health()
    • isHealthy()
    • getVersion()
    • getStats()
    • index.getStats()
    • updateKey() (#476) @alallema
  • Add typo tolerance settings (#371) @alallema
  • Add toString method to SearchRequest Class (#451) @alallema
  • Add support to PATCH HTTP method (#472) @alallema

Thanks again to @alallema, @brunoocasali, @ghousek1, @kisaga! 🎉

v0.7.2 ☕️

This version makes this package compatible with Meilisearch v0.27.0🎉 
Check out the changelog of Meilisearch v0.27.0 for more information about the changes.

🚀 Enhancements

• Ensure nested field support #374 @alallema
• Add new search parameters highlightPreTag, highlightPostTag and cropMarker #375 @alallema

Thanks again to @alallema, @brunoocasali! 🎉

v0.7.1 ☕️

This version makes this package compatible with Meilisearch v0.25 up to v0.26.0
🎉 Check out the changelog of Meilisearch v0.26.0 for more information about the ⚠️ Breaking changes about the flag and dump new behavior. (#339)

🚀 Enhancements

• Create new Details class and add Details field in Task class (#336) @kuruvasatya
• Added new method generateTenantToken() as a result of the addition of the multi-tenant functionality.
  This method creates a JWT tenant token that will allow the user to have multi-tenant indexes and thus restrict access to documents based on the end-user making the search request. (#345) @alallema

Thanks again to @alallema, @dichotommy, @kuruvasatya! 🎉

v0.7.0 ☕️

This package version is compatible with MeiliSearch v0.25.0 (#296)

⚠️ Breaking changes

• This package is only compatible with MeiliSearch v0.25.0 and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.25.0 or newer before doing the upgrade.
  Why isn't it compatible?
  • MeiliSearch v0.25.0 use Authorization header instead of X-Meili-API-Key (#306) @alallema
  • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
• Remove deleteIfExist and getOrCreate (#307) (#308) @alallema
• Redesign API update by task (#311) @alallema
  • All the actions on indexes are now asynchronous check out the task API references and the asynchronous tasks guide
    • createIndex(), updateIndex(), deleteIndex() are now asynchrone and return a Yask response instead of an Index.
    • index.create and index.delete from index return a Task.
    • waitForPendingUpdate() is renamed into waitForTask and is accessible from index and from client.
    • the current index.waitForTask() method call /tasks/:uid
    • index.getUpdateStatus is renamed index.getTask
    • index.getAllUpdateStatus is renamed index.getTasks
    • new method client.waitForTask() call /tasks/:uid
    • new method client.waitForTask()
    • new method client.getTasks that calls /tasks
    • new method client.getTask that calls /tasks/:uid
      Notes: The only two methods that now return an Index are client.index() and client.get_index()
• Change client.getKeys does not return an object of keys, but an array of keys. Check out keys API references.
• Changes related to the next MeiliSearch release (v0.25.0) (#296)

🚀 Enhancements

• Addition related to API keys (#317) @alallema
  • Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
    • client.getKey get information about a specific API key.
    • client.createKey create a new API key.
    • client.deleteKey delete an API key.
    • client.updateKey update an API key.
  • Check out the documentation guide.
• Add the possibility to add documents in batches and update documents in batches (#305) @diegonavarroq

🐛 Bug Fixes

• Change type for variable of databaseSize (#299) @diegonavarroq
• make Class Error accesible (#303) @Artumira96

Thanks again to @Artumira96, @alallema, @diegonavarroq, @irenejoeunpark ! 🎉

v0.6.0 ☕️

This package version is compatible with MeiliSearch v0.24.0

⚠️ Breaking changes

• Rename errorCode, errorLink, errorType and errorMessage in code, link, type and message (#280) @alallema
• Update the error change in UpdateStatus class but create error object containing code, link and type (#282) @alallema

🚀 Enhancements

• Add offset and attributesToRetrieve parameter to get docum… (#247) @ezienecker
• Add delete index if exists method (#248) @ezienecker
• Add RUD operations for ranking rule settings (#254) @ezienecker
• Implement sub-settings methods (#264) @ezienecker

Thanks again to @Hard-Coder05, @alallema, @curquiza, @ezienecker, @irenejoeunpark, and @ujjavala! 🎉

v0.5.0 ☕️

This package version is compatible with MeiliSearch v0.23.0

Changes

• addDocuments and updateDocuments take primaryKey as optional param (#224) @vishnugt
• Added getRawIndex and getRawIndexList methods (#239) @vishnugt

Breaking changes ⚠️

• Add support for filter arrays and nested filters in filter search (#222) @vishnugt

Thanks again to @alallema, @ansavanix, @curquiza, @inomag, @ishika22, @mohitsaxenaknoldus, and @vishnugt! 🎉

v0.4.1 ☕️

This package version is compatible with MeiliSearch v0.22.0 🎉

Changes

• Add sort feature compatibility (#204) @alallema. More about sorting.
  • Add sortable attributes methods: get_sortable_attributes, set_sortable_attributes, reset_sortable_attributes.
  • Add sort parameter during search.

Thanks again to @alallema! 🎉

v0.4.0 ☕️

This version makes this package compatible with MeiliSearch v0.21.0
🎉 Check out the changelog of MeiliSearch v0.21.0

Changes

• Add Fields in Dump (#180) @alallema
• Add facets distribution fields in search request (#185) @alallema

Breaking changes ⚠️

• Rename of buildDate into commitDate (#177) @alallema
• Rename attributes_for_faceting into filterable_attributes (#178) @alallema
• Rename FieldsDsitribution into FieldDistribution (#179) @alallema
• Rename Filters into Filter (#181) @alallema
• Changes related to the next MeiliSearch release (v0.21.0) (#157)

Thanks again to @alallema, @curquiza, and @ppshobi! 🎉

v0.3.1 ☕️

Changes

• Standardize health method (#171) @alallema

Thanks again to @alallema, @curquiza, @eskombro! 🎉