From babcaae687d1c88ec4f15c719bf6f7064863155a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Tue, 7 Jun 2022 19:54:07 +0200 Subject: [PATCH 01/84] Add release changelogs for v0.28.0 --- meilisearch-release-changelogs/v0.28.0.md | 173 ++++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 meilisearch-release-changelogs/v0.28.0.md diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md new file mode 100644 index 00000000..d4cca429 --- /dev/null +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -0,0 +1,173 @@ +# v0.28.0 release changelogs + +The main goal of this new release is to stabilize the Meilisearch API 🚀 +This introduces a lot of breaking changes (especially regarding the naming), and we are sorry for this. The purpose is to guarantee what we care about the most: provide the best search engine experience by stabilizing the Meilisearch API at the same time. So, it means the Meilisearch API will not break in the future. + + +⚠️ Since this is a release candidate (RC), the official documentation is not updated yet, but will be ready for the official v0.28.0 release. The work-in-progress documentation is available [here](). + +# New features 🚀 + +### Smart crop + +The smart crop is an improvement of the Meilisearch crop. + +The cropping algorithm tries to match the window with the highest density of query terms within the `cropLength` limit. Then it picks the window that contains the more ordered query terms. + +Done by @ManyTheFish (#2408) + +### API key management improvements + +- It is now possible to create a deterministic `key` value by specifying an `uid` field at creation. `uid` is a uuidv4. If omitted, Meilisearch generates it. +- Adds a `name` field to give a human-readable name to ease API key retrieval in a list at the convenience of the user. +- Introduce new actions to manage API Keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). + +Done by @ManyTheFish in #2438, #2451, #2475, and #2474) + +### Add the Hebrew language support + +New language support: Hebrew, using the [Niqqud library](https://github.com/benny-n/niqqud). + +Done by the amazing @benny-n in meilisearch/charabia#101. + +### Integrate the new tokenizer: add your language to Meilisearch! + +The contribution experience in the tokenizer has been significantly improved. +As for the Hebrew support language that has just been added, if your language is missing in Meilisearch please consider contributing to [the Meilisearch tokenizer](https://github.com/meilisearch/charabia) by following the CONTRIBUTING.md file by integrating your expected normalizer/segmenter. + +The whole core team is available to help you contribute. Feel free to ask any questions or clarifications you need! + +Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. + +# Breaking changes and improvement ⚠️ + + +For most of the following changes, if you use [one of our SDKs](https://docs.meilisearch.com/learn/what_is_meilisearch/sdks.html), these changes will be transparent for you by only updating to the latest version of the SDK. + +### Changes in `/indexes/{uid}/search` endpoint + +- `nbHits` is renamed `estimatedNbhits`. Indeed some users were confused by the name and use it for their pagination, but should not. Please check out this [fresh new guide]() to know how to paginate with Meilisearch without using `nbHits`. +- The `facetsDistribution` search parameter (used when calling the [`GET/POST /search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `facets` +- The `facetsDistribution` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `facetDistribution` +- The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` +- The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` +- `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because not used. + +Done by @irevoire in #2406. + +### Changes in `/indexes` endpoints + +- When getting the index list, the indexes are now paginated. It means: + - You can use the `offset` and `limit` parameters to browse the indexes. + - The indexes are returned in the `result` field in the response body. + - The `limit`, `offset`, and `total` are also now available in the response body. +- The endpoint to update an index is now `PATCH /indexes/{indexUid}` instead of `PUT` +- The already deprecated `name` field returned in the response body is totally removed. + +Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. + +### Changes in `indexes/{uid}/documents` endpoints + +- When getting the documents via the `GET /indexes/{uid}/documents` route, the pagination has been improved. It means: + - You can still use the `offset` and `limit` parameters to browse the indexes. + - The documents are returned in the `result` field in the response body. + - The `limit`, `offset`, and `total` are also now available in the response body. +- When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` +- The `fields` parameter is available for the `GET /indexes/{uid}/documents/{document_uid}` route. +- The [`displayedAttributes` settings](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact the `indexes/{uid}/documents` anymore, but ony the `/indexes/{uid}/search` endpoints. + +Done by @irevoire in #2372, #2433, and #2454. + +### Changes in `/tasks` and `/indexes/{uid}/tasks` endpoints + +- Add filtering on the `GET /tasks` endpoint: + - Add filtering capabilities on `type`, `status` and `indexUid` for `GET` `task` lists endpoints. + - It is possible to specify several values for a filter using the `,` character. e.g. `?status=enqueued,processing` + - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` +- Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. + - You can use the `limit`, `from`, `next` query parameters to browse the tasks. + - The tasks are still returned in the `result` field in the response body. + - The `limit`, `from`, and `next` are available in the response body. +- Remove `GET /indexes/:indexUid/tasks` is removed. It can be replaced by `GET /tasks?indexUid=:indexUid` +- Remove `GET /indexes/:indexUid/tasks/:taskUid` is removed. +- Rename `uid` to `taskUid` in the response body returned by every asynchronous task (ex: index creation, document addition...) +- Rename some task properties + - `documentPartial`-> `documentAdditionOrUpdate` + - `documentAddition`-> `documentAdditionOrUpdate` + - `clearAll` -> `documentDeletion` + +Done by Kerollmops in #2399 and #2445. + +### Make the dump creation an asynchronous `task` + +- Dump creation becomes an asynchronous task. It means the dump task is put at the end of the task queue but will be processed in priority. +- `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... +- The `GET /dumps/:dump_uid/status` route is removed because not useful anymore, use `GET /tasks` instead. +- Remove the `dump_already_processing` error when a dump is already processed since they can now be enqueued. + +Done by @MarinPostma in #2410 + +### Changes in `/keys` endpoint + +- Regarding the tenant token: `apiKeyPrefix` is renamed `apiKeyUid` +- Once a key is created, you cannot update `actions`, `indexes`, `expireAt` anymore. Only the `name` and `description` fields are updatable. You can delete and re-create the key if needed. +- When getting the key list (`GET /keys`), the keys are now paginated. It means: + - You can use the `offset` and `limit` parameters to browse the indexes. + - The keys are still returned in the `result` field in the response body. + - The `limit`, `offset`, and `total` are available in the response body. +- Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. + +Done by @ManyTheFish in #2438, #2451, #2475, and #2474) + +### Changes in `/indexes/{uid}/settings` endpoints + +The changes only concern the HTTP methods + +- The endpoint to update the global settings is now `PATCH /indexes/{indexUid}/settings` instead of `POST` +- The endpoint to update the typo-tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` +- The endpoint to update the displayed attributes settings is now `PUT /indexes/{indexUid}/settings/displayed-attributes` instead of `POST` +- The endpoint to update the distinct attribute settings is now `PUT /indexes/{indexUid}/settings/distinct-attribute` instead of `POST` +- The endpoint to update the filterable attribute settings is now `PUT /indexes/{indexUid}/settings/filterable-attributes` instead of `POST` +- The endpoint to update the ranking rules settings is now `PUT /indexes/{indexUid}/settings/ranking-rules` instead of `POST` +- The endpoint to update the searchable attributes settings is now `PUT /indexes/{indexUid}/settings/searchable-attributes` instead of `POST` +- The endpoint to update the sortable attributes settings is now `PUT /indexes/{indexUid}/settings/sortable-attributes` instead of `POST` +- The endpoint to update the stop-words settings is now `PUT /indexes/{indexUid}/settings/stop-words` instead of `POST` +- The endpoint to update the synonyms settings is now `PUT /indexes/{indexUid}/settings/synonyms` instead of `POST` + +Done by @Kerollmops in #2452 + +### Limit of 1000 for facet value + + +For performance reasons, the limit of facet values is now 1000. + +Done by Kerollmops in #2468 and meilisearch/milli#535 + +# Other improvements 🔨 + +- Geo-search: Support string type for `_geo` `lat` and `lng` fields (#2408 and meilisearch/milli#523) @irevoire +- Improve ranking rules error message (meilisearch/milli#536, #2468) @matthias-wright +- Remove the connection keep-alive timeout (#2471) @Thearas + +# Misc + +- Telemetry: handle the `X-Meilisearch-Client` header (#2374) @irevoire +- Telemetry: send the analytics to `telemetry.meilisearch.com` instead of segment (#2429) @irevoire +- Create custom error types for `TaskType`, `TaskStatus`, and `IndexUid` (#2460) @walterbm +- Some internal changes (#2447, #2464, #2453, #2455) @MarinPostma @Kerollmops +- Update dependencies (#2450) @Kerollmops +- Add dump tests in CI (#2357) @irevoire +- Deny warnings in CI (#2339) @MarinPostma +- Change Nelson path (#2347) @curquiza +- Re-integrate Clippy in the CI (#2424) @irevoire +- Fix typo in README (#2448) @ryanrussell +- Fix typo in code base comments (#2459) @ryanrussel +- Update url of `movies.json` in README (#2422) @0x0x1 +- Fix command in README (#2434) @0x0x1 + +---- + +❤️ Thanks again to our external contributors: +- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @ryanrussel, @Thearas, and @walterbm +- [Milli](https://github.com/meilisearch/milli): @matthias-wright +- [Charabia](https://github.com/meilisearch/charabia): @benny-n From 7ccca362255ba0d4f4941b39219981a01dd6c7f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 09:56:32 +0200 Subject: [PATCH 02/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index d4cca429..7e021e1f 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -59,7 +59,7 @@ Done by @irevoire in #2406. - When getting the index list, the indexes are now paginated. It means: - You can use the `offset` and `limit` parameters to browse the indexes. - - The indexes are returned in the `result` field in the response body. + - The indexes are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. - The endpoint to update an index is now `PATCH /indexes/{indexUid}` instead of `PUT` - The already deprecated `name` field returned in the response body is totally removed. From 6aa618b96d89029b3afb037ca9835eae2b7521d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 09:56:37 +0200 Subject: [PATCH 03/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 7e021e1f..ec898d0d 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -70,7 +70,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. - When getting the documents via the `GET /indexes/{uid}/documents` route, the pagination has been improved. It means: - You can still use the `offset` and `limit` parameters to browse the indexes. - - The documents are returned in the `result` field in the response body. + - The documents are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. - When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` - The `fields` parameter is available for the `GET /indexes/{uid}/documents/{document_uid}` route. From 016db99175fe7ece9f2a84f94fc3bc361215ce56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 09:57:41 +0200 Subject: [PATCH 04/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index ec898d0d..360cd2ff 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -85,7 +85,7 @@ Done by @irevoire in #2372, #2433, and #2454. - It is possible to specify several values for a filter using the `,` character. e.g. `?status=enqueued,processing` - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - - You can use the `limit`, `from`, `next` query parameters to browse the tasks. + - You can use the `limit`, `from` query parameters to browse the tasks. - The tasks are still returned in the `result` field in the response body. - The `limit`, `from`, and `next` are available in the response body. - Remove `GET /indexes/:indexUid/tasks` is removed. It can be replaced by `GET /tasks?indexUid=:indexUid` From 6af6f41129d19baf7d05afb521a4e17f48efeaa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 09:57:51 +0200 Subject: [PATCH 05/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 360cd2ff..fa615d0c 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -51,7 +51,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei - The `facetsDistribution` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `facetDistribution` - The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` - The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` -- `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because not used. +- `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because their values never change thus making them inoperable. Done by @irevoire in #2406. From 2deb5a9019b85522c56cd1519248b127d72558dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 8 Jun 2022 10:00:37 +0200 Subject: [PATCH 06/84] Update following reviews --- meilisearch-release-changelogs/v0.28.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index fa615d0c..b7549c70 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -98,7 +98,7 @@ Done by @irevoire in #2372, #2433, and #2454. Done by Kerollmops in #2399 and #2445. -### Make the dump creation an asynchronous `task` +### Changes regarding the dumps - Dump creation becomes an asynchronous task. It means the dump task is put at the end of the task queue but will be processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... @@ -116,6 +116,7 @@ Done by @MarinPostma in #2410 - The keys are still returned in the `result` field in the response body. - The `limit`, `offset`, and `total` are available in the response body. - Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. +- The `dumps.get` action is removed. Done by @ManyTheFish in #2438, #2451, #2475, and #2474) From 989ecef875565537cc0da6e803a9dc053a765635 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 18:50:28 +0200 Subject: [PATCH 07/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index b7549c70..2629db76 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -1,7 +1,8 @@ # v0.28.0 release changelogs The main goal of this new release is to stabilize the Meilisearch API 🚀 -This introduces a lot of breaking changes (especially regarding the naming), and we are sorry for this. The purpose is to guarantee what we care about the most: provide the best search engine experience by stabilizing the Meilisearch API at the same time. So, it means the Meilisearch API will not break in the future. + +This release introduces a lot of breaking changes (especially regarding names), and we are sorry for this. The purpose is to guarantee what we care about the most—providing the best search engine experience—by stabilizing the Meilisearch API. There should not be any breaking changes to the API in the future. ⚠️ Since this is a release candidate (RC), the official documentation is not updated yet, but will be ready for the official v0.28.0 release. The work-in-progress documentation is available [here](). From e4072c4a738121a80fd74c51b4328a3cbe12d074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 18:50:44 +0200 Subject: [PATCH 08/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 2629db76..e5753b42 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -7,7 +7,7 @@ This release introduces a lot of breaking changes (especially regarding names), ⚠️ Since this is a release candidate (RC), the official documentation is not updated yet, but will be ready for the official v0.28.0 release. The work-in-progress documentation is available [here](). -# New features 🚀 +## New features 🚀 ### Smart crop From a6f0e45f4502a0d22faf8dfeb1dd1db0a68bb835 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:01:01 +0200 Subject: [PATCH 09/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e5753b42..c654b26b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -13,7 +13,7 @@ This release introduces a lot of breaking changes (especially regarding names), The smart crop is an improvement of the Meilisearch crop. -The cropping algorithm tries to match the window with the highest density of query terms within the `cropLength` limit. Then it picks the window that contains the more ordered query terms. +The cropping algorithm tries to find the window(s) with the highest density of query terms within the `cropLength` limit. From these, it picks the window that contains the most query terms in order. Done by @ManyTheFish (#2408) From 2526a25b4759e8e9b2e22d6d195f1da0fb58f17d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:01:19 +0200 Subject: [PATCH 10/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index c654b26b..c5817344 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -19,7 +19,7 @@ Done by @ManyTheFish (#2408) ### API key management improvements -- It is now possible to create a deterministic `key` value by specifying an `uid` field at creation. `uid` is a uuidv4. If omitted, Meilisearch generates it. +- It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. - Adds a `name` field to give a human-readable name to ease API key retrieval in a list at the convenience of the user. - Introduce new actions to manage API Keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). From 92c1da293eadfc41b01dc118e773df3e3ddcd528 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:01:42 +0200 Subject: [PATCH 11/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index c5817344..45effb6c 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -20,7 +20,7 @@ Done by @ManyTheFish (#2408) ### API key management improvements - It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. -- Adds a `name` field to give a human-readable name to ease API key retrieval in a list at the convenience of the user. +- Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. - Introduce new actions to manage API Keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). Done by @ManyTheFish in #2438, #2451, #2475, and #2474) From 5b2027246bd0db98e7b0ade5ce3bb7917d672ab6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:01:51 +0200 Subject: [PATCH 12/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 45effb6c..faea65a3 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -17,7 +17,7 @@ The cropping algorithm tries to find the window(s) with the highest density of q Done by @ManyTheFish (#2408) -### API key management improvements +### API key management: deterministic keys - It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. - Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. From 0028e1e84091a784900de471e382c163975deabd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:02:07 +0200 Subject: [PATCH 13/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index faea65a3..85d360cb 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -21,7 +21,8 @@ Done by @ManyTheFish (#2408) - It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. - Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. -- Introduce new actions to manage API Keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). +- Introduces new actions to manage API keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). +- It is no longer possible to update an API key's `actions`, `indexes`, or `expiresAt` after creation. Done by @ManyTheFish in #2438, #2451, #2475, and #2474) From f8bb9cbfc5242871ca17baf8944f4c32c370c953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:02:21 +0200 Subject: [PATCH 14/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 85d360cb..d062fa21 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -32,7 +32,7 @@ New language support: Hebrew, using the [Niqqud library](https://github.com/benn Done by the amazing @benny-n in meilisearch/charabia#101. -### Integrate the new tokenizer: add your language to Meilisearch! +### New tokenizer contribution experience: add your language to Meilisearch The contribution experience in the tokenizer has been significantly improved. As for the Hebrew support language that has just been added, if your language is missing in Meilisearch please consider contributing to [the Meilisearch tokenizer](https://github.com/meilisearch/charabia) by following the CONTRIBUTING.md file by integrating your expected normalizer/segmenter. From f01fdd7fd2e90818ae111e3dbdad0e622d6d99fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:02:39 +0200 Subject: [PATCH 15/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index d062fa21..4a8e7d75 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -35,9 +35,10 @@ Done by the amazing @benny-n in meilisearch/charabia#101. ### New tokenizer contribution experience: add your language to Meilisearch The contribution experience in the tokenizer has been significantly improved. -As for the Hebrew support language that has just been added, if your language is missing in Meilisearch please consider contributing to [the Meilisearch tokenizer](https://github.com/meilisearch/charabia) by following the CONTRIBUTING.md file by integrating your expected normalizer/segmenter. -The whole core team is available to help you contribute. Feel free to ask any questions or clarifications you need! +If your language is missing in Meilisearch, please consider contributing to [the Meilisearch tokenizer](https://github.com/meilisearch/charabia) by following the CONTRIBUTING.md file and integrating your intended normalizer/segmenter. + +The whole core team is available to help you contribute. Feel free to ask for any clarifications you need! Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. From 0a9638f83688c16c63d6b820c65e16023f786dfa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:02:55 +0200 Subject: [PATCH 16/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 4a8e7d75..16f70cd6 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -26,7 +26,7 @@ Done by @ManyTheFish (#2408) Done by @ManyTheFish in #2438, #2451, #2475, and #2474) -### Add the Hebrew language support +### Hebrew language support New language support: Hebrew, using the [Niqqud library](https://github.com/benny-n/niqqud). From 81f0ae22eeb5fb29990cf1211fe5b3b8b4f42923 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:03:25 +0200 Subject: [PATCH 17/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 16f70cd6..c1558e6b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -49,7 +49,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei ### Changes in `/indexes/{uid}/search` endpoint -- `nbHits` is renamed `estimatedNbhits`. Indeed some users were confused by the name and use it for their pagination, but should not. Please check out this [fresh new guide]() to know how to paginate with Meilisearch without using `nbHits`. +- `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter (used when calling the [`GET/POST /search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `facets` - The `facetsDistribution` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `facetDistribution` - The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` From 024dc2b38442c8ec4da5e091a6230b240c2a7aa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:03:38 +0200 Subject: [PATCH 18/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index c1558e6b..8d424e6c 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -50,7 +50,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei ### Changes in `/indexes/{uid}/search` endpoint - `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. -- The `facetsDistribution` search parameter (used when calling the [`GET/POST /search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `facets` +- The `facetsDistribution` search parameter is renamed `facets` - The `facetsDistribution` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `facetDistribution` - The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` - The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` From cbc96bdba3df8b163ca28760ef52ae1aa618d6e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:03:49 +0200 Subject: [PATCH 19/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 8d424e6c..3b0691c8 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -51,7 +51,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei - `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter is renamed `facets` -- The `facetsDistribution` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `facetDistribution` +- The `facetsDistribution` field in the response body is renamed `facetDistribution` - The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` - The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` - `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because their values never change thus making them inoperable. From 42801170fc51237892e221de6b3659b480a20e3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:04:17 +0200 Subject: [PATCH 20/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 3b0691c8..b5a3eb1b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -52,7 +52,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei - `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter is renamed `facets` - The `facetsDistribution` field in the response body is renamed `facetDistribution` -- The `matches` search parameter (used when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed `showMatchesPosition` +- The `matches` search parameter is renamed `showMatchesPosition` - The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` - `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because their values never change thus making them inoperable. From 4a94d4c26cad15f9c15d8d7ac426da104234d070 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:04:26 +0200 Subject: [PATCH 21/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index b5a3eb1b..5f2e9a3d 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -53,7 +53,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei - The `facetsDistribution` search parameter is renamed `facets` - The `facetsDistribution` field in the response body is renamed `facetDistribution` - The `matches` search parameter is renamed `showMatchesPosition` -- The `_matchesInfo` field in the response body (received when calling the [`GET/POST /indexes/{uid}/search` route](https://docs.meilisearch.com/reference/api/search.html)) is renamed into `_matchesPosition` +- The `_matchesInfo` field in the response body is renamed `_matchesPosition` - `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because their values never change thus making them inoperable. Done by @irevoire in #2406. From 146539f0108f95e9f93912b5410b73e9e86e8abf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:05:22 +0200 Subject: [PATCH 22/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 5f2e9a3d..79fce3a2 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -54,7 +54,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei - The `facetsDistribution` field in the response body is renamed `facetDistribution` - The `matches` search parameter is renamed `showMatchesPosition` - The `_matchesInfo` field in the response body is renamed `_matchesPosition` -- `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed because their values never change thus making them inoperable. +- `exhaustiveNbHits` and `exhaustiveFacetsCount` are removed. Meilisearch does not return exhaustive hit or facet counts at this time. Done by @irevoire in #2406. From f21aef299b63c03a1e8826acef6073cf98f1dffb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:05:35 +0200 Subject: [PATCH 23/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 79fce3a2..88122328 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -60,7 +60,7 @@ Done by @irevoire in #2406. ### Changes in `/indexes` endpoints -- When getting the index list, the indexes are now paginated. It means: +- When getting the index list (`GET /indexes`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse the indexes. - The indexes are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. From 4eedd9b90e8af46dbd6c48306f4ea851670f0fa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:05:43 +0200 Subject: [PATCH 24/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 88122328..049ee6d1 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -61,7 +61,7 @@ Done by @irevoire in #2406. ### Changes in `/indexes` endpoints - When getting the index list (`GET /indexes`), the response is now paginated. That means: - - You can use the `offset` and `limit` parameters to browse the indexes. + - You can use the `offset` and `limit` parameters to browse indexes. - The indexes are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. - The endpoint to update an index is now `PATCH /indexes/{indexUid}` instead of `PUT` From eb4748ba53f22337d1d2a583f910a1a2f3d15cfc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:05:53 +0200 Subject: [PATCH 25/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 049ee6d1..3cb79dd8 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -63,7 +63,7 @@ Done by @irevoire in #2406. - When getting the index list (`GET /indexes`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse indexes. - The indexes are returned in the `results` field in the response body. - - The `limit`, `offset`, and `total` are also now available in the response body. + - `limit`, `offset`, and `total` now appear in the response body. - The endpoint to update an index is now `PATCH /indexes/{indexUid}` instead of `PUT` - The already deprecated `name` field returned in the response body is totally removed. From 817ed4b89b79261b450f6c5a6b3e812a00616934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:06:00 +0200 Subject: [PATCH 26/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 3cb79dd8..24b0e73b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -65,7 +65,7 @@ Done by @irevoire in #2406. - The indexes are returned in the `results` field in the response body. - `limit`, `offset`, and `total` now appear in the response body. - The endpoint to update an index is now `PATCH /indexes/{indexUid}` instead of `PUT` -- The already deprecated `name` field returned in the response body is totally removed. +- The already deprecated `name` field has now been removed entirely. Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. From 525dfb4a1276349fe20bb43c735a8564d1e51186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:06:47 +0200 Subject: [PATCH 27/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 24b0e73b..81e0d13b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -71,7 +71,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. ### Changes in `indexes/{uid}/documents` endpoints -- When getting the documents via the `GET /indexes/{uid}/documents` route, the pagination has been improved. It means: +- When getting the documents list (`GET /indexes/{uid}/documents`), pagination has been improved. That means: - You can still use the `offset` and `limit` parameters to browse the indexes. - The documents are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. From 31a7347efb76a083cbbc26fc9da299a42cf43ed6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:06:57 +0200 Subject: [PATCH 28/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 81e0d13b..ae06f995 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -72,7 +72,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. ### Changes in `indexes/{uid}/documents` endpoints - When getting the documents list (`GET /indexes/{uid}/documents`), pagination has been improved. That means: - - You can still use the `offset` and `limit` parameters to browse the indexes. + - You can still use the `offset` and `limit` parameters to browse documents. - The documents are returned in the `results` field in the response body. - The `limit`, `offset`, and `total` are also now available in the response body. - When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` From ffd973c2284999b1247a407c18b77322d70e59f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:05 +0200 Subject: [PATCH 29/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index ae06f995..ae2cf4e2 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -74,7 +74,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. - When getting the documents list (`GET /indexes/{uid}/documents`), pagination has been improved. That means: - You can still use the `offset` and `limit` parameters to browse documents. - The documents are returned in the `results` field in the response body. - - The `limit`, `offset`, and `total` are also now available in the response body. + - `limit`, `offset`, and `total` now appear in the response body. - When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` - The `fields` parameter is available for the `GET /indexes/{uid}/documents/{document_uid}` route. - The [`displayedAttributes` settings](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact the `indexes/{uid}/documents` anymore, but ony the `/indexes/{uid}/search` endpoints. From ec4e0f66f09cd0699e0317426842ac2cbf05ac3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:13 +0200 Subject: [PATCH 30/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index ae2cf4e2..e3c769ff 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -76,7 +76,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. - The documents are returned in the `results` field in the response body. - `limit`, `offset`, and `total` now appear in the response body. - When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` -- The `fields` parameter is available for the `GET /indexes/{uid}/documents/{document_uid}` route. +- The `fields` parameter is also available for the `GET /indexes/{uid}/documents/{document_uid}` endpoint. - The [`displayedAttributes` settings](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact the `indexes/{uid}/documents` anymore, but ony the `/indexes/{uid}/search` endpoints. Done by @irevoire in #2372, #2433, and #2454. From 3768751dd4d1aee56f47baab25332bdb005cf5d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:21 +0200 Subject: [PATCH 31/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e3c769ff..78c3046d 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -77,7 +77,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. - `limit`, `offset`, and `total` now appear in the response body. - When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` - The `fields` parameter is also available for the `GET /indexes/{uid}/documents/{document_uid}` endpoint. -- The [`displayedAttributes` settings](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact the `indexes/{uid}/documents` anymore, but ony the `/indexes/{uid}/search` endpoints. +- The [`displayedAttributes` setting](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact `GET indexes/{uid}/documents` anymore. Done by @irevoire in #2372, #2433, and #2454. From 3b2ab91c197eb52c5480173a959df988b5360fa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:32 +0200 Subject: [PATCH 32/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 78c3046d..9bfd0549 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -75,7 +75,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. - You can still use the `offset` and `limit` parameters to browse documents. - The documents are returned in the `results` field in the response body. - `limit`, `offset`, and `total` now appear in the response body. -- When getting the documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed into `fields` +- When getting documents via the `GET /indexes/{uid}/documents` route, the `attributesToRetrieve` parameter has been renamed `fields` - The `fields` parameter is also available for the `GET /indexes/{uid}/documents/{document_uid}` endpoint. - The [`displayedAttributes` setting](https://docs.meilisearch.com/reference/api/displayed_attributes.html) does not impact `GET indexes/{uid}/documents` anymore. From 84bd69e73255bb3738e1ff820934e6e08512503e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:40 +0200 Subject: [PATCH 33/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 9bfd0549..a1790859 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -83,7 +83,7 @@ Done by @irevoire in #2372, #2433, and #2454. ### Changes in `/tasks` and `/indexes/{uid}/tasks` endpoints -- Add filtering on the `GET /tasks` endpoint: +- You can now filter on the `GET /tasks` endpoint: - Add filtering capabilities on `type`, `status` and `indexUid` for `GET` `task` lists endpoints. - It is possible to specify several values for a filter using the `,` character. e.g. `?status=enqueued,processing` - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` From 09c8348727623818444a9bbf9925380281766209 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:48 +0200 Subject: [PATCH 34/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index a1790859..27c0b223 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -84,7 +84,7 @@ Done by @irevoire in #2372, #2433, and #2454. ### Changes in `/tasks` and `/indexes/{uid}/tasks` endpoints - You can now filter on the `GET /tasks` endpoint: - - Add filtering capabilities on `type`, `status` and `indexUid` for `GET` `task` lists endpoints. + - Filtering is possible on the `type`, `status`, and `indexUid` fields. - It is possible to specify several values for a filter using the `,` character. e.g. `?status=enqueued,processing` - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. From c97e0f5a00e3cf264f3b4b07b8c10473d80d24bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:07:59 +0200 Subject: [PATCH 35/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 27c0b223..1b4e3ac6 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -85,7 +85,7 @@ Done by @irevoire in #2372, #2433, and #2454. - You can now filter on the `GET /tasks` endpoint: - Filtering is possible on the `type`, `status`, and `indexUid` fields. - - It is possible to specify several values for a filter using the `,` character. e.g. `?status=enqueued,processing` + - Use the `,` character to specify several values for a filter, e.g. `?status=enqueued,processing`. This is equivalent to an `OR` operation. - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. From d8de3e5fee2abc17d87cf094bd658ec43a69952e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:07 +0200 Subject: [PATCH 36/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 1b4e3ac6..e7df510f 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -86,7 +86,7 @@ Done by @irevoire in #2372, #2433, and #2454. - You can now filter on the `GET /tasks` endpoint: - Filtering is possible on the `type`, `status`, and `indexUid` fields. - Use the `,` character to specify several values for a filter, e.g. `?status=enqueued,processing`. This is equivalent to an `OR` operation. - - Between two different filters, an `AND` operation is applied. e.g. `?status=enqueued&type=indexCreation` is equivalent to `status=enqueued AND type = indexCreation` + - Use the `&` character to apply multiple filters, e.g. `?status=enqueued&type=indexCreation`. This is equivalent to an `AND` operation. - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. - The tasks are still returned in the `result` field in the response body. From 6376ccef6639780a7e22a0efed247ac6103176c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:19 +0200 Subject: [PATCH 37/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 1 - 1 file changed, 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e7df510f..03ce6f1f 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -89,7 +89,6 @@ Done by @irevoire in #2372, #2433, and #2454. - Use the `&` character to apply multiple filters, e.g. `?status=enqueued&type=indexCreation`. This is equivalent to an `AND` operation. - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. - - The tasks are still returned in the `result` field in the response body. - The `limit`, `from`, and `next` are available in the response body. - Remove `GET /indexes/:indexUid/tasks` is removed. It can be replaced by `GET /tasks?indexUid=:indexUid` - Remove `GET /indexes/:indexUid/tasks/:taskUid` is removed. From 5f75349b59553c161e6a3d5d7ff57f1a9bd8e6b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:27 +0200 Subject: [PATCH 38/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 03ce6f1f..e6b43241 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -90,8 +90,8 @@ Done by @irevoire in #2372, #2433, and #2454. - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. - The `limit`, `from`, and `next` are available in the response body. -- Remove `GET /indexes/:indexUid/tasks` is removed. It can be replaced by `GET /tasks?indexUid=:indexUid` -- Remove `GET /indexes/:indexUid/tasks/:taskUid` is removed. +- `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` +- `GET /indexes/:indexUid/tasks/:taskUid` has been removed. - Rename `uid` to `taskUid` in the response body returned by every asynchronous task (ex: index creation, document addition...) - Rename some task properties - `documentPartial`-> `documentAdditionOrUpdate` From ea8be400fbb648c05bc4cfa8d1f624ec28f59e5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:35 +0200 Subject: [PATCH 39/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e6b43241..3edf1628 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -89,7 +89,7 @@ Done by @irevoire in #2372, #2433, and #2454. - Use the `&` character to apply multiple filters, e.g. `?status=enqueued&type=indexCreation`. This is equivalent to an `AND` operation. - Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. - - The `limit`, `from`, and `next` are available in the response body. + - `limit`, `from`, and `next` now appear in the response body. - `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` - `GET /indexes/:indexUid/tasks/:taskUid` has been removed. - Rename `uid` to `taskUid` in the response body returned by every asynchronous task (ex: index creation, document addition...) From 46dc5266fee34e5ece7f6f4b4992edb76de36143 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:42 +0200 Subject: [PATCH 40/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 3edf1628..0ca26f14 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -87,7 +87,7 @@ Done by @irevoire in #2372, #2433, and #2454. - Filtering is possible on the `type`, `status`, and `indexUid` fields. - Use the `,` character to specify several values for a filter, e.g. `?status=enqueued,processing`. This is equivalent to an `OR` operation. - Use the `&` character to apply multiple filters, e.g. `?status=enqueued&type=indexCreation`. This is equivalent to an `AND` operation. -- Add keyset pagination on the `GET /tasks` endpoints, allowing users to browse multiple sets of `task` items. +- Add keyset pagination on the `GET /tasks` endpoint, allowing users to browse multiple sets of `task` items. - You can use the `limit`, `from` query parameters to browse the tasks. - `limit`, `from`, and `next` now appear in the response body. - `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` From c2ee09fc708f9d5c4503734806e8b1a89f7762be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:08:51 +0200 Subject: [PATCH 41/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 0ca26f14..150fdf64 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -88,7 +88,7 @@ Done by @irevoire in #2372, #2433, and #2454. - Use the `,` character to specify several values for a filter, e.g. `?status=enqueued,processing`. This is equivalent to an `OR` operation. - Use the `&` character to apply multiple filters, e.g. `?status=enqueued&type=indexCreation`. This is equivalent to an `AND` operation. - Add keyset pagination on the `GET /tasks` endpoint, allowing users to browse multiple sets of `task` items. - - You can use the `limit`, `from` query parameters to browse the tasks. + - Use the `limit` and `from` query parameters to browse tasks. - `limit`, `from`, and `next` now appear in the response body. - `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` - `GET /indexes/:indexUid/tasks/:taskUid` has been removed. From 1a6682c7ccbd9887f76e09c9c974480e5ac078ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:09:19 +0200 Subject: [PATCH 42/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 150fdf64..2ee57c10 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -92,7 +92,7 @@ Done by @irevoire in #2372, #2433, and #2454. - `limit`, `from`, and `next` now appear in the response body. - `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` - `GET /indexes/:indexUid/tasks/:taskUid` has been removed. -- Rename `uid` to `taskUid` in the response body returned by every asynchronous task (ex: index creation, document addition...) +- `uid` has been renamed `taskUid` in the response body returned by every asynchronous task (e.g. index creation, document addition, etc...) - Rename some task properties - `documentPartial`-> `documentAdditionOrUpdate` - `documentAddition`-> `documentAdditionOrUpdate` From b80a9b42a75126dc577e6619fdc45a0f110065f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:09:25 +0200 Subject: [PATCH 43/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 2ee57c10..371a64cb 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -93,7 +93,7 @@ Done by @irevoire in #2372, #2433, and #2454. - `GET /indexes/:indexUid/tasks` has been removed. It can be replaced by `GET /tasks?indexUid=:indexUid` - `GET /indexes/:indexUid/tasks/:taskUid` has been removed. - `uid` has been renamed `taskUid` in the response body returned by every asynchronous task (e.g. index creation, document addition, etc...) -- Rename some task properties +- Some task properties have been renamed - `documentPartial`-> `documentAdditionOrUpdate` - `documentAddition`-> `documentAdditionOrUpdate` - `clearAll` -> `documentDeletion` From 845ebc2aa6fff02f838f93170e28b4a38049c2f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:09:35 +0200 Subject: [PATCH 44/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 371a64cb..9d5110dc 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -100,7 +100,7 @@ Done by @irevoire in #2372, #2433, and #2454. Done by Kerollmops in #2399 and #2445. -### Changes regarding the dumps +### Changes regarding dumps - Dump creation becomes an asynchronous task. It means the dump task is put at the end of the task queue but will be processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... From b27878c35577548af74fa73049a9c70a8e575425 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:09:42 +0200 Subject: [PATCH 45/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 9d5110dc..7cfc96de 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -102,7 +102,7 @@ Done by Kerollmops in #2399 and #2445. ### Changes regarding dumps -- Dump creation becomes an asynchronous task. It means the dump task is put at the end of the task queue but will be processed in priority. +- Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... - The `GET /dumps/:dump_uid/status` route is removed because not useful anymore, use `GET /tasks` instead. - Remove the `dump_already_processing` error when a dump is already processed since they can now be enqueued. From 133affab263820639b8357606fbb981ef3e8c21a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:09:54 +0200 Subject: [PATCH 46/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 7cfc96de..0d5c188d 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -104,7 +104,7 @@ Done by Kerollmops in #2399 and #2445. - Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... -- The `GET /dumps/:dump_uid/status` route is removed because not useful anymore, use `GET /tasks` instead. +- The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dump`. - Remove the `dump_already_processing` error when a dump is already processed since they can now be enqueued. Done by @MarinPostma in #2410 From cb705d2918e6e7459a0f5405c61ea72de60f8b3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:10:07 +0200 Subject: [PATCH 47/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 0d5c188d..bfa8ebf3 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -105,7 +105,7 @@ Done by Kerollmops in #2399 and #2445. - Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... - The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dump`. -- Remove the `dump_already_processing` error when a dump is already processed since they can now be enqueued. +- The `dump_already_processing` error has been removed since dumps can now be enqueued. Done by @MarinPostma in #2410 From 8611a37f0abafacb842fb60439d361d30e2ff1f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:13 +0200 Subject: [PATCH 48/84] Update meilisearch-release-changelogs/v0.28.0.md --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index bfa8ebf3..6d0a1709 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -104,7 +104,7 @@ Done by Kerollmops in #2399 and #2445. - Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... -- The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dump`. +- The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dumpCreation`. - The `dump_already_processing` error has been removed since dumps can now be enqueued. Done by @MarinPostma in #2410 From 68000f34adc65eabd77e8f93dbd26d7e93660168 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:19 +0200 Subject: [PATCH 49/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 6d0a1709..44ba1ace 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -112,7 +112,7 @@ Done by @MarinPostma in #2410 ### Changes in `/keys` endpoint - Regarding the tenant token: `apiKeyPrefix` is renamed `apiKeyUid` -- Once a key is created, you cannot update `actions`, `indexes`, `expireAt` anymore. Only the `name` and `description` fields are updatable. You can delete and re-create the key if needed. +- It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. - When getting the key list (`GET /keys`), the keys are now paginated. It means: - You can use the `offset` and `limit` parameters to browse the indexes. - The keys are still returned in the `result` field in the response body. From e93477eb4bf26ad5f9b40b532215b6ca2ff04c07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:26 +0200 Subject: [PATCH 50/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 44ba1ace..5539f6cd 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -113,7 +113,7 @@ Done by @MarinPostma in #2410 - Regarding the tenant token: `apiKeyPrefix` is renamed `apiKeyUid` - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. -- When getting the key list (`GET /keys`), the keys are now paginated. It means: +- When getting the keys list (`GET /keys`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse the indexes. - The keys are still returned in the `result` field in the response body. - The `limit`, `offset`, and `total` are available in the response body. From fcd45820a94432f029926d73f0f8569dd2df052a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:35 +0200 Subject: [PATCH 51/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 5539f6cd..934ac555 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -114,7 +114,7 @@ Done by @MarinPostma in #2410 - Regarding the tenant token: `apiKeyPrefix` is renamed `apiKeyUid` - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. - When getting the keys list (`GET /keys`), the response is now paginated. That means: - - You can use the `offset` and `limit` parameters to browse the indexes. + - You can use the `offset` and `limit` parameters to browse keys. - The keys are still returned in the `result` field in the response body. - The `limit`, `offset`, and `total` are available in the response body. - Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. From ff38be056bb476ddabcb8ed6b4dbba7e79acd91d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:43 +0200 Subject: [PATCH 52/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 1 - 1 file changed, 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 934ac555..b5f71193 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -115,7 +115,6 @@ Done by @MarinPostma in #2410 - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. - When getting the keys list (`GET /keys`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse keys. - - The keys are still returned in the `result` field in the response body. - The `limit`, `offset`, and `total` are available in the response body. - Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. - The `dumps.get` action is removed. From d52d72c33d1659aa03b6ac2ab34d47afcfd1d5a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:50 +0200 Subject: [PATCH 53/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index b5f71193..f2a022fa 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -115,7 +115,7 @@ Done by @MarinPostma in #2410 - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. - When getting the keys list (`GET /keys`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse keys. - - The `limit`, `offset`, and `total` are available in the response body. + - `limit`, `offset`, and `total` now appear in the response body. - Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. - The `dumps.get` action is removed. From a0ffff9240d7b93e31f00ea0fbfdb5e8ca726e99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:11:57 +0200 Subject: [PATCH 54/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index f2a022fa..aa5ee735 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -111,7 +111,7 @@ Done by @MarinPostma in #2410 ### Changes in `/keys` endpoint -- Regarding the tenant token: `apiKeyPrefix` is renamed `apiKeyUid` +- Tenant tokens: `apiKeyPrefix` has been renamed `apiKeyUid`. - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. - When getting the keys list (`GET /keys`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse keys. From c58c1b9c2cbad428192392bb570938884540b8a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:04 +0200 Subject: [PATCH 55/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index aa5ee735..fe887c91 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -116,7 +116,7 @@ Done by @MarinPostma in #2410 - When getting the keys list (`GET /keys`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse keys. - `limit`, `offset`, and `total` now appear in the response body. -- Due to all the changes on the `keys` resources, the dump's compatibility is not full with API keys. It means the keys created with an old version of Meilisearch will be imported with the same `actions` and `indexes` values, but the `key` and `uid` fields will be regenerated. You will need to update your keys. +- Due to changes to the `keys` resource, dumps are not fully compatible with API keys. As a result, keys imported from an old version of Meilisearch will have their `key` and `uid` fields regenerated. In other words, **you will need to update your keys**. Other key fields such as `actions` and `indexes` will not be affected. - The `dumps.get` action is removed. Done by @ManyTheFish in #2438, #2451, #2475, and #2474) From fe5b1adce29a0d3c3b67f82fedffa0d5492bb57b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:10 +0200 Subject: [PATCH 56/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index fe887c91..6afa68b0 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -117,7 +117,7 @@ Done by @MarinPostma in #2410 - You can use the `offset` and `limit` parameters to browse keys. - `limit`, `offset`, and `total` now appear in the response body. - Due to changes to the `keys` resource, dumps are not fully compatible with API keys. As a result, keys imported from an old version of Meilisearch will have their `key` and `uid` fields regenerated. In other words, **you will need to update your keys**. Other key fields such as `actions` and `indexes` will not be affected. -- The `dumps.get` action is removed. +- The `dumps.get` action has been removed. Done by @ManyTheFish in #2438, #2451, #2475, and #2474) From c1aec41bac1de89cb0cf317a4a56484887a9eb65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:16 +0200 Subject: [PATCH 57/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 6afa68b0..96b675ea 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -123,7 +123,7 @@ Done by @ManyTheFish in #2438, #2451, #2475, and #2474) ### Changes in `/indexes/{uid}/settings` endpoints -The changes only concern the HTTP methods +The following changes only concern the HTTP verb associated with a given method. - The endpoint to update the global settings is now `PATCH /indexes/{indexUid}/settings` instead of `POST` - The endpoint to update the typo-tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` From c14ca930338b34263edac982709574c56c3faccd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:25 +0200 Subject: [PATCH 58/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 96b675ea..e9847052 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -126,7 +126,7 @@ Done by @ManyTheFish in #2438, #2451, #2475, and #2474) The following changes only concern the HTTP verb associated with a given method. - The endpoint to update the global settings is now `PATCH /indexes/{indexUid}/settings` instead of `POST` -- The endpoint to update the typo-tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` +- The endpoint to update the typo tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` - The endpoint to update the displayed attributes settings is now `PUT /indexes/{indexUid}/settings/displayed-attributes` instead of `POST` - The endpoint to update the distinct attribute settings is now `PUT /indexes/{indexUid}/settings/distinct-attribute` instead of `POST` - The endpoint to update the filterable attribute settings is now `PUT /indexes/{indexUid}/settings/filterable-attributes` instead of `POST` From 1bd15e3a73975a1493a958995bb52b76c977c173 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:42 +0200 Subject: [PATCH 59/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e9847052..6814ab1d 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -133,7 +133,7 @@ The following changes only concern the HTTP verb associated with a given method. - The endpoint to update the ranking rules settings is now `PUT /indexes/{indexUid}/settings/ranking-rules` instead of `POST` - The endpoint to update the searchable attributes settings is now `PUT /indexes/{indexUid}/settings/searchable-attributes` instead of `POST` - The endpoint to update the sortable attributes settings is now `PUT /indexes/{indexUid}/settings/sortable-attributes` instead of `POST` -- The endpoint to update the stop-words settings is now `PUT /indexes/{indexUid}/settings/stop-words` instead of `POST` +- The endpoint to update the stop words settings is now `PUT /indexes/{indexUid}/settings/stop-words` instead of `POST` - The endpoint to update the synonyms settings is now `PUT /indexes/{indexUid}/settings/synonyms` instead of `POST` Done by @Kerollmops in #2452 From 2b21796a57cb670e13299bdf251d6dcb8b8c6f8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 8 Jun 2022 19:12:51 +0200 Subject: [PATCH 60/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 6814ab1d..95bd7ed2 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -147,7 +147,7 @@ Done by Kerollmops in #2468 and meilisearch/milli#535 # Other improvements 🔨 -- Geo-search: Support string type for `_geo` `lat` and `lng` fields (#2408 and meilisearch/milli#523) @irevoire +- Geosearch: Support string type for `_geo`, `lat`, and `lng` fields (#2408 and meilisearch/milli#523) @irevoire - Improve ranking rules error message (meilisearch/milli#536, #2468) @matthias-wright - Remove the connection keep-alive timeout (#2471) @Thearas From 236689feae507edc4999dc93718e9f1e597721d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 8 Jun 2022 19:18:40 +0200 Subject: [PATCH 61/84] Remove extra spaces --- meilisearch-release-changelogs/v0.28.0.md | 46 +++++++++++------------ 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 95bd7ed2..f3fd5c04 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -7,9 +7,9 @@ This release introduces a lot of breaking changes (especially regarding names), ⚠️ Since this is a release candidate (RC), the official documentation is not updated yet, but will be ready for the official v0.28.0 release. The work-in-progress documentation is available [here](). -## New features 🚀 +# New features 🚀 -### Smart crop +## Smart crop The smart crop is an improvement of the Meilisearch crop. @@ -17,7 +17,7 @@ The cropping algorithm tries to find the window(s) with the highest density of q Done by @ManyTheFish (#2408) -### API key management: deterministic keys +## API key management: deterministic keys - It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. - Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. @@ -26,13 +26,13 @@ Done by @ManyTheFish (#2408) Done by @ManyTheFish in #2438, #2451, #2475, and #2474) -### Hebrew language support +## Hebrew language support New language support: Hebrew, using the [Niqqud library](https://github.com/benny-n/niqqud). Done by the amazing @benny-n in meilisearch/charabia#101. -### New tokenizer contribution experience: add your language to Meilisearch +## New tokenizer contribution experience: add your language to Meilisearch The contribution experience in the tokenizer has been significantly improved. @@ -47,7 +47,7 @@ Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. For most of the following changes, if you use [one of our SDKs](https://docs.meilisearch.com/learn/what_is_meilisearch/sdks.html), these changes will be transparent for you by only updating to the latest version of the SDK. -### Changes in `/indexes/{uid}/search` endpoint +## Changes in `/indexes/{uid}/search` endpoint - `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter is renamed `facets` @@ -58,7 +58,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei Done by @irevoire in #2406. -### Changes in `/indexes` endpoints +## Changes in `/indexes` endpoints - When getting the index list (`GET /indexes`), the response is now paginated. That means: - You can use the `offset` and `limit` parameters to browse indexes. @@ -69,7 +69,7 @@ Done by @irevoire in #2406. Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. -### Changes in `indexes/{uid}/documents` endpoints +## Changes in `indexes/{uid}/documents` endpoints - When getting the documents list (`GET /indexes/{uid}/documents`), pagination has been improved. That means: - You can still use the `offset` and `limit` parameters to browse documents. @@ -81,7 +81,7 @@ Done by @irevoire and @Kerollmops in #2423, #2452, and #2454. Done by @irevoire in #2372, #2433, and #2454. -### Changes in `/tasks` and `/indexes/{uid}/tasks` endpoints +## Changes in `/tasks` and `/indexes/{uid}/tasks` endpoints - You can now filter on the `GET /tasks` endpoint: - Filtering is possible on the `type`, `status`, and `indexUid` fields. @@ -100,7 +100,7 @@ Done by @irevoire in #2372, #2433, and #2454. Done by Kerollmops in #2399 and #2445. -### Changes regarding dumps +## Changes regarding dumps - Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... @@ -109,7 +109,7 @@ Done by Kerollmops in #2399 and #2445. Done by @MarinPostma in #2410 -### Changes in `/keys` endpoint +## Changes in `/keys` endpoint - Tenant tokens: `apiKeyPrefix` has been renamed `apiKeyUid`. - It is no longer possible to update `actions`, `indexes`, or `expiresAt` after key creation. Only the `name` and `description` fields are updatable. @@ -121,24 +121,24 @@ Done by @MarinPostma in #2410 Done by @ManyTheFish in #2438, #2451, #2475, and #2474) -### Changes in `/indexes/{uid}/settings` endpoints +## Changes in `/indexes/{uid}/settings` endpoints The following changes only concern the HTTP verb associated with a given method. -- The endpoint to update the global settings is now `PATCH /indexes/{indexUid}/settings` instead of `POST` -- The endpoint to update the typo tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` -- The endpoint to update the displayed attributes settings is now `PUT /indexes/{indexUid}/settings/displayed-attributes` instead of `POST` -- The endpoint to update the distinct attribute settings is now `PUT /indexes/{indexUid}/settings/distinct-attribute` instead of `POST` -- The endpoint to update the filterable attribute settings is now `PUT /indexes/{indexUid}/settings/filterable-attributes` instead of `POST` -- The endpoint to update the ranking rules settings is now `PUT /indexes/{indexUid}/settings/ranking-rules` instead of `POST` -- The endpoint to update the searchable attributes settings is now `PUT /indexes/{indexUid}/settings/searchable-attributes` instead of `POST` -- The endpoint to update the sortable attributes settings is now `PUT /indexes/{indexUid}/settings/sortable-attributes` instead of `POST` -- The endpoint to update the stop words settings is now `PUT /indexes/{indexUid}/settings/stop-words` instead of `POST` -- The endpoint to update the synonyms settings is now `PUT /indexes/{indexUid}/settings/synonyms` instead of `POST` +- The endpoint to update the global settings is now `PATCH /indexes/{indexUid}/settings` instead of `POST` +- The endpoint to update the typo tolerance settings is now `PATCH /indexes/{indexUid}/settings/typo-tolerance` instead of `POST` +- The endpoint to update the displayed attributes settings is now `PUT /indexes/{indexUid}/settings/displayed-attributes` instead of `POST` +- The endpoint to update the distinct attribute settings is now `PUT /indexes/{indexUid}/settings/distinct-attribute` instead of `POST` +- The endpoint to update the filterable attribute settings is now `PUT /indexes/{indexUid}/settings/filterable-attributes` instead of `POST` +- The endpoint to update the ranking rules settings is now `PUT /indexes/{indexUid}/settings/ranking-rules` instead of `POST` +- The endpoint to update the searchable attributes settings is now `PUT /indexes/{indexUid}/settings/searchable-attributes` instead of `POST` +- The endpoint to update the sortable attributes settings is now `PUT /indexes/{indexUid}/settings/sortable-attributes` instead of `POST` +- The endpoint to update the stop words settings is now `PUT /indexes/{indexUid}/settings/stop-words` instead of `POST` +- The endpoint to update the synonyms settings is now `PUT /indexes/{indexUid}/settings/synonyms` instead of `POST` Done by @Kerollmops in #2452 -### Limit of 1000 for facet value +## Limit of 1000 for facet value For performance reasons, the limit of facet values is now 1000. From 54dfede7d159267d85e94578ff893ad7c11db7ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 8 Jun 2022 19:37:36 +0200 Subject: [PATCH 62/84] Add new sections about new limits --- meilisearch-release-changelogs/v0.28.0.md | 45 ++++++++++++++++++++--- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index f3fd5c04..57692808 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -42,6 +42,46 @@ The whole core team is available to help you contribute. Feel free to ask for an Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. +## Add limit customizations + +### Limit of facet values + +When searching using the `facets` serach parameter, Meilisearch will now return a maximum of 100 different facet values per faceted attributes. This limit is customizable by using the `faceting` settings with the `/indexes/{uid}/settings/faceting` endpoint. + +To increase this limit to 1000: + +```bash +curl \ + -X PATCH 'http://localhost:7700/indexes/books/settings/faceting' \ + -H 'Content-Type: application/json' \ + --data-binary '{ + "maxValuesPerFacet": 1000 + }' +``` + +You can get the value by using the HTTP `GET` method on this endpoint, or reset this value using the `DELETE` method. + +Done by @Kerollmops in meilisearch/milli#550 and #2494 + +### Limit of retrievable documents during the search + +During the search, Meilisearch returns a maximum of 1000 documents, meaning the end-user can only access the 1000 more relevant documents when searching. This limit is now customizable by using the `pagination` settings with the `/indexes/{uid}/settings/pagination` endpoint. + +To increase this limit to 20000: + +```bash +curl \ + -X PATCH 'http://localhost:7700/indexes/books/settings/pagination' \ + -H 'Content-Type: application/json' \ + --data-binary '{ + "limitedTo": 2000 + }' +``` + +You can get the value by using the HTTP `GET` method on this endpoint, or reset this value using the `DELETE` method. + +Done by @Kerollmops in meilisearch/milli#550 and #2494 + # Breaking changes and improvement ⚠️ @@ -138,12 +178,7 @@ The following changes only concern the HTTP verb associated with a given method. Done by @Kerollmops in #2452 -## Limit of 1000 for facet value - - -For performance reasons, the limit of facet values is now 1000. -Done by Kerollmops in #2468 and meilisearch/milli#535 # Other improvements 🔨 From 7373300cc118dc5ab1cee00b130fd3d61e1762af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:22:27 +0200 Subject: [PATCH 63/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 57692808..4cc48a94 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -142,7 +142,10 @@ Done by Kerollmops in #2399 and #2445. ## Changes regarding dumps -- Dump creation is now an asynchronous task. Dump tasks are placed at the end of the task queue but are processed in priority. +- Dump creation is now an asynchronous task. +- Dump tasks are placed at the end of the task queue, but processed in priority. + - In other words, a dump will run as soon as the current task is finished processing. + - The dump's `uid` will reflect when it was enqueued in relation to the other tasks, not when it was processed. - `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... - The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dumpCreation`. - The `dump_already_processing` error has been removed since dumps can now be enqueued. From 80b549afd9ab27efb1ae3270485ba2ccce5fb63e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:22:34 +0200 Subject: [PATCH 64/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 4cc48a94..7d867d39 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -42,7 +42,7 @@ The whole core team is available to help you contribute. Feel free to ask for an Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. -## Add limit customizations +## Customizable limits ### Limit of facet values From 9eef097a8ea6d96c7feab8039f005fa4d393941d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:22:57 +0200 Subject: [PATCH 65/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 7d867d39..d0ef6659 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -46,7 +46,9 @@ Done by @ManyTheFish, @loiclec @gmourier, and @curquiza. ### Limit of facet values -When searching using the `facets` serach parameter, Meilisearch will now return a maximum of 100 different facet values per faceted attributes. This limit is customizable by using the `faceting` settings with the `/indexes/{uid}/settings/faceting` endpoint. +When searching using the `facets` search parameter, Meilisearch will now return a maximum of 100 different facet values per faceted attribute. + +This default limit is customizable using the new `faceting` setting, accessible via the `/indexes/{uid}/settings/faceting` route. To increase this limit to 1000: From d70b72bcc9d68b24816030cdde061a4f1ca7f8d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:23:02 +0200 Subject: [PATCH 66/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index d0ef6659..5da3aa4f 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -65,7 +65,7 @@ You can get the value by using the HTTP `GET` method on this endpoint, or reset Done by @Kerollmops in meilisearch/milli#550 and #2494 -### Limit of retrievable documents during the search +### Limit of documents returned by search During the search, Meilisearch returns a maximum of 1000 documents, meaning the end-user can only access the 1000 more relevant documents when searching. This limit is now customizable by using the `pagination` settings with the `/indexes/{uid}/settings/pagination` endpoint. From 5eef4c89aaf2949cce107487ee2f9fe5b0ae46c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:23:14 +0200 Subject: [PATCH 67/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 5da3aa4f..2ac47588 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -67,7 +67,9 @@ Done by @Kerollmops in meilisearch/milli#550 and #2494 ### Limit of documents returned by search -During the search, Meilisearch returns a maximum of 1000 documents, meaning the end-user can only access the 1000 more relevant documents when searching. This limit is now customizable by using the `pagination` settings with the `/indexes/{uid}/settings/pagination` endpoint. +When making a search request, Meilisearch returns a maximum of 1000 documents: the documents deemed most relevant to the query. + +This default limit is now customizable using the `pagination` setting, accessible via the `/indexes/{uid}/settings/pagination` route. To increase this limit to 20000: From c8b93cd09aa6859bc6dbeca1763e02cc15c13fbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:23:20 +0200 Subject: [PATCH 68/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 2ac47588..5ad38dce 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -82,7 +82,7 @@ curl \ }' ``` -You can get the value by using the HTTP `GET` method on this endpoint, or reset this value using the `DELETE` method. +You can also get the value using the HTTP `GET` verb, or reset the value using the `DELETE` verb. Done by @Kerollmops in meilisearch/milli#550 and #2494 From e2def263c03f2038e561939db17f49f8196172de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 13:23:26 +0200 Subject: [PATCH 69/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 5ad38dce..2416a508 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -61,7 +61,7 @@ curl \ }' ``` -You can get the value by using the HTTP `GET` method on this endpoint, or reset this value using the `DELETE` method. +You can also get the value using the HTTP `GET` verb, or reset the value using the `DELETE` verb. Done by @Kerollmops in meilisearch/milli#550 and #2494 From 03609508e9bca75fbb8e406a77a217c7a76ecae3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 9 Jun 2022 14:05:28 +0200 Subject: [PATCH 70/84] Add PR about docker --- meilisearch-release-changelogs/v0.28.0.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 2416a508..aa53ef2a 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -185,8 +185,6 @@ The following changes only concern the HTTP verb associated with a given method. Done by @Kerollmops in #2452 - - # Other improvements 🔨 - Geosearch: Support string type for `_geo`, `lat`, and `lng` fields (#2408 and meilisearch/milli#523) @irevoire @@ -198,6 +196,7 @@ Done by @Kerollmops in #2452 - Telemetry: handle the `X-Meilisearch-Client` header (#2374) @irevoire - Telemetry: send the analytics to `telemetry.meilisearch.com` instead of segment (#2429) @irevoire - Create custom error types for `TaskType`, `TaskStatus`, and `IndexUid` (#2460) @walterbm +- Improve the Docker CIs (#2477 and #2491) @choznerol and @curquiza - Some internal changes (#2447, #2464, #2453, #2455) @MarinPostma @Kerollmops - Update dependencies (#2450) @Kerollmops - Add dump tests in CI (#2357) @irevoire @@ -212,6 +211,6 @@ Done by @Kerollmops in #2452 ---- ❤️ Thanks again to our external contributors: -- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @ryanrussel, @Thearas, and @walterbm +- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @choznerol, @ryanrussel, @Thearas, and @walterbm - [Milli](https://github.com/meilisearch/milli): @matthias-wright - [Charabia](https://github.com/meilisearch/charabia): @benny-n From ecc7f958703ac03933ad55b7cceedf060a2965a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 9 Jun 2022 16:56:06 +0200 Subject: [PATCH 71/84] Add pierre contribution --- meilisearch-release-changelogs/v0.28.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index aa53ef2a..c48a2a98 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -190,6 +190,7 @@ Done by @Kerollmops in #2452 - Geosearch: Support string type for `_geo`, `lat`, and `lng` fields (#2408 and meilisearch/milli#523) @irevoire - Improve ranking rules error message (meilisearch/milli#536, #2468) @matthias-wright - Remove the connection keep-alive timeout (#2471) @Thearas +- Improve index uid validation upon API key creation (#2414) @pierre-l # Misc @@ -211,6 +212,6 @@ Done by @Kerollmops in #2452 ---- ❤️ Thanks again to our external contributors: -- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @choznerol, @ryanrussel, @Thearas, and @walterbm +- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @choznerol, @pierre-l, @ryanrussel, @Thearas, and @walterbm - [Milli](https://github.com/meilisearch/milli): @matthias-wright - [Charabia](https://github.com/meilisearch/charabia): @benny-n From 2874d5d9719b9d37285139c1758a2d25792de7de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Thu, 9 Jun 2022 18:15:55 +0200 Subject: [PATCH 72/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index c48a2a98..9397366a 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -19,7 +19,7 @@ Done by @ManyTheFish (#2408) ## API key management: deterministic keys -- It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` is a `uuidv4`. If omitted, Meilisearch generates it. +- It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` value must be a UUID v4. If omitted, Meilisearch generates it. - Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. - Introduces new actions to manage API keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). - It is no longer possible to update an API key's `actions`, `indexes`, or `expiresAt` after creation. From e9c4753594ff24df7d02ba30ca8ccd386b44ea5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 9 Jun 2022 18:40:05 +0200 Subject: [PATCH 73/84] Add the fix --- meilisearch-release-changelogs/v0.28.0.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 9397366a..e3aee449 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -192,6 +192,10 @@ Done by @Kerollmops in #2452 - Remove the connection keep-alive timeout (#2471) @Thearas - Improve index uid validation upon API key creation (#2414) @pierre-l +# Fixes 🐞 + +- Fix filtering on documents with double or/and simple quote (#2500 and meilisearch/milli#552) @irevoire + # Misc - Telemetry: handle the `X-Meilisearch-Client` header (#2374) @irevoire From 9304d4ed09396fce8f84d42330da92f3bb4d300f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Mon, 13 Jun 2022 13:21:49 +0200 Subject: [PATCH 74/84] Add contributor PR in the release changelogs --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e3aee449..1df7baf0 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -209,7 +209,7 @@ Done by @Kerollmops in #2452 - Change Nelson path (#2347) @curquiza - Re-integrate Clippy in the CI (#2424) @irevoire - Fix typo in README (#2448) @ryanrussell -- Fix typo in code base comments (#2459) @ryanrussel +- Fix typo in code base comments (#2459, and #2508) @ryanrussel - Update url of `movies.json` in README (#2422) @0x0x1 - Fix command in README (#2434) @0x0x1 From 093598047c91bb1bdb1787cc67e53817c2da174c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Mon, 13 Jun 2022 18:05:52 +0200 Subject: [PATCH 75/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 1df7baf0..7105bad0 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -194,7 +194,7 @@ Done by @Kerollmops in #2452 # Fixes 🐞 -- Fix filtering on documents with double or/and simple quote (#2500 and meilisearch/milli#552) @irevoire +- Fix filtering on documents with double and/or single quote characters (#2500 and meilisearch/milli#552) @irevoire # Misc From 2134269ec63c10f778e9d7831ab5cf85085feaaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Tue, 14 Jun 2022 17:43:37 +0200 Subject: [PATCH 76/84] Update meilisearch-release-changelogs/v0.28.0.md --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 7105bad0..6d98f7d5 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -93,7 +93,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei ## Changes in `/indexes/{uid}/search` endpoint -- `nbHits` is renamed `estimatedNbHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. +- `nbHits` is renamed `estimatedTotalHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter is renamed `facets` - The `facetsDistribution` field in the response body is renamed `facetDistribution` - The `matches` search parameter is renamed `showMatchesPosition` From 6eaedf673f1ea9ddfe691e97f88f8f826dda79e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 15 Jun 2022 14:59:09 +0200 Subject: [PATCH 77/84] Fix examples --- meilisearch-release-changelogs/v0.28.0.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 6d98f7d5..08149bb9 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -50,14 +50,14 @@ When searching using the `facets` search parameter, Meilisearch will now return This default limit is customizable using the new `faceting` setting, accessible via the `/indexes/{uid}/settings/faceting` route. -To increase this limit to 1000: +To increase this limit to 3000: ```bash curl \ -X PATCH 'http://localhost:7700/indexes/books/settings/faceting' \ -H 'Content-Type: application/json' \ --data-binary '{ - "maxValuesPerFacet": 1000 + "maxValuesPerFacet": 3000 }' ``` @@ -71,7 +71,7 @@ When making a search request, Meilisearch returns a maximum of 1000 documents: t This default limit is now customizable using the `pagination` setting, accessible via the `/indexes/{uid}/settings/pagination` route. -To increase this limit to 20000: +To increase this limit to 2000: ```bash curl \ From 2c460096fb1b5d62c09efc026f0a06a412840d6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 16 Jun 2022 17:19:46 +0200 Subject: [PATCH 78/84] Add missing PR about docker CI improvement --- meilisearch-release-changelogs/v0.28.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 08149bb9..e2a2ce5f 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -189,6 +189,7 @@ Done by @Kerollmops in #2452 - Geosearch: Support string type for `_geo`, `lat`, and `lng` fields (#2408 and meilisearch/milli#523) @irevoire - Improve ranking rules error message (meilisearch/milli#536, #2468) @matthias-wright +- Improve docker CI: push vX.Y tag (without patch) to Docker Hub (#2529) @janithpet - Remove the connection keep-alive timeout (#2471) @Thearas - Improve index uid validation upon API key creation (#2414) @pierre-l @@ -216,6 +217,6 @@ Done by @Kerollmops in #2452 ---- ❤️ Thanks again to our external contributors: -- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @choznerol, @pierre-l, @ryanrussel, @Thearas, and @walterbm +- [Meilisearch](https://github.com/meilisearch/meilisearch): @0x0x1, @choznerol, @janithpet, @pierre-l, @ryanrussel, @Thearas, and @walterbm - [Milli](https://github.com/meilisearch/milli): @matthias-wright - [Charabia](https://github.com/meilisearch/charabia): @benny-n From 774721298af1d17dfa0794b8153c8da6c350f12c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Thu, 23 Jun 2022 19:07:24 +0200 Subject: [PATCH 79/84] Add new fix --- meilisearch-release-changelogs/v0.28.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index e2a2ce5f..9bab4541 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -196,6 +196,7 @@ Done by @Kerollmops in #2452 # Fixes 🐞 - Fix filtering on documents with double and/or single quote characters (#2500 and meilisearch/milli#552) @irevoire +- Fix behavior of `nbHits` with distinct attribute (#2546) @Kerollmops # Misc From 4ac38d960a0c456d85538f0dd607aaef8c685a52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Fri, 24 Jun 2022 13:49:41 +0200 Subject: [PATCH 80/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 9bab4541..34e52331 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -78,7 +78,7 @@ curl \ -X PATCH 'http://localhost:7700/indexes/books/settings/pagination' \ -H 'Content-Type: application/json' \ --data-binary '{ - "limitedTo": 2000 + "maxTotalHits": 2000 }' ``` @@ -192,11 +192,11 @@ Done by @Kerollmops in #2452 - Improve docker CI: push vX.Y tag (without patch) to Docker Hub (#2529) @janithpet - Remove the connection keep-alive timeout (#2471) @Thearas - Improve index uid validation upon API key creation (#2414) @pierre-l +- Improve `estimatedTotalHits` behavior with distinct attribute (#2546) @Kerollmops # Fixes 🐞 - Fix filtering on documents with double and/or single quote characters (#2500 and meilisearch/milli#552) @irevoire -- Fix behavior of `nbHits` with distinct attribute (#2546) @Kerollmops # Misc From f5bfa93590d4007e1ec3af07a3529b23d678de91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Tue, 5 Jul 2022 11:01:31 +0200 Subject: [PATCH 81/84] Update meilisearch-release-changelogs/v0.28.0.md Co-authored-by: Guillaume Mourier --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 34e52331..b9866379 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -150,7 +150,7 @@ Done by Kerollmops in #2399 and #2445. - Dump tasks are placed at the end of the task queue, but processed in priority. - In other words, a dump will run as soon as the current task is finished processing. - The dump's `uid` will reflect when it was enqueued in relation to the other tasks, not when it was processed. -- `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition... +- `POST /dumps` now returns `202` like any other asynchronous operation (e.g. index creation, document addition...) - The `GET /dumps/:dump_uid/status` endpoint has been removed. It can be replaced by `GET /tasks?type=dumpCreation`. - The `dump_already_processing` error has been removed since dumps can now be enqueued. From 06175fab4d99df1db426190225d135289f4d902f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 6 Jul 2022 12:17:59 +0200 Subject: [PATCH 82/84] Add mini-dashboard PR --- meilisearch-release-changelogs/v0.28.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index b9866379..01f1eedd 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -208,6 +208,7 @@ Done by @Kerollmops in #2452 - Update dependencies (#2450) @Kerollmops - Add dump tests in CI (#2357) @irevoire - Deny warnings in CI (#2339) @MarinPostma +- Update mini-dashboard for v0.28.0 (#2587) @mdubus @bidoubiwa - Change Nelson path (#2347) @curquiza - Re-integrate Clippy in the CI (#2424) @irevoire - Fix typo in README (#2448) @ryanrussell From 206d72e772626921aec6d1ed84c7e529d8e783a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 6 Jul 2022 15:39:53 +0200 Subject: [PATCH 83/84] Add bash command to create deterministic keys --- meilisearch-release-changelogs/v0.28.0.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index 01f1eedd..c40d910b 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -20,6 +20,15 @@ Done by @ManyTheFish (#2408) ## API key management: deterministic keys - It is now possible to create a deterministic `key` value by specifying a `uid` field at creation. `uid` value must be a UUID v4. If omitted, Meilisearch generates it. + +The [`key`](/reference/api/keys.md#key) field is generated by hashing the master key and the [`uid`](/reference/api/keys.md#uid): + +```bash +echo -n $HYPHENATED_UUID | openssl dgst -sha256 -hmac $MASTER_KEY +``` + +As a result, `key` values are deterministic between instances sharing the same configuration. Since the `key` field depends on the master key, it is not propagated to dumps and snapshots. If a malicious user ever gets access to your dumps or snapshots, they will not have access to your instance's API keys. + - Adds a `name` field: specify a human-readable `name` to make API key retrieval more convenient. - Introduces new actions to manage API keys (`keys.get`, `keys.create`, `keys.update`, `keys.delete`). - It is no longer possible to update an API key's `actions`, `indexes`, or `expiresAt` after creation. From 020652d523690c1c34692d20bac6dc3827745fb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 6 Jul 2022 17:09:48 +0200 Subject: [PATCH 84/84] Add link for new pagination guide --- meilisearch-release-changelogs/v0.28.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meilisearch-release-changelogs/v0.28.0.md b/meilisearch-release-changelogs/v0.28.0.md index c40d910b..58399097 100644 --- a/meilisearch-release-changelogs/v0.28.0.md +++ b/meilisearch-release-changelogs/v0.28.0.md @@ -102,7 +102,7 @@ For most of the following changes, if you use [one of our SDKs](https://docs.mei ## Changes in `/indexes/{uid}/search` endpoint -- `nbHits` is renamed `estimatedTotalHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide]() to learn how to paginate with Meilisearch without using `nbHits`. +- `nbHits` is renamed `estimatedTotalHits`. Some users were confused by the old name and used it for their pagination, which we discourage. Please check out this [fresh new guide](https://docs.meilisearch.com/learn/advanced/pagination.html) to learn how to paginate with Meilisearch without using `nbHits`. - The `facetsDistribution` search parameter is renamed `facets` - The `facetsDistribution` field in the response body is renamed `facetDistribution` - The `matches` search parameter is renamed `showMatchesPosition`