Skip to content

Commit 2e078ff

Browse files
guimachiavelliguimachiavelli
committed
improve wording, address reviewer feedback
1 parent f69ef6b commit 2e078ff

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

‎reference/api/documents.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ This endpoint accepts the following content types:
256256
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
257257
| **`primaryKey`** | `null` | [Primary key](/learn/getting_started/primary_key#primary-field) of the index |
258258
| **`csvDelimiter`** | `","` | Configure the character separating CSV fields. Must be a string containing [one ASCII character](https://www.rfc-editor.org/rfc/rfc20). |
259-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
259+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
260260

261261
<Warning>
262262
Configuring `csvDelimiter` and sending data with a content type other than CSV will cause Meilisearch to throw an error.
@@ -379,7 +379,7 @@ This endpoint accepts the following content types:
379379
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
380380
| **`primaryKey`** | `null` | [Primary key](/learn/getting_started/primary_key#primary-field) of the documents |
381381
| **`csvDelimiter`** | `","` | Configure the character separating CSV fields. Must be a string containing [one ASCII character](https://www.rfc-editor.org/rfc/rfc20). |
382-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
382+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
383383

384384
<Warning>
385385
Configuring `csvDelimiter` and sending data with a content type other than CSV will cause Meilisearch to throw an error.
@@ -453,7 +453,7 @@ curl \
453453
| **`function`** | `null` | A string containing a RHAI function |
454454
| **`filter`** | `null` | A string containing a filter expression |
455455
| **`context`** | `null` | An object with data Meilisearch should make available for the editing function |
456-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
456+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
457457

458458
#### `function`
459459

@@ -494,7 +494,7 @@ Delete all documents in the specified index.
494494

495495
| Query Parameter | Default Value | Description |
496496
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
497-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
497+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
498498

499499
### Example
500500

@@ -531,7 +531,7 @@ Delete one document based on its unique id.
531531

532532
| Query Parameter | Default Value | Description |
533533
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
534-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
534+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
535535

536536
### Example
537537

@@ -567,7 +567,7 @@ Delete a set of documents based on a filter.
567567

568568
| Query Parameter | Default Value | Description |
569569
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
570-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
570+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
571571

572572
### Body
573573

@@ -619,7 +619,7 @@ Delete a set of documents based on an array of document ids.
619619

620620
| Query Parameter | Default Value | Description |
621621
| :----------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- |
622-
| **`customMetadata`** | `null` | An arbitrary string accessible in the [generated task object](/reference/api/tasks#custommetadata) |
622+
| **`customMetadata`** | `null` | An arbitrary string accessible via the [generated task object](/reference/api/tasks#custommetadata) |
623623

624624
### Body
625625

‎reference/api/tasks.mdx‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ The `/tasks` route gives information about the progress of [asynchronous operati
3535
"duration": "PT0.001192S",
3636
"enqueuedAt": "2022-08-04T12:28:15.159167Z",
3737
"startedAt": "2022-08-04T12:28:15.161996Z",
38-
"finishedAt": "2022-08-04T12:28:15.163188Z",
39-
"customMetadata": null
38+
"finishedAt": "2022-08-04T12:28:15.163188Z"
4039
}
4140
```
4241

@@ -188,9 +187,7 @@ The `details` object is set to `null` for `snapshotCreation` tasks.
188187
| **`type`** | The [error type](/reference/errors/overview#errors) |
189188
| **`link`** | A link to the relevant section of the documentation |
190189

191-
### `network`
192-
193-
<NoticeTag type="experimental" label="experimental" />
190+
### `network` <NoticeTag type="experimental" label="experimental" />
194191

195192
**Type**: Object<br />
196193
**Description**: If the task was replicated from another remote or to other remotes, `network` will contain information about the remote task uids corresponding to this task. Otherwise, missing in task object.
@@ -229,8 +226,6 @@ curl \
229226
```
230227
</Note>
231228

232-
233-
234229
### `duration`
235230

236231
**Type**: String<br />

0 commit comments

Comments
 (0)