Add public page to return list data

Author: tatevikg1

src/Subscription/Controller/SubscribePageController.php

@@ -122,7 +122,7 @@ className: SubscribePage::class,
                 name: 'php-auth-pw',
                 description: 'Session key obtained from login',
                 in: 'header',
-                required: true,
+                required: false,
                 schema: new OA\Schema(type: 'string')
             ),
             new OA\Parameter(

src/Subscription/Controller/SubscriberListController.php

@@ -181,6 +181,73 @@ public function getList(
         return $this->json($this->normalizer->normalize($list), Response::HTTP_OK);
     }
 
+    #[Route('/{listId}/public', name: 'get_one_public', requirements: ['listId' => '\d+'], methods: ['GET'])]
+    #[OA\Get(
+        path: '/api/v2/lists/{listId}/public',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
+        'Returns a single subscriber list with specified ID.',
+        summary: 'Gets a subscriber list.',
+        tags: ['lists'],
+        parameters: [
+            new OA\Parameter(
+                name: 'listId',
+                description: 'List ID',
+                in: 'path',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+        ],
+        responses: [
+            new OA\Response(
+                response: 200,
+                description: 'Success',
+                content: [
+                    'application/json' => new OA\MediaType(
+                        schema: new OA\Schema(
+                            properties: [
+                                new OA\Property(property: 'id', type: 'integer', example: 1),
+                                new OA\Property(property: 'name', type: 'string', example: 'Newsletter subscribers'),
+                                new OA\Property(
+                                    property: 'description',
+                                    type: 'string',
+                                    example: 'Main public list',
+                                    nullable: true
+                                )
+                            ],
+                            type: 'object'
+                        )
+                    )
+                ]
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Failure',
+                content: new OA\JsonContent(
+                    properties: [
+                        new OA\Property(
+                            property: 'message',
+                            type: 'string',
+                            example: 'There is no list with that ID.'
+                        )
+                    ],
+                    type: 'object'
+                )
+            ),
+        ]
+    )]
+    public function getPublicList(#[MapEntity(mapping: ['listId' => 'id'])] ?SubscriberList $list = null): JsonResponse
+    {
+        if (!$list) {
+            throw $this->createNotFoundException('Subscriber list not found.');
+        }
+
+        return $this->json([
+            'id' => $list->getId(),
+            'name' => $list->getName(),
+            'description' => $list->getDescription(),
+        ], Response::HTTP_OK);
+    }
+
     #[Route('/{listId}', name: 'delete', requirements: ['listId' => '\d+'], methods: ['DELETE'])]
     #[OA\Delete(
         path: '/api/v2/lists/{listId}',

tests/Integration/Subscription/Controller/SubscribePageControllerTest.php

@@ -20,12 +20,12 @@ public function testControllerIsAvailableViaContainer(): void
         );
     }
 
-    public function testGetSubscribePageWithoutSessionReturnsForbidden(): void
+    public function testGetSubscribePageWithoutSessionReturnsPageIfItIsActive(): void
     {
         $this->loadFixtures([AdministratorFixture::class, SubscribePageFixture::class]);
 
         self::getClient()->request('GET', '/api/v2/subscribe-pages/1');
-        $this->assertHttpForbidden();
+        $this->assertHttpOkay();
     }
 
     public function testGetSubscribePageWithSessionReturnsPage(): void