Skip to content

Commit 7004419

Browse files
authored
fix(specs): deprecate task v1 [skip-bc] (#4327)
1 parent 31fe72f commit 7004419

File tree

7 files changed

+28
-20
lines changed

7 files changed

+28
-20
lines changed

specs/ingestion/paths/tasks/v1/disableTask.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
put:
22
tags:
33
- tasks
4-
summary: Disable a task
4+
summary: Disable a task V1
55
description: Disables a task using the v1 endpoint, please use `disableTask` instead.
66
operationId: disableTaskV1
77
deprecated: true

specs/ingestion/paths/tasks/v1/enableTask.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
put:
22
tags:
33
- tasks
4-
summary: Enable a task
4+
summary: Enable a task V1
55
description: Enables a task using the v1 endpoint, please use `enableTask` instead.
66
operationId: enableTaskV1
7+
deprecated: true
78
x-acl:
89
- addObject
910
- deleteIndex

specs/ingestion/paths/tasks/v1/runTask.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
post:
22
tags:
33
- tasks
4-
summary: Run a task
4+
summary: Run a task V1
55
description: Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
66
operationId: runTaskV1
7+
deprecated: true
78
x-acl:
89
- addObject
910
- deleteIndex

specs/ingestion/paths/tasks/v1/searchTasks.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
post:
22
tags:
33
- tasks
4-
summary: Search for tasks
4+
summary: Search for tasks V1
55
description: Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
66
operationId: searchTasksV1
7+
deprecated: true
78
x-acl:
89
- addObject
910
- deleteIndex

specs/ingestion/paths/tasks/v1/taskID.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
get:
22
tags:
33
- tasks
4-
summary: Retrieve a task
4+
summary: Retrieve a task V1
55
description: Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
66
operationId: getTaskV1
7+
deprecated: true
78
x-acl:
89
- addObject
910
- deleteIndex
@@ -23,9 +24,10 @@ get:
2324
patch:
2425
tags:
2526
- tasks
26-
summary: Update a task
27+
summary: Update a task V1
2728
description: Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
2829
operationId: updateTaskV1
30+
deprecated: true
2931
parameters:
3032
- $ref: '../../../common/parameters.yml#/pathTaskID'
3133
x-codegen-request-body-name: taskUpdate
@@ -51,6 +53,7 @@ delete:
5153
summary: Delete a task
5254
description: Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
5355
operationId: deleteTaskV1
56+
deprecated: true
5457
parameters:
5558
- $ref: '../../../common/parameters.yml#/pathTaskID'
5659
responses:

specs/ingestion/paths/tasks/v1/tasks.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
get:
22
tags:
33
- tasks
4-
summary: List tasks
4+
summary: List tasks V1
55
description: Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
66
operationId: listTasksV1
7+
deprecated: true
78
x-acl:
89
- addObject
910
- deleteIndex
@@ -44,9 +45,10 @@ get:
4445
post:
4546
tags:
4647
- tasks
47-
summary: Create a task
48+
summary: Create a task V1
4849
description: Creates a new task using the v1 endpoint, please use `createTask` instead.
4950
operationId: createTaskV1
51+
deprecated: true
5052
x-codegen-request-body-name: taskCreate
5153
requestBody:
5254
description: Request body for creating a task.

specs/ingestion/spec.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -144,18 +144,6 @@ paths:
144144
$ref: 'paths/sources/runSource.yml'
145145

146146
# tasks API.
147-
/1/tasks:
148-
$ref: 'paths/tasks/v1/tasks.yml'
149-
/1/tasks/search:
150-
$ref: 'paths/tasks/v1/searchTasks.yml'
151-
/1/tasks/{taskID}:
152-
$ref: 'paths/tasks/v1/taskID.yml'
153-
/1/tasks/{taskID}/run:
154-
$ref: 'paths/tasks/v1/runTask.yml'
155-
/1/tasks/{taskID}/enable:
156-
$ref: 'paths/tasks/v1/enableTask.yml'
157-
/1/tasks/{taskID}/disable:
158-
$ref: 'paths/tasks/v1/disableTask.yml'
159147
/2/tasks:
160148
$ref: 'paths/tasks/v2/tasks.yml'
161149
/2/tasks/search:
@@ -170,6 +158,18 @@ paths:
170158
$ref: 'paths/tasks/v2/enableTask.yml'
171159
/2/tasks/{taskID}/disable:
172160
$ref: 'paths/tasks/v2/disableTask.yml'
161+
/1/tasks:
162+
$ref: 'paths/tasks/v1/tasks.yml'
163+
/1/tasks/search:
164+
$ref: 'paths/tasks/v1/searchTasks.yml'
165+
/1/tasks/{taskID}:
166+
$ref: 'paths/tasks/v1/taskID.yml'
167+
/1/tasks/{taskID}/run:
168+
$ref: 'paths/tasks/v1/runTask.yml'
169+
/1/tasks/{taskID}/enable:
170+
$ref: 'paths/tasks/v1/enableTask.yml'
171+
/1/tasks/{taskID}/disable:
172+
$ref: 'paths/tasks/v1/disableTask.yml'
173173

174174
# transformations API.
175175
/1/transformations:

0 commit comments

Comments
 (0)