refs #16, created first draft of endpoint interfaces based on ER-diagram

README.md

@@ -31,9 +31,12 @@ docker-compose build
 
 ## Develop
 
-The endpoints are documented with Swagger 2.1 and OpenAPI 3.0. The current specification for the front-end is obtainable programatically from [http://fda-container-managing-service/swagger-resources](http://localhost:9091/swagger-resources).
+The endpoints are documented with Swagger 2.1 and OpenAPI 3.0. The current specification for the front-end is obtainable programatically from `http://localhost:<port>/swagger-resources`
 
-For easy visualization use OpenAPI at [http://fda-container-managing-service/swagger-ui/](http://localhost:9091/swagger-ui/)
+For easy visualization use OpenAPI at:
+
+- [http://fda-container-managing-service/swagger-ui/](http://localhost:9091/swagger-ui/)
+- [http://fda-database-managing-service/swagger-ui/](http://localhost:9092/swagger-ui/)
 
 ## Deployment
 

fda-container-managing-service/api/pom.xml

@@ -10,7 +10,7 @@
     </parent>
 
     <artifactId>api</artifactId>
-    <version>${global.version}</version>
+    <version>0.0.1-SNAPSHOT</version>
     <name>fda-container-managing-service-api</name>
 
     <properties>

fda-container-managing-service/pom.xml

@@ -10,7 +10,7 @@
 
     <groupId>at.tuwien</groupId>
     <artifactId>fda-container-managing-service</artifactId>
-    <version>${global.version}</version>
+    <version>0.0.1-SNAPSHOT</version>
     <name>fda-container-managing-service</name>
     <description>Demo project for Spring Boot</description>
 
@@ -22,7 +22,6 @@
     </modules>
 
     <properties>
-        <global.version>0.0.1-SNAPSHOT</global.version>
         <java.version>11</java.version>
         <spring-cloud.version>Hoxton.SR8</spring-cloud.version>
         <mapstruct.version>1.4.2.Final</mapstruct.version>

fda-container-managing-service/rest-service/pom.xml

@@ -10,7 +10,7 @@
     </parent>
 
     <artifactId>rest-service</artifactId>
-    <version>${global.version}</version>
+    <version>0.0.1-SNAPSHOT</version>
     <name>fda-container-managing-service-rest-service</name>
 
     <properties>
@@ -22,12 +22,12 @@
         <dependency>
             <groupId>at.tuwien</groupId>
             <artifactId>services</artifactId>
-            <version>${global.version}</version>
+            <version>0.0.1-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>at.tuwien</groupId>
             <artifactId>api</artifactId>
-            <version>${global.version}</version>
+            <version>0.0.1-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

fda-container-managing-service/rest-service/src/main/java/at/tuwien/endpoints/DatabaseContainerController.java

@@ -83,7 +83,7 @@ public class DatabaseContainerController {
     }
 
     @DeleteMapping("/container/{id}")
-    @ApiOperation(value = "Delete a database container.")
+    @ApiOperation(value = "Delete a database container")
     public ResponseEntity deleteDatabaseContainer(@RequestParam String id) throws ContainerNotFoundException, DockerClientException {
         containerService.remove(id);
         return ResponseEntity.status(HttpStatus.OK)

fda-container-managing-service/services/pom.xml

@@ -10,7 +10,7 @@
     </parent>
 
     <artifactId>services</artifactId>
-    <version>${global.version}</version>
+    <version>0.0.1-SNAPSHOT</version>
     <name>fda-container-managing-service-services</name>
 
     <properties>
@@ -22,7 +22,7 @@
         <dependency>
             <groupId>at.tuwien</groupId>
             <artifactId>api</artifactId>
-            <version>${project.version}</version>
+            <version>0.0.1-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

fda-database-managing-service/Dockerfile

@@ -11,7 +11,7 @@ COPY ./gateways ./gateways
 COPY ./rest-service ./rest-service
 COPY ./services ./services
 
-RUN mvn -q clean package > /dev/null
+RUN mvn -q clean package -DskipTests
 
 ###### SECOND STAGE ######
 FROM openjdk:11-jre-slim as runtime

fda-database-managing-service/api/pom.xml

@@ -10,7 +10,7 @@
     </parent>
 
     <artifactId>api</artifactId>
-    <version>${global.version}</version>
+    <version>0.0.1-SNAPSHOT</version>
     <name>fda-database-managing-service-api</name>
 
     <properties>

fda-database-managing-service/api/src/main/java/at/tuwien/dto/CreateDatabaseDTO.java

-package at.tuwien.dto;
-
-import com.fasterxml.jackson.annotation.JsonProperty;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-import lombok.Setter;
-
-@Getter
-@Setter
-@NoArgsConstructor
-public class CreateDatabaseDTO {
-
-    @JsonProperty("ContainerName")
-    private String containerName;
-    @JsonProperty("DatabaseName")
-    private String dbName;
-
-}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/database/DatabaseBriefDto.java

+package at.tuwien.dto.database;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class DatabaseBriefDto {
+
+    private Long id;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/database/DatabaseChangeDto.java

+package at.tuwien.dto.database;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class DatabaseChangeDto {
+
+    private Long databaseId;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/database/DatabaseCreateDto.java

+package at.tuwien.dto.database;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class DatabaseCreateDto {
+
+    /* container hash */
+    private String containerId;
+
+    private String name;
+
+    private String engine;
+
+    private String owner;
+
+    private String creator;
+
+    private String publisher;
+
+    private String publicationYear;
+
+    private String ResourceType;
+
+    private String description;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/database/DatabaseDto.java

+package at.tuwien.dto.database;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class DatabaseDto extends DatabaseBriefDto {
+
+    private String name;
+
+    private String containerId;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/TableBriefDto.java

+package at.tuwien.dto.table;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class TableBriefDto {
+
+    private Long id;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/TableCreateDto.java

+package at.tuwien.dto.table;
+
+import at.tuwien.dto.table.columns.AbstractColumnDto;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class TableCreateDto {
+
+    private String name;
+
+    private AbstractColumnDto[] columns;
+
+    private String description;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/TableDto.java

+package at.tuwien.dto.table;
+
+import at.tuwien.dto.table.columns.AbstractColumnDto;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class TableDto extends TableBriefDto {
+
+    private String name;
+
+    private AbstractColumnDto[] columns;
+
+    private String description;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/columns/AbstractColumnDto.java

+package at.tuwien.dto.table.columns;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public abstract class AbstractColumnDto {
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/columns/CategoricalColumnDto.java

+package at.tuwien.dto.table.columns;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class CategoricalColumnDto extends AbstractColumnDto {
+
+    private Long totalCategories;
+
+    private String[] categories;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/columns/NominalColumnDto.java

+package at.tuwien.dto.table.columns;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class NominalColumnDto extends AbstractColumnDto {
+
+    private Long maxLength;
+
+}

fda-database-managing-service/api/src/main/java/at/tuwien/dto/table/columns/NumericColumnDto.java

+package at.tuwien.dto.table.columns;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class NumericColumnDto extends AbstractColumnDto {
+
+    private Long maxLength;
+
+    private SiUnitDto siUnit;
+
+    private Double min;
+
+    private Double max;
+
+    private Double mean;
+
+    private Double median;
+
+    private Double standardDeviation;
+
+    private Object histogram;
+
+}