diff --git a/app/Http/Controllers/Api/DeployController.php b/app/Http/Controllers/Api/DeployController.php index 2ee56d0cd..03d02ae38 100644 --- a/app/Http/Controllers/Api/DeployController.php +++ b/app/Http/Controllers/Api/DeployController.php @@ -84,7 +84,7 @@ class DeployController extends Controller ], tags: ['Deployments'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Deployment Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Deployment Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( diff --git a/app/Http/Controllers/Api/OpenApi.php b/app/Http/Controllers/Api/OpenApi.php index 59731ef40..60337a76c 100644 --- a/app/Http/Controllers/Api/OpenApi.php +++ b/app/Http/Controllers/Api/OpenApi.php @@ -5,7 +5,7 @@ namespace App\Http\Controllers\Api; use OpenApi\Attributes as OA; #[OA\Info(title: 'Coolify', version: '0.1')] -#[OA\Server(url: 'https://app.coolify.io/api/v1')] +#[OA\Server(url: 'https://app.coolify.io/api/v1', description: 'Coolify Cloud API. Change the host to your own instance if you are self-hosting.')] #[OA\SecurityScheme( type: 'http', scheme: 'bearer', diff --git a/app/Http/Controllers/Api/ProjectController.php b/app/Http/Controllers/Api/ProjectController.php index 8316d5e82..6aec31e9b 100644 --- a/app/Http/Controllers/Api/ProjectController.php +++ b/app/Http/Controllers/Api/ProjectController.php @@ -61,7 +61,7 @@ class ProjectController extends Controller ], tags: ['Projects'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Project UUID', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Project UUID', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( @@ -107,7 +107,7 @@ class ProjectController extends Controller ], tags: ['Projects'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Project UUID', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Project UUID', schema: new OA\Schema(type: 'string')), new OA\Parameter(name: 'environment_name', in: 'path', required: true, description: 'Environment name', schema: new OA\Schema(type: 'string')), ], responses: [ diff --git a/app/Http/Controllers/Api/SecurityController.php b/app/Http/Controllers/Api/SecurityController.php index 11e8e27ca..67128234e 100644 --- a/app/Http/Controllers/Api/SecurityController.php +++ b/app/Http/Controllers/Api/SecurityController.php @@ -73,7 +73,7 @@ class SecurityController extends Controller ], tags: ['Private Keys'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Private Key Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Private Key Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( @@ -318,7 +318,7 @@ class SecurityController extends Controller ], tags: ['Private Keys'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Private Key Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Private Key Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( diff --git a/app/Http/Controllers/Api/ServersController.php b/app/Http/Controllers/Api/ServersController.php index fa159077d..5d4b56988 100644 --- a/app/Http/Controllers/Api/ServersController.php +++ b/app/Http/Controllers/Api/ServersController.php @@ -105,7 +105,7 @@ class ServersController extends Controller ], tags: ['Servers'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( @@ -182,7 +182,7 @@ class ServersController extends Controller ], tags: ['Servers'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( @@ -259,7 +259,7 @@ class ServersController extends Controller ], tags: ['Servers'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server\'s Uuid', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( @@ -732,7 +732,7 @@ class ServersController extends Controller ], tags: ['Servers'], parameters: [ - new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server UUID', schema: new OA\Schema(type: 'integer')), + new OA\Parameter(name: 'uuid', in: 'path', required: true, description: 'Server UUID', schema: new OA\Schema(type: 'string')), ], responses: [ new OA\Response( diff --git a/openapi.yaml b/openapi.yaml index a63f830b7..0ee8eedf7 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5,6 +5,7 @@ info: servers: - url: 'https://app.coolify.io/api/v1' + description: 'Coolify Cloud API. Change the host to your own instance if you are self-hosting.' paths: /applications: get: @@ -2833,7 +2834,7 @@ paths: description: 'Deployment Uuid' required: true schema: - type: integer + type: string responses: '200': description: 'Get deployment by UUID.' @@ -3062,7 +3063,7 @@ paths: description: 'Project UUID' required: true schema: - type: integer + type: string responses: '200': description: 'Project details' @@ -3166,7 +3167,7 @@ paths: description: 'Project UUID' required: true schema: - type: integer + type: string - name: environment_name in: path @@ -3325,7 +3326,7 @@ paths: description: 'Private Key Uuid' required: true schema: - type: integer + type: string responses: '200': description: 'Get all private keys.' @@ -3357,7 +3358,7 @@ paths: description: 'Private Key Uuid' required: true schema: - type: integer + type: string responses: '200': description: 'Private Key deleted.' @@ -3477,7 +3478,7 @@ paths: description: "Server's Uuid" required: true schema: - type: integer + type: string responses: '200': description: 'Get server by UUID' @@ -3597,7 +3598,7 @@ paths: description: "Server's Uuid" required: true schema: - type: integer + type: string responses: '200': description: 'Get resources by server' @@ -3629,7 +3630,7 @@ paths: description: "Server's Uuid" required: true schema: - type: integer + type: string responses: '200': description: 'Get domains by server' @@ -3661,7 +3662,7 @@ paths: description: 'Server UUID' required: true schema: - type: integer + type: string responses: '201': description: 'Server validation started.'