Skip to content

Commit e84dc50

Browse files
Apply suggestions from code review
Co-authored-by: Tamo <[email protected]>
1 parent 7a6e010 commit e84dc50

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

reference/api/batches.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ The `/batches` route gives information about the progress of batches of [asynchr
3232
"startedAt": "2024-12-10T15:20:30.18182Z",
3333
"finishedAt": "2024-12-10T15:20:30.432338Z",
3434
"progress": {
35-
"currentStep": [
35+
"steps": [
3636
{
37-
"name": "extracting words",
37+
"currentStep": "extracting words",
3838
"finished": 2,
3939
"total": 9,
4040
},
4141
{
42-
"name": "document",
42+
"currentStep": "document",
4343
"finished": 30546,
4444
"total": 31944,
4545
}
@@ -62,15 +62,15 @@ The `/batches` route gives information about the progress of batches of [asynchr
6262
### `progress`
6363

6464
**Type**: Object<br />
65-
**Description**: Object containing two fields: `currentStep` and `percentage`. Once Meilisearch has fully processed a batch, its `progress` is set to `null`.
65+
**Description**: Object containing two fields: `steps` and `percentage`. Once Meilisearch has fully processed a batch, its `progress` is set to `null`.
6666

67-
#### `currentStep`
67+
#### `steps`
6868

6969
Information about the current operations Meilisearch is performing in this batch. A step may consist of multiple substeps.
7070

7171
| Name | Description |
7272
| :---------------| :------------------------------------------------- |
73-
| **`name`** | A string describing the operation |
73+
| **`currentStep`** | A string describing the operation |
7474
| **`total`** | The total number of operations in the step |
7575
| **`finished`** | The number of operations Meilisearch has completed |
7676

@@ -112,7 +112,7 @@ List of the number of tasks in the batch separated by the indexes they affect.
112112
### `finishedAt`
113113

114114
**Type**: String<br />
115-
**Description**: The date and time when the task finished `processing`, whether `failed`, `succeeded`, or `canceled`, in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format
115+
**Description**: The date and time when the tasks finished `processing`, whether `failed`, `succeeded`, or `canceled`, in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format
116116

117117
## Get batches
118118

@@ -176,6 +176,7 @@ For example, `?uids=0` returns a batch containing the task with a `taskUid` equa
176176
"the"
177177
]
178178
},
179+
"progress": null,
179180
"stats": {
180181
"totalNbTasks": 1,
181182
"status": {
@@ -225,6 +226,7 @@ Get a single batch.
225226
"receivedDocuments": 1,
226227
"indexedDocuments": 1
227228
},
229+
"progress": null,
228230
"stats": {
229231
"totalNbTasks": 1,
230232
"status": {

0 commit comments

Comments
 (0)