Updated RAML definitions and swagger annotations (#292)

Updated RAML definitions and swagger annotations. Use EI version for swagger API. Change startup of docker environment in travis.

Author: e-pettersson-ericsson

.travis.yml

@@ -5,7 +5,7 @@ dist: xenial
 language: java
 
 services:
-  - docker 
+  - docker
 
 env:
   - JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-amd64
@@ -23,11 +23,9 @@ before_install:
 # This is only run before integrationTests job
 # To ensure docker containers are fully up and running we sleep 20s
 before_script:
-  - cd src/main/docker/
-  - source env.bash
-  - docker-compose up -d mongodb rabbitmq eiffel-er jenkins mail-server ei-backend
+  - source src/main/docker/env.bash
+  - docker-compose -f src/main/docker/docker-compose.yml up -d mongodb rabbitmq eiffel-er jenkins mail-server
   - sleep 60
-  - cd ../../../
 
 
 # Generate site documentation using mvn site plugin

src/main/java/com/ericsson/ei/config/SwaggerConfig.java

@@ -17,6 +17,8 @@
 
 package com.ericsson.ei.config;
 
+import com.ericsson.ei.controller.model.ParseInstanceInfoEI;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -30,6 +32,10 @@
 @Configuration
 @EnableSwagger2
 public class SwaggerConfig {
+
+    @Autowired
+    ParseInstanceInfoEI parseInstanceInfoEI;
+
     @Bean
     public Docket productApi() {
         return new Docket(DocumentationType.SWAGGER_2)
@@ -42,9 +48,9 @@ public Docket productApi() {
     @SuppressWarnings("deprecation")
     private ApiInfo metaData() {
         ApiInfo apiInfo = new ApiInfo(
-                "Subscription REST API",
-                "Subscription REST API to store and retrive the subscription.",
-                "1.0",
+                "Eiffel Intelligence REST API",
+                "A real time data aggregation and analysis solution for Eiffel events.",
+                parseInstanceInfoEI.getVersion(),
                 "Terms of service","",
                "Apache License Version 2.0",
                "https://www.apache.org/licenses/LICENSE-2.0");

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

@@ -9,7 +9,7 @@
 
 
 /**
- * No description
+ * This class handles requests related to authentication.
  * (Generated with springmvc-raml-parser v.2.0.4)
  * 
  */
@@ -20,21 +20,21 @@ public interface AuthController {
 
 
     /**
-     * This call for checking if security is enabled
+     * This method checks if security is enabled.
      * 
      */
     @RequestMapping(value = "", method = RequestMethod.GET)
     public ResponseEntity<?> getAuth();
 
     /**
-     * This call for getting logged in user
+     * This method returns a logged in user.
      * 
      */
     @RequestMapping(value = "/login", method = RequestMethod.GET)
     public ResponseEntity<?> getAuthLogin();
 
     /**
-     * This call for checking backend status
+     * This method checks Eiffel Intelligene backend status.
      * 
      */
     @RequestMapping(value = "/checkStatus", method = RequestMethod.GET)

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

@@ -37,7 +37,7 @@
  */
 @Component
 @CrossOrigin
-@Api(value = "Auth", description = "REST endpoints for authentication and authorization")
+@Api(value = "Auth", tags = {"Authentication"})
 public class AuthControllerImpl implements AuthController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AuthControllerImpl.class);

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

@@ -9,7 +9,7 @@
 
 
 /**
- * No description
+ * This class is responsible for providing templates of rules, Eiffel events and subscriptions.
  * (Generated with springmvc-raml-parser v.2.0.4)
  * 
  */
@@ -20,28 +20,28 @@ public interface DownloadController {
 
 
     /**
-     * This call for getting list of available templates
+     * This method returns a list of endpoints for downloading templates.
      * 
      */
     @RequestMapping(value = "", method = RequestMethod.GET)
     public ResponseEntity<?> getDownload();
 
     /**
-     * This call for getting subscriptions template
+     * This method returns a subscription template.
      * 
      */
     @RequestMapping(value = "/subscriptionsTemplate", method = RequestMethod.GET)
     public ResponseEntity<?> getDownloadSubscriptionsTemplate();
 
     /**
-     * This call for getting rules template
+     * This method returns a template for rules.
      * 
      */
     @RequestMapping(value = "/rulesTemplate", method = RequestMethod.GET)
     public ResponseEntity<?> getDownloadRulesTemplate();
 
     /**
-     * This call for getting events template
+     * This method returns a template for Eiffel events.
      * 
      */
     @RequestMapping(value = "/eventsTemplate", method = RequestMethod.GET)

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

@@ -18,6 +18,7 @@
 
 import java.io.InputStream;
 
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.io.IOUtils;
 import org.json.JSONObject;
 import org.slf4j.Logger;
@@ -33,12 +34,13 @@
 
 @Component
 @CrossOrigin
-@Api(value = "Get Templates", description = "REST endpoints for getting templates")
+@Api(value = "Download templates", tags = {"Download"})
 public class DownloadControllerImpl implements DownloadController {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(DownloadControllerImpl.class);
 
     @Override
+    @ApiOperation(value = "Retrieve REST endpoints for downloading templates")
     public ResponseEntity<?> getDownload() {
         try {
             JSONObject response = new JSONObject();
@@ -55,6 +57,7 @@ public ResponseEntity<?> getDownload() {
     }
 
     @Override
+    @ApiOperation(value = "Download subscription template")
     public ResponseEntity<?> getDownloadSubscriptionsTemplate() {
         try {
             InputStream is = getClass().getResourceAsStream("/templates/subscriptionsTemplate.json");
@@ -73,6 +76,7 @@ public ResponseEntity<?> getDownloadSubscriptionsTemplate() {
     }
 
     @Override
+    @ApiOperation(value = "Download rules template")
     public ResponseEntity<?> getDownloadRulesTemplate() {
         try {
             InputStream is = getClass().getResourceAsStream("/templates/rulesTemplate.json");
@@ -91,6 +95,7 @@ public ResponseEntity<?> getDownloadRulesTemplate() {
     }
 
     @Override
+    @ApiOperation(value = "Download Eiffel events template")
     public ResponseEntity<?> getDownloadEventsTemplate() {
         try {
             InputStream is = getClass().getResourceAsStream("/templates/eventsTemplate.json");

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

@@ -16,6 +16,7 @@
 */
 package com.ericsson.ei.controller;
 
+import io.swagger.annotations.ApiOperation;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -28,6 +29,7 @@
 @Controller
 public class EIHomeController {
 
+    @ApiOperation(value="", hidden = true)
     @RequestMapping(value = "/", method = RequestMethod.GET)
     public String home() {
         return "redirect:/swagger-ui.html";

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

@@ -9,8 +9,7 @@
 
 
 /**
- * Provides interaction with InstanceInfo resource
- * 
+ * This class provides information about Eiffel Intelligence backend.
  * (Generated with springmvc-raml-parser v.2.0.4)
  * 
  */
@@ -21,8 +20,7 @@ public interface InformationController {
 
 
     /**
-     * List of all instance information
-     * 
+     * This method retrieves backend instance information.
      * 
      */
     @RequestMapping(value = "", method = RequestMethod.GET)

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

@@ -29,7 +29,7 @@
 
 @Component
 @CrossOrigin
-@Api(value = "information", description = "The Information about Eiffel Intelligence Backend instance")
+@Api(value = "information", tags = {"Information"})
 public class InformationControllerImpl implements InformationController {
     private static final Logger LOGGER = (Logger) LoggerFactory.getLogger(InformationControllerImpl.class);
 
@@ -38,7 +38,7 @@ public class InformationControllerImpl implements InformationController {
 
     @Override
     @CrossOrigin
-    @ApiOperation(value = "Parse information")
+    @ApiOperation(value = "Shows information about Eiffel Intelligence backend")
     public ResponseEntity<?> getInformation() {
         try {
             String info = new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(instanceInfo);

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

@@ -10,7 +10,7 @@
 
 
 /**
- * No description
+ * This class returns aggregated data given a specific ID of an aggregated object.
  * (Generated with springmvc-raml-parser v.2.0.4)
  * 
  */
@@ -21,7 +21,7 @@ public interface QueryAggregatedObjectController {
 
 
     /**
-     * No description
+     * This method retrieves aggregated data on a specific aggregated object, given an ID.
      * 
      */
     @RequestMapping(value = "", method = RequestMethod.GET)