Refactor/admin attributes routes

src/Common/Validator/RequestValidator.php

@@ -29,18 +29,9 @@ public function validate(Request $request, string $dtoClass): RequestInterface
         }
         $routeParams = $request->attributes->get('_route_params') ?? [];
 
-        if (isset($routeParams['subscriberId'])) {
-            $routeParams['subscriberId'] = (int) $routeParams['subscriberId'];
-        }
-        if (isset($routeParams['messageId'])) {
-            $routeParams['messageId'] = (int) $routeParams['messageId'];
-        }
         if (isset($routeParams['listId'])) {
             $routeParams['listId'] = (int) $routeParams['listId'];
         }
-        if (isset($routeParams['administratorId'])) {
-            $routeParams['administratorId'] = (int) $routeParams['administratorId'];
-        }
 
         $data = array_merge($routeParams, $body ?? []);
 

src/Identity/Controller/AdminAttributeValueController.php

@@ -22,7 +22,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 
-#[Route('/administrators/attribute-values', name: 'admin_attribute_value_')]
+#[Route('/administrators', name: 'admin_attribute_value_')]
 class AdminAttributeValueController extends BaseController
 {
     private AdminAttributeManager $attributeManager;
@@ -46,13 +46,13 @@ public function __construct(
     }
 
     #[Route(
-        path: '/{adminId}/{definitionId}',
+        path: '/{adminId}/attributes/{definitionId}',
         name: 'create',
         requirements: ['adminId' => '\d+', 'definitionId' => '\d+'],
         methods: ['POST', 'PUT'],
     )]
     #[OA\Post(
-        path: '/api/v2/administrators/attribute-values/{adminId}/{definitionId}',
+        path: '/api/v2/administrators/{adminId}/attributes/{definitionId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Returns created/updated admin attribute.',
         summary: 'Create/update an admin attribute.',
@@ -133,13 +133,13 @@ public function createOrUpdate(
     }
 
     #[Route(
-        path: '/{adminId}/{definitionId}',
+        path: '/{adminId}/attributes/{definitionId}',
         name: 'delete',
         requirements: ['adminId' => '\d+', 'definitionId' => '\d+'],
         methods: ['DELETE'],
     )]
     #[OA\Delete(
-        path: '/api/v2/administrators/attribute-values/{adminId}/{definitionId}',
+        path: '/api/v2/administrators/{adminId}/attributes/{definitionId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Deletes a single admin attribute.',
         summary: 'Deletes an attribute.',
@@ -203,9 +203,9 @@ public function delete(
         return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 
-    #[Route('/{adminId}', name: 'get__list', requirements: ['adminId' => '\d+'], methods: ['GET'])]
+    #[Route('/{adminId}/attributes', name: 'get_list', requirements: ['adminId' => '\d+'], methods: ['GET'])]
     #[OA\Get(
-        path: '/api/v2/administrators/attribute-values/{adminId}',
+        path: '/api/v2/administrators/{adminId}/attributes',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Returns a JSON list of all admin attributes.',
         summary: 'Gets a list of all admin attributes.',
@@ -260,6 +260,11 @@ public function delete(
                 response: 403,
                 description: 'Failure',
                 content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/NotFoundErrorResponse')
             )
         ]
     )]
@@ -276,18 +281,18 @@ public function getPaginated(
 
         return $this->json(
             $this->paginatedDataProvider->getPaginatedList(
-                $request,
-                $this->normalizer,
-                AdminAttributeValue::class,
-                $filter
+                request: $request,
+                normalizer:$this->normalizer,
+                className: AdminAttributeValue::class,
+                filter: $filter
             ),
             Response::HTTP_OK
         );
     }
 
-    #[Route('/{adminId}/{definitionId}', name: 'get_one', methods: ['GET'])]
+    #[Route('/{adminId}/attributes/{definitionId}', name: 'get_one', methods: ['GET'])]
     #[OA\Get(
-        path: '/api/v2/administrators/attribute-values/{adminId}/{definitionId}',
+        path: '/api/v2/administrators/{adminId}/attributes/{definitionId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Returns a single attribute.',
         summary: 'Gets admin attribute.',
@@ -355,8 +360,6 @@ public function getAttributeDefinition(
             adminId: $admin->getId(),
             attributeDefinitionId: $definition->getId()
         );
-        $this->attributeManager->delete($attribute);
-        $this->entityManager->flush();
 
         return $this->json(
             $this->normalizer->normalize($attribute),

src/Identity/Controller/AdministratorController.php

@@ -157,16 +157,16 @@ public function createAdministrator(
         return $this->json($json, Response::HTTP_CREATED);
     }
 
-    #[Route('/{administratorId}', name: 'get_one', requirements: ['administratorId' => '\d+'], methods: ['GET'])]
+    #[Route('/{adminId}', name: 'get_one', requirements: ['adminId' => '\d+'], methods: ['GET'])]
     #[OA\Get(
-        path: '/api/v2/administrators/{administratorId}',
+        path: '/api/v2/administrators/{adminId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Get administrator by ID.',
         summary: 'Get Administrator',
         tags: ['administrators'],
         parameters: [
             new OA\Parameter(
-                name: 'administratorId',
+                name: 'adminId',
                 description: 'Administrator ID',
                 in: 'path',
                 required: true,
@@ -194,7 +194,7 @@ public function createAdministrator(
     )]
     public function getAdministrator(
         Request $request,
-        #[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator,
+        #[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator,
     ): JsonResponse {
         $this->requireAuthentication($request);
 
@@ -206,9 +206,9 @@ public function getAdministrator(
         return $this->json($json, Response::HTTP_OK);
     }
 
-    #[Route('/{administratorId}', name: 'update', requirements: ['administratorId' => '\d+'], methods: ['PUT'])]
+    #[Route('/{adminId}', name: 'update', requirements: ['adminId' => '\d+'], methods: ['PUT'])]
     #[OA\Put(
-        path: '/api/v2/administrators/{administratorId}',
+        path: '/api/v2/administrators/{adminId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Update an administrator.',
         summary: 'Update Administrator',
@@ -220,7 +220,7 @@ public function getAdministrator(
         tags: ['administrators'],
         parameters: [
             new OA\Parameter(
-                name: 'administratorId',
+                name: 'adminId',
                 description: 'Administrator ID',
                 in: 'path',
                 required: true,
@@ -248,7 +248,7 @@ public function getAdministrator(
     )]
     public function updateAdministrator(
         Request $request,
-        #[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator,
+        #[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator,
     ): JsonResponse {
         $this->requireAuthentication($request);
 
@@ -263,16 +263,16 @@ public function updateAdministrator(
         return $this->json($this->normalizer->normalize($administrator), Response::HTTP_OK);
     }
 
-    #[Route('/{administratorId}', name: 'delete', requirements: ['administratorId' => '\d+'], methods: ['DELETE'])]
+    #[Route('/{adminId}', name: 'delete', requirements: ['adminId' => '\d+'], methods: ['DELETE'])]
     #[OA\Delete(
-        path: '/api/v2/administrators/{administratorId}',
+        path: '/api/v2/administrators/{adminId}',
         description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
             'Delete an administrator.',
         summary: 'Delete Administrator',
         tags: ['administrators'],
         parameters: [
             new OA\Parameter(
-                name: 'administratorId',
+                name: 'adminId',
                 description: 'Administrator ID',
                 in: 'path',
                 required: true,
@@ -299,7 +299,7 @@ public function updateAdministrator(
     )]
     public function deleteAdministrator(
         Request $request,
-        #[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator
+        #[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator
     ): JsonResponse {
         $this->requireAuthentication($request);
 

src/Identity/Request/UpdateAdministratorRequest.php

@@ -58,8 +58,6 @@
 )]
 class UpdateAdministratorRequest implements RequestInterface
 {
-    public int $administratorId;
-
     #[Assert\Length(min: 3, max: 255)]
     #[UniqueLoginName]
     public ?string $loginName = null;
@@ -89,7 +87,6 @@ class UpdateAdministratorRequest implements RequestInterface
     public function getDto(): UpdateAdministratorDto
     {
         return new UpdateAdministratorDto(
-            administratorId: $this->administratorId,
             loginName: $this->loginName,
             password: $this->password,
             email: $this->email,

src/Messaging/Controller/CampaignController.php

@@ -144,13 +144,21 @@ public function getMessages(Request $request): JsonResponse
                 response: 403,
                 description: 'Failure',
                 content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/NotFoundErrorResponse')
             )
         ]
     )]
     public function getMessage(
         Request $request,
         #[MapEntity(mapping: ['messageId' => 'id'])] ?Message $message = null
     ): JsonResponse {
+        if ($message === null) {
+            throw $this->createNotFoundException('Campaign not found.');
+        }
         $this->requireAuthentication($request);
 
         return $this->json($this->campaignService->getMessage($message), Response::HTTP_OK);
@@ -271,6 +279,11 @@ public function createMessage(Request $request): JsonResponse
                 description: 'Failure',
                 content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
             ),
+            new OA\Response(
+                response: 404,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/NotFoundErrorResponse')
+            ),
             new OA\Response(
                 response: 422,
                 description: 'Failure',
@@ -282,6 +295,9 @@ public function updateMessage(
         Request $request,
         #[MapEntity(mapping: ['messageId' => 'id'])] ?Message $message = null,
     ): JsonResponse {
+        if ($message === null) {
+            throw $this->createNotFoundException('Campaign not found.');
+        }
         $authUser = $this->requireAuthentication($request);
 
         /** @var UpdateMessageRequest $updateMessageRequest */

src/Messaging/Controller/TemplateController.php

@@ -105,9 +105,9 @@ public function getTemplates(Request $request): JsonResponse
 
         return $this->json(
             $this->paginatedDataProvider->getPaginatedList(
-                $request,
-                $this->normalizer,
-                Template::class,
+                request: $request,
+                normalizer: $this->normalizer,
+                className: Template::class,
             ),
             Response::HTTP_OK
         );
@@ -178,51 +178,7 @@ public function getTemplate(
             required: true,
             content: new OA\MediaType(
                 mediaType: 'multipart/form-data',
-                schema: new OA\Schema(
-                    required: ['title'],
-                    properties: [
-                        new OA\Property(
-                            property: 'title',
-                            type: 'string',
-                            example: 'Newsletter Template'
-                        ),
-                        new OA\Property(
-                            property: 'content',
-                            type: 'string',
-                            example: '<html><body>[CONTENT]</body></html>'
-                        ),
-                        new OA\Property(
-                            property: 'text',
-                            type: 'string',
-                            example: '[CONTENT]'
-                        ),
-                        new OA\Property(
-                            property: 'file',
-                            description: 'Optional file upload for HTML content',
-                            type: 'string',
-                            format: 'binary'
-                        ),
-                        new OA\Property(
-                            property: 'check_links',
-                            description: 'Check that all links have full URLs',
-                            type: 'boolean',
-                            example: true
-                        ),
-                        new OA\Property(
-                            property: 'check_images',
-                            description: 'Check that all images have full URLs',
-                            type: 'boolean',
-                            example: false
-                        ),
-                        new OA\Property(
-                            property: 'check_external_images',
-                            description: 'Check that all external images exist',
-                            type: 'boolean',
-                            example: true
-                        ),
-                    ],
-                    type: 'object'
-                )
+                schema: new OA\Schema(ref: '#/components/schemas/CreateTemplateRequest')
             )
         ),
         tags: ['templates'],

src/Messaging/Request/CreateTemplateRequest.php

@@ -4,21 +4,60 @@
 
 namespace PhpList\RestBundle\Messaging\Request;
 
+use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Messaging\Model\Dto\CreateTemplateDto;
 use PhpList\RestBundle\Common\Request\RequestInterface;
 use PhpList\RestBundle\Messaging\Validator\Constraint\ContainsPlaceholder;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 use Symfony\Component\Validator\Constraints as Assert;
 
+#[OA\Schema(
+    schema: 'CreateTemplateRequest',
+    required: ['title'],
+    properties: [
+        new OA\Property(property: 'title', type: 'string', example: 'Newsletter Template'),
+        new OA\Property(
+            property: 'content',
+            type: 'string',
+            example: '<html><body>[CONTENT]</body></html>',
+            nullable: true
+        ),
+        new OA\Property(property: 'text', type: 'string', example: '[CONTENT]'),
+        new OA\Property(
+            property: 'file',
+            description: 'Optional file upload for HTML content',
+            type: 'string',
+            format: 'binary'
+        ),
+        new OA\Property(
+            property: 'check_links',
+            description: 'Check that all links have full URLs',
+            type: 'boolean',
+            example: true
+        ),
+        new OA\Property(
+            property: 'check_images',
+            description: 'Check that all images have full URLs',
+            type: 'boolean',
+            example: false
+        ),
+        new OA\Property(
+            property: 'check_external_images',
+            description: 'Check that all external images exist',
+            type: 'boolean',
+            example: true
+        ),
+    ],
+    type: 'object'
+)]
 class CreateTemplateRequest implements RequestInterface
 {
     #[Assert\NotBlank(normalizer: 'trim')]
     #[Assert\NotNull]
     public string $title;
 
-    #[Assert\NotBlank]
     #[ContainsPlaceholder]
-    public string $content;
+    public ?string $content = null;
 
     #[ContainsPlaceholder]
     public ?string $text = null;