ISSUE-344: api doc

Author: tatevikg1

composer.json

@@ -31,7 +31,7 @@
     },
     "require": {
         "php": "^8.1",
-        "phplist/core": "dev-ISSUE-337",
+        "phplist/core": "dev-main",
         "friendsofsymfony/rest-bundle": "*",
         "symfony/test-pack": "^1.0",
         "symfony/process": "^6.4",

docs/.gitkeep

@@ -267,11 +267,11 @@ public function deleteList(
         return new JsonResponse(null, Response::HTTP_NO_CONTENT, [], false);
     }
 
-    #[Route('/lists/{id}/members', name: 'get_subscriber_from_list', methods: ['GET'])]
+    #[Route('/lists/{id}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
     #[OA\Get(
-        path: '/lists/{list}/members',
+        path: '/lists/{list}/subscribers',
         description: 'Returns a JSON list of all subscribers for a subscriber list.',
-        summary: 'Gets a list of all subscribers (members) of a subscriber list.',
+        summary: 'Gets a list of all subscribers of a subscriber list.',
         tags: ['lists'],
         parameters: [
             new OA\Parameter(

openapi.yaml

@@ -39,7 +39,7 @@ public function __construct(
 
     #[Route('/subscribers', name: 'create_subscriber', methods: ['POST'])]
     #[OA\Post(
-        path: '/subscriber',
+        path: '/subscribers',
         description: 'Creates a new subscriber (if there is no subscriber with the given email address yet).',
         summary: 'Create a subscriber',
         requestBody: new OA\RequestBody(