Skip to content

Commit c04ba3f

Browse files
adamsaghyadamsaghy
authored
Merge pull request #5744
FINERACT-2501: Add more operationIds to harden feign method names
2 parents 59cf29a + 1cc99ce commit c04ba3f

55 files changed

Lines changed: 294 additions & 193 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎fineract-accounting/src/main/java/org/apache/fineract/accounting/accrual/api/AccrualAccountingApiResource.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public class AccrualAccountingApiResource {
5151
@POST
5252
@Consumes({ MediaType.APPLICATION_JSON })
5353
@Produces({ MediaType.APPLICATION_JSON })
54-
@Operation(summary = "Executes Periodic Accrual Accounting", method = "POST", description = """
54+
@Operation(summary = "Executes Periodic Accrual Accounting", operationId = "executePeriodicAccrualAccounting", method = "POST", description = """
5555
Mandatory Fields
5656
5757
tillDate

‎fineract-accounting/src/main/java/org/apache/fineract/accounting/closure/api/GLClosuresApiResource.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public class GLClosuresApiResource {
8181

8282
@GET
8383
@Produces({ MediaType.APPLICATION_JSON })
84-
@Operation(summary = "List Accounting closures", description = """
84+
@Operation(summary = "List Accounting closures", operationId = "retrieveAllGLClosures", description = """
8585
Example Requests:
8686
8787
glclosures""")
@@ -95,7 +95,7 @@ public List<GLClosureData> retrieveAllClosures(@QueryParam("officeId") @Paramete
9595
@GET
9696
@Path("{glClosureId}")
9797
@Produces({ MediaType.APPLICATION_JSON })
98-
@Operation(summary = "Retrieve an Accounting Closure", description = """
98+
@Operation(summary = "Retrieve an Accounting Closure", operationId = "retrieveOneGLClosure", description = """
9999
Example Requests:
100100
101101
glclosures/1
@@ -120,7 +120,8 @@ public GLClosureData retreiveClosure(@PathParam("glClosureId") @Parameter(descri
120120
@POST
121121
@Consumes({ MediaType.APPLICATION_JSON })
122122
@Produces({ MediaType.APPLICATION_JSON })
123-
@Operation(summary = "Create an Accounting Closure", description = "Mandatory Fields\n" + "officeId,closingDate")
123+
@Operation(summary = "Create an Accounting Closure", operationId = "createGLClosure", description = "Mandatory Fields\n"
124+
+ "officeId,closingDate")
124125
@RequestBody(required = true, content = @Content(schema = @Schema(implementation = GLClosuresApiResourceSwagger.PostGlClosuresRequest.class, description = "Request Body")))
125126
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = GLClosuresApiResourceSwagger.PostGlClosuresResponse.class)))
126127
public CommandProcessingResult createGLClosure(@Parameter(hidden = true) GLClosureRequest glClosureRequest) {
@@ -134,7 +135,7 @@ public CommandProcessingResult createGLClosure(@Parameter(hidden = true) GLClosu
134135
@Path("{glClosureId}")
135136
@Consumes({ MediaType.APPLICATION_JSON })
136137
@Produces({ MediaType.APPLICATION_JSON })
137-
@Operation(summary = "Update an Accounting closure", description = "Once an accounting closure is created, only the comments associated with it may be edited")
138+
@Operation(summary = "Update an Accounting closure", operationId = "updateGLClosure", description = "Once an accounting closure is created, only the comments associated with it may be edited")
138139
@RequestBody(content = @Content(schema = @Schema(implementation = GLClosuresApiResourceSwagger.PutGlClosuresRequest.class)))
139140
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = GLClosuresApiResourceSwagger.PutGlClosuresResponse.class)))
140141
public CommandProcessingResult updateGLClosure(@PathParam("glClosureId") @Parameter(description = "glClosureId") final Long glClosureId,
@@ -147,7 +148,7 @@ public CommandProcessingResult updateGLClosure(@PathParam("glClosureId") @Parame
147148
@DELETE
148149
@Path("{glClosureId}")
149150
@Produces({ MediaType.APPLICATION_JSON })
150-
@Operation(summary = "Delete an accounting closure", description = "Note: Only the latest accounting closure associated with a branch may be deleted.")
151+
@Operation(summary = "Delete an accounting closure", operationId = "deleteGLClosure", description = "Note: Only the latest accounting closure associated with a branch may be deleted.")
151152
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = GLClosuresApiResourceSwagger.DeleteGlClosuresResponse.class)))
152153
public CommandProcessingResult deleteGLClosure(
153154
@PathParam("glClosureId") @Parameter(description = "glclosureId") final Long glClosureId) {

‎fineract-accounting/src/main/java/org/apache/fineract/accounting/provisioning/api/ProvisioningEntriesApiResource.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public class ProvisioningEntriesApiResource {
7474
@POST
7575
@Consumes({ MediaType.APPLICATION_JSON })
7676
@Produces({ MediaType.APPLICATION_JSON })
77-
@Operation(summary = "Create new Provisioning Entries", description = """
77+
@Operation(summary = "Create new Provisioning Entries", operationId = "createProvisioningEntries", description = """
7878
Creates a new Provisioning Entries
7979
8080
Mandatory Fields
@@ -96,7 +96,7 @@ public CommandProcessingResult createProvisioningEntries(@Parameter(hidden = tru
9696
@Path("{entryId}")
9797
@Consumes({ MediaType.APPLICATION_JSON })
9898
@Produces({ MediaType.APPLICATION_JSON })
99-
@Operation(summary = "Recreates Provisioning Entry", description = "Recreates Provisioning Entry | createjournalentry.")
99+
@Operation(summary = "Recreates Provisioning Entry", operationId = "modifyProvisioningEntry", description = "Recreates Provisioning Entry | createjournalentry.")
100100
@RequestBody(content = @Content(schema = @Schema(implementation = ProvisioningEntriesApiResourceSwagger.PutProvisioningEntriesRequest.class)))
101101
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = ProvisioningEntriesApiResourceSwagger.PutProvisioningEntriesResponse.class)))
102102
public CommandProcessingResult modifyProvisioningEntry(@PathParam("entryId") @Parameter(description = "entryId") final Long entryId,
@@ -109,7 +109,7 @@ public CommandProcessingResult modifyProvisioningEntry(@PathParam("entryId") @Pa
109109
@GET
110110
@Path("{entryId}")
111111
@Produces({ MediaType.APPLICATION_JSON })
112-
@Operation(summary = "Retrieves a Provisioning Entry", description = "Returns the details of a generated Provisioning Entry.")
112+
@Operation(summary = "Retrieves a Provisioning Entry Metadata", operationId = "retrieveOneProvisioningEntry", description = "Returns the metadata of a generated Provisioning Entry.")
113113
public ProvisioningEntryData retrieveProvisioningEntry(@PathParam("entryId") @Parameter(description = "entryId") final Long entryId) {
114114
platformSecurityContext.authenticatedUser();
115115
return provisioningEntriesReadPlatformService.retrieveProvisioningEntryData(entryId);
@@ -118,6 +118,7 @@ public ProvisioningEntryData retrieveProvisioningEntry(@PathParam("entryId") @Pa
118118
@GET
119119
@Path("entries")
120120
@Produces({ MediaType.APPLICATION_JSON })
121+
@Operation(summary = "Retrieve Provisioning Entries Loan Products Given a Query", operationId = "retrieveProvisioningEntriesLoanProducts")
121122
public Page<LoanProductProvisioningEntryData> retrieveProviioningEntries(@QueryParam("entryId") final Long entryId,
122123
@QueryParam("offset") final Integer offset, @QueryParam("limit") final Integer limit,
123124
@QueryParam("officeId") final Long officeId, @QueryParam("productId") final Long productId,
@@ -131,7 +132,7 @@ public Page<LoanProductProvisioningEntryData> retrieveProviioningEntries(@QueryP
131132

132133
@GET
133134
@Produces({ MediaType.APPLICATION_JSON })
134-
@Operation(summary = "List all Provisioning Entries")
135+
@Operation(summary = "List all Provisioning Entries Metadata", operationId = "retrieveAllProvisioningEntries")
135136
public Page<ProvisioningEntryData> retrieveAllProvisioningEntries(
136137
@QueryParam("offset") @Parameter(description = "offset") final Integer offset,
137138
@QueryParam("limit") @Parameter(description = "limit") final Integer limit) {

‎fineract-accounting/src/main/java/org/apache/fineract/accounting/rule/api/AccountingRuleApiResource.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public class AccountingRuleApiResource {
9494
@GET
9595
@Path("template")
9696
@Produces({ MediaType.APPLICATION_JSON })
97-
@Operation(summary = "Retrieve Accounting Rule Details Template", description = """
97+
@Operation(summary = "Retrieve Accounting Rule Details Template", operationId = "retrieveTemplateAccountingRule", description = """
9898
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:
9999
100100
Field Defaults
@@ -109,7 +109,7 @@ public AccountingRuleData retrieveTemplate() {
109109

110110
@GET
111111
@Produces({ MediaType.APPLICATION_JSON })
112-
@Operation(summary = "Retrieve Accounting Rules", description = """
112+
@Operation(summary = "Retrieve Accounting Rules", operationId = "retrieveAllAccountingRules", description = """
113113
Returns the list of defined accounting rules.
114114
115115
Example Requests:
@@ -130,7 +130,7 @@ public List<AccountingRuleData> retrieveAllAccountingRules(@Context final UriInf
130130
@GET
131131
@Path("{accountingRuleId}")
132132
@Produces({ MediaType.APPLICATION_JSON })
133-
@Operation(summary = "Retrieve a Accounting rule", description = """
133+
@Operation(summary = "Retrieve a Accounting rule", operationId = "retrieveOneAccountingRule", description = """
134134
Returns the details of a defined Accounting rule.
135135
136136
Example Requests:
@@ -150,7 +150,7 @@ public AccountingRuleData retreiveAccountingRule(
150150
@POST
151151
@Consumes({ MediaType.APPLICATION_JSON })
152152
@Produces({ MediaType.APPLICATION_JSON })
153-
@Operation(summary = "Create/Define a Accounting rule", description = """
153+
@Operation(summary = "Create/Define a Accounting rule", operationId = "createAccountingRule", description = """
154154
Define a new Accounting rule.
155155
156156
Mandatory Fields
@@ -173,7 +173,7 @@ public CommandProcessingResult createAccountingRule(@Parameter(hidden = true) Ac
173173
@Path("{accountingRuleId}")
174174
@Consumes({ MediaType.APPLICATION_JSON })
175175
@Produces({ MediaType.APPLICATION_JSON })
176-
@Operation(summary = "Update a Accounting Rule", description = "Updates the details of a Accounting rule.")
176+
@Operation(summary = "Update a Accounting Rule", operationId = "updateAccountingRule", description = "Updates the details of a Accounting rule.")
177177
@RequestBody(content = @Content(schema = @Schema(implementation = AccountRuleRequest.class)))
178178
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountingRuleApiResourceSwagger.PutAccountingRulesResponse.class)))
179179
public CommandProcessingResult updateAccountingRule(
@@ -188,7 +188,7 @@ public CommandProcessingResult updateAccountingRule(
188188
@DELETE
189189
@Path("{accountingRuleId}")
190190
@Produces({ MediaType.APPLICATION_JSON })
191-
@Operation(summary = "Delete a Accounting Rule", description = "Deletes a Accounting rule.")
191+
@Operation(summary = "Delete a Accounting Rule", operationId = "deleteAccountingRule", description = "Deletes a Accounting rule.")
192192
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountingRuleApiResourceSwagger.DeleteAccountingRulesResponse.class)))
193193
public CommandProcessingResult deleteAccountingRule(
194194
@PathParam("accountingRuleId") @Parameter(description = "accountingRuleId") final Long accountingRuleId) {

‎fineract-branch/src/main/java/org/apache/fineract/organisation/teller/api/CashierApiResource.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.fineract.organisation.teller.api;
2020

21+
import io.swagger.v3.oas.annotations.Operation;
2122
import io.swagger.v3.oas.annotations.tags.Tag;
2223
import jakarta.ws.rs.GET;
2324
import jakarta.ws.rs.Path;
@@ -43,6 +44,7 @@ public class CashierApiResource {
4344

4445
@GET
4546
@Produces(MediaType.APPLICATION_JSON)
47+
@Operation(summary = "List Cashiers", operationId = "retrieveAllCashiers")
4648
public Collection<CashierData> getCashierData(@QueryParam("officeId") final Long officeId, @QueryParam("tellerId") final Long tellerId,
4749
@QueryParam("staffId") final Long staffId, @QueryParam("date") final String date) {
4850
final LocalDate dateRestriction = date != null ? LocalDate.parse(date, DateTimeFormatter.BASIC_ISO_DATE)

0 commit comments

Comments
 (0)