An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.
PHP coolifydatabasesdeploymentdockerdocker-composeinertiajslaravelmariadbmysqlnextjsnodejsphppostgresredisself-hostedself-hostingserverstatic-sitesveltesvelte5
feat(api): add update endpoints for scheduled tasks in applications and services
Ahmed2b913a1c35f6
diff --git a/app/Http/Controllers/Api/ScheduledTasksController.php b/app/Http/Controllers/Api/ScheduledTasksController.phpindex 4778dec2ab..13fe21a4aa 100644--- a/app/Http/Controllers/Api/ScheduledTasksController.php+++ b/app/Http/Controllers/Api/ScheduledTasksController.php@@ -76,6 +76,52 @@ class ScheduledTasksController extends Controllerreturn response()->json($this->removeSensitiveData($task), 201);}+ public function update_scheduled_task(Request $request, Application|Service $resource)+ {+ $teamId = getTeamIdFromToken();+ if (is_null($teamId)) {+ return invalidTokenResponse();+ }++ $return = validateIncomingRequest($request);+ if ($return instanceof \Illuminate\Http\JsonResponse) {+ return $return;+ }++ $validator = Validator::make($request->all(), [+ 'name' => 'string|max:255',+ 'command' => 'string',+ 'frequency' => 'string',+ 'container' => 'string|nullable',+ 'timeout' => 'integer|min:1',+ 'enabled' => 'boolean',+ ]);++ if ($validator->fails()) {+ return response()->json([+ 'message' => 'Validation failed.',+ 'errors' => $validator->errors(),+ ], 422);+ }++ if ($request->has('frequency') && ! validate_cron_expression($request->frequency)) {+ return response()->json([+ 'message' => 'Validation failed.',+ 'errors' => ['frequency' => ['Invalid cron expression or frequency format.']],+ ], 422);+ }++ $task = $resource->scheduled_tasks()->where('uuid', $request->task_uuid)->first();+ if (! $task) {+ return response()->json(['message' => 'Scheduled task not found.'], 404);+ }++ $data = $request->all();+ $task->update($data);++ return response()->json($this->removeSensitiveData($task), 200);+ }+#[OA\Get(summary: 'List Task',description: 'List all scheduled tasks for an application.',@@ -295,6 +341,93 @@ class ScheduledTasksController extends Controllerreturn response()->json(['message' => 'Scheduled task deleted.']);}+ #[OA\Patch(+ summary: 'Update Task',+ description: 'Update a scheduled task for an application.',+ path: '/applications/{uuid}/scheduled-tasks/{task_uuid}',+ operationId: 'update-scheduled-task-by-application-uuid',+ security: [+ ['bearerAuth' => []],+ ],+ tags: ['Scheduled Tasks'],+ parameters: [+ new OA\Parameter(+ name: 'uuid',+ in: 'path',+ description: 'UUID of the application.',+ required: true,+ schema: new OA\Schema(+ type: 'string',+ )+ ),+ new OA\Parameter(+ name: 'task_uuid',+ in: 'path',+ description: 'UUID of the scheduled task.',+ required: true,+ schema: new OA\Schema(+ type: 'string',+ )+ ),+ ],+ requestBody: new OA\RequestBody(+ description: 'Scheduled task data',+ required: true,+ content: new OA\MediaType(+ mediaType: 'application/json',+ schema: new OA\Schema(+ type: 'object',+ properties: [+ 'name' => ['type' => 'string', 'description' => 'The name of the scheduled task.'],+ 'command' => ['type' => 'string', 'description' => 'The command to execute.'],+ 'frequency' => ['type' => 'string', 'description' => 'The frequency of the scheduled task.'],+ 'container' => ['type' => 'string', 'nullable' => true, 'description' => 'The container where the command should be executed.'],+ 'timeout' => ['type' => 'integer', 'description' => 'The timeout of the scheduled task in seconds.', 'default' => 3600],+ 'enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if the scheduled task is enabled.', 'default' => true],+ ],+ ),+ )+ ),+ responses: [+ new OA\Response(+ response: 200,+ description: 'Scheduled task updated.',+ content: [+ new OA\MediaType(+ mediaType: 'application/json',+ schema: new OA\Schema(ref: '#/components/schemas/ScheduledTask')+ ),+ ]+ ),+ new OA\Response(+ response: 401,+ ref: '#/components/responses/401',+ ),+ new OA\Response(+ response: 404,+ ref: '#/components/responses/404',+ ),+ new OA\Response(+ response: 422,+ ref: '#/components/responses/422',+ ),+ ]+ )]+ public function update_scheduled_task_by_application_uuid(Request $request)+ {+ $teamId = getTeamIdFromToken();+ if (is_null($teamId)) {+ return invalidTokenResponse();+ }++ $application = Application::whereRelation('environment.project.team', 'id', $teamId)->where('uuid', $request->uuid)->first();+ if (! $application) {+ return response()->json(['message' => 'Application not found.'], 404);+ }++ return $this->update_scheduled_task($request, $application);+ }+#[OA\Get(summary: 'List Tasks',description: 'List all scheduled tasks for a service.',@@ -513,4 +646,91 @@ class ScheduledTasksController extends Controllerreturn response()->json(['message' => 'Scheduled task deleted.']);}++ #[OA\Patch(+ summary: 'Update Task',+ description: 'Update a scheduled task for a service.',+ path: '/services/{uuid}/scheduled-tasks/{task_uuid}',+ operationId: 'update-scheduled-task-by-service-uuid',+ security: [+ ['bearerAuth' => []],+ ],+ tags: ['Scheduled Tasks'],+ parameters: [+ new OA\Parameter(+ name: 'uuid',+ in: 'path',+ description: 'UUID of the service.',+ required: true,+ schema: new OA\Schema(+ type: 'string',+ )+ ),+ new OA\Parameter(+ name: 'task_uuid',+ in: 'path',+ description: 'UUID of the scheduled task.',+ required: true,+ schema: new OA\Schema(+ type: 'string',+ )+ ),+ ],+ requestBody: new OA\RequestBody(+ description: 'Scheduled task data',+ required: true,+ content: new OA\MediaType(+ mediaType: 'application/json',+ schema: new OA\Schema(+ type: 'object',+ properties: [+ 'name' => ['type' => 'string', 'description' => 'The name of the scheduled task.'],+ 'command' => ['type' => 'string', 'description' => 'The command to execute.'],+ 'frequency' => ['type' => 'string', 'description' => 'The frequency of the scheduled task.'],+ 'container' => ['type' => 'string', 'nullable' => true, 'description' => 'The container where the command should be executed.'],+ 'timeout' => ['type' => 'integer', 'description' => 'The timeout of the scheduled task in seconds.', 'default' => 3600],+ 'enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if the scheduled task is enabled.', 'default' => true],+ ],+ ),+ )+ ),+ responses: [+ new OA\Response(+ response: 200,+ description: 'Scheduled task updated.',+ content: [+ new OA\MediaType(+ mediaType: 'application/json',+ schema: new OA\Schema(ref: '#/components/schemas/ScheduledTask')+ ),+ ]+ ),+ new OA\Response(+ response: 401,+ ref: '#/components/responses/401',+ ),+ new OA\Response(+ response: 404,+ ref: '#/components/responses/404',+ ),+ new OA\Response(+ response: 422,+ ref: '#/components/responses/422',+ ),+ ]+ )]+ public function update_scheduled_task_by_service_uuid(Request $request)+ {+ $teamId = getTeamIdFromToken();+ if (is_null($teamId)) {+ return invalidTokenResponse();+ }++ $service = Service::whereRelation('environment.project.team', 'id', $teamId)->where('uuid', $request->uuid)->first();+ if (! $service) {+ return response()->json(['message' => 'Service not found.'], 404);+ }++ return $this->update_scheduled_task($request, $service);+ }}diff --git a/openapi.json b/openapi.jsonindex 7df13e4aeb..ef71fb5da6 100644--- a/openapi.json+++ b/openapi.json@@ -3571,6 +3571,100 @@}},"\/applications\/{uuid}\/scheduled-tasks\/{task_uuid}": {+ "patch": {+ "tags": [+ "Scheduled Tasks"+ ],+ "summary": "Update Task",+ "description": "Update a scheduled task for an application.",+ "operationId": "update-scheduled-task-by-application-uuid",+ "parameters": [+ {+ "name": "uuid",+ "in": "path",+ "description": "UUID of the application.",+ "required": true,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "task_uuid",+ "in": "path",+ "description": "UUID of the scheduled task.",+ "required": true,+ "schema": {+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "description": "Scheduled task data",+ "required": true,+ "content": {+ "application\/json": {+ "schema": {+ "properties": {+ "name": {+ "type": "string",+ "description": "The name of the scheduled task."+ },+ "command": {+ "type": "string",+ "description": "The command to execute."+ },+ "frequency": {+ "type": "string",+ "description": "The frequency of the scheduled task."+ },+ "container": {+ "type": "string",+ "nullable": true,+ "description": "The container where the command should be executed."+ },+ "timeout": {+ "type": "integer",+ "description": "The timeout of the scheduled task in seconds.",+ "default": 3600+ },+ "enabled": {+ "type": "boolean",+ "description": "The flag to indicate if the scheduled task is enabled.",+ "default": true+ }+ },+ "type": "object"+ }+ }+ }+ },+ "responses": {+ "200": {+ "description": "Scheduled task updated.",+ "content": {+ "application\/json": {+ "schema": {+ "$ref": "#\/components\/schemas\/ScheduledTask"+ }+ }+ }+ },+ "401": {+ "$ref": "#\/components\/responses\/401"+ },+ "404": {+ "$ref": "#\/components\/responses\/404"+ },+ "422": {+ "$ref": "#\/components\/responses\/422"+ }+ },+ "security": [+ {+ "bearerAuth": []+ }+ ]+ },"delete": {"tags": ["Scheduled Tasks"@@ -10301,6 +10395,100 @@}},"\/services\/{uuid}\/scheduled-tasks\/{task_uuid}": {+ "patch": {+ "tags": [+ "Scheduled Tasks"+ ],+ "summary": "Update Task",+ "description": "Update a scheduled task for a service.",+ "operationId": "update-scheduled-task-by-service-uuid",+ "parameters": [+ {+ "name": "uuid",+ "in": "path",+ "description": "UUID of the service.",+ "required": true,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "task_uuid",+ "in": "path",+ "description": "UUID of the scheduled task.",+ "required": true,+ "schema": {+ "type": "string"+ }+ }+ ],+ "requestBody": {+ "description": "Scheduled task data",+ "required": true,+ "content": {+ "application\/json": {+ "schema": {+ "properties": {+ "name": {+ "type": "string",+ "description": "The name of the scheduled task."+ },+ "command": {+ "type": "string",+ "description": "The command to execute."+ },+ "frequency": {+ "type": "string",+ "description": "The frequency of the scheduled task."+ },+ "container": {+ "type": "string",+ "nullable": true,+ "description": "The container where the command should be executed."+ },+ "timeout": {+ "type": "integer",+ "description": "The timeout of the scheduled task in seconds.",+ "default": 3600+ },+ "enabled": {+ "type": "boolean",+ "description": "The flag to indicate if the scheduled task is enabled.",+ "default": true+ }+ },+ "type": "object"+ }+ }+ }+ },+ "responses": {+ "200": {+ "description": "Scheduled task updated.",+ "content": {+ "application\/json": {+ "schema": {+ "$ref": "#\/components\/schemas\/ScheduledTask"+ }+ }+ }+ },+ "401": {+ "$ref": "#\/components\/responses\/401"+ },+ "404": {+ "$ref": "#\/components\/responses\/404"+ },+ "422": {+ "$ref": "#\/components\/responses\/422"+ }+ },+ "security": [+ {+ "bearerAuth": []+ }+ ]+ },"delete": {"tags": ["Scheduled Tasks"diff --git a/openapi.yaml b/openapi.yamlindex ac684c98a4..99cc84dcb9 100644--- a/openapi.yaml+++ b/openapi.yaml@@ -2258,6 +2258,72 @@ paths:-bearerAuth: []'/applications/{uuid}/scheduled-tasks/{task_uuid}':+ patch:+ tags:+ - 'Scheduled Tasks'+ summary: 'Update Task'+ description: 'Update a scheduled task for an application.'+ operationId: update-scheduled-task-by-application-uuid+ parameters:+ -+ name: uuid+ in: path+ description: 'UUID of the application.'+ required: true+ schema:+ type: string+ -+ name: task_uuid+ in: path+ description: 'UUID of the scheduled task.'+ required: true+ schema:+ type: string+ requestBody:+ description: 'Scheduled task data'+ required: true+ content:+ application/json:+ schema:+ properties:+ name:+ type: string+ description: 'The name of the scheduled task.'+ command:+ type: string+ description: 'The command to execute.'+ frequency:+ type: string+ description: 'The frequency of the scheduled task.'+ container:+ type: string+ nullable: true+ description: 'The container where the command should be executed.'+ timeout:+ type: integer+ description: 'The timeout of the scheduled task in seconds.'+ default: 3600+ enabled:+ type: boolean+ description: 'The flag to indicate if the scheduled task is enabled.'+ default: true+ type: object+ responses:+ '200':+ description: 'Scheduled task updated.'+ content:+ application/json:+ schema:+ $ref: '#/components/schemas/ScheduledTask'+ '401':+ $ref: '#/components/responses/401'+ '404':+ $ref: '#/components/responses/404'+ '422':+ $ref: '#/components/responses/422'+ security:+ -+ bearerAuth: []delete:tags:- 'Scheduled Tasks'@@ -6460,6 +6526,72 @@ paths:-bearerAuth: []'/services/{uuid}/scheduled-tasks/{task_uuid}':+ patch:+ tags:+ - 'Scheduled Tasks'+ summary: 'Update Task'+ description: 'Update a scheduled task for a service.'+ operationId: update-scheduled-task-by-service-uuid+ parameters:+ -+ name: uuid+ in: path+ description: 'UUID of the service.'+ required: true+ schema:+ type: string+ -+ name: task_uuid+ in: path+ description: 'UUID of the scheduled task.'+ required: true+ schema:+ type: string+ requestBody:+ description: 'Scheduled task data'+ required: true+ content:+ application/json:+ schema:+ properties:+ name:+ type: string+ description: 'The name of the scheduled task.'+ command:+ type: string+ description: 'The command to execute.'+ frequency:+ type: string+ description: 'The frequency of the scheduled task.'+ container:+ type: string+ nullable: true+ description: 'The container where the command should be executed.'+ timeout:+ type: integer+ description: 'The timeout of the scheduled task in seconds.'+ default: 3600+ enabled:+ type: boolean+ description: 'The flag to indicate if the scheduled task is enabled.'+ default: true+ type: object+ responses:+ '200':+ description: 'Scheduled task updated.'+ content:+ application/json:+ schema:+ $ref: '#/components/schemas/ScheduledTask'+ '401':+ $ref: '#/components/responses/401'+ '404':+ $ref: '#/components/responses/404'+ '422':+ $ref: '#/components/responses/422'+ security:+ -+ bearerAuth: []delete:tags:- 'Scheduled Tasks'diff --git a/routes/api.php b/routes/api.phpindex 7f9e0d3bea..9c4d703a99 100644--- a/routes/api.php+++ b/routes/api.php@@ -175,10 +175,12 @@ Route::group([Route::get('/applications/{uuid}/scheduled-tasks', [ScheduledTasksController::class, 'scheduled_tasks_by_application_uuid'])->middleware(['api.ability:read']);Route::post('/applications/{uuid}/scheduled-tasks', [ScheduledTasksController::class, 'create_scheduled_task_by_application_uuid'])->middleware(['api.ability:write']);+ Route::patch('/applications/{uuid}/scheduled-tasks/{task_uuid}', [ScheduledTasksController::class, 'update_scheduled_task_by_application_uuid'])->middleware(['api.ability:write']);Route::delete('/applications/{uuid}/scheduled-tasks/{task_uuid}', [ScheduledTasksController::class, 'delete_scheduled_task_by_application_uuid'])->middleware(['api.ability:write']);Route::get('/services/{uuid}/scheduled-tasks', [ScheduledTasksController::class, 'scheduled_tasks_by_service_uuid'])->middleware(['api.ability:read']);Route::post('/services/{uuid}/scheduled-tasks', [ScheduledTasksController::class, 'create_scheduled_task_by_service_uuid'])->middleware(['api.ability:write']);+ Route::patch('/services/{uuid}/scheduled-tasks/{task_uuid}', [ScheduledTasksController::class, 'update_scheduled_task_by_service_uuid'])->middleware(['api.ability:write']);Route::delete('/services/{uuid}/scheduled-tasks/{task_uuid}', [ScheduledTasksController::class, 'delete_scheduled_task_by_service_uuid'])->middleware(['api.ability:write']);});