FINERACT-2501: Added operationIds to harden feign methods in methods currently used in tests

- added operationIds to all endpoints for Feign methods currently used in these
- changed these first because changing other methods seems to break builds since these tests will shift due to items being taken out of the OpenApi spec
- added changes to WorkingCapitalStepDef

Author: edk12564

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/common/BatchApiStepDef.java

@@ -552,7 +552,7 @@ public void runBatchApiCreateAndApproveLoanRescheduleWithGivenUserLockedByCobErr
         // Create new user which cannot bypass loan COB execution
         PostUsersResponse createUserResponse = testContext().get(TestContextKey.CREATED_SIMPLE_USER_RESPONSE);
         Long createdUserId = createUserResponse.getResourceId();
-        GetUsersUserIdResponse user = fineractFeignClient.users().retrieveOne32(createdUserId);
+        GetUsersUserIdResponse user = fineractFeignClient.users().retrieveOneUser(createdUserId);
         String authorizationString = user.getUsername() + ":" + PWD_USER_WITH_ROLE;
         Base64 base64 = new Base64();
         headerMap.put("Authorization",

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/common/UserStepDef.java

@@ -68,7 +68,7 @@ public void createUserWithUsernameAndRoles(String username, String roleName, Lis
                 .repeatPassword(PWD_USER_WITH_ROLE) //
                 .roles(List.of(roleId));
 
-        PostUsersResponse createUserResponse = ok(() -> fineractClient.users().create16(postUsersRequest));
+        PostUsersResponse createUserResponse = ok(() -> fineractClient.users().createUser(postUsersRequest));
         testContext().set(TestContextKey.CREATED_SIMPLE_USER_RESPONSE, createUserResponse);
         testContext().set(TestContextKey.CREATED_SIMPLE_USER_USERNAME, generatedUsername);
         testContext().set(TestContextKey.CREATED_SIMPLE_USER_PASSWORD, PWD_USER_WITH_ROLE);

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/LoanRepaymentStepDef.java

@@ -145,7 +145,7 @@ public void makeRepaymentWithGivenUser(String repaymentType, String transactionD
 
         PostUsersResponse createUserResponse = testContext().get(TestContextKey.CREATED_SIMPLE_USER_RESPONSE);
         Long createdUserId = createUserResponse.getResourceId();
-        GetUsersUserIdResponse user = ok(() -> fineractClient.users().retrieveOne32(createdUserId));
+        GetUsersUserIdResponse user = ok(() -> fineractClient.users().retrieveOneUser(createdUserId));
 
         String apiBaseUrl = apiProperties.getBaseUrl() + "/fineract-provider/api/";
         FineractFeignClient userClient = FineractFeignClient.builder().baseUrl(apiBaseUrl)
@@ -200,7 +200,7 @@ public void makeRepaymentWithGivenUserByExternalId(String repaymentType, String
 
         PostUsersResponse createUserResponse = testContext().get(TestContextKey.CREATED_SIMPLE_USER_RESPONSE);
         Long createdUserId = createUserResponse.getResourceId();
-        GetUsersUserIdResponse user = ok(() -> fineractClient.users().retrieveOne32(createdUserId));
+        GetUsersUserIdResponse user = ok(() -> fineractClient.users().retrieveOneUser(createdUserId));
 
         String apiBaseUrl = apiProperties.getBaseUrl() + "/fineract-provider/api/";
         FineractFeignClient userClient = FineractFeignClient.builder().baseUrl(apiBaseUrl)

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/WorkingCapitalStepDef.java

@@ -210,8 +210,8 @@ public void updateWorkingCapitalLoanProductViaExternalId() {
                 .get(TestContextKey.WORKING_CAPITAL_LOAN_PRODUCT_CREATE_REQUEST);
         String externalId = workingCapitalLoanProductsRequest.getExternalId();
 
-        PutWorkingCapitalLoanProductsProductIdResponse responseWorkingCapitalLoanProductUpdate = ok(
-                () -> workingCapitalApi().updateWorkingCapitalLoanProduct1(externalId, workingCapitalLoanProductUpdateRequest, Map.of()));
+        PutWorkingCapitalLoanProductsProductIdResponse responseWorkingCapitalLoanProductUpdate = ok(() -> workingCapitalApi()
+                .updateWorkingCapitalLoanProductByExternalId(externalId, workingCapitalLoanProductUpdateRequest, Map.of()));
 
         testContext().set(TestContextKey.WORKING_CAPITAL_LOAN_PRODUCT_UPDATE_RESPONSE, responseWorkingCapitalLoanProductUpdate);
         testContext().set(TestContextKey.WORKING_CAPITAL_LOAN_PRODUCT_UPDATE_REQUEST, workingCapitalLoanProductUpdateRequest);
@@ -286,7 +286,7 @@ public void updateWorkingCapitalLoanProductWithInvalidPaymentAllocationFailed()
     @Then("Admin failed to retrieve a Working Capital Loan Product with id {int} that doesn't exist")
     public void retrieveWorkingCapitalLoanProductFailure(Integer productId) {
         CallFailedRuntimeException exception = fail(
-                () -> workingCapitalApi().retrieveWorkingCapitalLoanProductDetails(Long.valueOf(productId), Map.of()));
+                () -> workingCapitalApi().retrieveOneWorkingCapitalLoanProduct(Long.valueOf(productId), Map.of()));
         assertThat(exception.getStatus()).as(ErrorMessageHelper.dateFailureErrorCodeMsg()).isEqualTo(404);
         assertThat(exception.getDeveloperMessage())
                 .contains(ErrorMessageHelper.workingCapitalLoanProductIdentifiedDoesNotExistFailure(String.valueOf(productId)));
@@ -314,7 +314,7 @@ public void deleteWorkingCapitalLoanProductViaExternalId() {
         String externalId = workingCapitalLoanProductsUpdateRequest.getExternalId();
 
         DeleteWorkingCapitalLoanProductsProductIdResponse deleteWorkingCapitalLoanProductResponse = ok(
-                () -> workingCapitalApi().deleteWorkingCapitalLoanProduct1(externalId, Map.of()));
+                () -> workingCapitalApi().deleteWorkingCapitalLoanProductByExternalId(externalId, Map.of()));
         assertThat(deleteWorkingCapitalLoanProductResponse.getResourceId()).isEqualTo(resourceId);
     }
 
@@ -338,7 +338,7 @@ public void checkWorkingCapitalLoanProductIsDeletedViaExternalId() {
         String externalId = workingCapitalLoanProductsUpdateRequest.getExternalId();
 
         CallFailedRuntimeException exception = fail(
-                () -> workingCapitalApi().retrieveWorkingCapitalLoanProductDetails1(externalId, Map.of()));
+                () -> workingCapitalApi().retrieveOneWorkingCapitalLoanProductByExternalId(externalId, Map.of()));
         assertThat(exception.getStatus()).as(ErrorMessageHelper.dateFailureErrorCodeMsg()).isEqualTo(404);
         assertThat(exception.getDeveloperMessage())
                 .contains(ErrorMessageHelper.workingCapitalLoanProductIdentifiedDoesNotExistFailure(String.valueOf(externalId)));
@@ -367,7 +367,7 @@ public void checkWorkingCapitalLoanProductCreate() {
                 .get(TestContextKey.WORKING_CAPITAL_LOAN_PRODUCT_CREATE_RESPONSE);
         Long resourceId = workingCapitalLoanProductResponse.getResourceId();
         GetWorkingCapitalLoanProductsProductIdResponse getWorkingCapitalProductResponse = workingCapitalApi()
-                .retrieveWorkingCapitalLoanProductDetails(resourceId, Map.of());
+                .retrieveOneWorkingCapitalLoanProduct(resourceId, Map.of());
         checkWorkingCapitalLoanProductCreate(workingCapitalLoanProductCreateRequest, getWorkingCapitalProductResponse);
     }
 
@@ -377,7 +377,7 @@ public void checkWorkingCapitalLoanProductWithExternalIdCreate() {
         String externalId = workingCapitalLoanProductCreateRequest.getExternalId();
 
         GetWorkingCapitalLoanProductsProductIdResponse getWorkingCapitalProductResponse = workingCapitalApi()
-                .retrieveWorkingCapitalLoanProductDetails1(externalId, Map.of());
+                .retrieveOneWorkingCapitalLoanProductByExternalId(externalId, Map.of());
         checkWorkingCapitalLoanProductCreate(workingCapitalLoanProductCreateRequest, getWorkingCapitalProductResponse);
     }
 
@@ -480,7 +480,7 @@ public void checkWorkingCapitalLoanProductUpdate() {
         Long resourceId = workingCapitalLoanProductResponse.getResourceId();
 
         GetWorkingCapitalLoanProductsProductIdResponse getWorkingCapitalProductResponse = workingCapitalApi()
-                .retrieveWorkingCapitalLoanProductDetails(resourceId, Map.of());
+                .retrieveOneWorkingCapitalLoanProduct(resourceId, Map.of());
         checkWorkingCapitalLoanProductUpdate(workingCapitalLoanProductsUpdateRequest, getWorkingCapitalProductResponse);
     }
 
@@ -490,7 +490,7 @@ public void checkWorkingCapitalLoanProductWithExternalIdUpdate() {
         String externalId = workingCapitalLoanProductsUpdateRequest.getExternalId();
 
         GetWorkingCapitalLoanProductsProductIdResponse getWorkingCapitalProductResponse = workingCapitalApi()
-                .retrieveWorkingCapitalLoanProductDetails1(externalId, Map.of());
+                .retrieveOneWorkingCapitalLoanProductByExternalId(externalId, Map.of());
         checkWorkingCapitalLoanProductUpdate(workingCapitalLoanProductsUpdateRequest, getWorkingCapitalProductResponse);
     }
 
@@ -799,8 +799,7 @@ public PutWorkingCapitalLoanProductsProductIdRequest setWorkingCapitalLoanProduc
     }
 
     public void checkWorkingCapitalLoanProductDeleteFailure(Long productId) {
-        CallFailedRuntimeException exception = fail(
-                () -> workingCapitalApi().retrieveWorkingCapitalLoanProductDetails(productId, Map.of()));
+        CallFailedRuntimeException exception = fail(() -> workingCapitalApi().retrieveOneWorkingCapitalLoanProduct(productId, Map.of()));
         assertThat(exception.getStatus()).as(ErrorMessageHelper.dateFailureErrorCodeMsg()).isEqualTo(404);
         assertThat(exception.getDeveloperMessage())
                 .contains(ErrorMessageHelper.workingCapitalLoanProductIdentifiedDoesNotExistFailure(String.valueOf(productId)));

fineract-provider/src/main/java/org/apache/fineract/useradministration/api/UsersApiResource.java

@@ -90,8 +90,8 @@ public class UsersApiResource {
     private final BulkImportWorkbookService bulkImportWorkbookService;
 
     @GET
-    @Operation(summary = "Retrieve list of users", description = "Example Requests:\n" + "\n" + "users\n" + "\n" + "\n"
-            + "users?fields=id,username,email,officeName")
+    @Operation(summary = "Retrieve list of users", operationId = "retrieveAllUsers", description = "Example Requests:\n" + "\n" + "users\n"
+            + "\n" + "\n" + "users?fields=id,username,email,officeName")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = UsersApiResourceSwagger.GetUsersResponse.class)))) })
     @Consumes({ MediaType.APPLICATION_JSON })
@@ -108,8 +108,8 @@ public String retrieveAll(@Context final UriInfo uriInfo) {
 
     @GET
     @Path("{userId}")
-    @Operation(summary = "Retrieve a User", description = "Example Requests:\n" + "\n" + "users/1\n" + "\n" + "\n"
-            + "users/1?template=true\n" + "\n" + "\n" + "users/1?fields=username,officeName")
+    @Operation(summary = "Retrieve a User", operationId = "retrieveOneUser", description = "Example Requests:\n" + "\n" + "users/1\n" + "\n"
+            + "\n" + "users/1?template=true\n" + "\n" + "\n" + "users/1?fields=username,officeName")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.GetUsersUserIdResponse.class))) })
     @Consumes({ MediaType.APPLICATION_JSON })
@@ -131,7 +131,7 @@ public String retrieveOne(@PathParam("userId") @Parameter(description = "userId"
 
     @GET
     @Path("template")
-    @Operation(summary = "Retrieve User Details Template", description = "This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:\n"
+    @Operation(summary = "Retrieve User Details Template", operationId = "retrieveTemplateUser", description = "This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:\n"
             + "\n" + "Field Defaults\n" + "Allowed description Lists\n" + "Example Request:\n" + "\n" + "users/template")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.GetUsersTemplateResponse.class))) })
@@ -148,7 +148,7 @@ public String template(@Context final UriInfo uriInfo) {
     }
 
     @POST
-    @Operation(summary = "Create a User", description = "Adds new application user.\n" + "\n"
+    @Operation(summary = "Create a User", operationId = "createUser", description = "Adds new application user.\n" + "\n"
             + "Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).\n"
             + "\n" + "Mandatory Fields: \n" + "username, firstname, lastname, email, officeId, roles, sendPasswordToEmail\n" + "\n"
             + "Optional Fields: \n" + "staffId,passwordNeverExpires,isSelfServiceUser,clients")
@@ -171,7 +171,7 @@ public String create(@Parameter(hidden = true) final String apiRequestBodyAsJson
 
     @PUT
     @Path("{userId}")
-    @Operation(summary = "Update a User", description = "Updates the user")
+    @Operation(summary = "Update a User", operationId = "updateUser", description = "Updates the user")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.PutUsersUserIdRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.PutUsersUserIdResponse.class))) })
@@ -192,7 +192,7 @@ public String update(@PathParam("userId") @Parameter(description = "userId") fin
 
     @POST
     @Path("{userId}/pwd")
-    @Operation(summary = "Change the password of a User", description = "When updating a password you must provide the repeatPassword parameter also.")
+    @Operation(summary = "Change the password of a User", operationId = "changePasswordUser", description = "When updating a password you must provide the repeatPassword parameter also.")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.ChangePwdUsersUserIdRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.ChangePwdUsersUserIdResponse.class))) })
@@ -213,7 +213,7 @@ public String changePassword(@PathParam("userId") @Parameter(description = "user
 
     @DELETE
     @Path("{userId}")
-    @Operation(summary = "Delete a User", description = "Removes the user and the associated roles and permissions.")
+    @Operation(summary = "Delete a User", operationId = "deleteUser", description = "Removes the user and the associated roles and permissions.")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.DeleteUsersUserIdResponse.class))) })
     @Consumes({ MediaType.APPLICATION_JSON })