Update tasks routes #1259
Merged
Update tasks routes #1259
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bidoubiwa
force-pushed
the
update_task_route
branch
from
c655384 to
6058a5e
Compare
bidoubiwa
commented
Jun 14, 2022
Comment on lines
+92
to
+93
| const { results } = await this.getRawIndexes() | ||
| const indexes: Index[] = results.map( |
There was a problem hiding this comment.
needed to be change to be able to run the tasks tests 😕
bidoubiwa
commented
Jun 14, 2022
Comment on lines
+105
to
+107
| async getRawIndexes(): Promise<Result<IndexResponse[]>> { | ||
| const url = `indexes` | ||
| return await this.httpRequest.get<IndexResponse[]>(url) | ||
| return await this.httpRequest.get<Result<IndexResponse[]>>(url) |
There was a problem hiding this comment.
needed to be change to be able to run the tasks tests 😕
bidoubiwa
force-pushed
the
update_task_route
branch
from
b305057 to
b626044
Compare
bidoubiwa
force-pushed
the
update_task_route
branch
from
b626044 to
b160c8b
Compare
bidoubiwa
added
the
breaking-change
mdubus
reviewed
Jun 15, 2022
Comment on lines
+25
to
+27
| * @returns { Promise<Result<Task[]>> } | ||
| */ | ||
| async getTask(uid: number): Promise<Task> { |
There was a problem hiding this comment.
The "jsdoc return" doesn't match the one of the function
| return await this.httpRequest.get<Result<Task[]>>( | ||
| url, | ||
| removeUndefinedFromObject(queryParams) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Wait for a task to be processed. | ||
| * | ||
| * @param {number} uid Task identifier |
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Waits for multiple tasks to be processed | ||
| * | ||
| * @param {number} taskIds Tasks identifier list | ||
| * @param {number} taskUids Tasks identifier list |
meili-bors bot
added a commit
that referenced
this pull request
Jul 11, 2022
1294: Update version for the next release (v0.27.0) r=bidoubiwa a=bidoubiwa 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 - `client.updateKey(key: string, options: KeyPayload): Promise<Key>` now can just update the `description` and/or the name. #1266 - The type `EnqueuedTask` now returns an `taskUid` instead of an `uid` - `client.getTasks(...)` and `index.getTasks()` now returns a TasksResults type containing the following fields: `results`, `limit`, `from`, `next` #1269 - `index.search` changes in the response parameters: #1263 - `nbHits` replaced with `estimatedTotalHits` - `exhaustiveNbHits` is deleted - `exhaustiveFacetsCount` is deleted - `index.search` changes in the request parameters: #1263 - `matches` renamed `showMatchesPosition` - `_matchesInfo` response parameter is renamed `_matchesPosition` - `facetsDistribution` request parameter is renamed `facets`. - `facetsDistribution` response parameter is renamed `facetDistribution`. - The `Index` type and returned `IndexObject` does not contain a `name` field anymore - `client.getIndexes` and `client.getRawIndexes` now returns an `IndexesResults` type containing the following fields: `results`, `limit`, `offset`, `total` #1269 - `index.getDocuments` and `client.getDocuments` now returns an `DocumentsResults` type containing the following fields: `results`, `limit`, `offset`, `total` #1269 - `index.getDocuments` and `index.getDocument` query parameter `attributesToRetrieve` is now called `fields` #1264 - `client.getDumpStatus` has been removed #1267 - `client.createDump()` now returns an `EnqueuedTask` #1267 - `client.generateTenantToken(apiKeyUid, searchRules, options)` has now a mandatory `apiKeyUid` parameter which should contain the uid of a specific API key. #1268 ## 🚀 Enhancements - `client.getKeys(parameters: KeysQuery = {})` now accepts pagination parameters: `limit`, `offset` #1269 - `client.getKey(keyOrUid: string)` can now also find keys based on their key uid. #1266 - `client.createKey(options: KeyCreation)` lets you specify a custom uid (optionally) to create a new Key #1269 - The returned `Key` now has an additional `name` and `uid` string fields. #1266 - The `indexUid` field in both `EnqueuedTask` and `Task` can be null #1259 - `client.getTasks(parameters: TasksQuery = {})` and `index.getTasks(parameters: TasksQuery)` now accepts pagination parameters: `limit`, `from`, `next` and filters parameters: `type`, `status`, `indexUid` (same for `index.getTasks`) #1269 - `client.getIndexes` and `client.getRawIndexes` now accepts pagination parameters: `limit`, `offset` #1269 - `index.getDocuments` now accepts pagination parameters: `limit`, `offset` #1269 - `new MeiliSearch({ host, apiKey, headers, clientAgents })` now accept a new parameter `clientAgents` that should contain the agent from which the library is used. #1272 Analytics is enabled by default in the server, but you can disable them by following [this guide](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html#how-to-disable-data-collection) Also, of course, every analytics data we collect are **ANONYMOUS** [read the guide for more information](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html). Thanks again to `@bidoubiwa` ! 🎉 Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Related to: meilisearch/integration-guides#205
What does this PR do?
Routes changes
GET /indexes/:indexUid/tasks. UseGET /tasks?indexUid=:indexUidinstead.GET /indexes/:indexUid/tasks/:taskUid. UseGET /tasks/:taskUidinstead.index.getTask&index.waitForTasknow useGET /tasks/:task_uidindex.getTasks&index.waitForTasksnow useGET/tasks?indexUid=moviesNaming changes
Filtering
index.getTasksandclient.getTaskscan filter on type status and indexUid