ISSUE-344: fix parameter names

Author: tatevikg1

src/Controller/ListController.php

@@ -24,6 +24,7 @@
  *
  * @author Oliver Klee <oliver@phplist.com>
  * @author Xheni Myrtaj <xheni@phplist.com>
+ * @author Tatevik Grigoryan <tatevik@phplist.com>
  */
 class ListController extends AbstractController
 {
@@ -119,15 +120,15 @@ public function getLists(Request $request): JsonResponse
         return new JsonResponse($json, Response::HTTP_OK, [], true);
     }
 
-    #[Route('/lists/{id}', name: 'get_list', methods: ['GET'])]
+    #[Route('/lists/{listId}', name: 'get_list', methods: ['GET'])]
     #[OA\Get(
-        path: '/lists/{list}',
+        path: '/lists/{listId}',
         description: 'Returns a single subscriber list with specified ID.',
         summary: 'Gets a subscriber list.',
         tags: ['lists'],
         parameters: [
             new OA\Parameter(
-                name: 'list',
+                name: 'listId',
                 description: 'List ID',
                 in: 'path',
                 required: true,
@@ -189,8 +190,10 @@ public function getLists(Request $request): JsonResponse
             )
         ]
     )]
-    public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list): JsonResponse
-    {
+    public function getList(
+        Request $request,
+        #[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
+    ): JsonResponse {
         $this->requireAuthentication($request);
         $json = $this->serializer->serialize($list, 'json', [
             AbstractNormalizer::GROUPS => 'SubscriberList',
@@ -199,9 +202,9 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
         return new JsonResponse($json, Response::HTTP_OK, [], true);
     }
 
-    #[Route('/lists/{id}', name: 'delete_list', methods: ['DELETE'])]
+    #[Route('/lists/{listId}', name: 'delete_list', methods: ['DELETE'])]
     #[OA\Delete(
-        path: '/lists/{list}',
+        path: '/lists/{listId}',
         description: 'Deletes a single subscriber list.',
         summary: 'Deletes a list.',
         tags: ['lists'],
@@ -214,7 +217,7 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
                 schema: new OA\Schema(type: 'string')
             ),
             new OA\Parameter(
-                name: 'list',
+                name: 'listId',
                 description: 'List ID',
                 in: 'path',
                 required: true,
@@ -258,7 +261,7 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
     )]
     public function deleteList(
         Request $request,
-        #[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
+        #[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
     ): JsonResponse {
         $this->requireAuthentication($request);
 
@@ -267,9 +270,9 @@ public function deleteList(
         return new JsonResponse(null, Response::HTTP_NO_CONTENT, [], false);
     }
 
-    #[Route('/lists/{id}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
+    #[Route('/lists/{listId}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
     #[OA\Get(
-        path: '/lists/{id}/subscribers',
+        path: '/lists/{listId}/subscribers',
         description: 'Returns a JSON list of all subscribers for a subscriber list.',
         summary: 'Gets a list of all subscribers of a subscriber list.',
         tags: ['lists'],
@@ -282,7 +285,7 @@ public function deleteList(
                 schema: new OA\Schema(type: 'string')
             ),
             new OA\Parameter(
-                name: 'id',
+                name: 'listId',
                 description: 'List ID',
                 in: 'path',
                 required: true,
@@ -338,7 +341,7 @@ public function deleteList(
     )]
     public function getListMembers(
         Request $request,
-        #[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
+        #[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
     ): JsonResponse {
         $this->requireAuthentication($request);
 
@@ -351,9 +354,9 @@ public function getListMembers(
         return new JsonResponse($json, Response::HTTP_OK, [], true);
     }
 
-    #[Route('/lists/{id}/subscribers/count', name: 'get_subscribers_count_from_list', methods: ['GET'])]
+    #[Route('/lists/{listId}/subscribers/count', name: 'get_subscribers_count_from_list', methods: ['GET'])]
     #[OA\Get(
-        path: '/lists/{id}/count',
+        path: '/lists/{listId}/count',
         description: 'Returns a count of all subscribers in a given list.',
         summary: 'Gets the total number of subscribers of a list',
         tags: ['lists'],
@@ -366,7 +369,7 @@ public function getListMembers(
                 schema: new OA\Schema(type: 'string')
             ),
             new OA\Parameter(
-                name: 'id',
+                name: 'listId',
                 description: 'List ID',
                 in: 'path',
                 required: true,
@@ -396,7 +399,7 @@ public function getListMembers(
     )]
     public function getSubscribersCount(
         Request $request,
-        #[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
+        #[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
     ): JsonResponse {
         $this->requireAuthentication($request);
         $json = $this->serializer->serialize(count($list->getSubscribers()), 'json');

src/Controller/SessionController.php

@@ -129,15 +129,15 @@ public function createSession(Request $request): JsonResponse
      *
      * @throws AccessDeniedHttpException
      */
-    #[Route('/sessions/{id}', name: 'delete_session', methods: ['DELETE'])]
+    #[Route('/sessions/{sessionId}', name: 'delete_session', methods: ['DELETE'])]
     #[OA\Delete(
-        path: '/sessions/{session}',
+        path: '/sessions/{sessionId}',
         description: 'Delete the session passed as a parameter.',
         summary: 'Delete a session.',
         tags: ['sessions'],
         parameters: [
             new OA\Parameter(
-                name: 'session',
+                name: 'sessionId',
                 description: 'Session ID',
                 in: 'path',
                 required: true,
@@ -179,7 +179,7 @@ public function createSession(Request $request): JsonResponse
     )]
     public function deleteAction(
         Request $request,
-        #[MapEntity(mapping: ['id' => 'id'])] AdministratorToken $token
+        #[MapEntity(mapping: ['sessionId' => 'id'])] AdministratorToken $token
     ): JsonResponse {
         $administrator = $this->requireAuthentication($request);
         if ($token->getAdministrator() !== $administrator) {

src/Controller/SubscriberController.php

@@ -158,9 +158,9 @@ public function postAction(Request $request, SerializerInterface $serializer): J
         );
     }
 
-    #[Route('/subscribers/{subscriber}', name: 'get_subscriber_by_id', methods: ['GET'])]
+    #[Route('/subscribers/{subscriberId}', name: 'get_subscriber_by_id', methods: ['GET'])]
     #[OA\Get(
-        path: '/subscribers/{subscriber}',
+        path: '/subscribers/{subscriberId}',
         description: 'Get subscriber date by id.',
         summary: 'Get a subscriber',
         tags: ['subscribers'],
@@ -173,7 +173,7 @@ public function postAction(Request $request, SerializerInterface $serializer): J
                 schema: new OA\Schema(type: 'string')
             ),
             new OA\Parameter(
-                name: 'id',
+                name: 'subscriberId',
                 description: 'Subscriber ID',
                 in: 'path',
                 required: true,
@@ -228,7 +228,7 @@ public function postAction(Request $request, SerializerInterface $serializer): J
     )]
     public function getAction(
         Request $request,
-        #[MapEntity(mapping: ['id' => 'id'])] Subscriber $subscriber,
+        #[MapEntity(mapping: ['subscriberId' => 'id'])] Subscriber $subscriber,
         SerializerInterface $serializer
     ): JsonResponse {
         $this->requireAuthentication($request);