|
|
|
|
@ -339,6 +339,201 @@ |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file": { |
|
|
|
|
"post": { |
|
|
|
|
"operationId": "task_processing_api-set-file-contents-ex-app", |
|
|
|
|
"summary": "Upload a file so it can be referenced in a task result (ExApp route version)", |
|
|
|
|
"description": "Use field 'file' for the file upload\nThis endpoint requires admin access", |
|
|
|
|
"tags": [ |
|
|
|
|
"task_processing_api" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"parameters": [ |
|
|
|
|
{ |
|
|
|
|
"name": "taskId", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "The id of the task", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "integer", |
|
|
|
|
"format": "int64" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"name": "OCS-APIRequest", |
|
|
|
|
"in": "header", |
|
|
|
|
"description": "Required to be true for the API request to pass", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "boolean", |
|
|
|
|
"default": true |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"responses": { |
|
|
|
|
"201": { |
|
|
|
|
"description": "File created", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"fileId" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"fileId": { |
|
|
|
|
"type": "integer", |
|
|
|
|
"format": "int64" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"400": { |
|
|
|
|
"description": "File upload failed or no file was uploaded", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"message" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"message": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"500": { |
|
|
|
|
"description": "", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"message" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"message": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"404": { |
|
|
|
|
"description": "Task not found", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"message" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"message": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/progress": { |
|
|
|
|
"post": { |
|
|
|
|
"operationId": "task_processing_api-set-progress", |
|
|
|
|
@ -541,7 +736,7 @@ |
|
|
|
|
"output": { |
|
|
|
|
"type": "object", |
|
|
|
|
"nullable": true, |
|
|
|
|
"description": "The resulting task output", |
|
|
|
|
"description": "The resulting task output, files are represented by their IDs", |
|
|
|
|
"additionalProperties": { |
|
|
|
|
"type": "object" |
|
|
|
|
} |
|
|
|
|
|