-
Notifications
You must be signed in to change notification settings - Fork 13
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
feat(specs): add v2 endpoints for ingestion #3410
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a0ca699
feat(specs): add v2 endpoints for ingestion
shortcuts 0bd3c11
fix: body request name
shortcuts ff40c85
Merge branch 'main' into feat/ingestion-tasks-v2
shortcuts 3a63165
Merge branch 'main' into feat/ingestion-tasks-v2
shortcuts cac7fe6
fix: test names
shortcuts cf6bf23
fix: v1 response
shortcuts 3f317fd
fix(specs): rename ingestion list methods (#3411)
shortcuts ed1fdf1
Merge branch 'main' into feat/ingestion-tasks-v2
shortcuts f157c63
Merge branch 'main' into feat/ingestion-tasks-v2
shortcuts File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
put: | ||
tags: | ||
- tasks | ||
summary: Disable a task | ||
description: Disables a task using the v1 endpoint, please use `disableTask` instead. | ||
operationId: disableTaskV1 | ||
deprecated: true | ||
x-acl: | ||
- addObject | ||
- deleteIndex | ||
- editSettings | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
put: | ||
tags: | ||
- tasks | ||
summary: Enable a task | ||
description: Enables a task using the v1 endpoint, please use `enableTask` instead. | ||
operationId: enableTaskV1 | ||
x-acl: | ||
- addObject | ||
- deleteIndex | ||
- editSettings | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
post: | ||
tags: | ||
- tasks | ||
summary: Run a task | ||
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 | ||
x-acl: | ||
- addObject | ||
- deleteIndex | ||
- editSettings | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/run.yml#/RunResponse' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
post: | ||
tags: | ||
- tasks | ||
summary: Search for tasks | ||
description: Searches for tasks using the v1 endpoint, please use `searchTasks` instead. | ||
operationId: searchTasksV1 | ||
x-acl: | ||
- addObject | ||
- deleteIndex | ||
- editSettings | ||
requestBody: | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskSearch' | ||
required: true | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
title: searchTasksResponseV1 | ||
type: array | ||
items: | ||
$ref: '../../../common/schemas/task.yml#/TaskV1' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
get: | ||
tags: | ||
- tasks | ||
summary: Retrieve a task | ||
description: Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead. | ||
operationId: getTaskV1 | ||
x-acl: | ||
- addObject | ||
- deleteIndex | ||
- editSettings | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskV1' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' | ||
|
||
patch: | ||
tags: | ||
- tasks | ||
summary: Update a task | ||
description: Updates a task by its ID using the v1 endpoint, please use `updateTask` instead. | ||
operationId: updateTaskV1 | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
x-codegen-request-body-name: taskUpdate | ||
requestBody: | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskUpdateV1' | ||
required: true | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/task.yml#/TaskUpdateResponse' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' | ||
|
||
delete: | ||
tags: | ||
- tasks | ||
summary: Delete a task | ||
description: Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead. | ||
operationId: deleteTaskV1 | ||
parameters: | ||
- $ref: '../../../common/parameters.yml#/pathTaskID' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '../../../common/schemas/common.yml#/DeleteResponse' | ||
'400': | ||
$ref: '../../../../common/responses/BadRequest.yml' |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we can add all the deprecated in a second time, lets give some time for people to upgrade without having warnings all over the place 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it only warns in python, our usage is in JS so I guess that's fine to properly tag the fields
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are depreciation warning in scala and swift also
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we have to worry about those, the client is still in beta and our consumers rely on typescript so we should be fine