dave/coolify
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat(api): update OpenAPI spec for services (#5448)

Browse Source
This commit is contained in:
Meghea Iulian
2025-04-03 17:02:59 +03:00
committed by GitHub
parent 185eef0533
commit d9be1191d6
3 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
app/Http/Controllers/Api/ServicesController.php
View File

@@ -103,7 +103,7 @@ class ServicesController extends Controller
mediaType: 'application/json', mediaType: 'application/json',
schema: new OA\Schema( schema: new OA\Schema(
type: 'object', type: 'object',
required: ['server_uuid', 'project_uuid', 'environment_name', 'environment_uuid', 'type'], required: ['server_uuid', 'project_uuid', 'environment_name', 'environment_uuid'],
properties: [ properties: [
'type' => [ 'type' => [
'description' => 'The one-click service type', 'description' => 'The one-click service type',
@@ -205,6 +205,7 @@ class ServicesController extends Controller
'server_uuid' => ['type' => 'string', 'description' => 'Server UUID.'], 'server_uuid' => ['type' => 'string', 'description' => 'Server UUID.'],
'destination_uuid' => ['type' => 'string', 'description' => 'Destination UUID. Required if server has multiple destinations.'], 'destination_uuid' => ['type' => 'string', 'description' => 'Destination UUID. Required if server has multiple destinations.'],
'instant_deploy' => ['type' => 'boolean', 'default' => false, 'description' => 'Start the service immediately after creation.'], 'instant_deploy' => ['type' => 'boolean', 'default' => false, 'description' => 'Start the service immediately after creation.'],
'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'],
], ],
), ),
), ),
@@ -256,7 +257,7 @@ class ServicesController extends Controller
'environment_name' => 'string|nullable', 'environment_name' => 'string|nullable',
'environment_uuid' => 'string|nullable', 'environment_uuid' => 'string|nullable',
'server_uuid' => 'string|required', 'server_uuid' => 'string|required',
'destination_uuid' => 'string', 'destination_uuid' => 'string|nullable',
'name' => 'string|max:255', 'name' => 'string|max:255',
'description' => 'string|nullable', 'description' => 'string|nullable',
'instant_deploy' => 'boolean', 'instant_deploy' => 'boolean',

7
openapi.json
View File

@@ -5900,8 +5900,7 @@
"server_uuid", "server_uuid",
"project_uuid", "project_uuid",
"environment_name", "environment_name",
"environment_uuid", "environment_uuid"
"type"
], ],
"properties": { "properties": {
"type": { "type": {
@@ -6030,6 +6029,10 @@
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Start the service immediately after creation." "description": "Start the service immediately after creation."
},
"docker_compose_raw": {
"type": "string",
"description": "The Docker Compose raw content."
} }
}, },
"type": "object" "type": "object"

4
openapi.yaml
View File

@@ -3991,7 +3991,6 @@ paths:
- project_uuid - project_uuid
- environment_name - environment_name
- environment_uuid - environment_uuid
- type
properties: properties:
type: type:
description: 'The one-click service type' description: 'The one-click service type'
@@ -4024,6 +4023,9 @@ paths:
type: boolean type: boolean
default: false default: false
description: 'Start the service immediately after creation.' description: 'Start the service immediately after creation.'
docker_compose_raw:
type: string
description: 'The Docker Compose raw content.'
type: object type: object
responses: responses:
'201': '201':