Tasks API - Rename uid to taskUid in the 202 - Accepted Summari…

…zed 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]>
meilisearch · May 17, 2022 · e36c626 · e36c626
1 parent f667b57
commit e36c626
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/open-api.yaml b/open-api.yaml
@@ -828,9 +828,9 @@ components:
           schema:
             type: object
             properties:
-              uid:
+              taskUid:
                 type: number
-                description: 'This `uid` allows you to [track the current task](https://docs.meilisearch.com/reference/api/tasks.html).'
+                description: 'This `taskUid` allows you to [track the current task](https://docs.meilisearch.com/reference/api/tasks.html).'
               indexUid:
                 type: string
                 description: The unique identifier of the index where this task is operated
@@ -850,7 +850,7 @@ components:
           examples:
             Example:
               value:
-                uid: 0
+                taskUid: 0
                 indexUid: movies
                 status: enqueued
                 enqueuedAt: '2021-07-19T14:31:16.920473Z'

diff --git a/text/0060-tasks-api.md b/text/0060-tasks-api.md
@@ -75,7 +75,7 @@ The motivation is to stabilize the current `update` resource to a version that c
 
 | field      | type    | description                     |
 |------------|---------|---------------------------------|
-| uid        | integer | Unique sequential identifier           |
+| taskUid    | integer | Unique sequential identifier |
 | indexUid   | string | Unique index identifier |
 | status     | string  | Status of the task. Value is `enqueued` |
 | 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
 
 ```json
 {
-    "uid": 0,
+    "taskUid": 0,
     "indexUid": "movies",
     "status": "enqueued",
     "type": "createIndex",
@@ -524,7 +524,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
 
 ```json
 {
-    "uid": 0,
+    "taskUid": 0,
     "indexUid": "movies",
     "status": "enqueued",
     "type": "indexCreation",
@@ -546,7 +546,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
 
 ```json
 {
-    "uid": 1,
+    "taskUid": 1,
     "indexUid": "movies",
     "status": "enqueued",
     "type": "indexUpdate",
@@ -560,7 +560,7 @@ New task types are also added for these operations. `indexCreation`, `indexUpdat
 
 ```json
 {
-    "uid": 1,
+    "taskUid": 1,
     "indexUid": "movies",
     "status": "enqueued",
     "type": "indexDeletion",