Merge pull request #1314 from damodarguru/develop

MOSIP-34308
mosip · Sep 23, 2024 · b8b2002 · b8b2002
2 parents 1d4e1b9 + 508e148
commit b8b2002
Show file tree

Hide file tree

Showing 53 changed files with 734 additions and 1 deletion.
diff --git a/apitest/src/main/resources/resident/AcknowledgementController/AcknowledgementController.yml b/apitest/src/main/resources/resident/AcknowledgementController/AcknowledgementController.yml
@@ -1,6 +1,7 @@
 GetAcknowledgementController:
    Resident_GetAuthorizationtoken_uin_Valid_Smoke:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: The resident is trying to get an authorization token by using a valid UIN
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -16,6 +17,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_Valid_Smoke:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: The resident is trying to get an authorization token by using a valid VID
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -31,6 +33,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_Invalid_languageCode_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with an invalid language code
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -46,6 +49,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_Invalid_eventId_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with an invalid eventId
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -61,6 +65,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_Empty_languageCode_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with an empty language code
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -76,6 +81,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_spaceVal_languagecode_Neg:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with a space value for the language code
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -91,6 +97,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_SpaceVal_enentId_Neg:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with a space value for the eventId
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -106,6 +113,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_Empty_eventId_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with an empty eventId
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -121,6 +129,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_uin_Invalid_Role_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid UIN with an invalid role
       role: resident
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -136,6 +145,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_Invalid_languageCode_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with an invalid language code
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -151,6 +161,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_Invalid_eventId_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with an invalid eventId
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -166,6 +177,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_Empty_languageCode_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with an empty language code
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -181,6 +193,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_Empty_eventId_Negative:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with an empty eventId
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -196,6 +209,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_SpaceVal_languageCode_Neg:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with a space value for the language code
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -211,6 +225,7 @@ GetAcknowledgementController:
 
    Resident_GetAuthorizationtoken_vid_SpaceVal_eventId_Neg:
       endPoint: /resident/v1/ack/download/pdf/event/{eventId}/language/{languageCode}
+      description: Resident is trying to get an authorization token by using valid VID with a space value for the eventId
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/apitest/src/main/resources/resident/AddIdentity/AddIdentity.yml b/apitest/src/main/resources/resident/AddIdentity/AddIdentity.yml
@@ -1,6 +1,7 @@
 AddIdentity:
    Resident_AddIdentity_withValidParameters_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -29,6 +30,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_withValidParameters_maximum_email_character_smoke_Pos11111111111111:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with the maximum email characters and valid parameters
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -57,6 +59,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_ValidParam_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -85,6 +88,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -113,6 +117,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_PEXP_smoke:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner to expire the Perpetual VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -141,6 +146,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_PDEA_smoke:
       endPoint: /idrepository/v1/identity/
+      description: Add the identity in a positive manner to deactivate the perpetual VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -169,6 +175,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_TDEA_smoke:
       endPoint: /idrepository/v1/identity/
+      description: Add the identity in a positive manner to deactivate the Temporary VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -197,6 +204,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_PRE_smoke:
       endPoint: /idrepository/v1/identity/
+      description: Add the identity in a positive manner to reactivate the perpetual VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -225,6 +233,7 @@ AddIdentity:
 }'
    Resident_AddIdentity_Positive_TRE_smoke:
       endPoint: /idrepository/v1/identity/
+      description: Add the identity in a positive manner to reactivate the temporary VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -254,6 +263,7 @@ AddIdentity:
 
    Resident_AddIdentity_Valid_Params_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity using valid parameters
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -284,6 +294,7 @@ AddIdentity:
 
    Resident_AddIdentity_Valid_Params_AddUser_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity using valid parameters ensuring that the user is successfully added
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -314,6 +325,7 @@ AddIdentity:
 
    Resident_AddIdentity_ValidParameters_ChannelVerify_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Adding new identity using valid parameters and verifies the channel
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -344,6 +356,7 @@ AddIdentity:
 
    Resident_AddIdentity_ValidParams_For_Revoke_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity using valid parameters for revoke VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -373,6 +386,7 @@ AddIdentity:
 
    Resident_AddIdentity_Esignet_Integ_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Integrate Esignet functionality while adding a new identity
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -402,6 +416,7 @@ AddIdentity:
 
    Resident_AddIdentity_Esignet_Integ_Vid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Integrate VID within Esignet functionality while adding a new identity
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -431,6 +446,7 @@ AddIdentity:
 
    Resident_AddIdentity_GetRid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner while retrieving RID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -460,6 +476,7 @@ AddIdentity:
 
    Resident_AddIdentity_UpdateCount_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner while updating count
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -489,6 +506,7 @@ AddIdentity:
 
    Resident_AddIdentity_ForEotp_Scen_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner for expired OTP functionality
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -518,6 +536,7 @@ AddIdentity:
 
    Resident_AddIdentity_ForEotp_Scen_Vid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with VID positively for the expired OTP functionality
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -547,6 +566,7 @@ AddIdentity:
 
    Resident_AddIdentity_ForEotp_Temp_Vid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with temporary VID in a positive manner the expired OTP functionality
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -576,6 +596,7 @@ AddIdentity:
 
    Resident_AddIdentity_ForEotp_Onetime_Vid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with onetime VID in a positive manner the expired OTP functionality
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -605,6 +626,7 @@ AddIdentity:
 
    Resident_AddIdentity_OrdrSts_Valid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity in a positive manner with valid order status
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -634,6 +656,7 @@ AddIdentity:
 
    Resident_AddIdentity_Invalid_Scen_Vid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with an invalid scenario and VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -663,6 +686,7 @@ AddIdentity:
 
    Resident_AddIdentity_withInValid_DOB_Neg:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with an invalid DOB
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -696,6 +720,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_To_Genrate_VID_Six_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Adding identity with valid parameters to generate a VID under the Six scenario
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -725,6 +750,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_ToCreate_PreVid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters in a positive manner to create perpetual VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -754,6 +780,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_ToCreate_Three_PreVid_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters in a positive manner to create three perpetual VID
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -783,6 +810,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_To_Genrate_TempVid_Use_3_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters to generate a temporary VID using the Use 3 method
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -812,6 +840,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_For_SendOtp_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters to send OTP
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$
@@ -841,6 +870,7 @@ AddIdentity:
 
    Resident_AddIdentity_withValidParameters_To_Check_Ten_Transactions_smoke_Pos:
       endPoint: /idrepository/v1/identity/
+      description: Add identity with valid parameters to check ten transactions
       role: idrepo
       restMethod: post
       inputTemplate: resident/AddIdentity/addIdentity_$LANGNUMBER$

diff --git a/apitest/src/main/resources/resident/AuditLog/AuditLog.yml b/apitest/src/main/resources/resident/AuditLog/AuditLog.yml
@@ -1,6 +1,7 @@
 AuditLog:
    Resident_AuditLog_StatusCode_uin_all_Valid_Smoke:
       endPoint: /resident/v1/auth-proxy/audit/log
+      description: Audit log correctly returns the status codes for all operations performed on a resident when a valid UIN is provided
       role: residentNew
       checkErrorsOnlyInResponse: true
       restMethod: post
@@ -28,6 +29,7 @@ AuditLog:
 
    Resident_AuditLog_StatusCode_vid_all_Valid_Smoke:
       endPoint: /resident/v1/auth-proxy/audit/log
+      description: Audit log correctly returns the status codes for all operations performed on a resident when a valid VID is provided
       role: residentNewVid
       checkErrorsOnlyInResponse: true
       restMethod: post