Skip to content

CRQ-44335 add task input information #31

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.

Sign up for GitHub

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

Open
ldavidsdl wants to merge 2 commits into
base: main
Choose a base branch
from
Open

CRQ-44335 add task input information #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7654b10
CRQ-44335 add task input information
ldavidsdl Jan 29, 2026
4e2d09c
CRQ-44335 adapt simpler file type
ldavidsdl Jan 30, 2026
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
105 changes: 103 additions & 2 deletions articles/LCPublicAPI/api/Webhooks.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,11 +228,15 @@
"id": "1zdzlmo5rwf8k"
},
"description": "The failed task type."
},
"input": {
"$ref": "#/components/schemas/task-input"
}
},
"required": [
"id",
"name"
"name",
"input"
]
},
"failed-task-error": {
Expand Down Expand Up @@ -563,13 +567,17 @@
},
"format": "date-time",
"description": "The project due date.\n\nGMT Timezone\n\nAllowed formats:\\\n\"YYYY-MM-DDThh:mmZ\"\\\n\"YYYY-MM-DDThh:mm:ssZ\"\\\n\"YYYY-MM-DDThh:mm:ss.sZ\"\\\n\"YYYY-MM-DDThh:mm:ss.ssZ\"\\\n\"YYYY-MM-DDThh:mm:ss.sssZ\""
},
"input": {
"$ref": "#/components/schemas/task-input"
}
},
"required": [
"id",
"status",
"taskType",
"assignees"
"assignees",
"input"
]
},
"task-event-assignees": {
Expand Down Expand Up @@ -625,6 +633,99 @@
"automatic"
]
},
"task-input": {
"title": "Task Input",
"type": "object",
"x-stoplight": {
"id": "task-input"
},
"description": "Information about the task input. Currently only `sourceFile` and `targetFile` objects are populated in webhook events.",
"properties": {
"id": {
"type": "string",
"description": "The input identifier."
},
"inputType": {
"type": "string",
"enum": [
"sourceFile",
"targetFile",
"languageDirection",
"project"
],
"description": "The type of input."
},
"sourceFile": {
"$ref": "#/components/schemas/task-input-source-file",
"description": "Source file information. Present when inputType is sourceFile."
},
"targetFile": {
"$ref": "#/components/schemas/task-input-target-file",
"description": "Target file information. Present when inputType is targetFile."
}
},
"required": [
"id",
"inputType"
]
},
"task-input-source-file": {
"title": "Task Input Source File",
"type": "object",
"x-stoplight": {
"id": "task-input-source-file"
},
"description": "Source file information for task input.",
"properties": {
"fileVersionId": {
"type": "string",
"description": "The file version identifier."
},
"version": {
"type": "integer",
"description": "The file version number."
},
"type": {
"type": "string",
"enum": [
"native",
"bcm"
],
"description": "The file type."
}
},
"required": [
"fileVersionId",
"version",
"type"
]
},
"task-input-target-file": {
"title": "Task Input Target File",
"type": "object",
"x-stoplight": {
"id": "task-input-target-file"
},
"description": "Target file information for task input. Extends source file with additional sourceFileId.",
"allOf": [
{
"$ref": "#/components/schemas/task-input-source-file"
},
{
"type": "object",
"properties": {
"sourceFileId": {
"type": "string",
"description": "The identifier of the source file associated with this target file."
}
},
"required": [
"sourceFileId",
"type"
]
}
]
},
"webhook": {
"title": "Webhook",
"type": "object",
Expand Down