feat(api): unify service creation endpoint and enhance validation
This commit is contained in:
@@ -89,10 +89,10 @@ class ServicesController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[OA\Post(
|
#[OA\Post(
|
||||||
summary: 'Create one-click',
|
summary: 'Create service',
|
||||||
description: 'Create a one-click service',
|
description: 'Create a one-click / custom service',
|
||||||
path: '/services/one-click',
|
path: '/services',
|
||||||
operationId: 'create-one-click-service',
|
operationId: 'create-service',
|
||||||
security: [
|
security: [
|
||||||
['bearerAuth' => []],
|
['bearerAuth' => []],
|
||||||
],
|
],
|
||||||
@@ -236,9 +236,9 @@ class ServicesController extends Controller
|
|||||||
),
|
),
|
||||||
]
|
]
|
||||||
)]
|
)]
|
||||||
public function create_one_click_service(Request $request)
|
public function create_service(Request $request)
|
||||||
{
|
{
|
||||||
$allowedFields = ['type', 'name', 'description', 'project_uuid', 'environment_name', 'environment_uuid', 'server_uuid', 'destination_uuid', 'instant_deploy'];
|
$allowedFields = ['type', 'name', 'description', 'project_uuid', 'environment_name', 'environment_uuid', 'server_uuid', 'destination_uuid', 'instant_deploy', 'docker_compose_raw'];
|
||||||
|
|
||||||
$teamId = getTeamIdFromToken();
|
$teamId = getTeamIdFromToken();
|
||||||
if (is_null($teamId)) {
|
if (is_null($teamId)) {
|
||||||
@@ -250,7 +250,8 @@ class ServicesController extends Controller
|
|||||||
return $return;
|
return $return;
|
||||||
}
|
}
|
||||||
$validator = customApiValidator($request->all(), [
|
$validator = customApiValidator($request->all(), [
|
||||||
'type' => 'string|required',
|
'type' => 'string|required_without:docker_compose_raw',
|
||||||
|
'docker_compose_raw' => 'string|required_without:type',
|
||||||
'project_uuid' => 'string|required',
|
'project_uuid' => 'string|required',
|
||||||
'environment_name' => 'string|nullable',
|
'environment_name' => 'string|nullable',
|
||||||
'environment_uuid' => 'string|nullable',
|
'environment_uuid' => 'string|nullable',
|
||||||
@@ -373,89 +374,16 @@ class ServicesController extends Controller
|
|||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
return response()->json(['message' => 'Service not found.'], 404);
|
return response()->json(['message' => 'Service not found.', 'valid_service_types' => $serviceKeys], 404);
|
||||||
|
} elseif (filled($request->docker_compose_raw)) {
|
||||||
|
|
||||||
|
$service = new Service;
|
||||||
|
$result = $this->upsert_service($request, $service, $teamId);
|
||||||
|
|
||||||
|
return response()->json(serializeApiResponse($result))->setStatusCode(201);
|
||||||
} else {
|
} else {
|
||||||
return response()->json(['message' => 'Invalid service type.', 'valid_service_types' => $serviceKeys], 400);
|
return response()->json(['message' => 'No service type or docker_compose_raw provided.'], 400);
|
||||||
}
|
}
|
||||||
|
|
||||||
return response()->json(['message' => 'Invalid service type.'], 400);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[OA\Post(
|
|
||||||
summary: 'Create',
|
|
||||||
description: 'Create a service',
|
|
||||||
path: '/services',
|
|
||||||
operationId: 'create-service',
|
|
||||||
security: [
|
|
||||||
['bearerAuth' => []],
|
|
||||||
],
|
|
||||||
tags: ['Services'],
|
|
||||||
requestBody: new OA\RequestBody(
|
|
||||||
required: true,
|
|
||||||
content: new OA\MediaType(
|
|
||||||
mediaType: 'application/json',
|
|
||||||
schema: new OA\Schema(
|
|
||||||
type: 'object',
|
|
||||||
required: ['server_uuid', 'project_uuid', 'environment_name', 'environment_uuid', 'docker_compose_raw'],
|
|
||||||
properties: [
|
|
||||||
'name' => ['type' => 'string', 'maxLength' => 255, 'description' => 'Name of the service.'],
|
|
||||||
'description' => ['type' => 'string', 'nullable' => true, 'description' => 'Description of the service.'],
|
|
||||||
'project_uuid' => ['type' => 'string', 'description' => 'Project UUID.'],
|
|
||||||
'environment_name' => ['type' => 'string', 'description' => 'Environment name. You need to provide at least one of environment_name or environment_uuid.'],
|
|
||||||
'environment_uuid' => ['type' => 'string', 'description' => 'Environment UUID. You need to provide at least one of environment_name or environment_uuid.'],
|
|
||||||
'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.'],
|
|
||||||
'connect_to_docker_network' => ['type' => 'boolean', 'default' => false, 'description' => 'Connect the service to the predefined docker network.'],
|
|
||||||
'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'],
|
|
||||||
|
|
||||||
],
|
|
||||||
),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
responses: [
|
|
||||||
new OA\Response(
|
|
||||||
response: 201,
|
|
||||||
description: 'Service created successfully.',
|
|
||||||
content: [
|
|
||||||
new OA\MediaType(
|
|
||||||
mediaType: 'application/json',
|
|
||||||
schema: new OA\Schema(
|
|
||||||
type: 'object',
|
|
||||||
properties: [
|
|
||||||
'uuid' => ['type' => 'string', 'description' => 'Service UUID.'],
|
|
||||||
'domains' => ['type' => 'array', 'items' => ['type' => 'string', 'nullable' => true], 'description' => 'Service domains.'],
|
|
||||||
]
|
|
||||||
)
|
|
||||||
),
|
|
||||||
]
|
|
||||||
),
|
|
||||||
new OA\Response(
|
|
||||||
response: 401,
|
|
||||||
ref: '#/components/responses/401',
|
|
||||||
),
|
|
||||||
new OA\Response(
|
|
||||||
response: 400,
|
|
||||||
ref: '#/components/responses/400',
|
|
||||||
),
|
|
||||||
]
|
|
||||||
)]
|
|
||||||
public function create_service(Request $request)
|
|
||||||
{
|
|
||||||
$teamId = getTeamIdFromToken();
|
|
||||||
if (is_null($teamId)) {
|
|
||||||
return invalidTokenResponse();
|
|
||||||
}
|
|
||||||
|
|
||||||
$return = validateIncomingRequest($request);
|
|
||||||
if ($return instanceof \Illuminate\Http\JsonResponse) {
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$service = new Service;
|
|
||||||
$result = $this->upsert_service($request, $service, $teamId);
|
|
||||||
|
|
||||||
return response()->json(serializeApiResponse($result))->setStatusCode(201);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[OA\Get(
|
#[OA\Get(
|
||||||
@@ -757,15 +685,16 @@ class ServicesController extends Controller
|
|||||||
}
|
}
|
||||||
$dockerCompose = base64_decode($request->docker_compose_raw);
|
$dockerCompose = base64_decode($request->docker_compose_raw);
|
||||||
$dockerComposeRaw = Yaml::dump(Yaml::parse($dockerCompose), 10, 2, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
$dockerComposeRaw = Yaml::dump(Yaml::parse($dockerCompose), 10, 2, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||||||
|
$connectToDockerNetwork = $request->connect_to_docker_network ?? false;
|
||||||
|
|
||||||
$service->name = $request->name;
|
$service->name = $request->name ?? null;
|
||||||
$service->description = $request->description;
|
$service->description = $request->description ?? null;
|
||||||
$service->docker_compose_raw = $dockerComposeRaw;
|
$service->docker_compose_raw = $dockerComposeRaw;
|
||||||
$service->environment_id = $environment->id;
|
$service->environment_id = $environment->id;
|
||||||
$service->server_id = $server->id;
|
$service->server_id = $server->id;
|
||||||
$service->destination_id = $destination->id;
|
$service->destination_id = $destination->id;
|
||||||
$service->destination_type = $destination->getMorphClass();
|
$service->destination_type = $destination->getMorphClass();
|
||||||
$service->connect_to_docker_network = $request->connect_to_docker_network;
|
$service->connect_to_docker_network = $connectToDockerNetwork;
|
||||||
$service->save();
|
$service->save();
|
||||||
|
|
||||||
$service->parse();
|
$service->parse();
|
||||||
|
@@ -7,7 +7,6 @@ use App\Models\Project;
|
|||||||
use App\Models\Service;
|
use App\Models\Service;
|
||||||
use App\Models\StandaloneDocker;
|
use App\Models\StandaloneDocker;
|
||||||
use App\Models\SwarmDocker;
|
use App\Models\SwarmDocker;
|
||||||
use Illuminate\Support\Str;
|
|
||||||
use Livewire\Component;
|
use Livewire\Component;
|
||||||
use Symfony\Component\Yaml\Yaml;
|
use Symfony\Component\Yaml\Yaml;
|
||||||
|
|
||||||
@@ -66,7 +65,6 @@ class DockerCompose extends Component
|
|||||||
$destination_class = $destination->getMorphClass();
|
$destination_class = $destination->getMorphClass();
|
||||||
|
|
||||||
$service = Service::create([
|
$service = Service::create([
|
||||||
'name' => 'service'.Str::random(10),
|
|
||||||
'docker_compose_raw' => $this->dockerComposeRaw,
|
'docker_compose_raw' => $this->dockerComposeRaw,
|
||||||
'environment_id' => $environment->id,
|
'environment_id' => $environment->id,
|
||||||
'server_id' => (int) $server_id,
|
'server_id' => (int) $server_id,
|
||||||
@@ -85,8 +83,6 @@ class DockerCompose extends Component
|
|||||||
'resourceable_type' => $service->getMorphClass(),
|
'resourceable_type' => $service->getMorphClass(),
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
$service->name = "service-$service->uuid";
|
|
||||||
|
|
||||||
$service->parse(isNew: true);
|
$service->parse(isNew: true);
|
||||||
|
|
||||||
return redirect()->route('project.service.configuration', [
|
return redirect()->route('project.service.configuration', [
|
||||||
|
@@ -73,7 +73,6 @@ class Create extends Component
|
|||||||
if ($oneClickService) {
|
if ($oneClickService) {
|
||||||
$destination = StandaloneDocker::whereUuid($destination_uuid)->first();
|
$destination = StandaloneDocker::whereUuid($destination_uuid)->first();
|
||||||
$service_payload = [
|
$service_payload = [
|
||||||
'name' => "$oneClickServiceName-".str()->random(10),
|
|
||||||
'docker_compose_raw' => base64_decode($oneClickService),
|
'docker_compose_raw' => base64_decode($oneClickService),
|
||||||
'environment_id' => $environment->id,
|
'environment_id' => $environment->id,
|
||||||
'service_type' => $oneClickServiceName,
|
'service_type' => $oneClickServiceName,
|
||||||
|
@@ -50,6 +50,11 @@ class Service extends BaseModel
|
|||||||
|
|
||||||
protected static function booted()
|
protected static function booted()
|
||||||
{
|
{
|
||||||
|
static::creating(function ($service) {
|
||||||
|
if (blank($service->name)) {
|
||||||
|
$service->name = 'service-'.(new Cuid2);
|
||||||
|
}
|
||||||
|
});
|
||||||
static::created(function ($service) {
|
static::created(function ($service) {
|
||||||
$service->compose_parsing_version = self::$parserVersion;
|
$service->compose_parsing_version = self::$parserVersion;
|
||||||
$service->save();
|
$service->save();
|
||||||
|
@@ -114,7 +114,6 @@ Route::group([
|
|||||||
|
|
||||||
Route::get('/services', [ServicesController::class, 'services'])->middleware(['api.ability:read']);
|
Route::get('/services', [ServicesController::class, 'services'])->middleware(['api.ability:read']);
|
||||||
Route::post('/services', [ServicesController::class, 'create_service'])->middleware(['api.ability:write']);
|
Route::post('/services', [ServicesController::class, 'create_service'])->middleware(['api.ability:write']);
|
||||||
Route::post('/services/one-click', [ServicesController::class, 'create_one_click_service'])->middleware(['api.ability:write']);
|
|
||||||
|
|
||||||
Route::get('/services/{uuid}', [ServicesController::class, 'service_by_uuid'])->middleware(['api.ability:read']);
|
Route::get('/services/{uuid}', [ServicesController::class, 'service_by_uuid'])->middleware(['api.ability:read']);
|
||||||
Route::patch('/services/{uuid}', [ServicesController::class, 'update_by_uuid'])->middleware(['ability:write']);
|
Route::patch('/services/{uuid}', [ServicesController::class, 'update_by_uuid'])->middleware(['ability:write']);
|
||||||
|
@@ -99,15 +99,6 @@ Route::middleware(['throttle:login'])->group(function () {
|
|||||||
Route::get('/auth/{provider}/redirect', [OauthController::class, 'redirect'])->name('auth.redirect');
|
Route::get('/auth/{provider}/redirect', [OauthController::class, 'redirect'])->name('auth.redirect');
|
||||||
Route::get('/auth/{provider}/callback', [OauthController::class, 'callback'])->name('auth.callback');
|
Route::get('/auth/{provider}/callback', [OauthController::class, 'callback'])->name('auth.callback');
|
||||||
|
|
||||||
// Route::prefix('magic')->middleware(['auth'])->group(function () {
|
|
||||||
// Route::get('/servers', [MagicController::class, 'servers']);
|
|
||||||
// Route::get('/destinations', [MagicController::class, 'destinations']);
|
|
||||||
// Route::get('/projects', [MagicController::class, 'projects']);
|
|
||||||
// Route::get('/environments', [MagicController::class, 'environments']);
|
|
||||||
// Route::get('/project/new', [MagicController::class, 'newProject']);
|
|
||||||
// Route::get('/environment/new', [MagicController::class, 'newEnvironment']);
|
|
||||||
// });
|
|
||||||
|
|
||||||
Route::middleware(['auth', 'verified'])->group(function () {
|
Route::middleware(['auth', 'verified'])->group(function () {
|
||||||
Route::middleware(['throttle:force-password-reset'])->group(function () {
|
Route::middleware(['throttle:force-password-reset'])->group(function () {
|
||||||
Route::get('/force-password-reset', ForcePasswordReset::class)->name('auth.force-password-reset');
|
Route::get('/force-password-reset', ForcePasswordReset::class)->name('auth.force-password-reset');
|
||||||
|
Reference in New Issue
Block a user