FINERACT-2494: Standardize operationId for Savings module#5665
Open
Ambika-Sony wants to merge 1 commit intoapache:developfrom
Open
FINERACT-2494: Standardize operationId for Savings module#5665Ambika-Sony wants to merge 1 commit intoapache:developfrom
Ambika-Sony wants to merge 1 commit intoapache:developfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This Pull Request standardizes the operationId naming conventions within the Savings module API resources (SavingsAccountsApiResource.java).
By providing explicit and unique operationId values in the @operation Swagger annotations, we ensure that client-side SDKs (like the Fineract Java and TypeScript clients) generate clean, predictable, and user-friendly method names.
Key Technical Achievements
Architectural Migration: Successfully transitioned the standardization logic from the legacy fineract-provider structure into the new 1.15.0-SNAPSHOT modular architecture.
Upstream Synchronization: Performed a manual rebase against upstream/develop to resolve complex conflicts in GitHub workflows and the newly created fineract-savings sub-module.
Structural Integrity: Resolved JPA configuration path conflicts (persistence.xml) across multiple modules (fineract-loan, fineract-cob, fineract-investor) caused by the recent project refactor.
Clean History: Utilized a git reset --soft workflow to ensure a single, clean, and high-quality commit on top of the latest project state.
Verification Results
Local Build: Verified with ./gradlew :fineract-savings:compileJava — BUILD SUCCESSFUL.
Static Analysis: Verified that the new module paths are correctly mapped and that no new checkstyle violations were introduced in the Savings API resource.
Parity: Confirmed that all operationId values align with the patterns used in other standardized modules.
Checklist
[x] Write the commit message as per our guidelines.
[x] Acknowledge that we will not review PRs that are not passing the build ("green").
[x] Follow our coding conventions.
[x] This PR is focused on a single task (Savings API standardization).