Skip to content

v0.5.0

Choose a tag to compare

@meili-bot meili-bot released this 19 Jan 18:08
· 803 commits to main since this release
35586f5

This package version is compatible with MeiliSearch v0.25.0 ๐ŸŽ‰

โš ๏ธ 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 uses Authorization header instead of X-Meili-API-Key (#121) @brunoocasali
    • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks.
  • Rename PendingUpdate to TaskInfo (#123) @brunoocasali
  • Changes related to the new task API (#125, #120, #127) @brunoocasali. Check out the task API references and the asynchronous tasks guide
  • Multiple naming changes regarding the v0.25.0 upgrade (#119, #120, #125, #127) @brunoocasali:
    • client.getUpdateStatus to client.getTask
    • client.getAllUpdateStatus to client.getTasks
    • client.getKeys responds with a Future<List<Key>> not Future<Map<String, String>>
    • index.getAllUpdateStatus to index.getTasks
    • index.getUpdateStatus to index.getTask
    • index.update, index.delete, client.createIndex, client.deleteIndex and client.updateIndex now responds with Future<TaskInfo>

๐Ÿš€ Enhancements

  • Remove getOrCreate from MeiliSearchClient (#119) @brunoocasali
  • Add a new method who responds with raw information from API (#124) @brunoocasali
  • Add PATCH method support (#121) @brunoocasali
  • Add support to keys (according to v0.25.0 spec) more (#121) @brunoocasali
    • Create a new resource class Key to represent keys
    • Create methods to support keys:
      • client.getKeys
      • client.getKey
      • client.createKey
      • client.updateKey
      • client.deleteKey
  • Updates regarding code samples:

Check out the documentation guide.

Thanks again to @alallema and @brunoocasali! ๐ŸŽ‰