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

Tasks API - Filter tasks list by type/status/indexUid #116

Merged
merged 6 commits into from
Jul 7, 2022
Merged

Tasks API - Filter tasks list by type/status/indexUid #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
34de968
move filtering tasks by status/type parameter to task api spec
gmourier Feb 21, 2022
7789cd2
Update specification
gmourier Apr 21, 2022
8f50ff8
Add details about case-sensitivy + rework error message
gmourier May 23, 2022
c2df7e1
Introducing naming changes plus make the specification a source of tr…
gmourier May 25, 2022
a0d688a
Remove a future possibility being introduced
gmourier May 25, 2022
4d3ebdd
misc - replace createIndex to the right type and add the missing type…
gmourier Jun 14, 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
146 changes: 36 additions & 110 deletions open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ components:
indexUid: movies
batchUid: 0
status: succeeded
type: documentAddition
type: documentAdditionOrUpdate
details:
receivedDocuments: 10
indexedDocuments: 10
Expand Down Expand Up @@ -314,30 +314,28 @@ components:
type: string
description: The type of the task
enum:
- documentAddition
- documentPartial
- documentAdditionOrUpdate
- documentDeletion
- indexCreation
- indexUpdate
- indexDeletion
- settingsUpdate
- clearAll
details:
type: object
description: Details information of the task payload.
properties:
receivedDocuments:
type: integer
description: Number of documents received for documentAddition or documentPartial task.
description: Number of documents received for documentAdditionOrUpdate task.
indexedDocuments:
type: integer
description: Number of documents finally indexed for documentAddition or documentPartial task or if batched, in the batchUid.
description: Number of documents finally indexed for documentAdditionOrUpdate task or if batched, in the batchUid.
receivedDocumentsIds:
type: integer
description: Number of document ids received for documentDeletion task.
deletedDocuments:
type: integer
description: 'Number of documents finally deleted for documentDeletion, indexDeletion or clearAll task.'
description: 'Number of documents finally deleted for documentDeletion and indexDeletion tasks.'
primaryKey:
type: string
description: Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
Expand Down Expand Up @@ -681,6 +679,27 @@ components:
required: true
schema:
type: number
taskIndexUid:
name: indexUid
in: path
description: Permits to filter tasks by their related index. By default, when `indexUid` query parameter is not set, the tasks of all the indexes are returned. It is possible to specify several indexes by separating them with the `,` character.
required: false
schema:
type: string
taskType:
name: type
in: path
description: Permits to filter tasks by their related type. By default, when `type` query parameter is not set, all task types are returned. It's possible to specify several types by separating them with the `,` character.
required: false
schema:
type: string
taskStatus:
name: status
in: path
description: Permits to filter tasks by their status. By default, when `status` query parameter is not set, all task statuses are returned. It's possible to specify several types by separating them with the `,` character.
required: false
schema:
type: string
primaryKey:
name: primaryKey
in: query
Expand Down Expand Up @@ -856,6 +875,10 @@ components:
type: string
description: The status of the task
example: enqueued
type:
type: string
description: The type of the task
example: indexCreation
enqueuedAt:
$ref: '#/components/schemas/timestamp'
description: Represent the date and time as `RFC 3339` format when the task has been enqueued
Expand Down Expand Up @@ -2535,106 +2558,6 @@ paths:
description: Not Found
parameters:
- $ref: '#/components/parameters/indexUid'
'/indexes/{indexUid}/tasks':
get:
operationId: indexes.tasks.list
summary: Get all tasks of an index
description: |
Get all [tasks](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) of an [index](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
tags:
- Tasks
security:
- apiKey: []
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/task'
examples:
Example:
value:
results:
- uid: 1
indexUid: movies,
batchUid: 1
status: succeeded
type: documentAddition
details:
receivedDocuments: 79000
indexedDocuments: 79000
duration: PT2S
enqueuedAt: '2021-01-01T09:39:00.000000Z'
startedAt: '2021-01-01T09:39:01.000000Z'
finishedAt: '2021-01-01T09:39:02.000000Z'
- uid: 0
indexUid: movies
batchUid: 0
status: failed
type: documentAddition
details:
receivedDocuments: 67493
indexedDocuments: 0
error:
message: 'Document does not have a `:primaryKey` attribute: `:documentRepresentation`.'
code: missing_document_id
type: invalid_request
link: 'https://docs.meilisearch.com/errors#missing_document_id'
duration: PT5S
enqueuedAt: '2021-01-01T09:38:00.000000Z'
startedAt: '2021-01-01T09:38:02.000000Z'
finishedAt: '2021-01-01T09:38:07.000000Z'
'401':
$ref: '#/components/responses/401'
'404':
description: Not Found
parameters:
- $ref: '#/components/parameters/indexUid'
'/indexes/{indexUid}/tasks/{taskUid}':
get:
operationId: indexes.tasks.get
summary: Get a task of an index
description: |
Get a [task](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) of an [index](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
tags:
- Tasks
security:
- apiKey: []
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/task'
examples:
Example:
value:
uid: 1
indexUid: movies
batchUid: 1
status: succeeded
type: documentAddition
details:
receivedDocuments: 79000
indexedDocuments: 79000
duration: PT1S
enqueuedAt: '2021-01-01T09:39:00.000000Z'
startedAt: '2021-01-01T09:39:01.000000Z'
finishedAt: '2021-01-01T09:39:02.000000Z'
'401':
$ref: '#/components/responses/401'
'404':
description: Not Found
parameters:
- $ref: '#/components/parameters/indexUid'
- $ref: '#/components/parameters/taskUid'
/keys:
get:
operationId: keys.list
Expand Down Expand Up @@ -2919,7 +2842,7 @@ paths:
indexUid: movies
batchUid: 1
status: succeeded
type: documentAddition
type: documentAdditionOrUpdate
details:
receivedDocuments: 79000
indexedDocuments: 79000
Expand All @@ -2931,7 +2854,7 @@ paths:
indexUid: movies_Review
batchUid: 0
status: failed
type: documentAddition
type: documentAdditionOrUpdate
details:
receivedDocuments: 67493
indexedDocuments: 0
Expand All @@ -2951,6 +2874,9 @@ paths:
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/from'
- $ref: '#/components/parameters/taskIndexUid'
- $ref: '#/components/parameters/taskStatus'
- $ref: '#/components/parameters/taskType'
security:
- apiKey: []
'/tasks/:taskUid':
Expand All @@ -2973,7 +2899,7 @@ paths:
indexUid: movies
batchUid: 1
status: succeeded
type: documentAddition
type: documentAdditionOrUpdate
details:
receivedDocuments: 79000
indexedDocuments: 79000
Expand Down
19 changes: 9 additions & 10 deletions text/0034-telemetry-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
| TypoTolerance Updated | Occurs when typo tolerance settings are updated via `POST` - `/indexes/:indexUid/settings/typo-tolerance`. |
| Dump Created | Occurs when a dump is created via `POST` - `/dumps`. |
| Tasks Seen | Occurs when tasks are fetched globally via `GET` - `/tasks`. |
| Index Tasks Seen | Occurs when tasks are filtered by index via `GET` - `/indexes/:indexUid/tasks`. |

----

#### Summarized Metrics/Events table
Expand Down Expand Up @@ -128,8 +128,11 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
| `typo_tolerance.disable_on_words` | `true` if at least one value is defined | `false` | `Settings Updated`, `TypoTolerance Updated` |
| `typo_tolerance.min_word_size_for_typos.one_typo` | The defined value for `minWordSizeForTypos.oneTypo` property | `5` | `Settings Updated`, `TypoTolerance Updated` |
| `typo_tolerance.min_word_size_for_typos.two_typos`| The defined value for `minWordSizeForTypos.twoTypos` property | `9` | `Settings Updated`, `TypoTolerance Updated` |
| `per_task_uid` | `true` if an uid is used to fetch a particular task resource, otherwise `false` | true | `Tasks Seen`, `Index Tasks Seen` |
|
| `per_task_uid` | `true` if an uid is used to fetch a particular task resource, otherwise `false` | true | `Tasks Seen` |
| `filtered_by_index_uid` | `true` if `GET /tasks` endpoint is filered by `indexUid`, otherwise `false` | false | `Tasks Seen` |
| `filtered_by_type` | `true` if `GET /tasks` endpoint is filered by `type`, otherwise `false` | false | `Tasks Seen` |
| `filtered_by_status` | `true` if `GET /tasks` endpoint is filered by `status`, otherwise `false` | false | `Tasks Seen` |


----

Expand Down Expand Up @@ -367,13 +370,9 @@ This property allows us to gather essential information to better understand on
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | `["Meilisearch Ruby (v2.1)", "Ruby (3.0)"]` |
| per_task_uid | `true` if an uid is used to fetch a particular task resource, otherwise `false` | `true` |

## `Index Tasks Seen`

| Property name | Description | Example |
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | `["Meilisearch Ruby (v2.1)", "Ruby (3.0)"]` |
| per_task_uid | `true` if an uid is used to fetch a particular task resource, otherwise `false` | `true` |
| filtered_by_index_uid | `true` if `GET /tasks` endpoint is filered by `indexUid`, otherwise `false` | `false` |
| filtered_by_type | `true` if `GET /tasks` endpoint is filered by `type`, otherwise `false` | `false` |
| filtered_by_status | `true` if `GET /tasks` endpoint is filered by `status`, otherwise `false` | `false` |

---

Expand Down
Loading