Skip to content

fix(specs): deprecate task v1 [skip-bc] #4327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion specs/ingestion/paths/tasks/v1/disableTask.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
put:
tags:
- tasks
summary: Disable a task
summary: Disable a task V1
description: Disables a task using the v1 endpoint, please use `disableTask` instead.
operationId: disableTaskV1
deprecated: true
Expand Down
3 changes: 2 additions & 1 deletion specs/ingestion/paths/tasks/v1/enableTask.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
put:
tags:
- tasks
summary: Enable a task
summary: Enable a task V1
description: Enables a task using the v1 endpoint, please use `enableTask` instead.
operationId: enableTaskV1
deprecated: true
x-acl:
- addObject
- deleteIndex
Expand Down
3 changes: 2 additions & 1 deletion specs/ingestion/paths/tasks/v1/runTask.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
post:
tags:
- tasks
summary: Run a task
summary: Run a task V1
description: Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
operationId: runTaskV1
deprecated: true
x-acl:
- addObject
- deleteIndex
Expand Down
3 changes: 2 additions & 1 deletion specs/ingestion/paths/tasks/v1/searchTasks.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
post:
tags:
- tasks
summary: Search for tasks
summary: Search for tasks V1
description: Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
operationId: searchTasksV1
deprecated: true
x-acl:
- addObject
- deleteIndex
Expand Down
7 changes: 5 additions & 2 deletions specs/ingestion/paths/tasks/v1/taskID.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
get:
tags:
- tasks
summary: Retrieve a task
summary: Retrieve a task V1
description: Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
operationId: getTaskV1
deprecated: true
x-acl:
- addObject
- deleteIndex
Expand All @@ -23,9 +24,10 @@ get:
patch:
tags:
- tasks
summary: Update a task
summary: Update a task V1
description: Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
operationId: updateTaskV1
deprecated: true
parameters:
- $ref: '../../../common/parameters.yml#/pathTaskID'
x-codegen-request-body-name: taskUpdate
Expand All @@ -51,6 +53,7 @@ delete:
summary: Delete a task
description: Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
operationId: deleteTaskV1
deprecated: true
parameters:
- $ref: '../../../common/parameters.yml#/pathTaskID'
responses:
Expand Down
6 changes: 4 additions & 2 deletions specs/ingestion/paths/tasks/v1/tasks.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
get:
tags:
- tasks
summary: List tasks
summary: List tasks V1
description: Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
operationId: listTasksV1
deprecated: true
x-acl:
- addObject
- deleteIndex
Expand Down Expand Up @@ -44,9 +45,10 @@ get:
post:
tags:
- tasks
summary: Create a task
summary: Create a task V1
description: Creates a new task using the v1 endpoint, please use `createTask` instead.
operationId: createTaskV1
deprecated: true
x-codegen-request-body-name: taskCreate
requestBody:
description: Request body for creating a task.
Expand Down
24 changes: 12 additions & 12 deletions specs/ingestion/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,18 +144,6 @@ paths:
$ref: 'paths/sources/runSource.yml'

# tasks API.
/1/tasks:
$ref: 'paths/tasks/v1/tasks.yml'
/1/tasks/search:
$ref: 'paths/tasks/v1/searchTasks.yml'
/1/tasks/{taskID}:
$ref: 'paths/tasks/v1/taskID.yml'
/1/tasks/{taskID}/run:
$ref: 'paths/tasks/v1/runTask.yml'
/1/tasks/{taskID}/enable:
$ref: 'paths/tasks/v1/enableTask.yml'
/1/tasks/{taskID}/disable:
$ref: 'paths/tasks/v1/disableTask.yml'
/2/tasks:
$ref: 'paths/tasks/v2/tasks.yml'
/2/tasks/search:
Expand All @@ -170,6 +158,18 @@ paths:
$ref: 'paths/tasks/v2/enableTask.yml'
/2/tasks/{taskID}/disable:
$ref: 'paths/tasks/v2/disableTask.yml'
/1/tasks:
$ref: 'paths/tasks/v1/tasks.yml'
/1/tasks/search:
$ref: 'paths/tasks/v1/searchTasks.yml'
/1/tasks/{taskID}:
$ref: 'paths/tasks/v1/taskID.yml'
/1/tasks/{taskID}/run:
$ref: 'paths/tasks/v1/runTask.yml'
/1/tasks/{taskID}/enable:
$ref: 'paths/tasks/v1/enableTask.yml'
/1/tasks/{taskID}/disable:
$ref: 'paths/tasks/v1/disableTask.yml'

# transformations API.
/1/transformations:
Expand Down