You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fineract.apache.org by "AshharAhmadKhan (via GitHub)" <gi...@apache.org> on 2026/06/26 06:12:00 UTC
[PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
AshharAhmadKhan opened a new pull request, #6043:
URL: https://github.com/apache/fineract/pull/6043
JIRA: https://issues.apache.org/jira/browse/FINERACT-2501
This PR is a continuation of the work started in #5597, #5744, and #6042, which addressed the instability of auto-generated Feign client method names caused by Swagger deduplication numbers shifting when new endpoints are added.
This PR covers the Infrastructure, Organisation, and User Management modules, adding explicit operationId values to all endpoints that were missing them. The naming convention follows the same pattern established in the previous PRs: methodName + EntityName + DescriptionClause (for example, retrieveAllHolidays, handleCommandsScheduler, updateRolePermissions).
Files changed:
- AccountNumberFormatsApiResource (6 operationIds added)
- CodesApiResource (6 operationIds added)
- ExternalServicesConfigurationApiResource (2 operationIds added)
- EntityDatatableChecksApiResource (4 operationIds added)
- HookApiResource (6 operationIds added)
- InstanceModeApiResource (1 operationId added)
- InlineJobApiResource (1 operationId added)
- SchedulerApiResource (2 operationIds added)
- SurveyApiResource (3 operationIds added)
- HolidaysApiResource (6 operationIds added)
- OfficesApiResource (7 operationIds added)
- ProvisioningCriteriaApiResource (5 operationIds added)
- StaffApiResource (2 operationIds added)
- WorkingDaysApiResource (3 operationIds added)
- ForgotPasswordApiResource (1 operationId added)
- PasswordPreferencesApiResource (3 operationIds added)
- PermissionsApiResource (2 operationIds added)
- RolesApiResource (9 operationIds added)
- UsersApiResource (2 operationIds added)
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4852799977
> Hey @adamsaghy , I don't think we can use handleCommand for all three, otherwise the same collision will happen. How about handleHolidayCommand, handleSchedulerCommand, handleRoleCommand? Does that work?
What kind of collision you are referring? The method names can be the same for different swagger classes, no?
Example:
`fineractClient.holidays.handleCommand(...)
`fineractClient.schedulers.handleCommand(...)`
`fineractClient.roles.handleCommand(...)`
Am I mistaken?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4808913511
@AshharAhmadKhan
```
/home/runner/work/fineract/fineract/fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/helper/CodeHelper.java:58: error: cannot find symbol
return ok(() -> fineractClient.codes().retrieveCodes(Map.of())).stream().filter(r -> name.equals(r.getName())).findAny()
^
symbol: method retrieveCodes(Map<Object,Object>)
location: interface CodesApi
/home/runner/work/fineract/fineract/fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/helper/CodeHelper.java:58: error: cannot find symbol
return ok(() -> fineractClient.codes().retrieveCodes(Map.of())).stream().filter(r -> name.equals(r.getName())).findAny()
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4853023484
Hey @adamsaghy , you're right I overthought the uniqueness part! But I have verified that operationIds are unique throughout the entire upstream codebase and handleCommands + EntityName is already an established convention there with handleCommandsCenter, handleCommandsGroup, handleCommandsSavingsAccount etc. So I think the current names are fine. What do you think?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4833606462
Hey @adamsaghy , I don't think we can use handleCommand for all three, otherwise the same collision will happen.
How about handleHolidayCommand, handleSchedulerCommand, handleRoleCommand?
Does that work?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on code in PR #6043:
URL: https://github.com/apache/fineract/pull/6043#discussion_r3491264242
##########
fineract-provider/src/main/java/org/apache/fineract/organisation/holiday/api/HolidaysApiResource.java:
##########
@@ -97,7 +97,7 @@ public String createNewHoliday(@Parameter(hidden = true) final String apiRequest
@Path("{holidayId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- @Operation(summary = "Activate a Holiday", description = "Always Holidays are created in pending state. This API allows to activate a holiday.\n"
+ @Operation(summary = "Activate a Holiday", operationId = "handleCommandsHoliday", description = "Always Holidays are created in pending state. This API allows to activate a holiday.\n"
Review Comment:
`handleCommandsHoliday` sounds weird... i think simple `handleCommand` would be enough
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4810815537
@adamsaghy issue addressed, please trigger checks.
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4853118733
> Hey @adamsaghy , you're right I overthought the uniqueness part! But I have verified that operationIds are unique throughout the entire upstream codebase and handleCommands + EntityName is already an established convention there with handleCommandsCenter, handleCommandsGroup, handleCommandsSavingsAccount etc. So I think the current names are fine. What do you think?
fine
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on code in PR #6043:
URL: https://github.com/apache/fineract/pull/6043#discussion_r3491273554
##########
fineract-provider/src/main/java/org/apache/fineract/useradministration/api/RolesApiResource.java:
##########
@@ -160,7 +161,7 @@ public String retrieveRole(@PathParam("roleId") @Parameter(description = "roleId
@Path("{roleId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- @Operation(summary = "Enable Role | Disable Role", tags = {
+ @Operation(summary = "Enable Role | Disable Role", operationId = "handleCommandsRole", tags = {
Review Comment:
`handleCommandsRole` has a weird sounding. `handleCommand` maybe?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy merged PR #6043:
URL: https://github.com/apache/fineract/pull/6043
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4850282784
Hey @adamsaghy, would love your guidance on this whenever you have a chance. Happy to go with whichever naming convention you think fits best. Thanks!
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on code in PR #6043:
URL: https://github.com/apache/fineract/pull/6043#discussion_r3491266819
##########
fineract-e2e-tests-runner/src/test/java/org/apache/fineract/test/initializer/global/SchedulerGlobalInitializerStep.java:
##########
@@ -38,6 +38,6 @@ public class SchedulerGlobalInitializerStep implements FineractGlobalInitializer
@Override
public void initialize() throws Exception {
- executeVoid(() -> fineractClient.scheduler().changeSchedulerStatus(Map.of("command", SCHEDULER_STATUS_STOP)));
+ executeVoid(() -> fineractClient.scheduler().handleCommandsScheduler(Map.of("command", SCHEDULER_STATUS_STOP)));
Review Comment:
`handleCommand`?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4825254854
@adamsaghy can u have a look please when you get a chance?
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2501: Add operationIds to Infrastructure, Organisation and User Management modules to harden feign method names [fineract]
Posted by "AshharAhmadKhan (via GitHub)" <gi...@apache.org>.
AshharAhmadKhan commented on PR #6043:
URL: https://github.com/apache/fineract/pull/6043#issuecomment-4808627884
@adamsaghy Please re run checks here too.
--
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: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org