Skip to content

v0.18.0 πŸ’Ž

Compare
Choose a tag to compare
@meili-bot meili-bot released this 12 Jan 14:05
· 489 commits to main since this release
5f282ef

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 (#275)
    • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
  • Changes related to the new task API (#276) @curquiza Check out the task API references and the asynchronous tasks guide
    • create_index, update_index and delete_index are now asynchrone regarding MeiliSearch and do not return a Index instance anymore, but a task object. Please use index() method instead.
    • Rename index.get_all_update_status into index.tasks
    • Rename index.get_update_status into index.task
    • wait_for_pending_update is renamed into wait_for_task and is accessible from index and from client
  • Remove get_or_create_index method (#277) @curquiza
  • Remove delete_index_if_exists method (#278) @curquiza
  • client.keys does not return an object of keys, but an array of keys. Check out keys API references.

πŸš€ Enhancements

  • Add API keys methods (#279) @curquiza
    • client.create_key
    • client.update_key
    • client.delete_key
    • client.key

Check out the documentation guide.

  • Add new method create_index! that creates an index synchronously regarding MeiliSearch. Be careful using it, this can block your code in production.
  • Add new methods client.tasks and client.task

Thanks again to @curquiza, and @brunoocasali ! πŸŽ‰