Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit 5af2af4

Browse files
gmourierbidoubiwa
andcommitted
Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response (#144)
* Rename 202 uid to taskUid * Update text/0060-tasks-api.md Co-authored-by: cvermand <[email protected]> Co-authored-by: cvermand <[email protected]>
1 parent d6b433a commit 5af2af4

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

open-api.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -838,9 +838,9 @@ components:
838838
schema:
839839
type: object
840840
properties:
841-
uid:
841+
taskUid:
842842
type: number
843-
description: 'This `uid` allows you to [track the current task](https://docs.meilisearch.com/reference/api/tasks.html).'
843+
description: 'This `taskUid` allows you to [track the current task](https://docs.meilisearch.com/reference/api/tasks.html).'
844844
indexUid:
845845
type: string
846846
description: The unique identifier of the index where this task is operated
@@ -860,7 +860,7 @@ components:
860860
examples:
861861
Example:
862862
value:
863-
uid: 0
863+
taskUid: 0
864864
indexUid: movies
865865
status: enqueued
866866
enqueuedAt: '2021-07-19T14:31:16.920473Z'

text/0060-tasks-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The motivation is to stabilize the current `update` resource to a version that c
7575

7676
| field | type | description |
7777
|------------|---------|---------------------------------|
78-
| uid | integer | Unique sequential identifier |
78+
| taskUid | integer | Unique sequential identifier |
7979
| indexUid | string | Unique index identifier |
8080
| status | string | Status of the task. Value is `enqueued` |
8181
| enqueuedAt | string | Represent the date and time as `RFC 3339` format when the task has been enqueued |
@@ -293,7 +293,7 @@ e.g. A summarized `task` object in a `202 Accepted` HTTP response returned at in
293293

294294
```json
295295
{
296-
"uid": 0,
296+
"taskUid": 0,
297297
"indexUid": "movies",
298298
"status": "enqueued",
299299
"type": "createIndex",
@@ -524,7 +524,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
524524

525525
```json
526526
{
527-
"uid": 0,
527+
"taskUid": 0,
528528
"indexUid": "movies",
529529
"status": "enqueued",
530530
"type": "indexCreation",
@@ -546,7 +546,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
546546

547547
```json
548548
{
549-
"uid": 1,
549+
"taskUid": 1,
550550
"indexUid": "movies",
551551
"status": "enqueued",
552552
"type": "indexUpdate",
@@ -560,7 +560,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
560560

561561
```json
562562
{
563-
"uid": 1,
563+
"taskUid": 1,
564564
"indexUid": "movies",
565565
"status": "enqueued",
566566
"type": "indexDeletion",

0 commit comments

Comments
 (0)