[MOSIP-34305] Pre reg api test case description addition (#691)

* [��MOSIP-3430 Pre reg api test case description addition Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 updated description for all preReg API Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 updated description for GetSpecificDocumentforaPRID Signed-off-by: gopalaswin <[email protected]> * [��MOSIP-3430 Pre reg api test case description addition Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 updated description for all preReg API Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 updated description for GetSpecificDocumentforaPRID Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 Signed-off-by: gopalaswin <[email protected]> * MOSIP-3430 Signed-off-by: gopalaswin <[email protected]> --------- Signed-off-by: gopalaswin <[email protected]> Signed-off-by: gopalaswin <[email protected]>
mosip · Aug 13, 2024 · 13cf98c · 13cf98c
1 parent 2e90591
commit 13cf98c
Show file tree

Hide file tree

Showing 39 changed files with 309 additions and 3 deletions.
diff --git a/apitest/src/main/resources/preReg/AddLostUinApplication/AddLostUinApplication.yml b/apitest/src/main/resources/preReg/AddLostUinApplication/AddLostUinApplication.yml
@@ -1,6 +1,7 @@
 AddLostUinApplication:
    Prereg_AddLostUinApplication_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/lostuin
+      description: process the lost UIN application with a valid ID
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -18,6 +19,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_Invalid_id:
       endPoint: /preregistration/v1/applications/lostuin
+      description: process the lost UIN application with an invalid ID
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -38,6 +40,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_invalid_lang_code:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application with an invalid language code
       role: batch
       restMethod: post
       inputTemplate: preReg/AddLostUinApplication/addLostUinApplication
@@ -57,6 +60,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_without_version:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application without specifying the version
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -77,6 +81,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_without_version_attribute:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application without specifying the version and attribute
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -97,6 +102,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_with_INVALID_version:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application with an invalid version
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -117,6 +123,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application with a valid data
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -135,6 +142,7 @@ AddLostUinApplication:
 
    Prereg_AddLostUinApplication_inValid_langcode:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application with an invalid language code
       role: batch
       restMethod: post
       inputTemplate: preReg/AddLostUinApplication/addLostUinApplication
@@ -154,6 +162,7 @@ AddLostUinApplication:
 }'
    Prereg_AddLostUinApplication_without_any_data:
       endPoint: /preregistration/v1/applications/lostuin
+      description: Process the lost UIN application with no data provided
       role: batch
       restMethod: post
       inputTemplate: preReg/AddLostUinApplication/addLostUinApplication

diff --git a/apitest/src/main/resources/preReg/AddUpdateRegistration/AddUpdateRegistration.yml b/apitest/src/main/resources/preReg/AddUpdateRegistration/AddUpdateRegistration.yml
@@ -1,6 +1,7 @@
 AddUpdateRegistration:
    Prereg_AddUpdateRegistration_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/updateregistration
+      description: add an update to the registration with valid data
       role: batch
       templateFields: ["langCode"]
       restMethod: post
@@ -19,6 +20,7 @@ AddUpdateRegistration:
 
    Prereg_AddUpdateRegistration_inValid_langcode:
       endPoint: /preregistration/v1/applications/updateregistration
+      description: add an update to the registration with an invalid data
       role: batch
       restMethod: post
       inputTemplate: preReg/AddUpdateRegistration/addUpdateRegistration

diff --git a/...src/main/resources/preReg/CancelApplicationsAppointment/CancelApplicationsAppointment.yml b/...src/main/resources/preReg/CancelApplicationsAppointment/CancelApplicationsAppointment.yml
@@ -1,6 +1,7 @@
 CancelApplicationsAppointment:
    Prereg_CancelApplicationsAppointment_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/appointment/{preRegistrationId}
+      description: Canceling appointment for a valid preregistration ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: put
@@ -13,6 +14,7 @@ CancelApplicationsAppointment:
 }'
    Prereg_CancelApplicationsAppointment_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/applications/appointment/{preRegistrationId}
+      description: Canceling appointment for an invalid preregistration ID
       role: batch
       restMethod: put
       inputTemplate: preReg/CancelApplicationsAppointment/cancelApplicationsAppointment

diff --git a/apitest/src/main/resources/preReg/CancelAppointment/CancelAppointment.yml b/apitest/src/main/resources/preReg/CancelAppointment/CancelAppointment.yml
@@ -1,6 +1,7 @@
 CancelAppointment:
    Prereg_CancelAppointment_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/appointment/{preRegistrationId}
+      description: Cancel appointment for a valid preregistration ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: put
@@ -13,6 +14,7 @@ CancelAppointment:
 }'
    Prereg_CancelAppointment_with_already_cancelled_appoinment:
       endPoint: /preregistration/v1/appointment/{preRegistrationId}
+      description: Canceling an appointment that has already been cancelled
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: put
@@ -30,6 +32,7 @@ CancelAppointment:
 }'
    Prereg_CancelAppointment_cancell_incomplete_appoinment:
       endPoint: /preregistration/v1/appointment/{preRegistrationId}
+      description: Canceling an appointment with an incomplete appointment data
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: put
@@ -47,6 +50,7 @@ CancelAppointment:
 }'
    Prereg_CancelAppointment_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/appointment/{preRegistrationId}
+      description: Canceling an appointment with an invalid preregistration ID
       role: batch
       restMethod: put
       inputTemplate: preReg/CancelAppointment/cancelAppointment

diff --git a/apitest/src/main/resources/preReg/CopyDocument/CopyDocument.yml b/apitest/src/main/resources/preReg/CopyDocument/CopyDocument.yml
@@ -1,6 +1,7 @@
 CopyDocument:
    Prereg_CopyDocument_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/documents/{preRegistrationId}?catCode={doc_cat_code}&sourcePreId={preRegistrationId}
+      description: Copy the valid Proof of Address (POA) document
       role: batch
       restMethod: put
       inputTemplate: preReg/CopyDocument/copyDocument
@@ -15,6 +16,7 @@ CopyDocument:
 }'
    Prereg_CopyDocument_in_Valid_doc_cat_code_sid:
       endPoint: /preregistration/v1/documents/{preRegistrationId}?catCode={doc_cat_code}&sourcePreId={preRegistrationId}
+      description: Copy the Proof of Address (POA) document with the invalid document category code
       role: batch
       restMethod: put
       inputTemplate: preReg/CopyDocument/copyDocument
@@ -32,6 +34,7 @@ CopyDocument:
 }'
    Prereg_CopyDocument_blank_doc_cat_code_sid:
       endPoint: /preregistration/v1/documents/{preRegistrationId}?catCode={doc_cat_code}&sourcePreId={preRegistrationId}
+      description: Copy the blank document and categorize it with the code
       role: batch
       restMethod: put
       inputTemplate: preReg/CopyDocument/copyDocument
@@ -49,6 +52,7 @@ CopyDocument:
 }'
    Prereg_CopyDocument_Invalid_preRegistrationId_sid:
       endPoint: /preregistration/v1/documents/{preRegistrationId}?catCode={doc_cat_code}&sourcePreId={preRegistrationId}
+      description: Copy the Proof of Address (POA) document with the invalid preregistration ID
       role: batch
       restMethod: put
       inputTemplate: preReg/CopyDocument/copyDocument

diff --git a/apitest/src/main/resources/preReg/DeleteAllDocForaPRID/DeleteAllDocForaPRID.yml b/apitest/src/main/resources/preReg/DeleteAllDocForaPRID/DeleteAllDocForaPRID.yml
@@ -1,6 +1,7 @@
 DeleteAllDocForaPRID:
    Prereg_DeletePreRegistration_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/documents/preregistration/{preRegistrationId}
+      description: Delete preregistration with all valid preregistration ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: delete
@@ -13,6 +14,7 @@ DeleteAllDocForaPRID:
 }'
    Prereg_DeletePreRegistration_InValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/documents/preregistration/{preRegistrationId}
+      description: Delete preregistration with an invalid preregisteration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeleteAllDocForaPRID/deleteAllDocForaPRID

diff --git a/apitest/src/main/resources/preReg/DeleteBooking/DeleteBooking.yml b/apitest/src/main/resources/preReg/DeleteBooking/DeleteBooking.yml
@@ -1,6 +1,7 @@
 DeleteBooking:
    Prereg_DeleteBooking_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/appointment?preRegistrationId={preRegistrationId}
+      description: Delete bookings for all valid preregistration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeleteBooking/deleteBooking

diff --git a/apitest/src/main/resources/preReg/DeleteLostUinApplication/DeleteLostUinApplication.yml b/apitest/src/main/resources/preReg/DeleteLostUinApplication/DeleteLostUinApplication.yml
@@ -1,6 +1,7 @@
 DeleteLostUinApplication:
    Prereg_DeleteLostUinApplication_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/prereg/{applicationId}
+      description: Delete the lost UIN application with valid data
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: delete
@@ -14,6 +15,7 @@ DeleteLostUinApplication:
 }'
    Prereg_DeleteLostUinApplication_after_its_deletion:
       endPoint: /preregistration/v1/applications/prereg/{applicationId}
+      description: Delete the lost UIN application after it has been removed
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: delete
@@ -31,6 +33,7 @@ DeleteLostUinApplication:
 }'
    Prereg_DeleteLostUinApplication_multiple_application_sid:
       endPoint: /preregistration/v1/applications/prereg/{applicationId}
+      description: Delete the lost UIN application with multiple preregistration IDs for the application
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: delete
@@ -44,6 +47,7 @@ DeleteLostUinApplication:
 }'
    Prereg_DeleteLostUinApplication_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/applications/prereg/{applicationId}
+      description: Delete the lost UIN application with an invalid preregistration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeleteLostUinApplication/deleteLostUinApplication
@@ -60,6 +64,7 @@ DeleteLostUinApplication:
 }'
    Prereg_DeleteLostUinApplication_random_number_sid:
       endPoint: /preregistration/v1/applications/prereg/{applicationId}
+      description: Delete the lost UIN application with a random number preregistration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeleteLostUinApplication/deleteLostUinApplication

diff --git a/apitest/src/main/resources/preReg/DeletePreRegistration/DeletePreRegistration.yml b/apitest/src/main/resources/preReg/DeletePreRegistration/DeletePreRegistration.yml
@@ -1,6 +1,7 @@
 DeletePreRegistration:
    Prereg_DeletePreRegistration_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/prereg/{preRegistrationId}
+      description: Delete the preregistration with a valid preregistration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeletePreRegistration/deletePreRegistration
@@ -13,6 +14,7 @@ DeletePreRegistration:
 }'
    Prereg_DeletePreRegistration_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/applications/prereg/{preRegistrationId}
+      description: Delete the preregistration with an invalid preregistration ID
       role: batch
       restMethod: delete
       inputTemplate: preReg/DeletePreRegistration/deletePreRegistration

diff --git a/apitest/src/main/resources/preReg/DeleteSpecificDocForaPRID/DeleteSpecificDocForaPRID.yml b/apitest/src/main/resources/preReg/DeleteSpecificDocForaPRID/DeleteSpecificDocForaPRID.yml
@@ -1,6 +1,7 @@
 DeleteSpecificDocForaPRID:
    Prereg_DeleteSpecificDocForaPRID_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/documents/{documentId}?preRegistrationId={preRegistrationId}
+      description: Delete specific document for a valid PRID 
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: post
@@ -15,6 +16,7 @@ DeleteSpecificDocForaPRID:
 }'
    Prereg_DeletePreRegistration_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/documents/{documentId}?preRegistrationId={preRegistrationId}
+      description: Delete preregistration with an invalid PRID
       role: batch
       restMethod: post
       inputTemplate: preReg/DeleteSpecificDocForaPRID/deleteSpecificDocForaPRID
@@ -32,6 +34,7 @@ DeleteSpecificDocForaPRID:
 }'
    Prereg_DeletePreRegistration_inValid_documentId_sid:
       endPoint: /preregistration/v1/documents/{documentId}?preRegistrationId={preRegistrationId}
+      description: Delete preregistration with an invalid document ID 
       role: batch
       restMethod: post
       inputTemplate: preReg/DeleteSpecificDocForaPRID/deleteSpecificDocForaPRID

diff --git a/apitest/src/main/resources/preReg/FetchApplicationByPrid/FetchApplicationByPrid.yml b/apitest/src/main/resources/preReg/FetchApplicationByPrid/FetchApplicationByPrid.yml
@@ -1,6 +1,7 @@
 FetchApplicationByPrid:
    Prereg_FetchApplicationByPrid_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/prereg/{preRegistrationId}
+      description: Fetch demographic details using a valid PRID
       role: batch
       restMethod: get
       inputTemplate: preReg/FetchApplicationByPrid/fetchApplicationByPrid
@@ -13,6 +14,7 @@ FetchApplicationByPrid:
 }'
    Prereg_FetchApplicationByPrid_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/applications/prereg/{preRegistrationId}
+      description: Fetch demographic details using an invalid PRID
       role: batch
       restMethod: get
       inputTemplate: preReg/FetchApplicationByPrid/fetchApplicationByPrid

diff --git a/...src/main/resources/preReg/FetchAppointmentDetailsByPrid/FetchAppointmentDetailsByPrid.yml b/...src/main/resources/preReg/FetchAppointmentDetailsByPrid/FetchAppointmentDetailsByPrid.yml
@@ -1,6 +1,7 @@
 FetchAppointmentDetailsByPrid:
    Prereg_FetchAppointmentDetailsByPrid_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/appointment/{preRegistrationId}
+      description: Fetch appointment details for the preregistration ID
       role: batch
       restMethod: get
       inputTemplate: preReg/FetchAppointmentDetailsByPrid/fetchAppointmentDetailsByPrid
@@ -13,6 +14,7 @@ FetchAppointmentDetailsByPrid:
 }'
    Prereg_FetchAppointmentDetailsByPrid_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/applications/appointment/{preRegistrationId}
+      description: Fetch appointment details for the invalid preregistration ID
       role: batch
       restMethod: get
       inputTemplate: preReg/FetchAppointmentDetailsByPrid/fetchAppointmentDetailsByPrid

diff --git a/apitest/src/main/resources/preReg/GetAllApplications/GetAllApplications.yml b/apitest/src/main/resources/preReg/GetAllApplications/GetAllApplications.yml
@@ -1,6 +1,7 @@
 GetAllApplications:
    Prereg_GetAllApplications_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications
+      description: Retrieve all applications with valid data
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -13,6 +14,7 @@ GetAllApplications:
 }'
    Prereg_GetAllApplications_InValid:
       endPoint: /preregistration/v1/applications
+      description: Retrieve all applications with invalid data
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -30,6 +32,7 @@ GetAllApplications:
 }'
    Prereg_GetAllApplications_InValid_Type:
       endPoint: /preregistration/v1/applications?type={type}
+      description: Retrieve all applications with an invalid type
       role: batch
       restMethod: get
       inputTemplate: preReg/GetAllApplications/getAllApplications
@@ -46,6 +49,7 @@ GetAllApplications:
 }'
    Prereg_GetAllApplications_Valid_Type_Smoke_sid:
       endPoint: /preregistration/v1/applications?type={type}
+      description: Retrieve all applications with a valid type
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/...ources/preReg/GetAllApplicationsWithapplicationId/GetAllApplicationsWithapplicationId.yml b/...ources/preReg/GetAllApplicationsWithapplicationId/GetAllApplicationsWithapplicationId.yml
@@ -1,6 +1,7 @@
 GetAllApplicationsWithapplicationId:
    Prereg_GetAllApplicationsWithapplicationId_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications/{applicationId}
+      description: Retrieve all applications with the application ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -13,6 +14,7 @@ GetAllApplicationsWithapplicationId:
 }'
    Prereg_GetAllApplicationsWithapplicationId_with_expired:
       endPoint: /preregistration/v1/applications/{applicationId}
+      description: Retrieve all applications with the expired application ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -25,6 +27,7 @@ GetAllApplicationsWithapplicationId:
 }'
    Prereg_GetAllApplicationsWithapplicationId_with_invalid_applicationId:
       endPoint: /preregistration/v1/applications/{applicationId}
+      description: Retrieve all applications with an invalid application ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/apitest/src/main/resources/preReg/GetAllDocForPrId/GetAllDocForPrId.yml b/apitest/src/main/resources/preReg/GetAllDocForPrId/GetAllDocForPrId.yml
@@ -1,6 +1,7 @@
 GetAllDocForPrId:
    Prereg_GetAllDocForPrId_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/documents/preregistration/{preRegistrationId}
+      description: Retrieve all documents associated with the valid Pre-Registration ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -15,6 +16,7 @@ GetAllDocForPrId:
 }'
    Prereg_GetAllDocForPrId_inValid_preRegistrationId_sid:
       endPoint: /preregistration/v1/documents/preregistration/{preRegistrationId}
+      description: Retrieve all documents associated with the invalid Pre-Registration ID
       role: batch
       restMethod: get
       inputTemplate: preReg/GetAllDocForPrId/getAllDocForPrId

diff --git a/apitest/src/main/resources/preReg/GetAllPreRegApplications/GetAllPreRegApplications.yml b/apitest/src/main/resources/preReg/GetAllPreRegApplications/GetAllPreRegApplications.yml
@@ -1,6 +1,7 @@
 GetAllPreRegApplications:
    Prereg_GetAllPreRegApplications_All_Valid_Smoke_sid:
       endPoint: /preregistration/v1/applications
+      description: Retrieve all preregistered applications with a valid preregistration ID
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -12,6 +13,7 @@ GetAllPreRegApplications:
 }'
    Prereg_GetAllPreRegApplications_LOST_UIN_APPLICATION_sid:
       endPoint: /preregistration/v1/applications
+      description: Retrieve all preregistered applications with a prereg ID associated with the lost UIN application
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -23,6 +25,7 @@ GetAllPreRegApplications:
 }'
    Prereg_GetAllPreRegApplications_DELETE_UIN_APPLICATION_sid:
       endPoint: /preregistration/v1/applications
+      description: Retrieve all preregistered applications with a prereg ID associated with a deleted UIN application
       role: batch
       checkErrorsOnlyInResponse: true
       restMethod: get