Skip to content

Update Keys API for Meilisearch v.28 #517

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 9 commits into from
Jan 5, 2023
Merged

Update Keys API for Meilisearch v.28 #517

merged 9 commits into from
Jan 5, 2023

Conversation

alallema
Copy link
Contributor

@alallema alallema commented Dec 28, 2022 •
edited
Loading

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
@alallema alallema mentioned this pull request Dec 28, 2022
Merged
bidoubiwa
bidoubiwa suggested changes Jan 4, 2023
View reviewed changes
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

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
Merged
6 tasks
@alallema alallema requested a review from bidoubiwa January 5, 2023 12:23
@alallema alallema requested a review from bidoubiwa January 5, 2023 12:59
bidoubiwa
bidoubiwa approved these changes Jan 5, 2023
View reviewed changes
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

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
@alallema alallema mentioned this pull request Jan 17, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brunoocasali brunoocasali brunoocasali requested changes

@bidoubiwa bidoubiwa bidoubiwa approved these changes

Assignees
No one assigned
Labels
breaking-change The related changes are breaking for the users
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alallema @brunoocasali @bidoubiwa