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

Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response #144

Merged
merged 2 commits into from
May 17, 2022
Merged

Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8aad17b
Rename 202 uid to taskUid
gmourier Apr 21, 2022
f452648
Update text/0060-tasks-api.md
gmourier May 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -850,7 +850,7 @@ components:
examples:
Example:
value:
uid: 0
taskUid: 0
indexUid: movies
status: enqueued
enqueuedAt: '2021-07-19T14:31:16.920473Z'
Expand Down
10 changes: 5 additions & 5 deletions text/0060-tasks-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down