From 862afaa0e97f019d4e1ce32464b9fe024b2c7397 Mon Sep 17 00:00:00 2001 From: Boy132 Date: Tue, 15 Apr 2025 23:47:31 +0200 Subject: [PATCH] Fix api docs for server update requests (#1262) * workaround for api docs error * add deprecated notice --- .../Servers/UpdateServerBuildConfigurationRequest.php | 10 +++++++--- .../Application/Servers/UpdateServerDetailsRequest.php | 2 +- .../Application/Servers/UpdateServerStartupRequest.php | 4 ++-- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/app/Http/Requests/Api/Application/Servers/UpdateServerBuildConfigurationRequest.php b/app/Http/Requests/Api/Application/Servers/UpdateServerBuildConfigurationRequest.php index 8c8d9e0ec..052ae1d4b 100644 --- a/app/Http/Requests/Api/Application/Servers/UpdateServerBuildConfigurationRequest.php +++ b/app/Http/Requests/Api/Application/Servers/UpdateServerBuildConfigurationRequest.php @@ -12,7 +12,7 @@ class UpdateServerBuildConfigurationRequest extends ServerWriteRequest */ public function rules(): array { - $rules = Server::getRulesForUpdate($this->parameter('server', Server::class)); + $rules = $this->route() ? Server::getRulesForUpdate($this->parameter('server', Server::class)) : Server::getRules(); return [ 'allocation' => $rules['allocation_id'], @@ -26,13 +26,17 @@ class UpdateServerBuildConfigurationRequest extends ServerWriteRequest 'limits.threads' => $this->requiredToOptional('threads', $rules['threads'], true), 'limits.disk' => $this->requiredToOptional('disk', $rules['disk'], true), - // Legacy rules to maintain backwards compatable API support without requiring - // a major version bump. + // Deprecated - use limits.memory 'memory' => $this->requiredToOptional('memory', $rules['memory']), + // Deprecated - use limits.swap 'swap' => $this->requiredToOptional('swap', $rules['swap']), + // Deprecated - use limits.io 'io' => $this->requiredToOptional('io', $rules['io']), + // Deprecated - use limits.cpu 'cpu' => $this->requiredToOptional('cpu', $rules['cpu']), + // Deprecated - use limits.threads 'threads' => $this->requiredToOptional('threads', $rules['threads']), + // Deprecated - use limits.disk 'disk' => $this->requiredToOptional('disk', $rules['disk']), 'add_allocations' => 'bail|array', diff --git a/app/Http/Requests/Api/Application/Servers/UpdateServerDetailsRequest.php b/app/Http/Requests/Api/Application/Servers/UpdateServerDetailsRequest.php index 0d781a9bf..ad419e8ac 100644 --- a/app/Http/Requests/Api/Application/Servers/UpdateServerDetailsRequest.php +++ b/app/Http/Requests/Api/Application/Servers/UpdateServerDetailsRequest.php @@ -11,7 +11,7 @@ class UpdateServerDetailsRequest extends ServerWriteRequest */ public function rules(): array { - $rules = Server::getRulesForUpdate($this->parameter('server', Server::class)); + $rules = $this->route() ? Server::getRulesForUpdate($this->parameter('server', Server::class)) : Server::getRules(); return [ 'external_id' => $rules['external_id'], diff --git a/app/Http/Requests/Api/Application/Servers/UpdateServerStartupRequest.php b/app/Http/Requests/Api/Application/Servers/UpdateServerStartupRequest.php index c03bb9bdb..d1330c9ae 100644 --- a/app/Http/Requests/Api/Application/Servers/UpdateServerStartupRequest.php +++ b/app/Http/Requests/Api/Application/Servers/UpdateServerStartupRequest.php @@ -17,12 +17,12 @@ class UpdateServerStartupRequest extends ApplicationApiRequest */ public function rules(): array { - $data = Server::getRulesForUpdate($this->parameter('server', Server::class)); + $rules = $this->route() ? Server::getRulesForUpdate($this->parameter('server', Server::class)) : Server::getRules(); return [ 'startup' => 'sometimes|string', 'environment' => 'present|array', - 'egg' => $data['egg_id'], + 'egg' => $rules['egg_id'], 'image' => 'sometimes|string', 'skip_scripts' => 'present|boolean', ];