Skip to content

v0.25.0rc0

Pre-release
Pre-release
Compare
Choose a tag to compare
@curquiza curquiza released this 07 Dec 16:48
· 41 commits to release-v0.25.0 since this release
v0.25.0rc0
8096b56
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

This version of MeiliSearch introduces a much requested feature: API key management.

For more information on how to update to the latest version of MeiliSearch, read our dedicated guide.

Breaking changes

API Key management

This new feature allows you to manage and restrict the access of API Keys.

It also involves breaking changes to how keys are handled curently:

  • public and private keys do not exist anymore and are replaced by two default API Keys: Default Search API Key and Default Admin API Key. They are automatically generated when you first launch MeiliSearch with a master-key.
    🚨 If you are upgrading from a version prior to v0.25.0, you will need to update your code to replace the previous public and private API keys with the newly generated keys to communicate with MeiliSearch.
  • The X-MEILI-API-KEY header is replaced by the Authorization: Bearer <apiKey> header.
  • API Key object lists are now returned in a results array.
  • Added management of API Keys via the endpoint /keys for the master-key holder.
    • Keys can be created/updated/deleted/listed and fetched.
    • Keys can be restricted to certain actions on specific indexes.
    • Keys can expire at a defined time.

@ManyTheFish

Task API

To improve user understanding and experience, we refashioned MeiliSearch's asynchronous updates:

  • The update resource has been renamed to task. The names of existing API routes have also been updated to reflect this change.
  • GET - /indexes/:indexUid/updates and GET - /indexes/:indexUid/updates/:updateId are updated to /indexes/:indexUid/tasks and /indexes/:indexUid/tasks/:taskUid.
  • Tasks are accessible as a resource independent of index
    • GET - /tasks
    • GET - /tasks/:taskUid
  • The task uid is incremented globally and not by index.
  • The task_not_found error has been introduced.
  • The format of the task object has been updated.
    • updateId is now uid.
    • status values are updated. Possible values are: enqueued, processing, succeeded, failed.
    • type is no longer an object. It is now a string containing the values previously held in the now-outdated type.name field.
    • The type field values have been updated to be more clear and consistent with our naming rules. Possible values are: indexCreation, indexUpdate, indexDeletion, documentsAddition, documentsPartial, documentsDeletion, settingsUpdate, clearAll.
    • A details object is added to contain specific information related to a task payload. This was previously displayed in the type object.
    • An indexUid field is added containing the name of the index where the task is performed.
    • startedProcessingAt is updated to startedAt.
    • processedAt is updated to finishedAt.
    • duration, startedAt, and processedAt now useISO 8601 format.
  • 202 Accepted responses previously returning an updateId now return a summarized task object.
  • The MEILI_MAX_UDB_SIZE environment variable is renamed to MEILI_MAX_TASK_DB_SIZE.
  • The --max-udb-size CLI option is renamed to --max-task-db-size.
  • task object lists are now returned under a results array with the most recent task object displayed first.

@MarinPostma, @irevoire

Other breaking changes

  • Creating, updating, and deleting indexes are now asynchronous operations. This removes potential race conditions that existed before. @MarinPostma
  • MeiliSearch v0.25 and subsequent releases are not compatible with dumps created prior to v0.22.
    • To migrate a dump from pre-v0.22 to v0.25 MeiliSearch, first load your dump into v0.24.0, create a dump using v0.24.0, and then import this dump into v0.25.0.

Improvements

Fixes

Misc

❤️ Thanks again to our external contributors:

Contributors

Kerollmops, ManyTheFish, and 8 other contributors
Assets 5