added operationId

Signed-off-by: bidi47 <bidi@apidemia.com>

Author: bidi47

src/Admin/src/OpenAPI.php

@@ -27,6 +27,7 @@
  */
 #[OA\Get(
     path: '/admin',
+    operationId: 'getAdminCollection',
     description: 'Authenticated (super)admin fetches a list of admin accounts',
     summary: 'Admin lists admin accounts',
     security: [['AuthToken' => []]],
@@ -98,6 +99,7 @@
  */
 #[OA\Post(
     path: '/admin',
+    operationId: 'postAdminResource',
     description: 'Authenticated (super)admin creates a new admin account',
     summary: 'Admin creates an admin account',
     security: [['AuthToken' => []]],
@@ -157,6 +159,7 @@
  */
 #[OA\Delete(
     path: '/admin/{id}',
+    operationId: 'deleteAdminResource',
     description: 'Authenticated (super)admin deletes an admin account identified by its id',
     summary: 'Admin deletes an admin account',
     security: [['AuthToken' => []]],
@@ -187,6 +190,7 @@
  */
 #[OA\Get(
     path: '/admin/{id}',
+    operationId: 'getAdminResource',
     description: 'Authenticated (super)admin fetches an admin account identified by its id',
     summary: 'Admin fetches an admin account',
     security: [['AuthToken' => []]],
@@ -218,6 +222,7 @@
  */
 #[OA\Patch(
     path: '/admin/{id}',
+    operationId: 'patchAdminResource',
     description: 'Authenticated (super)admin updates an existing admin account',
     summary: 'Admin updates an admin account',
     security: [['AuthToken' => []]],
@@ -284,6 +289,7 @@
  */
 #[OA\Get(
     path: '/admin/role',
+    operationId: 'getAdminRoleCollection',
     description: 'Authenticated (super)admin fetches a list of admin roles',
     summary: 'Admin lists admin roles',
     security: [['AuthToken' => []]],
@@ -352,6 +358,7 @@
  */
 #[OA\Get(
     path: '/admin/role/{id}',
+    operationId: 'getAdminRoleResource',
     description: 'Authenticated (super)admin fetches an admin role identified by its id',
     summary: 'Admin fetches an admin role',
     security: [['AuthToken' => []]],
@@ -383,6 +390,7 @@
  */
 #[OA\Get(
     path: '/admin/account',
+    operationId: 'getAdminAccountResource',
     description: 'Authenticated (super)admin fetches their own account data',
     summary: 'Admin fetches their own account',
     security: [['AuthToken' => []]],
@@ -401,6 +409,7 @@
  */
 #[OA\Patch(
     path: '/admin/account',
+    operationId: 'patchAdminAccountResource',
     description: 'Authenticated (super)admin updates their own account data',
     summary: 'Admin updates their own account',
     security: [['AuthToken' => []]],

src/App/src/OpenAPI.php

@@ -14,6 +14,7 @@
  */
 #[OA\Get(
     path: '/',
+    operationId: 'getIndexResource',
     description: 'API home page outputting default message',
     summary: 'API home page',
     tags: ['Home'],
@@ -35,6 +36,7 @@
  */
 #[OA\Post(
     path: '/error-report',
+    operationId: 'postErrorReportResource',
     description: 'Third-party application reports an error to the API',
     summary: 'Report an error to the API',
     security: [['ErrorReportingToken' => []]],

src/Security/src/OpenAPI.php

@@ -13,6 +13,7 @@
  */
 #[OA\Post(
     path: '/security/generate-token',
+    operationId: 'postGenerateToken',
     description: 'Client generates access token using username and password',
     summary: 'Generate access token',
     requestBody: new OA\RequestBody(
@@ -50,6 +51,7 @@
  */
 #[OA\Post(
     path: '/security/refresh-token',
+    operationId: 'postRefreshToken',
     description: 'Client refreshes access token using refresh token',
     summary: 'Refresh access token',
     requestBody: new OA\RequestBody(

src/User/src/OpenAPI.php

@@ -46,6 +46,7 @@
  */
 #[OA\Get(
     path: '/user',
+    operationId: 'getUserCollection',
     description: 'Authenticated (super)admin fetches a list of user accounts',
     summary: 'Admin lists user accounts',
     security: [['AuthToken' => []]],
@@ -115,6 +116,7 @@
  */
 #[OA\Post(
     path: '/user',
+    operationId: 'postUserResource',
     description: 'Authenticated (super)admin creates a new user account',
     summary: 'Admin creates user account',
     security: [['AuthToken' => []]],
@@ -187,6 +189,7 @@
  */
 #[OA\Delete(
     path: '/user/{id}',
+    operationId: 'deleteUserResource',
     description: 'Authenticated (super)admin deletes (anonymizes) a user account identified by its id',
     summary: 'Admin deletes (anonymizes) user account',
     security: [['AuthToken' => []]],
@@ -217,6 +220,7 @@
  */
 #[OA\Get(
     path: '/user/{id}',
+    operationId: 'getUserResource',
     description: 'Authenticated (super)admin fetches a user account identified by its id',
     summary: 'Admin views user account',
     security: [['AuthToken' => []]],
@@ -248,6 +252,7 @@
  */
 #[OA\Patch(
     path: '/user/{id}',
+    operationId: 'patchUserResource',
     description: 'Authenticated (super)admin updates an existing user account',
     summary: 'Admin updates user account',
     security: [['AuthToken' => []]],
@@ -322,6 +327,7 @@
  */
 #[OA\Delete(
     path: '/user/{id}/avatar',
+    operationId: 'deleteUserAvatarResource',
     description: 'Authenticated (super)admin deletes a user avatar identified by user id',
     summary: 'Admin deletes user avatar',
     security: [['AuthToken' => []]],
@@ -352,6 +358,7 @@
  */
 #[OA\Get(
     path: '/user/{id}/avatar',
+    operationId: 'getUserAvatarResource',
     description: 'Authenticated (super)admin fetches a user avatar identified by user id',
     summary: 'Admin views user avatar',
     security: [['AuthToken' => []]],
@@ -383,6 +390,7 @@
  */
 #[OA\Post(
     path: '/user/{id}/avatar',
+    operationId: 'postUserAvatarResource',
     description: 'Authenticated (super)admin creates user avatar for user identified by user id',
     summary: 'Admin creates user avatar',
     security: [['AuthToken' => []]],
@@ -434,6 +442,7 @@
  */
 #[OA\Get(
     path: '/user/role',
+    operationId: 'getUserRoleCollection',
     description: 'Authenticated (super)admin fetches a list of user roles',
     summary: 'Admin lists user roles',
     security: [['AuthToken' => []]],
@@ -502,6 +511,7 @@
  */
 #[OA\Get(
     path: '/user/role/{id}',
+    operationId: 'getUserRoleResource',
     description: 'Authenticated (super)admin fetches a user role identified by its id',
     summary: 'Admin views user role',
     security: [['AuthToken' => []]],
@@ -533,6 +543,7 @@
  */
 #[OA\Patch(
     path: '/user/{id}/activate',
+    operationId: 'patchUserActivate',
     description: 'Authenticated (super)admin activates an existing user account',
     summary: 'Admin activates user account',
     security: [['AuthToken' => []]],
@@ -575,6 +586,7 @@
  */
 #[OA\Patch(
     path: '/user/{id}/deactivate',
+    operationId: 'patchUserDeactivate',
     description: 'Authenticated (super)admin deactivates an existing user account',
     summary: 'Admin deactivates user account',
     security: [['AuthToken' => []]],
@@ -612,6 +624,7 @@
  */
 #[OA\Delete(
     path: '/user/account',
+    operationId: 'deleteUserAccountResource',
     description: 'Authenticated user deletes (anonymizes) their own account',
     summary: 'User deletes (anonymizes) their own account',
     security: [['AuthToken' => []]],
@@ -633,6 +646,7 @@
  */
 #[OA\Get(
     path: '/user/account',
+    operationId: 'getUserAccountResource',
     description: 'Authenticated user fetches their own account data',
     summary: 'User fetches their own account',
     security: [['AuthToken' => []]],
@@ -651,6 +665,7 @@
  */
 #[OA\Patch(
     path: '/user/account',
+    operationId: 'patchUserAccountResource',
     description: 'Authenticated user updates their own account data',
     summary: 'User updates their own account',
     security: [['AuthToken' => []]],
@@ -704,6 +719,7 @@
  */
 #[OA\Post(
     path: '/user/account',
+    operationId: 'postUserAccountResource',
     description: 'Register user account',
     summary: 'Unauthenticated user registers new user account',
     requestBody: new OA\RequestBody(
@@ -764,6 +780,7 @@
  */
 #[OA\Delete(
     path: '/user/account/avatar',
+    operationId: 'deleteUserAccountAvatarResource',
     description: 'Authenticated user deletes their user avatar',
     summary: 'User deletes their own avatar',
     security: [['AuthToken' => []]],
@@ -785,6 +802,7 @@
  */
 #[OA\Get(
     path: '/user/account/avatar',
+    operationId: 'getUserAccountAvatarResource',
     description: 'Authenticated user fetches their own avatar',
     summary: 'User fetches their own avatar',
     security: [['AuthToken' => []]],
@@ -807,6 +825,7 @@
  */
 #[OA\Post(
     path: '/user/account/avatar',
+    operationId: 'postUserAccountAvatarResource',
     description: 'Authenticated user creates their own avatar',
     summary: 'User creates their own avatar',
     security: [['AuthToken' => []]],
@@ -844,6 +863,7 @@
  */
 #[OA\Patch(
     path: '/user/account/activate/{hash}',
+    operationId: 'patchUserAccountActivate',
     description: 'Unauthenticated user activates their account using the hash from an activation link',
     summary: 'Unauthenticated user activates their account',
     tags: ['ActivateUser'],
@@ -879,6 +899,7 @@
  */
 #[OA\Post(
     path: '/user/account/activate',
+    operationId: 'postUserAccountActivate',
     description: 'Unauthenticated user requests an account activation link by providing their email',
     summary: 'Unauthenticated user requests to activate account',
     requestBody: new OA\RequestBody(
@@ -925,6 +946,7 @@
  */
 #[OA\Post(
     path: '/user/account/recover',
+    operationId: 'postUserAccountRecover',
     description: 'Unauthenticated user recovers their identity by providing their email',
     summary: 'Unauthenticated user recovers their identity',
     requestBody: new OA\RequestBody(
@@ -966,6 +988,7 @@
  */
 #[OA\Get(
     path: '/user/account/reset-password/{hash}',
+    operationId: 'getUserAccountResetPasswordResource',
     description: 'Unauthenticated user fetches a reset password by its hash',
     summary: 'Unauthenticated user fetches reset password',
     tags: ['ResetPassword'],
@@ -1000,6 +1023,7 @@
  */
 #[OA\Patch(
     path: '/user/account/reset-password/{hash}',
+    operationId: 'patchUserAccountResetPasswordResource',
     description: 'Unauthenticated user modifies their password using a reset password identified by its hash',
     summary: 'Unauthenticated user modifies their password',
     requestBody: new OA\RequestBody(
@@ -1061,6 +1085,7 @@
  */
 #[OA\Post(
     path: '/user/account/reset-password',
+    operationId: 'postUserAccountResetPasswordResource',
     description: 'Unauthenticated user requests to reset their password by providing their email/identity',
     summary: 'Unauthenticated user requests to modify their password',
     requestBody: new OA\RequestBody(