Add api description for controllers

Author: jainadc9

pom.xml

@@ -297,6 +297,7 @@
             <groupId>io.springfox</groupId>
             <artifactId>springfox-boot-starter</artifactId>
             <version>3.0.0</version>
+            <scope>compile</scope>
         </dependency>
 
         <dependency>

src/main/java/com/ericsson/ei/controller/AggregatedObjectControllerImpl.java

@@ -38,13 +38,15 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 /**
  * This class represents the REST GET mechanism to extract the aggregated data on the basis of the
  * Id from the aggregatedObject.
  */
 @Component
 @CrossOrigin
+@Api(tags = {"Aggregated objects"}, description = "Fetch aggregated data based on Id")
 public class AggregatedObjectControllerImpl implements AggregatedObjectController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AggregatedObjectControllerImpl.class);

src/main/java/com/ericsson/ei/controller/AuthenticationControllerImpl.java

@@ -31,13 +31,15 @@
 import com.ericsson.ei.utils.ResponseMessage;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 /**
  * Endpoint /authentication/login should be secured if LDAP is enabled.
  * Endpoint /authentication should never be secured.
  */
 @Component
 @CrossOrigin
+@Api(tags = {"Authentication"}, description = "Authentication queries")
 public class AuthenticationControllerImpl implements AuthenticationController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AuthenticationControllerImpl.class);

src/main/java/com/ericsson/ei/controller/EIHomeController.java

@@ -17,6 +17,7 @@
 package com.ericsson.ei.controller;
 
 import io.swagger.annotations.ApiOperation;
+import springfox.documentation.annotations.ApiIgnore;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -27,6 +28,7 @@
 *
 */
 @Controller
+@ApiIgnore
 public class EIHomeController {
 
     @ApiOperation(value="", hidden = true)

src/main/java/com/ericsson/ei/controller/FailedNotificationControllerImpl.java

@@ -34,12 +34,14 @@
 import com.ericsson.ei.utils.ResponseMessage;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 /**
  * This class contains logic for retrieving failed notifications for the given subscription.
  */
 @Component
 @CrossOrigin
+@Api(tags = {"Failed notifications"}, description = "Fetch failed notifications of a subscription")
 public class FailedNotificationControllerImpl implements FailedNotificationController {
 
     private final static Logger LOGGER = LoggerFactory.getLogger(

src/main/java/com/ericsson/ei/controller/InformationControllerImpl.java

@@ -17,6 +17,7 @@
 import com.ericsson.ei.utils.ResponseMessage;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 import javax.servlet.http.HttpServletRequest;
 
@@ -30,6 +31,7 @@
 
 @Component
 @CrossOrigin
+@Api(tags = {"Information"}, description = "Information about Eiffel Intelligence backend")
 public class InformationControllerImpl implements InformationController {
     private static final Logger LOGGER = LoggerFactory.getLogger(InformationControllerImpl.class);
 

src/main/java/com/ericsson/ei/controller/RuleControllerImpl.java

@@ -35,9 +35,11 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 @Component
 @CrossOrigin
+@Api(tags = {"Rules"}, description = "Active rules queries")
 public class RuleControllerImpl implements RuleController{
 
     private static final Logger LOGGER = LoggerFactory.getLogger(RuleControllerImpl.class);

src/main/java/com/ericsson/ei/controller/RuleTestControllerImpl.java

@@ -27,10 +27,12 @@
 import io.netty.util.internal.StringUtil;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.Api;
 import lombok.Setter;
 
 @Component
 @CrossOrigin
+@Api(tags = {"Rule-test"}, description = "Test rules on Eiffel events")
 public class RuleTestControllerImpl implements RuleTestController {
     private static final Logger LOGGER = LoggerFactory.getLogger(RuleTestControllerImpl.class);
 

src/main/java/com/ericsson/ei/controller/StatusControllerImpl.java

@@ -32,13 +32,15 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 
 /**
  * Endpoint /status should display EI back-end status and services Eiffel Intelligence is dependent
  * on.
  */
 @Component
 @CrossOrigin
+@Api(tags = {"Status"}, description = "Information of EI and its dependencies")
 public class StatusControllerImpl implements StatusController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(StatusControllerImpl.class);

src/main/java/com/ericsson/ei/controller/SubscriptionControllerImpl.java

@@ -53,6 +53,7 @@
 
 @Component
 @CrossOrigin
+@Api(tags = {"Subscriptions"}, description = "Subscription handling requests")
 public class SubscriptionControllerImpl implements SubscriptionController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(SubscriptionControllerImpl.class);

src/main/java/com/ericsson/ei/controller/TemplateControllerImpl.java

@@ -21,6 +21,7 @@
 import javax.servlet.http.HttpServletRequest;
 
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.Api;
 import org.apache.commons.io.IOUtils;
 import org.json.JSONObject;
 import org.slf4j.Logger;
@@ -34,6 +35,7 @@
 
 @Component
 @CrossOrigin
+@Api(tags = {"Templates"}, description = "Templates of rules, Eiffel events and subscriptions")
 public class TemplateControllerImpl implements TemplateController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(