ISSUE-345: 422 in schema

Author: tatevikg1

Diff for: composer.json

@@ -29,9 +29,15 @@
         "forum": "https://discuss.phplist.org/",
         "source": "https://github.com/phpList/rest-api"
     },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/phpList/core"
+        }
+    ],
     "require": {
         "php": "^8.1",
-        "phplist/core": "v5.0.0-alpha4",
+        "phplist/core": "dev-ISSUE-345",
         "friendsofsymfony/rest-bundle": "*",
         "symfony/test-pack": "^1.0",
         "symfony/process": "^6.4",

Diff for: src/Controller/ListController.php

@@ -47,7 +47,7 @@ public function __construct(
         $this->serializer = $serializer;
     }
 
-    #[Route('/', name: 'get_lists', methods: ['GET'])]
+    #[Route('', name: 'get_lists', methods: ['GET'])]
     #[OA\Get(
         path: '/lists',
         description: 'Returns a JSON list of all subscriber lists.',

Diff for: src/Controller/SubscriberController.php

@@ -90,16 +90,8 @@ public function __construct(Authentication $authentication, SubscriberManager $s
             new OA\Response(
                 response: 422,
                 description: 'Failure',
-                content: new OA\JsonContent(
-                    properties: [
-                        new OA\Property(
-                            property: 'message',
-                            type: 'string',
-                            example: 'Some fields invalid: email, confirmed, html_email'
-                        )
-                    ]
-                )
-            )
+                content: new OA\JsonContent(ref: '#/components/schemas/ValidationErrorResponse')
+            ),
         ]
     )]
     public function createSubscriber(
@@ -170,6 +162,11 @@ public function createSubscriber(
                 description: 'Failure',
                 content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
             ),
+            new OA\Response(
+                response: 422,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/ValidationErrorResponse')
+            ),
             new OA\Response(
                 response: 404,
                 description: 'Not Found',

Diff for: src/Controller/Traits/AuthenticationTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace PhpList\RestBundle\Controller\Traits;
@@ -9,26 +10,20 @@
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
 /**
- * This traits provides functionality for authenticating the REST API client.
+ * This trait provides functionality for authenticating the REST API client.
  *
  * Please note that this trait requires the class to set the authentication instance via DI.
  *
  * @author Oliver Klee <[email protected]>
+ * @author Tatevik Grigoryan <[email protected]>
  */
 trait AuthenticationTrait
 {
-    /**
-     * @var Authentication
-     */
-    private $authentication = null;
+    private ?Authentication $authentication = null;
 
     /**
      * Checks for valid authentication in the given request and throws an exception if there is none.
      *
-     * @param Request $request
-     *
-     * @return Administrator the authenticated administrator
-     *
      * @throws AccessDeniedHttpException
      */
     private function requireAuthentication(Request $request): Administrator

Diff for: src/OpenApi/SwaggerSchemas.php

@@ -58,6 +58,17 @@
     ],
     type: 'object'
 )]
+#[OA\Schema(
+    schema: 'ValidationErrorResponse',
+    properties: [
+        new OA\Property(
+            property: 'message',
+            type: 'string',
+            example: 'Some fields invalid: email, confirmed, html_email'
+        )
+    ],
+    type: 'object'
+)]
 class SwaggerSchemas
 {
 }