Skip to content

v0.14.0 πŸ¦€

Compare
Choose a tag to compare
@curquiza curquiza released this 10 Feb 17:46
· 1015 commits to main since this release
d13db02

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
    • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
  • Remove delete_index_if_exists and get_or_create_index (#225) @irevoire

  • Redesign update API to task API (#225) @irevoire

    • All the actions on indexes are now asynchronous check out the task API references and the asynchronous tasks guide
      • create_index(), update_index(), delete_index() are now asynchrone and return a task response instead of an Index.
      • index.create and index.delete from index return a task.
      • wait_for_pending_update() is renamed into wait_for_task and is accessible from index and from client.
      • the current index.wait_for_task() method call /tasks/:uid
      • index.get_update_status is renamed index.get_task
      • index.get_all_update_status is renamed index.get_tasks
      • new method client.wait_for_task() call /tasks/:uid
      • new method client.get_tasks that calls /tasks
      • new method client.get_task that calls /tasks/:uid
        Notes: The only two methods that now return an Index are client.index() and client.get_index()
  • Change client.get_keys does not return an object of keys, but an array of keys. Check out keys API references.

  • The Progress type have been removed entirely (#227) @irevoire

πŸš€ Enhancements

  • Addition related to API keys (#227) @irevoire
    • Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
      • client.get_key get information about a specific API key.
      • client.create_key create a new API key.
      • client.delete_key delete an API key.
      • client.update_key update an API key.
    • Check out the documentation guide.
  • A KeyBuilder type has been added to eases the creation of keys (#227) @irevoire
  • An Action enum has been created to represents all the possible action (#227) @irevoire
  • Add method wait_for_completion directly on the Task (#225) @irevoire

Thanks again to @alallema, @curquiza, @irevoire, and @moises-marquez! πŸŽ‰