FINERACT-2169: Account rules api refactor; #4435
Open
+68
−80
Conversation
This file contains 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
adamsaghy
reviewed
Mar 10, 2025
| @@ -105,15 +106,9 @@ public class AccountingRuleApiResource { | |||
| + "\n" + "Field Defaults\n" + "Allowed Value Lists\n" + "Example Request:\n" + "\n" + "accountingrules/template") | |||
| @ApiResponses({ | |||
| @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountingRuleApiResourceSwagger.GetAccountRulesTemplateResponse.class))) }) | |||
There was a problem hiding this comment.
You might wanna remove the Swagger response annotation here as the AccountingRuleApiResourceSwagger.GetAccountRulesTemplateResponse contains only a couple of the fields that are retrieved... Without the annotation it will generate the swagger response based on the return data type which is better in this case!
There was a problem hiding this comment.
Yes, it's good idea and i'd really like to do it!
adamsaghy
reviewed
Mar 10, 2025
| @@ -196,15 +173,13 @@ public String createAccountingRule(@Parameter(hidden = true) final String jsonRe | |||
| @RequestBody(content = @Content(schema = @Schema(implementation = AccountingRuleApiResourceSwagger.PutAccountingRulesRequest.class))) | |||
| @ApiResponses({ | |||
| @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountingRuleApiResourceSwagger.PutAccountingRulesResponse.class))) }) | |||
There was a problem hiding this comment.
Kindly validate whether the CommandProcessingResult and AccountingRuleApiResourceSwagger.PutAccountingRulesResponse fields are matching!
We can consider removing the annotation and the explicit swagger class if it is not matching!
adamsaghy
requested changes
Mar 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
Write the commit message as per https://github.com/apache/fineract/#pull-requests
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.
Create/update unit or integration tests for verifying the changes made.
Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.
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
Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)
FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.