edk12564 opened a new pull request, #5597: URL: https://github.com/apache/fineract/pull/5597
JIRA: FINERACT-2501 ## Description According to FINERACT-2501, deduplication numbers in Feign client methods are unstable. More on this below. **The Problem** Fineract uses Swagger/OpenAPI to auto-generate Feign client methods from our endpoints. Since many endpoints share the same method name (e.g., retrieveAll()), Swagger appends a deduplication number to create unique operationIds. For example, retrieveAll35() for SavingsProductsApiResource.retrieveAll(). These deduplication numbers are unstable. When a new endpoint with a duplicate name is added, the numbers can shift. In my testing, after adding a new dummy retrieveAll() endpoint, retrieveAll35() no longer pointed to SavingsProductsApiResource. It actually shifted to retrieveAll36(). Since we hardcode these deduplicated method names in our Cucumber tests, any shift will silently call the wrong API, breaking tests. To start, the currently used Feign methods must be refactored, and the endpoints must have operationIds added to them. This is because changes in other modules will cause these in use methods to change due to instability. This results in build failures. ## Changes - 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 shifted in the OpenApi spec The methodology for naming OperationIds is methodName + entityName + descriptionClause. For example, update() for SavingsProducts that updates using an externalId becomes updateSavingsProductsByExternalId. ## More Changes Certain method names were named improperly. In FinancialActivityAccountsApiResource, we have createGLAccount endpoints. However, this endpoint actually creates a mapping between a FinancialActivityAccount and a GLAccount that already exists. For this case, I updated the operationId to be more descriptive on the actual function. ## Results All affected tests in integration and Cucumber tests pass. <img width="1263" height="349" alt="Screenshot 2026-03-08 at 5 19 54 PM" src="https://github.com/user-attachments/assets/927699be-055e-445e-b632-2e6eccb6851f"; /> <img width="1304" height="250" alt="Screenshot 2026-03-08 at 5 25 16 PM" src="https://github.com/user-attachments/assets/8fca744a-1192-4946-9555-cbda3584e25b"; /> ## Checklist Please make sure these boxes are checked before submitting your pull request - thanks! - [x] Write the commit message as per [our guidelines](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#pull-requests) - [x] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers. - [x] Create/update [unit or integration tests](https://fineract.apache.org/docs/current/#_testing) for verifying the changes made. - [x] Follow our [coding conventions](https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions). - [x] Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes - [x] [This PR must not be a "code dump"](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit). Large changes can be made in a branch, with assistance. Ask for help on the [developer mailing list](https://fineract.apache.org/#contribute). Your assigned reviewer(s) will follow our [guidelines for code reviews](https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
