feat: add Endpoint for list a workspace for actually authorized user

Author: BibaltiK

public/api/docs/swagger.json

@@ -290,7 +290,7 @@
                 ],
                 "summary": "Returns a collection of all workspaces owned by or associated with the currently authenticated user.",
                 "description": "List all workspaces for the authenticated account",
-                "operationId": "findWorkspaces",
+                "operationId": "findOwnWorkspaces",
                 "parameters": [
                     {
                         "name": "page",
@@ -322,7 +322,18 @@
                         "content": {
                             "application/json": {
                                 "schema": {
-                                    "$ref": "#/components/schemas/WorkspaceList"
+                                    "properties": {
+                                        "workspaces": {
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "#/components/schemas/WorkspaceResponse"
+                                            }
+                                        },
+                                        "meta": {
+                                            "$ref": "#/components/schemas/PaginationMeta"
+                                        }
+                                    },
+                                    "type": "object"
                                 }
                             }
                         }
@@ -595,6 +606,25 @@
                 },
                 "type": "object"
             },
+            "PaginationMeta": {
+                "title": "Pagination Meta",
+                "description": "Info about the number of pages and limits",
+                "properties": {
+                    "currentPage": {
+                        "type": "integer",
+                        "example": 1
+                    },
+                    "totalPages": {
+                        "type": "integer",
+                        "example": 10
+                    },
+                    "totalItems": {
+                        "type": "integer",
+                        "example": 100
+                    }
+                },
+                "type": "object"
+            },
             "WorkspaceList": {
                 "properties": {
                     "workspaces": {

src/App/Workspace/src/DTO/PaginationMeta.php

@@ -2,17 +2,26 @@
 
 namespace ownHackathon\Workspace\DTO;
 
+use OpenApi\Attributes as OA;
+
+#[OA\Schema(
+    title: 'Pagination Meta',
+    description: 'Info about the number of pages and limits'
+)]
 readonly class PaginationMeta
 {
     public function __construct(
-        public int $totalItems,
-        public int $totalPages,
+        #[OA\Property(example: 1)]
         public int $currentPage,
+        #[OA\Property(example: 10)]
+        public int $totalPages,
+        #[OA\Property(example: 100)]
+        public int $totalItems,
     ) {
     }
 
     public static function fromValues(int $totalCount, int $totalPages, int $currentPage): self
     {
-        return new self($totalCount, $totalPages, $currentPage);
+        return new self($currentPage, $totalPages, $totalCount);
     }
 }

src/App/Workspace/src/Handler/ListOwnWorkspacesHandler.php

@@ -4,11 +4,12 @@
 
 use Exdrals\Identity\DTO\Response\HttpResponseMessage;
 use Exdrals\Shared\Domain\Account\AccountInterface;
+use Exdrals\Shared\Domain\Enum\DataType;
 use Fig\Http\Message\StatusCodeInterface as HTTP;
 use Laminas\Diactoros\Response\JsonResponse;
 use OpenApi\Attributes as OA;
 use ownHackathon\Shared\Domain\ValueObject\Pagination;
-use ownHackathon\Workspace\DTO\WorkspaceList;
+use ownHackathon\Workspace\DTO\PaginationMeta;
 use ownHackathon\Workspace\DTO\WorkspaceResponse;
 use ownHackathon\Workspace\Infrastructure\Persistence\Repository\WorkspaceRepository;
 use ownHackathon\Workspace\Infrastructure\Service\PaginationService;
@@ -26,7 +27,7 @@ public function __construct(
 
     #[OA\Get(
         path: '/me/workspaces',
-        operationId: 'findWorkspaces',
+        operationId: 'findOwnWorkspaces',
         description: 'List all workspaces for the authenticated account',
         summary: 'Returns a collection of all workspaces owned by or associated with the currently authenticated user.',
         security: [['accessToken' => []]],
@@ -58,7 +59,21 @@ public function __construct(
     #[OA\Response(
         response: HTTP::STATUS_OK,
         description: 'A list of workspaces belonging to the user.',
-        content: new OA\JsonContent(ref: WorkspaceList::class)
+        content: new OA\JsonContent(
+            properties: [
+                new OA\Property(
+                    property: 'workspaces',
+                    type: 'array',
+                    items: new OA\Items(ref: WorkspaceResponse::class)
+                ),
+                new OA\Property(
+                    property: 'meta',
+                    ref: PaginationMeta::class,
+                    type: DataType::OBJECT->value
+                ),
+            ],
+            type: DataType::OBJECT->value
+        )
     )]
     #[OA\Response(
         response: HTTP::STATUS_UNAUTHORIZED,
@@ -86,7 +101,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface
             'workspaces' => $response,
             'meta' => [
                 'currentPage' => $metaData->currentPage,
-                'maxPages' => $metaData->totalPages,
+                'totalPages' => $metaData->totalPages,
                 'totalItems' => $metaData->totalItems,
             ],
         ], HTTP::STATUS_OK);