Skip to content

Update Keys API for Meilisearch v.28 - #517

Merged
alallema merged 9 commits into
bump-meilisearch-v0.28.0from
keys_changes
Jan 5, 2023
Merged

alallema merged 9 commits into
bump-meilisearch-v0.28.0from
keys_changes

Conversation

@alallema

@alallema alallema commented Dec 28, 2022 •

Copy link
Copy Markdown
Contributor

Pull Request

Related to: meilisearch/integration-guides#205

What does this PR do?

Breaking because enforces the users to use Meilisearch v0.28.0

Changes

  • PATCH /keys/:uid_or_key can update only name and description fields.
  • Add new :name and :uid attributes in Keys class
  • client.getKeys() accept pagination metadata, added limit (default: 20), offset (default: 0).
  • Creation of KeyUpdate class
  • Creation of KeysQuery class
  • Wrap the Keys objects in a Results object

@alallema
alallema changed the base branch from main to bump-meilisearch-v0.28.0 December 28, 2022 11:52
@alallema
alallema marked this pull request as ready for review December 28, 2022 11:57

@bidoubiwa bidoubiwa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you change the name of the PR with more context? For example

Update Keys API for Meilisearch v.28


Could you double check the documentation above the methods? I maybe forgot to suggest some changes

@alallema alallema changed the title Keys changes Update Keys API for Meilisearch v.28 Jan 4, 2023
@bidoubiwa bidoubiwa mentioned this pull request Jan 4, 2023
6 tasks done
alallema and others added 3 commits January 4, 2023 16:25
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
alallema and others added 4 commits January 5, 2023 13:54
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
@alallema
alallema requested a review from bidoubiwa January 5, 2023 12:59

@bidoubiwa bidoubiwa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 🔥🔥🔥🔥🔥 GREAT WORK

@alallema
alallema merged commit 041fdfa into bump-meilisearch-v0.28.0 Jan 5, 2023
@alallema
alallema deleted the keys_changes branch January 5, 2023 15:35
@alallema alallema added the breaking-change The related changes are breaking for the users label Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change The related changes are breaking for the users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants