Skip to content

Changes related to the next Meilisearch release (v0.28.0) #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 24 commits into from
Jul 11, 2022
Merged

Changes related to the next Meilisearch release (v0.28.0) #1257

merged 24 commits into from
Jul 11, 2022

Conversation

meili-bot
Copy link
Contributor

Related to this issue: meilisearch/integration-guides#205

This PR:

  • gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out.
  • should pass the tests against the latest pre-release of Meilisearch.
  • might eventually contain test failures until the Meilisearch v0.28.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.28.0) is out.

This PR is auto-generated for the pre-release week purpose.

@bidoubiwa
Copy link
Contributor

bidoubiwa commented Jun 15, 2022 •
edited
Loading

Changes related to the keys management

Related to:
issue: meilisearch/meilisearch#2442
issue: meilisearch/meilisearch#2369

  • GET /keys has pagination metadata, added limit (default: 20), offset (default: 0), total.
  • GET /keys/:uid_or_key can receive either a :uid or :key to find the key, not just the :key how it used to be.
  • Add the possibility to specify :uid to generate deterministic API keys if null Meilisearch generates one. It must be a UUID v4 value.
  • Add a :name attribute to the resource (can be null).
  • Add new values to the actions attribute: keys.get, keys.create, keys.update and keys.delete.
  • PATCH /keys/:uid_or_key can update only name and description fields.
  • apiKeyPrefix claim is now named apiKeyUid and expects the uid of the signing API key as a value.

Changes related to the HTTP verbs

Related to:
issue: meilisearch/meilisearch#2419

  • PATCH /indexes/{indexUid} instead of PUT
  • PATCH /indexes/{indexUid}/settings instead of POST
  • PATCH /indexes/{indexUid}/settings/typo-tolerance instead of POST
  • PUT /indexes/{indexUid}/settings/displayed-attributes instead of POST
  • PUT /indexes/{indexUid}/settings/distinct-attribute instead of POST
  • PUT /indexes/{indexUid}/settings/filterable-attributes instead of POST
  • PUT /indexes/{indexUid}/settings/ranking-rules instead of POST
  • PUT /indexes/{indexUid}/settings/searchable-attributes instead of POST
  • PUT /indexes/{indexUid}/settings/sortable-attributes instead of POST
  • PUT /indexes/{indexUid}/settings/stop-words instead of POST
  • PUT /indexes/{indexUid}/settings/synonyms instead of POST

Changes related to the tasks resources

Related to:
issue: meilisearch/meilisearch#2377

Changes related to the search

Related to:
issue: meilisearch/meilisearch#2376

All the changes:

  • Rename nbHits response parameter to estimatedTotalHits.
  • Delete exhaustiveNbHits response parameter.
  • Delete exhaustiveFacetsCount response parameter.
  • matches request parameter is renamed showMatchesPosition.
  • _matchesInfo response parameter is renamed _matchesPosition.
  • facetsDistribution request parameter is renamed facets.
  • facetsDistribution response parameter is renamed facetDistribution.

Changes related to the indexes resources

Related to:
issue: meilisearch/meilisearch#2373

All the changes:

  • Remove the name field in the index.
  • Wrap the indexes objects in a results key. Update tasks routes  #1259
  • GET /indexes has pagination metadata, added limit (default: 20), offset (default: 0), total.

Changes related to the documents resources

Related to:
issue: meilisearch/meilisearch#2372

All the changes:

  • GET /documents/:uid, GET /documents Add the possibility to reduce the body payload by using a query parameter called fields (previously called attributesToRetrieve), check the issue and the spec for the entire behavior.
  • Wrap the indexes objects in a results key.
  • GET /documents has pagination metadata, added limit (default: 20), offset (default: 0), total.
  • ⚠️ The displayedAttributes settings do not impact anymore the displayed fields returned in the /documents endpoints. These settings only affect the /search endpoint.

Changes related to the dumps resources

Related to:
issue: meilisearch/meilisearch#2371

All the changes:

  • Remove code sample get_dump_status_1
  • Remove method get dump status.
  • A dump creation now responds with a task object from type dumpCreation.
  • The error dump_already_processing don't need to be handled.

Changes regarding the smart crop behavior

Related to:
issue: meilisearch/meilisearch#2299

  • we must ensure our tests pass after this behavioral change.

Fix tests regarding two new settings, pagination and faceting

Related to:
issue: meilisearch/meilisearch#2368
issue: meilisearch/meilisearch#2495

  • According to the issues above, we must ensure our tests pass after adding the two new settings.
    ⚠️ These settings should not be implemented right now ⚠️. We will do that later in coop between the Integrations team and our community ❤️.
    Since we have some tests that rely on the result of the GET /settings API result, we should make them pass.

bidoubiwa and others added 9 commits June 15, 2022 15:58
@bidoubiwa
Update tasks routes (#1259)
aa75407 
* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant
@bidoubiwa
Update the tests impacted by the task api changes (#1260)
4edba56 
* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant

* Update the tests impacted by the task api changes

* Keep task destructing in tests

* Fix linting
@bidoubiwa
Fix comments on tasks method
1ee79b1
@bidoubiwa
Wrap get indexes routes in results object v0.28 (#1261)
b8cec6e 
* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant

* Update the tests impacted by the task api changes

* Keep task destructing in tests

* Fix linting

* Wrap get indexes routes in results object
@bidoubiwa
Update http methods in settings routes v0.28 (#1262)
6fcd2a3 
* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant

* Update the tests impacted by the task api changes

* Keep task destructing in tests

* Fix linting

* Wrap get indexes routes in results object

* Rebase

* Change http methods on route settings route

* Fix wrong http methods on documents routes
@bidoubiwa
Update search method v0.28 (#1263)
4ab9921 
* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant

* Update the tests impacted by the task api changes

* Keep task destructing in tests

* Fix linting

* Wrap get indexes routes in results object

* Rebase

* Change http methods on route settings route

* Update search routes for v0.28.0

* Remove console log from tests
@bidoubiwa
Update documents method v0.28 (#1264)
512adba 
* Update tasks API

* Make task typs an enum

* Update wait for tasks tests

* Wrap get indexes routes in results object

* Fix wrong http methods on documents routes

* Update get documents method v0.27

* Apply review changes
@bidoubiwa
Update key management v0.28 (#1266)
e1864ab 
* Update tasks API

* Make task typs an enum

* Update wait for tasks tests

* Wrap get indexes routes in results object

* Change http methods on route settings route

* Fix wrong http methods on documents routes

* Update keys method v0.28

* Update tests

* Simplify the tests
@bidoubiwa
Update dumps method v0.28 (#1267)
ef27da8 
* Update tasks API

* Make task typs an enum

* Update wait for tasks tests

* Wrap get indexes routes in results object

* Change http methods on route settings route

* Fix wrong http methods on documents routes

* Update dumps method v0.28
@bidoubiwa bidoubiwa added the skip-changelog The PR will not appear in the release changelogs label Jun 22, 2022
bidoubiwa and others added 4 commits June 22, 2022 17:19
@bidoubiwa
Update waitForTasks return format to not use resource result (#1271)
128df4d
@bidoubiwa
Update token creation v0.28.0 (#1268)
b61f466 
* Update tasks API

* Make task typs an enum

* Update wait for tasks tests

* Wrap get indexes routes in results object

* Change http methods on route settings route

* Fix wrong http methods on documents routes

* Update token payload from apiKeyPrefix to apiKeyUid

* Update the tokens generation for v0.28.0

* Remove console log

* Fix variable camel casing

* Update expires at message and tests description

* Remove the newlines in token errors
@bidoubiwa
Add pagination system on resources for v0.28.0 (#1269)
d4a2a8a 
* Add pagination on documents

* Add pagination on documents

* Add pagination on indexes and keys

* Improve typing

* Add pagination on tasks

* Add tests on pagination

* Update task types

* Add default parameters in JS docs

* Update TaskParam to TasksQuery

* Fix typing of getTask in JsDocs
@bidoubiwa
Unskip get search tests
bb9a022
@bidoubiwa bidoubiwa force-pushed the bump-meilisearch-v0.28.0 branch from ba04c47 to cb4e04f Compare June 27, 2022 15:36
@bidoubiwa bidoubiwa force-pushed the bump-meilisearch-v0.28.0 branch from cb4e04f to 60db7c2 Compare June 27, 2022 15:43
bidoubiwa and others added 4 commits June 28, 2022 11:29
@bidoubiwa
Add pagination and faceting types on settings for v0.28.0 (#1281)
5c8aa80 
* Add types on settings and fix tests

* Fix esm env test

* Fix esm env test
@bidoubiwa
Add client header with package information (#1272)
bb1a824 
* Add pagination on tasks

* Add client header with package information

* Update package version to correct one

* Update user agent naming

* Make x-meilisearch-client an array of string

* Fix type in jsdoc

* Rollback previous commit

* Rollback tasks changes

* Put client agents at the root of config object

* Merge custom headers with default headers
@bidoubiwa
Merge branch 'main' of github.com:meilisearch/meilisearch-js into bum…
bdb80db 
…p-meilisearch-v0.28.0
@bidoubiwa
Fix readme information
75da3b2
@bidoubiwa bidoubiwa force-pushed the bump-meilisearch-v0.28.0 branch from f6b8b83 to 75da3b2 Compare June 29, 2022 09:39
@bidoubiwa bidoubiwa marked this pull request as ready for review July 11, 2022 15:06
@bidoubiwa bidoubiwa requested review from brunoocasali and mdubus July 11, 2022 15:06
brunoocasali
brunoocasali approved these changes Jul 11, 2022
View reviewed changes
Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!!! 🎲 🏡

@bidoubiwa
Copy link
Contributor

bors merge

@meili-bors
Copy link
Contributor

meili-bors bot commented Jul 11, 2022

Build succeeded:

@meili-bors meili-bors bot merged commit cb18e04 into main Jul 11, 2022
@meili-bors meili-bors bot deleted the bump-meilisearch-v0.28.0 branch July 11, 2022 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brunoocasali brunoocasali brunoocasali approved these changes

@mdubus mdubus Awaiting requested review from mdubus

Assignees

No one assigned

Labels

skip-changelog The PR will not appear in the release changelogs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@meili-bot @bidoubiwa @brunoocasali