Portfolio module

fineract-provider/src/main/java/org/apache/fineract/commands/api/AuditsApiResource.java

@@ -52,7 +52,10 @@
 @Path("/audits")
 @Component
 @Scope("singleton")
-@Api(value = "Audits",description = "Every non-read Mifos API request is audited. A fully processed request can not be changed or deleted. See maker checker api for situations where an audit is not fully processed.\n" + "\n" + "Permissions: To search and look at audit entries a user needs to be attached to a role that has one of the ALL_FUNCTIONS, ALL_FUNCTIONS_READ or READ_AUDIT permissions.\n" + "\n" + "Data Scope: A user can only see audits that are within their data scope. However, 'head office' users can see all audits including those that aren't office/branch related e.g. Loan Product changes.")
+@Api(tags = {"Audits"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Audits", description = "Every non-read Mifos API request is audited. A fully processed request can not be changed or deleted. See maker checker api for situations where an audit is not fully processed.\\n\" + \"\\n\" + \"Permissions: To search and look at audit entries a user needs to be attached to a role that has one of the ALL_FUNCTIONS, ALL_FUNCTIONS_READ or READ_AUDIT permissions.\\n\" + \"\\n\" + \"Data Scope: A user can only see audits that are within their data scope. However, 'head office' users can see all audits including those that aren't office/branch related e.g. Loan Product changes.\")")
+})
 public class AuditsApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "actionName", "entityName", "resourceId",

fineract-provider/src/main/java/org/apache/fineract/commands/api/MakercheckersApiResource.java

@@ -54,7 +54,11 @@
 @Path("/makercheckers")
 @Component
 @Scope("singleton")
-@Api(value = "Maker Checker (or 4-eye) functionality")
+@Api(tags = {"Maker Checker (or 4-eye) functionality"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Maker Checker (or 4-eye) functionality")
+})
+
 public class MakercheckersApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "actionName", "entityName", "resourceId",

fineract-provider/src/main/java/org/apache/fineract/infrastructure/accountnumberformat/api/AccountNumberFormatsApiResource.java

@@ -55,7 +55,11 @@
 @Path(AccountNumberFormatConstants.resourceRelativeURL)
 @Component
 @Scope("singleton")
-@Api(value = "Account number format", description = "Account number preferences are used to describe custom formats for account numbers associated with Customer, Loan and Savings accounts." )
+@Api(tags = {"Account number format"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Account number format", description = "Account number preferences are used to describe custom formats for account numbers associated with Customer, Loan and Savings accounts." )
+})
+
 public class AccountNumberFormatsApiResource {
 
     private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/cache/api/CacheApiResource.java

@@ -53,7 +53,11 @@
 @Produces({ MediaType.APPLICATION_JSON })
 @Component
 @Scope("singleton")
-@Api(value = "Cache", description = "The following settings are possible for cache:\n" + "\n" + "No Caching: caching turned off\n" + "Single node: caching on for single instance deployments of platorm (works for multiple tenants but only one tomcat)\n" + "By default caching is set to No Caching. Switching between caches results in the cache been clear e.g. from Single node to No cache and back again would clear down the single node cache.")
+@Api(tags = {"Cache"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Cache", description = "The following settings are possible for cache:\n" + "\n" + "No Caching: caching turned off\n" + "Single node: caching on for single instance deployments of platorm (works for multiple tenants but only one tomcat)\n" + "By default caching is set to No Caching. Switching between caches results in the cache been clear e.g. from Single node to No cache and back again would clear down the single node cache.")
+})
+
 public class CacheApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id"));

fineract-provider/src/main/java/org/apache/fineract/infrastructure/codes/api/CodeValuesApiResource.java

@@ -55,7 +55,11 @@
 @Path("/codes/{codeId}/codevalues")
 @Component
 @Scope("singleton")
-@Api(value = "Code Values", description = "Code and code values: Codes represent a specific category of data, their code values are a specific instance of that category.\n" + "\n" + "Codes are mostly system defined which means the code itself comes out of the box and cannot be modified however its code values can be. e.g. 'Customer Identifier', it defaults to a code value of 'Passport' but could be 'Drivers License, National Id' etc")
+Api(tags = {"Code Values"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Code Values", description = "Code and code values: Codes represent a specific category of data, their code values are a specific instance of that category.\n" + "\n" + "Codes are mostly system defined which means the code itself comes out of the box and cannot be modified however its code values can be. e.g. 'Customer Identifier', it defaults to a code value of 'Passport' but could be 'Drivers License, National Id' etc")
+})
+
 public class CodeValuesApiResource {
 
     /**

fineract-provider/src/main/java/org/apache/fineract/infrastructure/codes/api/CodesApiResource.java

@@ -53,7 +53,10 @@
 @Path("/codes")
 @Component
 @Scope("singleton")
-@Api(value = "Codes", description = "Code and code values: Codes represent a specific category of data, their code values are a specific instance of that category.\n" + "\n" + "Codes are mostly system defined which means the code itself comes out of the box and cannot be modified however its code values can be. e.g. 'Customer Identifier', it defaults to a code value of 'Passport' but could be 'Drivers License, National Id' etc")
+Api(tags = {"Codes"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Codes", description = "Code and code values: Codes represent a specific category of data, their code values are a specific instance of that category.\n" + "\n" + "Codes are mostly system defined which means the code itself comes out of the box and cannot be modified however its code values can be. e.g. 'Customer Identifier', it defaults to a code value of 'Passport' but could be 'Drivers License, National Id' etc")
+})
 public class CodesApiResource {
 
     /**

fineract-provider/src/main/java/org/apache/fineract/infrastructure/configuration/api/ExternalServicesConfigurationApiResource.java

@@ -48,7 +48,11 @@
 @Path("/externalservice")
 @Component
 @Scope("singleton")
-@Api(value = "External Services", description = "External Services Configuration related to set of supported configurations for third party services like Amazon S3 and SMTP:\n" + "\n" + "S3 (Amazon S3):\n" + "s3_access_key -\n" + "s3_bucket_name -\n" + "s3_secret_key -\n" + "\n" + "\n" + "SMTP (Email Service):\n" + "username -\n" + "password -\n" + "host -\n" + "port -\n" + "useTLS -")
+Api(tags = {"External Services"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "External Services", description = "External Services Configuration related to set of supported configurations for third party services like Amazon S3 and SMTP:\n" + "\n" + "S3 (Amazon S3):\n" + "s3_access_key -\n" + "s3_bucket_name -\n" + "s3_secret_key -\n" + "\n" + "\n" + "SMTP (Email Service):\n" + "username -\n" + "password -\n" + "host -\n" + "port -\n" + "useTLS -")
+})
+
 public class ExternalServicesConfigurationApiResource {
 
     private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/configuration/api/GlobalConfigurationApiResource.java

@@ -46,7 +46,11 @@
 @Path("/configurations")
 @Component
 @Scope("singleton")
-@Api(value = "Global Configuration", description = "Global configuration related to set of supported enable/disable configurations:\n" + "\n" + "maker-checker - defaults to false - if true turns on maker-checker functionality\n" + "reschedule-future-repayments - defaults to false - if true reschedules repayemnts which falls on a non-working day to configured repayment rescheduling rule\n" + "allow-transactions-on-non_workingday - defaults to false - if true allows transactions on non-working days\n" + "reschedule-repayments-on-holidays - defaults to false - if true reschedules repayemnts which falls on a non-working day to defined reschedule date\n" + "allow-transactions-on-holiday - defaults to false - if true allows transactions on holidays\n" + "savings-interest-posting-current-period-end - Set it at the database level before any savings interest is posted. When set as false(default), interest will be posted on the first date of next period. If set as true, interest will be posted on last date of current period. There is no difference in the interest amount posted.\n" + "financial-year-beginning-month - Set it at the database level before any savings interest is posted. Allowed values 1 - 12 (January - December). Interest posting periods are evaluated based on this configuration.\n" + "meetings-mandatory-for-jlg-loans - if set to true, enforces all JLG loans to follow a meeting schedule belonging to either the parent group or Center.")
+Api(tags = {"Global Configuration"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Global Configuration", description = "Global configuration related to set of supported enable/disable configurations:\n" + "\n" + "maker-checker - defaults to false - if true turns on maker-checker functionality\n" + "reschedule-future-repayments - defaults to false - if true reschedules repayemnts which falls on a non-working day to configured repayment rescheduling rule\n" + "allow-transactions-on-non_workingday - defaults to false - if true allows transactions on non-working days\n" + "reschedule-repayments-on-holidays - defaults to false - if true reschedules repayemnts which falls on a non-working day to defined reschedule date\n" + "allow-transactions-on-holiday - defaults to false - if true allows transactions on holidays\n" + "savings-interest-posting-current-period-end - Set it at the database level before any savings interest is posted. When set as false(default), interest will be posted on the first date of next period. If set as true, interest will be posted on last date of current period. There is no difference in the interest amount posted.\n" + "financial-year-beginning-month - Set it at the database level before any savings interest is posted. Allowed values 1 - 12 (January - December). Interest posting periods are evaluated based on this configuration.\n" + "meetings-mandatory-for-jlg-loans - if set to true, enforces all JLG loans to follow a meeting schedule belonging to either the parent group or Center.")
+})
+
 public class GlobalConfigurationApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("globalConfiguration"));

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/DatatablesApiResource.java

@@ -56,7 +56,11 @@
 @Path("/datatables")
 @Component
 @Scope("singleton")
-@Api(value = "Data Tables", description = "The datatables API allows you to plug-in your own tables (MySql) that have a relationship to a Apache Fineract core table. For example, you might want to add some extra client fields and record information about each of the clients' family members. Via the API you can create, read, update and delete entries for each 'plugged-in' table. The API checks for permission and for 'data scoping' (only data within the users' office hierarchy can be managed by the user).\n" + "\n" + "The Apache Fineract Reference App uses a JQuery plug-in called stretchydatatables (which in turn uses this datatables resource) to provide a pretty flexible CRUD (Create, Read, Update, Delete) User Interface.")
+Api(tags = {"Data Tables"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Data Tables", description = "The datatables API allows you to plug-in your own tables (MySql) that have a relationship to a Apache Fineract core table. For example, you might want to add some extra client fields and record information about each of the clients' family members. Via the API you can create, read, update and delete entries for each 'plugged-in' table. The API checks for permission and for 'data scoping' (only data within the users' office hierarchy can be managed by the user).\n" + "\n" + "The Apache Fineract Reference App uses a JQuery plug-in called stretchydatatables (which in turn uses this datatables resource) to provide a pretty flexible CRUD (Create, Read, Update, Delete) User Interface.")
+})
+
 public class DatatablesApiResource {
 
     private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/EntityDatatableChecksApiResource.java

@@ -53,7 +53,11 @@
 @Path("/entityDatatableChecks")
 @Component
 @Scope("singleton")
-@Api(value = "Entity-Datatable Checks", description = "This defines Entity-Datatable Check.")
+Api(tags = {"Entity Datatable Check"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Entity Data Table", description = "This defines Entity-Datatable Check.")
+})
+
 public class EntityDatatableChecksApiResource {
 
     private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/ReportsApiResource.java

@@ -53,7 +53,11 @@
 @Path("/reports")
 @Component
 @Scope("singleton")
-@Api(value = "Reports", description = "Non-core reports can be added, updated and deleted.")
+Api(tags = {"Reports"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Reports", description = "Non-core reports can be added, updated and deleted.")
+})
+
 public class ReportsApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "reportName", "reportType", "reportSubType",

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/RunreportsApiResource.java

@@ -58,8 +58,12 @@
 @Path("/runreports")
 @Component
 @Scope("singleton")
-@Api(value = "Run Reports", description = "")
-public class RunreportsApiResource {
+@Api(tags = {"Run Reports"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Run Reports", description = "")
+})
+
+        public class RunreportsApiResource {
 
     private final PlatformSecurityContext context;
     private final ToApiJsonSerializer<ReportData> toApiJsonSerializer;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/documentmanagement/api/DocumentManagementApiResource.java

@@ -61,7 +61,11 @@
 @Path("{entityType}/{entityId}/documents")
 @Component
 @Scope("singleton")
-@Api(value = "Documents", description = "Multiple Documents (a combination of a name, description and a file) may be attached to different Entities like Clients, Groups, Staff, Loans, Savings and Client Identifiers in the system\n" + "\n" + "Note: The currently allowed Entities are\n" + "\n" + "Clients: URL Pattern as clients\n" + "Staff: URL Pattern as staff\n" + "Loans: URL Pattern as loans\n" + "Savings: URL Pattern as savings\n" + "Client Identifiers: URL Pattern as client_identifiers\n" + "Groups: URL Pattern as groups")
+@Api(tags = {"Documents"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Documents", description = "Multiple Documents (a combination of a name, description and a file) may be attached to different Entities like Clients, Groups, Staff, Loans, Savings and Client Identifiers in the system\n" + "\n" + "Note: The currently allowed Entities are\n" + "\n" + "Clients: URL Pattern as clients\n" + "Staff: URL Pattern as staff\n" + "Loans: URL Pattern as loans\n" + "Savings: URL Pattern as savings\n" + "Client Identifiers: URL Pattern as client_identifiers\n" + "Groups: URL Pattern as groups")
+})
+
 public class DocumentManagementApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "parentEntityType", "parentEntityId",

fineract-provider/src/main/java/org/apache/fineract/infrastructure/entityaccess/api/FineractEntityApiResource.java

@@ -53,7 +53,11 @@
 @Produces({ MediaType.APPLICATION_JSON })
 @Component
 @Scope("singleton")
-@Api(value = "DomainName/api/v1/entitytoentitymapping", description = "") // https://github.com/swagger-api/swagger-ui/issues/1655
+@Api(tags = {"DomainName/api/v1/entitytoentitymapping"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "DomainName/api/v1/entitytoentitymapping", description = "")
+})
+ // https://github.com/swagger-api/swagger-ui/issues/1655
 public class FineractEntityApiResource {
 
     private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/hooks/api/HookApiResource.java

@@ -55,7 +55,11 @@
 @Produces({ MediaType.APPLICATION_JSON })
 @Component
 @Scope("singleton")
-@Api(value = "Hooks", description = "Hooks are a mechanism to trigger custom code on the occurence of events.")
+@Api(tags = {"Hooks")
+@SwaggerDefinition(tags = {
+		@Tag(name = "Hooks", description = "Hooks are a mechanism to trigger custom code on the occurence of events. ")
+})
+
 public class HookApiResource {
 
 	private final PlatformSecurityContext context;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/reportmailingjob/api/ReportMailingJobApiResource.java

@@ -52,7 +52,11 @@
 @Path("/" + ReportMailingJobConstants.REPORT_MAILING_JOB_RESOURCE_NAME)
 @Component
 @Scope("singleton")
-@Api(value = "Report Mailing Jobs", description = "This resource allows you to create a scheduled job that runs a report and sents it by email to specified email addresses.\n" + "\n" + "The scheduled job can be configured to run once or on a regular basis (once a day, twice a week, etc).")
+@Api(tags = {"Report Mailing Jobs"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Report Mailing Jobs", description = "This resource allows you to create a scheduled job that runs a report and sents it by email to specified email addresses.\\n\" + \"\\n\" + \"The scheduled job can be configured to run once or on a regular basis (once a day, twice a week, etc)")
+})
+
 public class ReportMailingJobApiResource {
 
     private final PlatformSecurityContext platformSecurityContext;

fineract-provider/src/main/java/org/apache/fineract/infrastructure/security/api/AuthenticationApiResource.java

@@ -54,7 +54,10 @@
 @Component
 @Profile("basicauth")
 @Scope("singleton")
-@Api(value = "Authentication HTTP Basic", description = "An API capability that allows client applications to verify authentication details using HTTP Basic Authentication.")
+@Api(tags = {"Authentication HTTP Basic"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Authentication HTTP Basic", description = "An API capability that allows client applications to verify authentication details using HTTP Basic Authentication.")
+})
 public class AuthenticationApiResource {
 
     private final DaoAuthenticationProvider customAuthenticationProvider;

fineract-provider/src/main/java/org/apache/fineract/organisation/holiday/api/HolidaysApiResource.java

@@ -58,7 +58,11 @@
 @Path("/holidays")
 @Component
 @Scope("singleton")
-@Api(value = "Holidays", description = "Some MFI's span large regions where different branch offices might observe different holidays. They need the ability to define holidays for specific branch offices and be able to set the repayment rule to follow during those holidays.\n" + "\n" + "The reschedule of repayments to repaymentsRescheduledTo date during defined holidays is turned on/off by enabling/disabling reschedule-repayments-on-holidays in Global configurations.\n" + "\n" + "Allow Repayment transactions on a defined holidays is turned on/off by enabling/disabling allow-transactions-on-holiday in Global configurations.")
+@Api(tags = {"Holidays"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Holidays", description = "Some MFI's span large regions where different branch offices might observe different holidays. They need the ability to define holidays for specific branch offices and be able to set the repayment rule to follow during those holidays.\\n\" + \"\\n\" + \"The reschedule of repayments to repaymentsRescheduledTo date during defined holidays is turned on/off by enabling/disabling reschedule-repayments-on-holidays in Global configurations.\\n\" + \"\\n\" + \"Allow Repayment transactions on a defined holidays is turned on/off by enabling/disabling allow-transactions-on-holiday in Global configurations.")
+})
+
 public class HolidaysApiResource {
 
     private final DefaultToApiJsonSerializer<HolidayData> toApiJsonSerializer;

fineract-provider/src/main/java/org/apache/fineract/organisation/monetary/api/CurrenciesApiResource.java

@@ -49,7 +49,11 @@
 @Path("/currencies")
 @Component
 @Scope("singleton")
-@Api(value = "Currency", description = "Application related configuration around viewing/updating the currencies permitted for use within the MFI.")
+@Api(tags = {"Currency"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Currency", description = "Application related configuration around viewing/updating the currencies permitted for use within the MFI.")
+})
+
 public class CurrenciesApiResource {
 
     private final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("selectedCurrencyOptions", "currencyOptions"));

fineract-provider/src/main/java/org/apache/fineract/organisation/office/api/OfficesApiResource.java

@@ -62,7 +62,11 @@
 @Path("/offices")
 @Component
 @Scope("singleton")
-@Api(value = "Offices", description = "Offices are used to model an MFIs structure. A hierarchical representation of offices is supported. There will always be at least one office (which represents the MFI or an MFIs head office). All subsequent offices added must have a parent office.")
+@Api(tags = {"Offices"})
+@SwaggerDefinition(tags = {
+        @Tag(name = "Offices", description = "Offices are used to model an MFIs structure. A hierarchical representation of offices is supported. There will always be at least one office (which represents the MFI or an MFIs head office). All subsequent offices added must have a parent office.")
+})
+
 public class OfficesApiResource {
 
     /**