Skip to content
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.

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

Add uid to the generateTenantToken method #187

Merged
merged 1 commit into from
Jun 22, 2022

Conversation

brunoocasali
Copy link
Member

Now we need to inform a uid from a given API key, this PR makes everything work.

@brunoocasali brunoocasali added the breaking-change The related changes are breaking for the users label Jun 22, 2022
@brunoocasali brunoocasali requested a review from alallema June 22, 2022 19:55
@brunoocasali brunoocasali marked this pull request as ready for review June 22, 2022 19:55
@brunoocasali
Copy link
Member Author

@alallema I'll merge this, but I still want your feedback :)

@brunoocasali brunoocasali merged commit 6468637 into bump-meilisearch-v0.28.0 Jun 22, 2022
@brunoocasali brunoocasali deleted the tenant-token-with-uid branch June 22, 2022 20:36
bors bot added a commit that referenced this pull request Jul 11, 2022
189: Update version for the next release (v0.6.0) r=brunoocasali a=brunoocasali

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

## 💥  Breaking changes
- `MeiliSearchClient#getDumpStatus` method was removed. (#173) `@brunoocasali`
- `MeiliSearchClient#getIndexes` method now return a object type `Result<MeiliSearchIndex>`. (#183) `@brunoocasali`
- `TaskInfo`, `TaskImpl`, `ClientTaskImpl` are now just `Task`. (#185) `@brunoocasali`
  - The method `getStatus` was removed in the new class.
- `MeiliSearchClient#generateTenantToken` now require a `String uid` which is the `uid` of the `Key` instance used to sign the token.  (#187) `@brunoocasali`
- `MeiliSearchClient#createDump` now responds with `Task`. (#181) `@brunoocasali`
- `MeiliSearchClient#getKeys` method now return a object type `Result<Key>`.  (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#updateKey` now can just update a `description` and/or `name`. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#search` `facetsDistribution` is now `facets` (#175) `@brunoocasali`
- `MeiliSearchIndex#search` `matches` is now `showMatchesPosition` (#175) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` method now return a object type `Future<Result>`.
- `MeiliSearchIndex#getDocuments` method now accepts a object as a parameter and `offset`, `limit`, `attributesToRetrieve` were not longer accepted.
- `nbHits`, `exhaustiveNbHits`, `facetsDistribution`, `exhaustiveFacetsCount` were removed from `SearchResult`. (#175) `@brunoocasali`

## 🚀  Enhancements
- `MeiliSearchClient#getIndexes` accepts a object `IndexesQuery` to filter and paginate the results.
- `MeiliSearchClient#getKeys` accepts a object `KeysQuery` to filter and paginate the results. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getKey` accepts both a `Key#uid` or `Key#key` value. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchIndex#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchClient#createKey` can specify a `uid` (optionally) to create a new `Key`. (#186), (#182) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` accepts a object `DocumentsQuery` to filter and paginate the results. (#184) `@brunoocasali`
- `Key` has now a `name` and `uid` string fields. (#186), (#182) `@brunoocasali`
- `estimatedTotalHits`, `facetDistribution` were added to `SearchResult` (#175) `@brunoocasali`
- Sending a invalid `uid` or `apiKey` will raise `InvalidApiKeyException`. (#187) `@brunoocasali`
- Remove unused generic T in search method (#176) `@ShakyaCsun`

## 💅  Misc

- Improve Docker configuration in the package (#164) `@brunoocasali` 
- Add test for `filter` paramter with spaces (#179) `@ShakyaCsun`
- Improve pub spec score points (#171) `@brunoocasali`

Thanks again to `@ShakyaCsun,` `@brunoocasali,` `@dependabot` ! 🎉

Co-authored-by: Bruno Casali <[email protected]>
bors bot added a commit that referenced this pull request Jul 11, 2022
189: Update version for the next release (v0.6.0) r=brunoocasali a=brunoocasali

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

## 💥  Breaking changes
- `MeiliSearchClient#getDumpStatus` method was removed. (#173) `@brunoocasali`
- `MeiliSearchClient#getIndexes` method now return a object type `Result<MeiliSearchIndex>`. (#183) `@brunoocasali`
- `TaskInfo`, `TaskImpl`, `ClientTaskImpl` are now just `Task`. (#185) `@brunoocasali`
  - The method `getStatus` was removed in the new class.
- `MeiliSearchClient#generateTenantToken` now require a `String uid` which is the `uid` of the `Key` instance used to sign the token.  (#187) `@brunoocasali`
- `MeiliSearchClient#createDump` now responds with `Task`. (#181) `@brunoocasali`
- `MeiliSearchClient#getKeys` method now return a object type `Result<Key>`.  (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#updateKey` now can just update a `description` and/or `name`. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#search` `facetsDistribution` is now `facets` (#175) `@brunoocasali`
- `MeiliSearchIndex#search` `matches` is now `showMatchesPosition` (#175) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` method now return a object type `Future<Result>`.
- `MeiliSearchIndex#getDocuments` method now accepts a object as a parameter and `offset`, `limit`, `attributesToRetrieve` were not longer accepted.
- `nbHits`, `exhaustiveNbHits`, `facetsDistribution`, `exhaustiveFacetsCount` were removed from `SearchResult`. (#175) `@brunoocasali`

## 🚀  Enhancements
- `MeiliSearchClient#getIndexes` accepts a object `IndexesQuery` to filter and paginate the results.
- `MeiliSearchClient#getKeys` accepts a object `KeysQuery` to filter and paginate the results. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getKey` accepts both a `Key#uid` or `Key#key` value. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchIndex#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchClient#createKey` can specify a `uid` (optionally) to create a new `Key`. (#186), (#182) `@brunoocasali`
- `MeiliSearchIndex#getDocument` accepts a list of fields to reduce the final payload.
- `MeiliSearchIndex#getDocuments` accepts a object `DocumentsQuery` to filter and paginate the results. (#184) `@brunoocasali`
- `Key` has now a `name` and `uid` string fields. (#186), (#182) `@brunoocasali`
- `estimatedTotalHits`, `facetDistribution` were added to `SearchResult` (#175) `@brunoocasali`
- Sending a invalid `uid` or `apiKey` will raise `InvalidApiKeyException`. (#187) `@brunoocasali`
- Remove unused generic T in search method (#176) `@ShakyaCsun`

## 💅  Misc

- Improve Docker configuration in the package (#164) `@brunoocasali` 
- Add test for `filter` paramter with spaces (#179) `@ShakyaCsun`
- Improve pub spec score points (#171) `@brunoocasali`

Thanks again to `@ShakyaCsun,` `@brunoocasali,` `@dependabot` ! 🎉

Co-authored-by: Bruno Casali <[email protected]>
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.

1 participant