Add extension to the OpenAPI processor to automatically convert '*' t…

…o a list of all properties, to save typing and avoid mistakes with newly added field.s

backend/src/Console/Command/Dev/GenerateApiDocsCommand.php

@@ -8,6 +8,7 @@
 use App\Container\EnvironmentAwareTrait;
 use App\Container\LoggerAwareTrait;
 use App\OpenApi\AddXEnumNames;
+use App\OpenApi\MakeAllFieldsRequired;
 use App\Utilities\Types;
 use App\Version;
 use OpenApi\Annotations\OpenApi;
@@ -78,6 +79,7 @@ public function generate(
 
         $pipeline = $generator->getProcessorPipeline();
         $pipeline->add(new AddXEnumNames());
+        $pipeline->add(new MakeAllFieldsRequired());
 
         return $generator->generate($finder);
     }

backend/src/Entity/Api/Account/ChangePassword.php

@@ -9,10 +9,7 @@
 
 #[OA\Schema(
     schema: 'Api_Account_ChangePassword',
-    required: [
-        'current_password',
-        'new_password',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class ChangePassword

backend/src/Entity/Api/Account/NewApiKey.php

@@ -8,9 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Account_NewApiKey',
-    required: [
-        'key',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class NewApiKey

backend/src/Entity/Api/Account/TwoFactorStatus.php

@@ -8,9 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Account_TwoFactorStatus',
-    required: [
-        'two_factor_enabled',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class TwoFactorStatus

backend/src/Entity/Api/Admin/AuditLog.php

@@ -11,18 +11,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_AuditLog',
-    required: [
-        'id',
-        'timestamp',
-        'operation',
-        'operation_text',
-        'class',
-        'identifier',
-        'target_class',
-        'target',
-        'user',
-        'changes',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class AuditLog

backend/src/Entity/Api/Admin/AuditLogChangeset.php

@@ -8,11 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_AuditLogChangeset',
-    required: [
-        'field',
-        'from',
-        'to',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class AuditLogChangeset

backend/src/Entity/Api/Admin/Permission.php

@@ -8,10 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_Permission',
-    required: [
-        'id',
-        'name',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class Permission

backend/src/Entity/Api/Admin/Permissions.php

@@ -8,10 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_Permissions',
-    required: [
-        'global',
-        'station',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class Permissions

backend/src/Entity/Api/Admin/ServerStats/CpuStats.php

@@ -8,11 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_CpuStats',
-    required: [
-        'total',
-        'cores',
-        'load',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final class CpuStats

backend/src/Entity/Api/Admin/ServerStats/CpuStatsSection.php

@@ -9,13 +9,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_CpuStatsSection',
-    required: [
-        'name',
-        'usage',
-        'idle',
-        'io_wait',
-        'steal',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class CpuStatsSection

backend/src/Entity/Api/Admin/ServerStats/MemoryStats.php

@@ -10,22 +10,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_MemoryStats',
-    required: [
-        'total_bytes',
-        'total_readable',
-        'free_bytes',
-        'free_readable',
-        'buffers_bytes',
-        'buffers_readable',
-        'cached_bytes',
-        'cached_readable',
-        'sReclaimable_bytes',
-        'sReclaimable_readable',
-        'shmem_bytes',
-        'shmem_readable',
-        'used_bytes',
-        'used_readable',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class MemoryStats

backend/src/Entity/Api/Admin/ServerStats/NetworkInterfaceReceived.php

@@ -11,17 +11,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_NetworkInterfaceReceived',
-    required: [
-        'speed_bytes',
-        'speed_readable',
-        'packets',
-        'errs',
-        'drop',
-        'fifo',
-        'frame',
-        'compressed',
-        'multicast',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class NetworkInterfaceReceived

backend/src/Entity/Api/Admin/ServerStats/NetworkInterfaceStats.php

@@ -8,11 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_NetworkInterfaceStats',
-    required: [
-        'interface_name',
-        'received',
-        'transmitted',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class NetworkInterfaceStats

backend/src/Entity/Api/Admin/ServerStats/NetworkInterfaceTransmitted.php

@@ -11,17 +11,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_NetworkInterfaceTransmitted',
-    required: [
-        'speed_bytes',
-        'speed_readable',
-        'packets',
-        'errs',
-        'drop',
-        'fifo',
-        'frame',
-        'carrier',
-        'compressed',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final class NetworkInterfaceTransmitted

backend/src/Entity/Api/Admin/ServerStats/ServerStats.php

@@ -8,13 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats',
-    required: [
-        'cpu',
-        'memory',
-        'swap',
-        'disk',
-        'network',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class ServerStats

backend/src/Entity/Api/Admin/ServerStats/StorageStats.php

@@ -10,14 +10,7 @@
 
 #[OA\Schema(
     schema: 'Api_Admin_ServerStats_StorageStats',
-    required: [
-        'total_bytes',
-        'total_readable',
-        'free_bytes',
-        'free_readable',
-        'used_bytes',
-        'used_readable',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final class StorageStats

backend/src/Entity/Api/Error.php

@@ -11,14 +11,7 @@
 
 #[OA\Schema(
     schema: 'Api_Error',
-    required: [
-        'code',
-        'type',
-        'message',
-        'formatted_message',
-        'extra_data',
-        'success',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class Error

backend/src/Entity/Api/LogContents.php

@@ -8,11 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_LogContents',
-    required: [
-        'contents',
-        'eof',
-        'position',
-    ],
+    required: ['*'],
     type: 'object',
     readOnly: true
 )]

backend/src/Entity/Api/LogType.php

@@ -9,13 +9,7 @@
 
 #[OA\Schema(
     schema: 'Api_LogType',
-    required: [
-        'key',
-        'name',
-        'path',
-        'tail',
-        'links',
-    ],
+    required: ['*'],
     type: 'object',
     readOnly: true
 )]

backend/src/Entity/Api/Status.php

@@ -8,11 +8,7 @@
 
 #[OA\Schema(
     schema: 'Api_Status',
-    required: [
-        'success',
-        'message',
-        'formatted_message',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 readonly class Status

backend/src/Entity/Api/SystemStatus.php

@@ -9,10 +9,7 @@
 
 #[OA\Schema(
     schema: 'Api_SystemStatus',
-    required: [
-        'online',
-        'timestamp',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class SystemStatus

backend/src/Entity/Api/Time.php

@@ -9,13 +9,7 @@
 
 #[OA\Schema(
     schema: 'Api_Time',
-    required: [
-        'timestamp',
-        'utc_datetime',
-        'utc_date',
-        'utc_time',
-        'utc_json',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class Time

backend/src/Entity/Api/UploadFile.php

@@ -10,10 +10,7 @@
 
 #[OA\Schema(
     schema: 'Api_UploadFile',
-    required: [
-        'path',
-        'file',
-    ],
+    required: ['*'],
     type: 'object'
 )]
 final readonly class UploadFile

backend/src/OpenApi/MakeAllFieldsRequired.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\OpenApi;
+
+use OpenApi\Analysis;
+use OpenApi\Annotations as OA;
+use OpenApi\Generator;
+
+/**
+ * Expand '*' in the `required` field to be every field in the schema.
+ */
+class MakeAllFieldsRequired
+{
+    public function __invoke(Analysis $analysis): void
+    {
+        /** @var OA\Schema[] $schemas */
+        $schemas = $analysis->getAnnotationsOfType(OA\Schema::class, true);
+
+        foreach ($schemas as $schema) {
+            if ($schema->required === ['*']) {
+                $schema->required = $this->getPropertyNames($schema);
+            }
+        }
+    }
+
+    protected function getPropertyNames(OA\Schema $schema): array
+    {
+        $propertyNames = [];
+
+        if (!Generator::isDefault($schema->allOf)) {
+            foreach ($schema->allOf as $item) {
+                $propertyNames = array_merge($propertyNames, $this->getPropertyNames($item));
+            }
+        }
+
+        if (!Generator::isDefault($schema->properties)) {
+            foreach ($schema->properties as $property) {
+                if (!Generator::isDefault($property->property)) {
+                    $propertyNames[] = $property->property;
+                }
+            }
+        }
+
+        return $propertyNames;
+    }
+}

web/static/openapi.yml

@@ -4472,7 +4472,6 @@ components:
         - name
         - path
         - tail
-        - links
       type: object
       readOnly: true
       allOf: