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

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

View File

@@ -103,7 +103,7 @@ class ServicesController extends Controller
mediaType: 'application/json',
schema: new OA\Schema(
type: 'object',
required: ['server_uuid', 'project_uuid', 'environment_name', 'environment_uuid', 'type'],
required: ['server_uuid', 'project_uuid', 'environment_name', 'environment_uuid'],
properties: [
'type' => [
'description' => 'The one-click service type',
@@ -205,6 +205,7 @@ class ServicesController extends Controller
'server_uuid' => ['type' => 'string', 'description' => 'Server UUID.'],
'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.'],
'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'],
],
),
),
@@ -256,7 +257,7 @@ class ServicesController extends Controller
'environment_name' => 'string|nullable',
'environment_uuid' => 'string|nullable',
'server_uuid' => 'string|required',
'destination_uuid' => 'string',
'destination_uuid' => 'string|nullable',
'name' => 'string|max:255',
'description' => 'string|nullable',
'instant_deploy' => 'boolean',

View File

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

View File

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