Merge pull request #2594 from tarlepp/feat/open-api-annotations-to-at…

…tributes Feat - Use Open API attributes instead of annotations
tarlepp · Dec 31, 2023 · de51535 · de51535
2 parents d516430 + fd27fa1
commit de51535
Show file tree

Hide file tree

Showing 13 changed files with 60 additions and 68 deletions.
diff --git a/config/packages/nelmio_api_doc.yaml b/config/packages/nelmio_api_doc.yaml
@@ -16,7 +16,7 @@ nelmio_api_doc:
             path_patterns:
                 - ^/api/doc
                 - ^/api/doc.json
-                - ^/(auth|healthz|version|profile|localization)
+                - ^/(healthz|version|v1/auth|v1/profile|v1/localization)
         internal:
             path_patterns: # an array of regexps
                 - ^/[a-z]
diff --git a/src/Controller/v1/Localization/TimeZoneController.php b/src/Controller/v1/Localization/TimeZoneController.php
@@ -76,7 +76,12 @@ public function __construct(
                 ],
                 type: 'object'
             ),
-            example: ['en', 'fi']
+            example: [
+                'timezone' => 'Europe',
+                'identifier' => 'Europe/Helsinki',
+                'offset' => 'GMT+2:00',
+                'value' => 'Europe/Helsinki',
+            ],
         ),
     )]
     public function __invoke(): JsonResponse

diff --git a/src/Controller/v1/Profile/GroupsController.php b/src/Controller/v1/Profile/GroupsController.php
@@ -44,14 +44,13 @@ public function __construct(
         methods: [Request::METHOD_GET],
     )]
     #[IsGranted(AuthenticatedVoter::IS_AUTHENTICATED_FULLY)]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/Profile/IndexController.php b/src/Controller/v1/Profile/IndexController.php
@@ -49,14 +49,13 @@ public function __construct(
         methods: [Request::METHOD_GET],
     )]
     #[IsGranted(AuthenticatedVoter::IS_AUTHENTICATED_FULLY)]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/Profile/RolesController.php b/src/Controller/v1/Profile/RolesController.php
@@ -42,14 +42,11 @@ public function __construct(
         methods: [Request::METHOD_GET],
     )]
     #[IsGranted(AuthenticatedVoter::IS_AUTHENTICATED_FULLY)]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        example: 'Bearer {token}',
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/Role/InheritedRolesController.php b/src/Controller/v1/Role/InheritedRolesController.php
@@ -48,14 +48,13 @@ public function __construct(
         methods: [Request::METHOD_GET],
     )]
     #[IsGranted(RoleEnum::ADMIN->value)]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/User/AttachUserGroupController.php b/src/Controller/v1/User/AttachUserGroupController.php
@@ -58,14 +58,13 @@ public function __construct(
     )]
     #[IsGranted(Role::ROOT->value)]
     #[OA\Tag(name: 'User Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Parameter(name: 'user', description: 'User GUID', in: 'path', required: true)]
     #[OA\Parameter(name: 'userGroup', description: 'User Group GUID', in: 'path', required: true)]

diff --git a/src/Controller/v1/User/DetachUserGroupController.php b/src/Controller/v1/User/DetachUserGroupController.php
@@ -57,14 +57,13 @@ public function __construct(
     )]
     #[IsGranted(Role::ROOT->value)]
     #[OA\Tag(name: 'User Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Parameter(name: 'user', description: 'User GUID', in: 'path', required: true)]
     #[OA\Parameter(name: 'userGroup', description: 'User Group GUID', in: 'path', required: true)]

diff --git a/src/Controller/v1/User/UserGroupsController.php b/src/Controller/v1/User/UserGroupsController.php
@@ -49,14 +49,13 @@ public function __construct(
     )]
     #[IsGranted(new Expression('is_granted("IS_USER_HIMSELF", object) or "ROLE_ROOT" in role_names'), 'user')]
     #[OA\Tag(name: 'User Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/User/UserRolesController.php b/src/Controller/v1/User/UserRolesController.php
@@ -47,14 +47,13 @@ public function __construct(
     )]
     #[IsGranted(new Expression('is_granted("IS_USER_HIMSELF", object) or "ROLE_ROOT" in role_names'), 'user')]
     #[OA\Tag(name: 'User Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,

diff --git a/src/Controller/v1/UserGroup/AttachUserController.php b/src/Controller/v1/UserGroup/AttachUserController.php
@@ -57,14 +57,13 @@ public function __construct(
     )]
     #[IsGranted(Role::ROOT->value)]
     #[OA\Tag(name: 'UserGroup Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Parameter(name: 'userGroup', description: 'User Group GUID', in: 'path', required: true)]
     #[OA\Parameter(name: 'user', description: 'User GUID', in: 'path', required: true)]

diff --git a/src/Controller/v1/UserGroup/DetachUserController.php b/src/Controller/v1/UserGroup/DetachUserController.php
@@ -57,14 +57,13 @@ public function __construct(
     )]
     #[IsGranted(Role::ROOT->value)]
     #[OA\Tag(name: 'UserGroup Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Parameter(name: 'userGroup', description: 'User Group GUID', in: 'path', required: true)]
     #[OA\Parameter(name: 'user', description: 'User GUID', in: 'path', required: true)]

diff --git a/src/Controller/v1/UserGroup/UsersController.php b/src/Controller/v1/UserGroup/UsersController.php
@@ -54,14 +54,13 @@ public function __construct(
     )]
     #[IsGranted(Role::ROOT->value)]
     #[OA\Tag(name: 'UserGroup Management')]
-    #[OA\SecurityScheme(
-        securityScheme: 'bearerAuth',
-        type: 'http',
+    #[OA\Parameter(
+        name: 'Authorization',
         description: 'Authorization header',
-        name: 'bearerAuth',
         in: 'header',
-        bearerFormat: 'JWT',
-        scheme: 'bearer',
+        required: true,
+        example: 'Bearer {token}',
+        allowReserved: true,
     )]
     #[OA\Response(
         response: 200,