Merge pull request #1127 from credebl/develop

Sync changes from DEV to QA.

Author: bhavanakarwade

apps/api-gateway/src/agent-service/agent-service.controller.ts

@@ -61,18 +61,20 @@ export class AgentController {
 
   /**
    * Get Organization agent health
-   * @param orgId
-   * @param reqUser
-   * @param res
+   * @param orgId The ID of the organization
+   * @param reqUser The user making the request
+   * @param res The response object
    * @returns Get agent details
    */
   @Get('/orgs/:orgId/agents/health')
   @ApiOperation({
     summary: 'Get the agent health details',
-    description: 'Get the agent health details'
+    description: 'Get the agent health details for the organization'
   })
-  @UseGuards(AuthGuard('jwt'))
-  async getAgentHealth(@Param('orgId') orgId: string, @User() reqUser: user, @Res() res: Response): Promise<Response> {
+  @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
+  @Roles(OrgRoles.OWNER, OrgRoles.ADMIN, OrgRoles.HOLDER, OrgRoles.ISSUER, OrgRoles.SUPER_ADMIN, OrgRoles.MEMBER, OrgRoles.VERIFIER)
+  
+  async getAgentHealth(@Param('orgId') orgId: string, @User() reqUser: user, @Res() res: Response): Promise<Response> {    
     const agentData = await this.agentService.getAgentHealth(reqUser, orgId);
 
     const finalResponse: IResponse = {
@@ -84,10 +86,16 @@ export class AgentController {
     return res.status(HttpStatus.OK).json(finalResponse);
   }
 
+  /**
+   * Get the ledger config details
+   * @param reqUser The user making the request
+   * @param res The response object
+   * @returns Ledger config details
+   */
   @Get('/orgs/agents/ledgerConfig')
   @ApiOperation({
     summary: 'Get the ledger config details',
-    description: 'Get the ledger config details'
+    description: 'Get the all supported ledger configuration details for the platform'
   })
   @UseGuards(AuthGuard('jwt'))
   async getLedgerDetails(@User() reqUser: user, @Res() res: Response): Promise<Response> {
@@ -104,14 +112,15 @@ export class AgentController {
 
   /**
    * Spinup the agent by organization
-   * @param agentSpinupDto
-   * @param user
+   * @param agentSpinupDto The details of the agent to be spun up
+   * @param user The user making the request
+   * @param res The response object
    * @returns Get agent status
    */
   @Post('/orgs/:orgId/agents/spinup')
   @ApiOperation({
-    summary: 'Agent spinup',
-    description: 'Create a new agent spin up.'
+    summary: 'Spinup the platform admin agent',
+    description: 'Initialize and configure a new platform admin agent for the platform.'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN)
@@ -139,20 +148,20 @@ export class AgentController {
 
   /**
    * Create wallet for shared agent
-   * @param orgId
-   * @param createTenantDto
-   * @param user
-   * @param res
-   * @returns wallet initialization status
+   * @param orgId The ID of the organization
+   * @param createTenantDto The details of the tenant to be created
+   * @param user The user making the request
+   * @param res The response object
+   * @returns Wallet initialization status
    */
   @Post('/orgs/:orgId/agents/wallet')
   @ApiOperation({
-    summary: 'Shared Agent',
-    description: 'Create a shared agent.'
+    summary: 'Create Shared Agent Wallet',
+    description: 'Initialize and create a shared agent wallet for the organization.'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN)
-  @ApiResponse({ status: HttpStatus.CREATED, description: 'Success', type: ApiResponseDto })
+  @ApiResponse({ status: HttpStatus.CREATED, description: 'Wallet successfully created', type: ApiResponseDto })
   async createTenant(
     @Param('orgId') orgId: string,
     @Body() createTenantDto: CreateTenantDto,
@@ -174,13 +183,16 @@ export class AgentController {
 
   /**
    * Create wallet
-   * @param orgId
-   * @returns wallet
+   * @param orgId The ID of the organization
+   * @param createWalletDto The details of the wallet to be created
+   * @param user The user making the request
+   * @param res The response object
+   * @returns Wallet details
    */
   @Post('/orgs/:orgId/agents/createWallet')
   @ApiOperation({
-    summary: 'Create wallet',
-    description: 'Create wallet'
+    summary: 'Create tenant in the agent',
+    description: 'Create a new wallet for the organization without storing the wallet details in the platform.'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN)
@@ -203,16 +215,18 @@ export class AgentController {
     return res.status(HttpStatus.CREATED).json(finalResponse);
   }
 
-  // This function will be used after multiple did method implementation in create wallet
   /**
    * Create did
-   * @param orgId
-   * @returns did
+   * @param orgId The ID of the organization
+   * @param createDidDto The details of the DID to be created
+   * @param user The user making the request
+   * @param res The response object
+   * @returns DID details
    */
   @Post('/orgs/:orgId/agents/did')
   @ApiOperation({
-    summary: 'Create new did',
-    description: 'Create new did for an organization'
+    summary: 'Create new DID',
+    description: 'Create a new DID for an organization wallet'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN, OrgRoles.ISSUER)
@@ -246,10 +260,15 @@ export class AgentController {
 
   /**
    * Create Secp256k1 key pair for polygon DID
-   * @param orgId
+   * @param orgId The ID of the organization
+   * @param res The response object
    * @returns Secp256k1 key pair for polygon DID
    */
   @Post('/orgs/:orgId/agents/polygon/create-keys')
+  @ApiOperation({
+    summary: 'Create Secp256k1 key pair for polygon DID',
+    description: 'Create Secp256k1 key pair for polygon DID for an organization'
+  })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN, OrgRoles.PLATFORM_ADMIN, OrgRoles.ISSUER, OrgRoles.VERIFIER)
   @ApiResponse({ status: HttpStatus.CREATED, description: 'Success', type: ApiResponseDto })
@@ -267,14 +286,15 @@ export class AgentController {
 
   /**
    * Configure the agent by organization
-   * @param agentSpinupDto
-   * @param user
-   * @returns Get agent status
+   * @param agentConfigureDto The details of the agent configuration
+   * @param user The user making the request
+   * @param res The response object
+   * @returns Agent configuration status
    */
   @Post('/orgs/:orgId/agents/configure')
   @ApiOperation({
-    summary: 'Agent configure',
-    description: 'Create a new agent configure.'
+    summary: 'Configure the organization agent',
+    description: 'Configure the running dedicated agent for the organization using the provided configuration details.'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN)
@@ -299,10 +319,17 @@ export class AgentController {
     return res.status(HttpStatus.CREATED).json(finalResponse);
   }
 
+  /**
+   * Delete wallet
+   * @param orgId The ID of the organization
+   * @param user The user making the request
+   * @param res The response object
+   * @returns Success message
+   */
   @Delete('/orgs/:orgId/agents/wallet')
   @ApiOperation({
-    summary: 'Delete wallet',
-    description: 'Delete agent wallet by organization.'
+    summary: 'Delete agent wallet',
+    description: 'Delete agent wallet for the organization using orgId.'
   })
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
   @Roles(OrgRoles.OWNER)
@@ -321,4 +348,4 @@ export class AgentController {
 
     return res.status(HttpStatus.OK).json(finalResponse);
   }
-}
+}

apps/api-gateway/src/authz/authz.controller.ts

@@ -40,13 +40,15 @@ export class AuthzController {
     private readonly commonService: CommonService) { }
 
   /**
-   * @param email
-   * @param verificationcode
-   * @returns User's email verification status 
+   * Verify user’s email address.
+   * 
+   * @param email  The email address of the user.
+   * @param verificationcode The verification code sent to the user's email.
+   * @returns Returns the email verification status. 
    */
   @Get('/verify')
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
-  @ApiOperation({ summary: 'Verify user’s email', description: 'Verify user’s email' })
+  @ApiOperation({ summary: 'Verify user’s email', description: 'Checks if the provided verification code is valid for the given email.' })
   async verifyEmail(@Query() query: EmailVerificationDto, @Res() res: Response): Promise<Response> {
     await this.authzService.verifyEmail(query);
     const finalResponse: IResponseType = {
@@ -55,13 +57,14 @@ export class AuthzController {
     };
 
     return res.status(HttpStatus.OK).json(finalResponse);
-
   }
 
   /**
-  * @param email
-  * @returns User's verification email sent status
-  */
+ * Sends a verification email to the user.
+ * 
+ * @body UserEmailVerificationDto.
+ * @returns The status of the verification email.
+ */
   @Post('/verification-mail')
   @ApiResponse({ status: HttpStatus.CREATED, description: 'Created', type: ApiResponseDto })
   @ApiOperation({ summary: 'Send verification email', description: 'Send verification email to new user' })
@@ -75,13 +78,14 @@ export class AuthzController {
   }
 
   /**
-  *
-  * @Body userInfo
+  * Registers a new user on the platform.
+  * 
+  * @body AddUserDetailsDto
   * @returns User's registration status and user details
   */
   @Post('/signup')
   @ApiResponse({ status: HttpStatus.CREATED, description: 'Created', type: ApiResponseDto })
-  @ApiOperation({ summary: 'Register new user to platform', description: 'Register new user to platform' })
+  @ApiOperation({ summary: 'Register new user to platform', description: 'Register new user to platform with the provided details.' })
   async addUserDetails(@Body() userInfo: AddUserDetailsDto, @Res() res: Response): Promise<Response> {
     const userData = await this.authzService.addUserDetails(userInfo);
       const finalResponse = {
@@ -93,13 +97,15 @@ export class AuthzController {
 
   }
   /**
-  * @Body loginUserDto
+  * Authenticates a user and returns an access token. 
+  * 
+  * @body LoginUserDto
   * @returns User's access token details
   */
   @Post('/signin')
   @ApiOperation({
     summary: 'Authenticate the user for the access',
-    description: 'Authenticate the user for the access'
+    description: 'Allows registered user to sign.'
   })
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: AuthTokenResponse })
   @ApiBody({ type: LoginUserDto })
@@ -120,11 +126,18 @@ export class AuthzController {
     }
   }
 
+
+  /**
+ * Resets user's password.
+ * 
+ * @body ResetPasswordDto
+ * @returns The password reset status.
+ */
   @Post('/reset-password')
   @ApiOperation({
     summary: 'Reset password',
-    description: 'Reset Password of the user'
-  })
+    description: 'Allows users to reset a new password which should be different form existing password.'
+  }) 
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
   async resetPassword(@Body() resetPasswordDto: ResetPasswordDto, @Res() res: Response): Promise<Response> {
 
@@ -134,15 +147,19 @@ export class AuthzController {
         message: ResponseMessages.user.success.resetPassword,
         data: userData
       };
-
       return res.status(HttpStatus.OK).json(finalResponse);
-   
   }
 
+/**
+ * Initiates the password reset process by sending a reset link to the user's email.
+ *
+ * @body ForgotPasswordDto
+ * @returns Status message indicating whether the reset link was sent successfully.
+ */
   @Post('/forgot-password')
   @ApiOperation({
     summary: 'Forgot password',
-    description: 'Forgot Password of the user'
+    description: 'Sends a password reset link to the user’s email.'
   })
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
   async forgotPassword(@Body() forgotPasswordDto: ForgotPasswordDto, @Res() res: Response): Promise<Response> {
@@ -156,10 +173,17 @@ export class AuthzController {
       return res.status(HttpStatus.OK).json(finalResponse);
   }
 
+/**
+ * Resets the user's password using a verification token.
+ *
+ * @param email The email address of the user.
+ * @body ResetTokenPasswordDto
+ * @returns Status message indicating whether the password reset was successful.
+ */
   @Post('/password-reset/:email')
   @ApiOperation({
-    summary: 'Reset password with token',
-    description: 'Reset Password of the user using token'
+    summary: 'Reset password with verification token',
+    description: 'Resets a user’s password using a verification token sent to their email'
   })
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
   async resetNewPassword(
@@ -173,15 +197,19 @@ export class AuthzController {
         message: ResponseMessages.user.success.resetPassword,
         data: userData
       };
-
       return res.status(HttpStatus.OK).json(finalResponse);
-   
   }
 
+/**
+ * Generates a new access token using a refresh token.
+ *
+ * @body RefreshTokenDto
+ * @returns New access token and its details.
+ */
   @Post('/refresh-token')
   @ApiOperation({
     summary: 'Token from refresh token',
-    description: 'Get a new token from a refresh token'
+    description: 'Generates a new access token using a refresh token.'
   })
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
   async refreshToken(

apps/api-gateway/src/authz/dtos/forgot-password.dto.ts

@@ -5,7 +5,7 @@ import { Transform } from 'class-transformer';
 import {  trim } from '@credebl/common/cast.helper';
 
 export class ForgotPasswordDto {
-    @ApiProperty({ example: 'awqx@getnada.com' })
+    @ApiProperty({ example: 'awqx@yopmail.com' })
     @IsEmail({}, { message: 'Please provide a valid email' })
     @IsNotEmpty({ message: 'Email is required' })
     @IsString({ message: 'Email should be a string' })

apps/api-gateway/src/authz/dtos/reset-password.dto.ts

@@ -5,7 +5,7 @@ import { Transform } from 'class-transformer';
 import {  trim } from '@credebl/common/cast.helper';
 
 export class ResetPasswordDto {
-    @ApiProperty({ example: 'awqx@getnada.com' })
+    @ApiProperty({ example: 'awqx@yopmail.com' })
     @IsEmail({}, { message: 'Please provide a valid email' })
     @IsNotEmpty({ message: 'Email is required' })
     @IsString({ message: 'Email should be a string' })