meilisearch/meilisearch-php v0.21.0

v0.21.0 🐘

on PHP Packagist

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

⚠️ 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 (#265)
  • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
• Remove deleteIndexIfExists method (#266) @alallema
• Remove getOrCreateIndex method (#267) @alallema
• Redesign update API to task API (#268) @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 task 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.getIndex()
• 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) (#261)

🚀 Enhancements

• Extract functionality to a more specific class (#272) @jonatanrdsantos
• Addition related to API keys (#269) @alallema
  • Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
    • http.patch use by updateKey
    • 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.

Thanks again to @alallema, @curquiza, @jonatanrdsantos, @norkunas, and Jonatan Santos! 🎉