v0.14.0 π¦
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
Authorizationheader instead ofX-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
- MeiliSearch v0.25.0 uses
-
Remove
delete_index_if_existsandget_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 ataskresponse instead of anIndex.index.createandindex.deletefrom index return atask.wait_for_pending_update()is renamed intowait_for_taskand is accessible fromindexand fromclient.- the current
index.wait_for_task()method call/tasks/:uid index.get_update_statusis renamedindex.get_taskindex.get_all_update_statusis renamedindex.get_tasks- new method
client.wait_for_task()call/tasks/:uid - new method
client.get_tasksthat calls/tasks - new method
client.get_taskthat calls/tasks/:uid
Notes: The only two methods that now return anIndexareclient.index()andclient.get_index()
- All the actions on indexes are now asynchronous check out the task API references and the asynchronous tasks guide
-
Change
client.get_keysdoes not return an object of keys, but an array of keys. Check out keys API references. -
The
Progresstype 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.
- Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
- A
KeyBuildertype has been added to eases the creation of keys (#227) @irevoire - An
Actionenum has been created to represents all the possible action (#227) @irevoire - Add method
wait_for_completiondirectly on the Task (#225) @irevoire
Thanks again to @alallema, @curquiza, @irevoire, and @moises-marquez! π