feat: create job with data dto

This commit is contained in:
izzy
2026-01-12 12:32:55 +00:00
parent d4ad523eb3
commit b49ee6d90d
11 changed files with 323 additions and 3 deletions
+61
View File
@@ -8476,6 +8476,56 @@
"x-immich-state": "Alpha"
}
},
"/queues/job": {
"post": {
"description": "Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.",
"operationId": "queueJob",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueJobCreateDto"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
}
},
"security": [
{
"bearer": []
},
{
"cookie": []
},
{
"api_key": []
}
],
"summary": "Create a manual job",
"tags": [
"Queues"
],
"x-immich-admin-only": true,
"x-immich-history": [
{
"version": "v2.5.0",
"state": "Added"
},
{
"version": "v2.5.0",
"state": "Alpha"
}
],
"x-immich-permission": "job.create",
"x-immich-state": "Alpha"
}
},
"/queues/{name}": {
"get": {
"description": "Retrieves a specific queue by its name.",
@@ -19135,6 +19185,17 @@
},
"type": "object"
},
"QueueJobCreateDto": {
"properties": {
"job": {
"type": "object"
}
},
"required": [
"job"
],
"type": "object"
},
"QueueJobResponseDto": {
"properties": {
"data": {
@@ -1038,6 +1038,9 @@ export type QueueResponseDto = {
name: QueueName;
statistics: QueueStatisticsDto;
};
export type QueueJobCreateDto = {
job: object;
};
export type QueueUpdateDto = {
isPaused?: boolean;
};
@@ -3834,6 +3837,18 @@ export function getQueues(opts?: Oazapfts.RequestOpts) {
...opts
}));
}
/**
* Create a manual job
*/
export function queueJob({ queueJobCreateDto }: {
queueJobCreateDto: QueueJobCreateDto;
}, opts?: Oazapfts.RequestOpts) {
return oazapfts.ok(oazapfts.fetchText("/queues/job", oazapfts.json({
...opts,
method: "POST",
body: queueJobCreateDto
})));
}
/**
* Retrieve a queue
*/