Add missing Tag annotations for APIs (FINERACT-1222)

2021-02-26 11:31:07 +01:00
parent ac86e14f3e
commit f30114892f
29 changed files with 59 additions and 10 deletions
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.bulkimport.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.ArrayList;
 import java.util.Collection;
 import javax.ws.rs.Consumes;
@@ -45,6 +46,7 @@ import org.springframework.stereotype.Component;
@Path("/imports")
@Component
@Scope("singleton")
+@Tag(name = "Bulk Import", description = "")
 public class BulkImportApiResource {

    private final String resourceNameForPermissions = "IMPORT";
@@ -19,6 +19,7 @@

 package org.apache.fineract.infrastructure.creditbureau.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -56,6 +57,7 @@ import org.springframework.stereotype.Component;
@Path("/CreditBureauConfiguration")
@Component
@Scope("singleton")
+@Tag(name = "Credit Bureau Configuration", description = "")
 public class CreditBureauConfigurationAPI {

    private final Set<String> responseDataParameters = new HashSet<>(
@@ -21,6 +21,7 @@ package org.apache.fineract.infrastructure.documentmanagement.api;
 import com.sun.jersey.core.header.FormDataContentDisposition;
 import com.sun.jersey.multipart.FormDataBodyPart;
 import com.sun.jersey.multipart.FormDataParam;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Base64;
@@ -57,6 +58,7 @@ import org.springframework.stereotype.Component;
@Component
@Scope("singleton")
@Path("{entity}/{entityId}/images")
+@Tag(name = "Images", description = "")
 public class ImagesApiResource {

    private final PlatformSecurityContext context;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.entityaccess.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Collection;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.DELETE;
@@ -50,7 +51,7 @@ import org.springframework.stereotype.Component;
@Produces({ MediaType.APPLICATION_JSON })
@Component
@Scope("singleton")
-
+@Tag(name = "Fineract Entity", description = "")
 public class FineractEntityApiResource {

    private final PlatformSecurityContext context;
@@ -20,6 +20,7 @@ package org.apache.fineract.infrastructure.gcm.api;

 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Collection;
 import java.util.HashMap;
 import javax.ws.rs.Consumes;
@@ -46,6 +47,7 @@ import org.springframework.stereotype.Component;
@Path("/self/device/registration")
@Component
@Scope("singleton")
+@Tag(name = "Device Registration", description = "")
 public class DeviceRegistrationApiResource {

    private final PlatformSecurityContext context;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.security.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import java.util.Map;
 import javax.ws.rs.DefaultValue;
@@ -52,6 +53,7 @@ import org.springframework.stereotype.Component;
@Component
@Profile("twofactor")
@Scope("singleton")
+@Tag(name = "Two Factor", description = "")
 public class TwoFactorApiResource {

    private final ToApiJsonSerializer<OTPMetadata> otpRequestSerializer;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.sms.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Collection;
 import java.util.Date;
 import javax.ws.rs.Consumes;
@@ -54,7 +55,7 @@ import org.springframework.stereotype.Component;
@Produces({ MediaType.APPLICATION_JSON })
@Component
@Scope("singleton")
-
+@Tag(name = "SMS", description = "")
 public class SmsApiResource {

    private final String resourceNameForPermissions = "SMS";
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.survey.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
@@ -44,7 +45,7 @@ import org.springframework.stereotype.Component;
@Path("/likelihood")
@Component
@Scope("singleton")
-
+@Tag(name = "Likelihood", description = "")
 public class LikelihoodApiResource {

    private final DefaultToApiJsonSerializer<LikelihoodData> toApiJsonSerializer;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.infrastructure.survey.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -36,7 +37,7 @@ import org.springframework.stereotype.Component;
@Path("/povertyLine")
@Component
@Scope("singleton")
-
+@Tag(name = "Poverty Line", description = "")
 public class PovertyLineApiResource {

    private final DefaultToApiJsonSerializer<PpiPovertyLineData> toApiJsonSerializer;
@@ -26,6 +26,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.DELETE;
@@ -58,7 +59,7 @@ import org.springframework.stereotype.Component;
@Path("/survey")
@Component
@Scope("singleton")
-
+@Tag(name = "Survey", description = "")
 public class SurveyApiResource {

    private final DefaultToApiJsonSerializer<SurveyData> toApiJsonSerializer;
@@ -28,6 +28,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
@@ -75,8 +76,8 @@ import org.springframework.stereotype.Component;

@Path("/interoperation") // api/v1/
@Component
-@Scope
-
+@Scope("singleton")
+@Tag(name = "Inter Operation", description = "")
 public class InteropApiResource {

    private PlatformSecurityContext context;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.calendar.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.time.LocalDate;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -62,6 +63,7 @@ import org.springframework.stereotype.Component;
@Path("/{entityType}/{entityId}/calendars")
@Component
@Scope("singleton")
+@Tag(name = "Calendar", description = "")
 public class CalendarsApiResource {

    /**
@@ -20,6 +20,7 @@
 package org.apache.fineract.portfolio.client.api;

 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -52,6 +53,7 @@ import org.springframework.stereotype.Component;
@Path("/clients/{clientId}/familymembers")
@Component
@Scope("singleton")
+@Tag(name = "Client Family Member", description = "")
 public class ClientFamilyMembersApiResources {

    private final Set<String> responseDataParameters = new HashSet<>(Arrays.asList("id", "clientId", "firstName", "middleName", "lastName",
@@ -26,6 +26,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
@@ -55,7 +56,7 @@ import org.springframework.stereotype.Component;
@Path("/collectionsheet")
@Component
@Scope("singleton")
-
+@Tag(name = "Collection Sheet", description = "")
 public class CollectionSheetApiResourse {

    private final CollectionSheetReadPlatformService collectionSheetReadPlatformService;
@@ -26,6 +26,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -58,7 +59,7 @@ import org.springframework.stereotype.Component;
@Path("/funds")
@Component
@Scope("singleton")
-
+@Tag(name = "Funds", description = "")
 public class FundsApiResource {

    /**
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.group.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -42,6 +43,7 @@ import org.springframework.stereotype.Component;
@Path("/grouplevels")
@Component
@Scope("singleton")
+@Tag(name = "Groups Level", description = "")
 public class GroupsLevelApiResource {

    private static final Set<String> GROUPLEVEL_DATA_PARAMETERS = new HashSet<>(Arrays.asList("levelId", "levelName", "parentLevelId",
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.loanaccount.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.time.LocalDate;
 import java.util.Arrays;
 import java.util.Collection;
@@ -55,6 +56,7 @@ import org.springframework.stereotype.Component;
@Path("/loans/loanreassignment")
@Component
@Scope("singleton")
+@Tag(name = "Bulk Loans", description = "")
 public class BulkLoansApiResource {

    private final Set<String> responseDataParameters = new HashSet<>(Arrays.asList("officeId", "fromLoanOfficerId", "assignmentDate",
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.loanaccount.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
@@ -47,6 +48,7 @@ import org.springframework.stereotype.Component;
@Path("/loans/{loanId}/disbursements")
@Component
@Scope("singleton")
+@Tag(name = "Loan Disbursement Details", description = "")
 public class LoanDisbursementDetailApiResource {

    private final Set<String> responseDataParameters = new HashSet<>(
@@ -20,6 +20,7 @@ package org.apache.fineract.portfolio.loanaccount.guarantor.api;

 import com.sun.jersey.core.header.FormDataContentDisposition;
 import com.sun.jersey.multipart.FormDataParam;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.io.InputStream;
 import java.util.Arrays;
 import java.util.Collection;
@@ -72,6 +73,7 @@ import org.springframework.stereotype.Component;
@Path("/loans/{loanId}/guarantors")
@Component
@Scope("singleton")
+@Tag(name = "Guarantors", description = "")
 public class GuarantorsApiResource {

    private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.loanaccount.rescheduleloan.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.HashSet;
 import java.util.List;
 import javax.ws.rs.Consumes;
@@ -53,6 +54,7 @@ import org.springframework.stereotype.Component;
@Path("/rescheduleloans")
@Component
@Scope("singleton")
+@Tag(name = "Reschedule Loans", description = "")
 public class RescheduleLoansApiResource {

    private final DefaultToApiJsonSerializer<LoanRescheduleRequestData> loanRescheduleRequestToApiJsonSerializer;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.loanproduct.productmix.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -52,6 +53,7 @@ import org.springframework.stereotype.Component;
@Path("/loanproducts/{productId}/productmix")
@Component
@Scope("singleton")
+@Tag(name = "Product Mix", description = "")
 public class ProductMixApiResource {

    private final String resourceNameForPermissions = "PRODUCTMIX";
@@ -20,6 +20,7 @@ package org.apache.fineract.portfolio.meeting.api;

 import static org.apache.fineract.portfolio.meeting.MeetingApiConstants.MEETING_RESOURCE_NAME;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.time.LocalDate;
 import java.util.Arrays;
 import java.util.Collection;
@@ -68,6 +69,7 @@ import org.springframework.stereotype.Component;
@Path("/{entityType}/{entityId}/meetings")
@Component
@Scope("singleton")
+@Tag(name = "Meetings", description = "")
 public class MeetingsApiResource {

    private final PlatformSecurityContext context;
@@ -25,6 +25,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;
@@ -58,7 +59,7 @@ import org.springframework.stereotype.Component;
@Path("/products/{type}")
@Component
@Scope("singleton")
-
+@Tag(name = "Products", description = "")
 public class ProductsApiResource {

    private final ApplicationContext applicationContext;
@@ -19,6 +19,7 @@

 package org.apache.fineract.portfolio.rate.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -54,6 +55,7 @@ import org.springframework.stereotype.Component;
@Path("/rates")
@Component
@Scope("singleton")
+@Tag(name = "Rate", description = "")
 public class RateApiResource {

    private final Set<String> responseDataParameters = new HashSet<>(Arrays.asList("id", "name", "percentage", "productApply", "active"));
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.savings.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -43,6 +44,7 @@ import org.springframework.stereotype.Component;
@Path("/savingsaccounts/{savingsId}/onholdtransactions")
@Component
@Scope("singleton")
+@Tag(name = "Deposit Account On Hold Fund Transactions", description = "")
 public class DepositAccountOnHoldFundTransactionsApiResource {

    private final PlatformSecurityContext context;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.savings.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
@@ -55,6 +56,7 @@ import org.springframework.stereotype.Component;
@Path("/fixeddepositaccounts/{fixedDepositAccountId}/transactions")
@Component
@Scope("singleton")
+@Tag(name = "Fixed Deposit Account Transactions", description = "")
 public class FixedDepositAccountTransactionsApiResource {

    private final PlatformSecurityContext context;
@@ -18,6 +18,7 @@
 */
 package org.apache.fineract.portfolio.savings.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.Collection;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
@@ -55,6 +56,7 @@ import org.springframework.stereotype.Component;
@Path("/savingsaccounts/{savingsId}/transactions")
@Component
@Scope("singleton")
+@Tag(name = "Savings Account Transactions", description = "")
 public class SavingsAccountTransactionsApiResource {

    private final PlatformSecurityContext context;
@@ -19,6 +19,7 @@

 package org.apache.fineract.portfolio.self.products.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -38,6 +39,7 @@ import org.springframework.stereotype.Component;
@Path("/self/savingsproducts")
@Component
@Scope("singleton")
+@Tag(name = "Self Savings Products", description = "")
 public class SelfSavingsProductsApiResource {

    private final SavingsProductsApiResource savingsProductsApiResource;
@@ -19,6 +19,7 @@

 package org.apache.fineract.portfolio.self.products.api;

+import io.swagger.v3.oas.annotations.tags.Tag;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -38,6 +39,7 @@ import org.springframework.stereotype.Component;
@Path("/self/products/share")
@Component
@Scope("singleton")
+@Tag(name = "Self Share Products", description = "")
 public class SelfShareProductsApiResource {

    private final ProductsApiResource productsApiResource;