Boy132 e1308cb04d
Small api docs improvements (#1032)
* update scramble

* cleanup application api endpoints

* cleanup client api endpoints

* fix security schema and make docs homepage nicer

* remove duplicate myclabs/deep-copy

* style(api-docs): use Blade template and Tailwind for styling

* Publish scramble view

* Use localStorage theme instead of config

* Update routes/docs.php

Co-authored-by: Lance Pioch <git@lance.sh>

---------

Co-authored-by: Quinten <67589015+QuintenQVD0@users.noreply.github.com>
Co-authored-by: RMartinOscar <40749467+RMartinOscar@users.noreply.github.com>
Co-authored-by: Lance Pioch <git@lance.sh>
2025-02-26 16:12:19 +01:00

104 lines
3.6 KiB
PHP

<?php
namespace App\Http\Controllers\Api\Client\Servers;
use App\Models\Server;
use App\Facades\Activity;
use App\Models\ServerVariable;
use App\Services\Servers\StartupCommandService;
use App\Transformers\Api\Client\EggVariableTransformer;
use App\Http\Controllers\Api\Client\ClientApiController;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use App\Http\Requests\Api\Client\Servers\Startup\GetStartupRequest;
use App\Http\Requests\Api\Client\Servers\Startup\UpdateStartupVariableRequest;
use Dedoc\Scramble\Attributes\Group;
#[Group('Server - Startup')]
class StartupController extends ClientApiController
{
/**
* StartupController constructor.
*/
public function __construct(
private StartupCommandService $startupCommandService,
) {
parent::__construct();
}
/**
* List startup variables
*
* Returns the startup information for the server including all the variables.
*/
public function index(GetStartupRequest $request, Server $server): array
{
$startup = $this->startupCommandService->handle($server);
return $this->fractal->collection(
$server->variables()->orderBy('sort')->where('user_viewable', true)->get()
)
->transformWith($this->getTransformer(EggVariableTransformer::class))
->addMeta([
'startup_command' => $startup,
'docker_images' => $server->egg->docker_images,
'raw_startup_command' => $server->startup,
])
->toArray();
}
/**
* Update startup variable
*
* Updates a single variable for a server.
*
* @throws \Illuminate\Validation\ValidationException
* @throws \App\Exceptions\Model\DataValidationException
*/
public function update(UpdateStartupVariableRequest $request, Server $server): array
{
$variable = $server->variables()->where('env_variable', $request->input('key'))->first();
if (!$variable || !$variable->user_viewable) {
throw new BadRequestHttpException('The environment variable you are trying to edit does not exist.');
} elseif (!$variable->user_editable) {
throw new BadRequestHttpException('The environment variable you are trying to edit is read-only.');
}
$original = $variable->server_value;
// Revalidate the variable value using the egg variable specific validation rules for it.
$this->validate($request, ['value' => $variable->rules]);
ServerVariable::query()->updateOrCreate([
'server_id' => $server->id,
'variable_id' => $variable->id,
], [
'variable_value' => $request->input('value') ?? '',
]);
$variable = $variable->refresh();
$variable->server_value = $request->input('value');
$startup = $this->startupCommandService->handle($server);
if ($variable->env_variable !== $request->input('value')) {
Activity::event('server:startup.edit')
->subject($variable)
->property([
'variable' => $variable->env_variable,
'old' => $original,
'new' => $request->input('value'),
])
->log();
}
return $this->fractal->item($variable)
->transformWith($this->getTransformer(EggVariableTransformer::class))
->addMeta([
'startup_command' => $startup,
'raw_startup_command' => $server->startup,
])
->toArray();
}
}