INJIMOB-1566 Description updated for masterData 6 APIs

Signed-off-by: NitinHegde <[email protected]>
mosip · Aug 2, 2024 · 5a80256 · 5a80256
1 parent a6cdb9f
commit 5a80256
Show file tree

Hide file tree

Showing 127 changed files with 622 additions and 28 deletions.
diff --git a/apitest/src/main/resources/masterdata/GetBiometricTypes/GetBiometricTypes.yml b/apitest/src/main/resources/masterdata/GetBiometricTypes/GetBiometricTypes.yml
@@ -1,6 +1,7 @@
 GetBiometricTypes:
    Masterdata_GetBiometricTypes_allValid_smoke:
       endPoint: /v1/masterdata/biometrictypes
+      description: Retrieve all the biometric data
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/...src/main/resources/masterdata/GetBiometricTypesByLangcode/GetBiometricTypesByLangcode.yml b/...src/main/resources/masterdata/GetBiometricTypesByLangcode/GetBiometricTypesByLangcode.yml
@@ -1,6 +1,7 @@
 GetBiometricTypesByLangcode:
    Masterdata_GetBiometricTypesByLangcode_allValid_smoke:
       endPoint: /v1/masterdata/biometrictypes/{langcode}
+      description: Retrieve biometric data in a specific language
       role: admin
       checkErrorsOnlyInResponse: true
       templateFields: ["langcode"]
@@ -15,6 +16,7 @@ GetBiometricTypesByLangcode:
 }'
    Masterdata_GetBiometricTypesByLangcode_InValid_langCode:
       endPoint: /v1/masterdata/biometrictypes/{langcode}
+      description: Retrieve biometric data for an invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetBiometricTypesByLangcode/getBiometricTypesByLangcode

diff --git a/apitest/src/main/resources/masterdata/GetDeviceHistory/GetDeviceHistory.yml b/apitest/src/main/resources/masterdata/GetDeviceHistory/GetDeviceHistory.yml
@@ -1,6 +1,7 @@
 GetDeviceHistory:
    Masterdata_GetDeviceHistory_allValid_smoke:
       endPoint: /v1/masterdata/deviceshistories/{id}/{langcode}/{effdatetimes}
+      description: Retrieve device history details based on ID, language code, and effective times
       role: regproc
       templateFields: ["langCode"]
       restMethod: get

diff --git a/apitest/src/main/resources/masterdata/GetDocCategory/GetDocCategory.yml b/apitest/src/main/resources/masterdata/GetDocCategory/GetDocCategory.yml
@@ -1,6 +1,7 @@
 GetDocCategory:
    Admin_GetDocCategory_allValid_smoke:
       endPoint: /v1/masterdata/documentcategories
+      description: Retrieve all the document categories
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/apitest/src/main/resources/masterdata/GetDocCategoryByLangCode/GetDocCategoryByLangCode.yml b/apitest/src/main/resources/masterdata/GetDocCategoryByLangCode/GetDocCategoryByLangCode.yml
@@ -1,6 +1,7 @@
 GetDocCategoryByLangCode:
    Admin_GetDocCategoryByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/documentcategories/{code}/{langcode}
+      description: Retrieve document categories based on a valid code and language code
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -15,12 +16,13 @@ GetDocCategoryByLangCode:
 
    Admin_GetDocCategoryByLangCode_Invalid_code:
       endPoint: /v1/masterdata/documentcategories/{code}/{langcode}
+      description: Retrieve document categories based on a invalid code and an valid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetDocCategoryByLangCode/getDocCategoryByLangCode
       outputTemplate: masterdata/error
       input: '{
-      "code":"INVALID",
+      "code":"ABC",
       "langcode":"eng"
 }'
       output: '{
@@ -34,6 +36,7 @@ GetDocCategoryByLangCode:
 
    Admin_GetDocCategoryByLangCode_Invalid_langcode:
       endPoint: /v1/masterdata/documentcategories/{code}/{langcode}
+      description: Retrieve document categories based on a valid code and an invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetDocCategoryByLangCode/getDocCategoryByLangCode

diff --git a/apitest/src/main/resources/masterdata/GetDocType_DocCatByAppID/GetDocType_DocCatByAppID.yml b/apitest/src/main/resources/masterdata/GetDocType_DocCatByAppID/GetDocType_DocCatByAppID.yml
@@ -1,6 +1,7 @@
 GetDocType_DocCatByAppID:
    Masterdata_GetDocType_DocCatByAppID_valid_smoke:
       endPoint: /v1/masterdata/applicanttype/{applicantId}/languages?languages={languages}
+      description: Retrieve document type and document categories based on an applicant ID and language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetDocType_DocCatByAppID/getDocType_DocCatByAppID
@@ -18,6 +19,7 @@ GetDocType_DocCatByAppID:
 }'
    Masterdata_GetDocType_DocCatByAppID_invalid_language:
       endPoint: /v1/masterdata/applicanttype/{applicantId}/languages?languages={languages}
+      description: Retrieve document type and document categories based on an applicant ID and an invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetDocType_DocCatByAppID/getDocType_DocCatByAppID

diff --git a/...est/src/main/resources/masterdata/GetDocumentTypeByLangCode/GetDocumentTypeByLangCode.yml b/...est/src/main/resources/masterdata/GetDocumentTypeByLangCode/GetDocumentTypeByLangCode.yml
@@ -1,6 +1,7 @@
 GetDocumentTypeByLangCode:
    Masterdata_GetDocumentTypeByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/documenttypes/{langcode}
+      description: Retrieve document type by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -20,6 +21,7 @@ GetDocumentTypeByLangCode:
 
    Masterdata_GetDocumentTypeByLangCode_InValid_langcode:
       endPoint: /v1/masterdata/documenttypes/{langcode}
+      description: Retrieve document type by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetDocumentTypeByLangCode/getDocumentTypeByLangCode

diff --git a/apitest/src/main/resources/masterdata/GetExceptionalHolidays/GetExceptionalHolidays.yml b/apitest/src/main/resources/masterdata/GetExceptionalHolidays/GetExceptionalHolidays.yml
@@ -1,6 +1,7 @@
 GetExceptionalHolidays:
    Admin_GetExceptionalHolidays_allValid_smoke:
       endPoint: /v1/masterdata/exceptionalholidays/{registrationCenterId}/{langCode}
+      description: Retrieve exceptional holidays based on a valid registration center ID and language code
       role: admin
       checkErrorsOnlyInResponse: true
       templateFields: ["langCode"]
@@ -16,6 +17,7 @@ GetExceptionalHolidays:
 
    Admin_GetExceptionalHolidays_InValid_Invalid_registrationCenterId:
       endPoint: /v1/masterdata/exceptionalholidays/{registrationCenterId}/{langCode}
+      description: Retrieve exceptional holidays based on a invalid registration center ID and valid language code
       role: admin
       templateFields: ["langCode"]
       restMethod: get
@@ -36,6 +38,7 @@ GetExceptionalHolidays:
 
    Admin_GetExceptionalHolidays_InValid_Invalid_langCode:
       endPoint: /v1/masterdata/exceptionalholidays/{registrationCenterId}/{langCode}
+      description: Retrieve exceptional holidays based on a valid registration center ID and invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetExceptionalHolidays/getExceptionalHolidays

diff --git a/apitest/src/main/resources/masterdata/GetHolidaysMissingIds/GetHolidaysMissingIds.yml b/apitest/src/main/resources/masterdata/GetHolidaysMissingIds/GetHolidaysMissingIds.yml
@@ -1,6 +1,7 @@
 GetHolidaysMissingIds:
    Admin_GetHolidaysMissingIds_allValid_smoke:
       endPoint: /v1/masterdata/holidays/missingids/{langcode}
+      description: Retrieve holidays for missing IDs with a valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       templateFields: ["langcode"]
@@ -18,6 +19,7 @@ GetHolidaysMissingIds:
 
    Admin_GetHolidaysMissingIds_InValid_Inavild_langCode:
       endPoint: /v1/masterdata/holidays/missingids/{langcode}
+      description: Retrieve holidays for missing IDs with a invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetHolidaysMissingIds/getHolidaysMissingIds

diff --git a/apitest/src/main/resources/masterdata/GetIdTypeByLangCode/GetIdTypeByLangCode.yml b/apitest/src/main/resources/masterdata/GetIdTypeByLangCode/GetIdTypeByLangCode.yml
@@ -1,6 +1,7 @@
 GetIdTypeByLangCode:
    Admin_GetIdTypeByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/idtypes/{langcode}
+      description: Retrieve ID type by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -20,6 +21,7 @@ GetIdTypeByLangCode:
 
    Admin_GetIdTypeByLangCode_InValid_Invalid_langCode:
       endPoint: /v1/masterdata/idtypes/{langcode}
+      description: Retrieve ID type by valid inlanguage code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetIdTypeByLangCode/getIdTypeByLangCode

diff --git a/apitest/src/main/resources/masterdata/GetIndividualType/GetIndividualType.yml b/apitest/src/main/resources/masterdata/GetIndividualType/GetIndividualType.yml
@@ -1,6 +1,7 @@
 GetIndividualType:
    MasterData_GetIndividualType_allValid_smoke:
       endPoint: /v1/masterdata/individualtypes/all
+      description: Retrieve individual type details
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetIndividualType/getIndividualType

diff --git a/apitest/src/main/resources/masterdata/GetLanguage/GetLanguage.yml b/apitest/src/main/resources/masterdata/GetLanguage/GetLanguage.yml
@@ -1,6 +1,7 @@
 GetLanguage:
    Admin_GetLanguage_allValid_smoke:
       endPoint: /v1/masterdata/languages
+      description: Retrieve all the languages list
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/apitest/src/main/resources/masterdata/GetLeafZonesByLangCode/GetLeafZonesByLangCode.yml b/apitest/src/main/resources/masterdata/GetLeafZonesByLangCode/GetLeafZonesByLangCode.yml
@@ -1,6 +1,7 @@
 GetLeafZonesByLangCode:
    MasterData_GetLeafZonesByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/zones/leafzones/{langCode}
+      description: Retrieve leafs zone details by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -13,6 +14,7 @@ GetLeafZonesByLangCode:
 }'
    MasterData_GetLeafZonesByLangCode_inValid_code:
       endPoint: /v1/masterdata/zones/leafzones/{langCode}
+      description: Retrieve leafs zone details by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetLeafZonesByLangCode/getLeafZonesByLangCode

diff --git a/apitest/src/main/resources/masterdata/GetLeafsByLangCode/GetLeafsByLangCode.yml b/apitest/src/main/resources/masterdata/GetLeafsByLangCode/GetLeafsByLangCode.yml
@@ -1,6 +1,7 @@
 GetLeafsByLangCode:
    MasterData_GetLeafsByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/zones/leafs/{langCode}
+      description: Retrieve leafs details by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -13,6 +14,7 @@ GetLeafsByLangCode:
 }'
    MasterData_GetLeafsByLangCode_inValid_code:
       endPoint: /v1/masterdata/zones/leafs/{langCode}
+      description: Retrieve leafs details by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetLeafsByLangCode/getLeafsByLangCode

diff --git a/...es/masterdata/GetLocationHierarchyByHierarchyName/GetLocationHierarchyByHierarchyName.yml b/...es/masterdata/GetLocationHierarchyByHierarchyName/GetLocationHierarchyByHierarchyName.yml
@@ -1,6 +1,7 @@
 GetLocationHierarchyByHierarchyName:
    Admin_GetLocationHierarchyByHierarchyName_allValid_smoke:
       endPoint: /v1/masterdata/locations/locationhierarchy/{hierarchyname}
+      description: Retrieve location hierarchy details by valid hierarchy name
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetLocationHierarchyByHierarchyName/getLocationHierarchyByHierarchyName
@@ -21,6 +22,7 @@ GetLocationHierarchyByHierarchyName:
 
    Admin_GetLocationHierarchyByHierarchyName_Invalid_Invalid_hierarchyname:
       endPoint: /v1/masterdata/locations/locationhierarchy/{hierarchyname}
+      description: Retrieve location hierarchy details by invalid hierarchy name
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetLocationHierarchyByHierarchyName/getLocationHierarchyByHierarchyName

diff --git a/...GetLocationHierarchyLevelByLastUpdatedDate/GetLocationHierarchyLevelByLastUpdatedDate.yml b/...GetLocationHierarchyLevelByLastUpdatedDate/GetLocationHierarchyLevelByLastUpdatedDate.yml
@@ -1,6 +1,7 @@
 GetLocationHierarchyLevelByLastUpdatedDate:
    Admin_GetLocationHierarchyLevelByLastUpdatedDate_allValid_smoke:
       endPoint: /v1/masterdata/locationHierarchyLevels?lastUpdated=2020-10-20T17:13:44.793Z
+      description: Retrieve location hierarchy details based on valid last updated date
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -14,6 +15,7 @@ GetLocationHierarchyLevelByLastUpdatedDate:
 
    Admin_GetLocationHierarchyLevelByLastUpdatedDate_with_Invalid_lD:
       endPoint: /v1/masterdata/locationHierarchyLevels?lastUpdated=abc
+      description: Retrieve location hierarchy details based on invalid last updated date
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetLocationHierarchyLevelByLastUpdatedDate/getLocationHierarchyLevelByLastUpdatedDate

diff --git a/apitest/src/main/resources/masterdata/GetLocations/GetLocations.yml b/apitest/src/main/resources/masterdata/GetLocations/GetLocations.yml
@@ -1,6 +1,7 @@
 GetLocations:
    Admin_GetLocations_allValid_smoke:
       endPoint: /v1/masterdata/locations/all
+      description: Retrieve location details
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/apitest/src/main/resources/masterdata/GetMachineHistory/GetMachineHistory.yml b/apitest/src/main/resources/masterdata/GetMachineHistory/GetMachineHistory.yml
@@ -1,6 +1,7 @@
 GetMachineHistory:
    Admin_GetMachineHistory_allValid_smoke:
       endPoint: /v1/masterdata/machineshistories/{id}/{langcode}/{effdatetimes}
+      description: Retrieve machine history details using valid ID, language code and effective date
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
@@ -28,6 +29,7 @@ GetMachineHistory:
 
    Admin_GetMachineHistory_Invalid_Invalid_lD:
       endPoint: /v1/masterdata/machineshistories/{id}/{langcode}/{effdatetimes}
+      description: Retrieve machine history details using an invalid ID, valid language code, and valid effective date
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMachineHistory/getMachineHistory
@@ -48,6 +50,7 @@ GetMachineHistory:
 
    Admin_GetMachineHistory_Invalid_Invalid_effdatetimes:
       endPoint: /v1/masterdata/machineshistories/{id}/{langcode}/{effdatetimes}
+      description: Retrieve machine history details using an valid ID, valid language code, and invalid effective date
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMachineHistory/getMachineHistory
@@ -68,6 +71,7 @@ GetMachineHistory:
 
    Admin_GetMachineHistory_Invalid_Invalid_langCode:
       endPoint: /v1/masterdata/machineshistories/{id}/{langcode}/{effdatetimes}
+      description: Retrieve machine history details using an valid ID, invalid language code, and valid effective date
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMachineHistory/getMachineHistory

diff --git a/apitest/src/main/resources/masterdata/GetMachines/GetMachines.yml b/apitest/src/main/resources/masterdata/GetMachines/GetMachines.yml
@@ -1,6 +1,7 @@
 GetMachines:
    Admin_GetMachines_allValid_smoke:
       endPoint: /v1/masterdata/machines
+      description: Retrieve machine details
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get

diff --git a/...c/main/resources/masterdata/GetMappedMachinesByRegCentID/GetMappedMachinesByRegCentID.yml b/...c/main/resources/masterdata/GetMappedMachinesByRegCentID/GetMappedMachinesByRegCentID.yml
@@ -1,19 +1,21 @@
 GetMappedMachinesByRegCentID:
    Admin_GetMappedMachinesByRegCentID_allValid_smoke:
       endPoint: /v1/masterdata/machines/mappedmachines/{regCenterId}
+      description: Retrieve mapped machine details by valid regisration centre ID
       role: admin
       checkErrorsOnlyInResponse: true
       restMethod: get
       inputTemplate: masterdata/GetMappedMachinesByRegCentID/getMappedMachinesByRegCentID
       outputTemplate: masterdata/GetMappedMachinesByRegCentID/getMappedMachinesByRegCentIDResult
       input: '{
-      "regCenterId":"10001"
+      "regCenterId":"10005"
 }'
       output: '{
 }'
 
    Admin_GetMappedMachinesByRegCentID_Invalid_Invalid_regCenterId:
       endPoint: /v1/masterdata/machines/mappedmachines/{regCenterId}
+      description: Retrieve mapped machine details by invalid regisration centre ID
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMappedMachinesByRegCentID/getMappedMachinesByRegCentID

diff --git a/.../masterdata/GetMissingDocumentCategoryByLangcode/GetMissingDocumentCategoryByLangcode.yml b/.../masterdata/GetMissingDocumentCategoryByLangcode/GetMissingDocumentCategoryByLangcode.yml
@@ -1,6 +1,7 @@
 GetMissingDocumentCategoryByLangcode:
    Masterdata_GetMissingDocumentCategoryByLangcode_allValid_smoke:
       endPoint: /v1/masterdata/documentcategories/missingids/{langcode}
+      description: Retrieve missing document category by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       templateFields: ["langcode"]
@@ -15,6 +16,7 @@ GetMissingDocumentCategoryByLangcode:
 }'
    Masterdata_GetDocumentTypeByLangCode_InValid_langcode:
       endPoint: /v1/masterdata/documentcategories/missingids/{langcode}
+      description: Retrieve missing document category by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMissingDocumentCategoryByLangcode/getMissingDocumentCategoryByLangcode

diff --git a/...esources/masterdata/GetMissingDocumentTypeByLangcode/GetMissingDocumentTypeByLangcode.yml b/...esources/masterdata/GetMissingDocumentTypeByLangcode/GetMissingDocumentTypeByLangcode.yml
@@ -1,6 +1,7 @@
 GetMissingDocumentTypeByLangcode:
    Masterdata_GetDocumentTypeByLangCode_all_valid_smoke:
       endPoint: /v1/masterdata/documenttypes/missingids/{langcode}
+      description: Retrieve missing document type by valid language code
       role: admin
       checkErrorsOnlyInResponse: true
       templateFields: ["langcode"]
@@ -15,6 +16,7 @@ GetMissingDocumentTypeByLangcode:
 }'
    Masterdata_GetDocumentTypeByLangCode_InValid_langcode:
       endPoint: /v1/masterdata/documenttypes/missingids/{langcode}
+      description: Retrieve missing document type by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetMissingDocumentTypeByLangcode/getMissingDocumentTypeByLangcode

diff --git a/apitest/src/main/resources/masterdata/GetModuleByIdLangCode/GetModuleByIdLangCode.yml b/apitest/src/main/resources/masterdata/GetModuleByIdLangCode/GetModuleByIdLangCode.yml
@@ -1,6 +1,7 @@
 GetModuleByIdLangCode:
    Admin_GetModuleByIdLangCode_allValid_smoke:
       endPoint: /v1/masterdata/modules/{id}/{langcode}
+      description: Retrieve module details by by valid ID and language code
       role: admin
       templateFields: ["langcode"]
       restMethod: get
@@ -22,6 +23,7 @@ GetModuleByIdLangCode:
 
    Admin_GetModuleByIdLangCode_Invalid_Invalid_langcode:
       endPoint: /v1/masterdata/modules/{id}/{langcode}
+      description: Retrieve module details by by valid ID and invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetModuleByIdLangCode/getModuleByIdLangCode
@@ -41,6 +43,7 @@ GetModuleByIdLangCode:
 
    Admin_GetModuleByIdLangCode_Invalid_Invalid_lD:
       endPoint: /v1/masterdata/modules/{id}/{langcode}
+      description: Retrieve module details by by invalid ID and valid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetModuleByIdLangCode/getModuleByIdLangCode

diff --git a/apitest/src/main/resources/masterdata/GetModuleByLangCode/GetModuleByLangCode.yml b/apitest/src/main/resources/masterdata/GetModuleByLangCode/GetModuleByLangCode.yml
@@ -1,6 +1,7 @@
 GetModuleByLangCode:
    Admin_GetModuleByLangCode_allValid_smoke:
       endPoint: /v1/masterdata/modules/{langcode}
+      description: Retrieve module details by valid language code
       role: admin
       templateFields: ["langcode"]
       restMethod: get
@@ -21,6 +22,7 @@ GetModuleByLangCode:
 
    Admin_GetModuleByLangCode_Invalid_Invalid_langcode:
       endPoint: /v1/masterdata/modules/{langcode}
+      description: Retrieve module details by invalid language code
       role: admin
       restMethod: get
       inputTemplate: masterdata/GetModuleByLangCode/getModuleByLangCode