Merge branch 'dev' into feat/client-v1

Author: sfdamm

.gitignore

@@ -381,8 +381,8 @@ sketch
 ## OpenAPI Generator ###
 /client/src/api/
 /gateway/src/main/java/de/tum/aet/devops25/api/generated/
-/concept-svc/src/main/java/generated/
-/user-svc/src/main/java/generated/
+/concept-svc/src/main/java/de/tum/aet/devops25/api/generated/
+/user-svc/src/main/java/de/tum/aet/devops25/api/generated/
 /genai-svc/client/
 
 # OpenAPI Generator CLI configuration

README.md

@@ -85,7 +85,7 @@ The project is split into several main directories:
 
 - `/api`: OpenAPI specifications (single source of truth)
 - `/client`: Angular 19 frontend
-- `/server`: Spring Boot microservices (API Gateway)
+- `/gateway`: API Gateway (Spring Boot)
 - `/user-svc`: User Service (Spring Boot)
 - `/concept-svc`: Concept Service (Spring Boot)
 - `/genai-svc`: GenAI Service (Python/Flask/LangChain)
@@ -166,36 +166,73 @@ cd team-git-push-force
    npm install
    ```
 
-### Server Setup
+### Backend Services Setup
 
-1. Navigate to the `server` directory:
+1. Generate code from OpenAPI specifications:
    ```bash
-   cd server
+   ./api/scripts/gen-all.sh
    ```
-2. Build the project:
+
+2. Navigate to each service directory and build the project:
    ```bash
+   # For Gateway
+   cd gateway
+   ./gradlew build
+
+   # For User Service
+   cd ../user-svc
    ./gradlew build
+
+   # For Concept Service
+   cd ../concept-svc
+   ./gradlew build
+
+   # For GenAI Service
+   cd ../genai-svc
+   pip install -r requirements.txt
    ```
 
 ## Running the Application
 
 ### Option 1: Using Docker Compose (Recommended)
 
-The easiest way to run the entire application is using Docker Compose:
+Before running the application, you need to generate code from the OpenAPI specifications. You can use the provided start-dev script which handles this automatically:
+
+```bash
+./start-dev.sh
+```
+
+This script will:
+1. Run code generation from OpenAPI specs
+2. Start all services using Docker Compose
+
+Alternatively, you can run these steps manually:
 
 ```bash
+# First, generate code from OpenAPI specs
+./api/scripts/gen-all.sh
+
+# Then start Docker Compose
 docker-compose up
 ```
 
 This will start all services:
 - Client (Angular frontend) at [http://localhost:3000](http://localhost:3000)
-- Server (API Gateway) at [http://localhost:8080](http://localhost:8080)
+- API Gateway at [http://localhost:8080](http://localhost:8080)
 - User Service at [http://localhost:8081](http://localhost:8081)
 - Concept Service at [http://localhost:8082](http://localhost:8082)
-- GenAI Service at [http://localhost:8083](http://localhost:5000)
+- GenAI Service at [http://localhost:8083](http://localhost:8083)
 
 ### Option 2: Manual Startup
 
+Before starting the services manually, you need to generate code from the OpenAPI specifications:
+
+```bash
+./api/scripts/gen-all.sh
+```
+
+This will generate the necessary code for all services based on the OpenAPI specifications in the `/api` directory.
+
 #### Start the Client
 
 ```bash
@@ -204,13 +241,29 @@ npm run dev
 ```
 The client will be available at [http://localhost:3000](http://localhost:3000).
 
-#### Start the Server
+#### Start the Gateway
+
+```bash
+cd gateway
+./gradlew bootRun
+```
+The API Gateway will be available at [http://localhost:8080](http://localhost:8080).
+
+#### Start the User Service
+
+```bash
+cd user-svc
+./gradlew bootRun
+```
+The User Service will be available at [http://localhost:8081](http://localhost:8081).
+
+#### Start the Concept Service
 
 ```bash
-cd server
+cd concept-svc
 ./gradlew bootRun
 ```
-The server API will be available at [http://localhost:8080](http://localhost:8080).
+The Concept Service will be available at [http://localhost:8082](http://localhost:8082).
 
 #### Start the GenAI Service
 

api/README.md

@@ -25,6 +25,19 @@ We follow an API-first approach to development:
 
 ## Usage
 
+### Installation
+
+Install the required tools for linting and code generation:
+
+```bash
+# Install Redocly CLI for linting OpenAPI specs
+npm install -g @redocly/cli@latest
+
+# Install OpenAPI Generator tools
+npm install -g @openapitools/openapi-generator-cli
+pip install openapi-python-client
+```
+
 ### Linting OpenAPI Specs
 
 ```bash
@@ -42,6 +55,38 @@ This will generate:
 - Python client for the GenAI service
 - TypeScript SDK for the web client
 
+#### Generated Code Locations
+
+The code generation script places files in the following locations:
+
+- **Java (Spring Boot)**: 
+  - Gateway: `gateway/src/main/java/de/tum/aet/devops25/api/generated/`
+  - User Service: `user-svc/src/main/java/de/tum/aet/devops25/api/generated/`
+  - Concept Service: `concept-svc/src/main/java/de/tum/aet/devops25/api/generated/`
+
+- **Python Client**:
+  - GenAI Service: `genai-svc/client/`
+
+- **TypeScript SDK**:
+  - Web Client: `client/src/api/generated.ts`
+
+#### Code Generation Options
+
+The script supports generating code for specific languages:
+
+```bash
+# Generate only Java code
+./api/scripts/gen-all.sh java
+
+# Generate only Python client
+./api/scripts/gen-all.sh python
+
+# Generate only TypeScript SDK
+./api/scripts/gen-all.sh typescript
+```
+
+Running the script without arguments generates code for all languages.
+
 ## Versioning
 
 All APIs are versioned in the URL path (e.g., `/api/v1/resource`). When making breaking changes:

api/scripts/gen-all.sh

@@ -28,10 +28,6 @@ generate_java() {
   echo "Generating Java code..."
   check_command openapi-generator-cli
 
-  # Create output directories
-  create_dir "user-svc/src/main/java/generated"
-  create_dir "concept-svc/src/main/java/generated"
-
   # Generate code for API Gateway
   openapi-generator-cli generate \
     -i api/gateway.yaml \
@@ -46,7 +42,7 @@ generate_java() {
   openapi-generator-cli generate \
     -i api/user-service.yaml \
     -g spring \
-    -o user-svc/src/main/java/generated \
+    -o user-svc \
     --skip-validate-spec \
     --api-package de.tum.aet.devops25.api.generated.controller \
     --model-package de.tum.aet.devops25.api.generated.model \
@@ -56,7 +52,7 @@ generate_java() {
   openapi-generator-cli generate \
     -i api/concept-service.yaml \
     -g spring \
-    -o concept-svc/src/main/java/generated \
+    -o concept-svc \
     --skip-validate-spec \
     --api-package de.tum.aet.devops25.api.generated.controller \
     --model-package de.tum.aet.devops25.api.generated.model \

concept-svc/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

concept-svc/.openapi-generator/FILES

@@ -0,0 +1,18 @@
+README.md
+pom.xml
+src/main/java/de/tum/aet/devops25/api/generated/controller/ApiUtil.java
+src/main/java/de/tum/aet/devops25/api/generated/controller/ConceptsApi.java
+src/main/java/de/tum/aet/devops25/api/generated/controller/HealthApi.java
+src/main/java/de/tum/aet/devops25/api/generated/model/AgendaItem.java
+src/main/java/de/tum/aet/devops25/api/generated/model/ApplyConceptSuggestionRequest.java
+src/main/java/de/tum/aet/devops25/api/generated/model/ApplyConceptSuggestionRequestSuggestion.java
+src/main/java/de/tum/aet/devops25/api/generated/model/Concept.java
+src/main/java/de/tum/aet/devops25/api/generated/model/CreateConceptRequest.java
+src/main/java/de/tum/aet/devops25/api/generated/model/CreateConceptRequestInitialRequirements.java
+src/main/java/de/tum/aet/devops25/api/generated/model/ErrorResponse.java
+src/main/java/de/tum/aet/devops25/api/generated/model/EventDetails.java
+src/main/java/de/tum/aet/devops25/api/generated/model/GetConceptServiceHealth200Response.java
+src/main/java/de/tum/aet/devops25/api/generated/model/GetUserConcepts200Response.java
+src/main/java/de/tum/aet/devops25/api/generated/model/Pricing.java
+src/main/java/de/tum/aet/devops25/api/generated/model/Speaker.java
+src/main/java/de/tum/aet/devops25/api/generated/model/UpdateConceptRequest.java

concept-svc/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.14.0

concept-svc/README.md

@@ -0,0 +1,27 @@
+
+# OpenAPI generated API stub
+
+Spring Framework stub
+
+
+## Overview
+This code was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+By using the [OpenAPI-Spec](https://openapis.org), you can easily generate an API stub.
+This is an example of building API stub interfaces in Java using the Spring framework.
+
+The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
+by adding ```@Controller``` classes that implement the interface. Eg:
+```java
+@Controller
+public class PetController implements PetApi {
+// implement all PetApi methods
+}
+```
+
+You can also use the interface to create [Spring-Cloud Feign clients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).Eg:
+```java
+@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
+public interface PetClient extends PetApi {
+
+}
+```

concept-svc/pom.xml

@@ -0,0 +1,103 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.openapitools</groupId>
+    <artifactId>openapi-spring</artifactId>
+    <packaging>jar</packaging>
+    <name>openapi-spring</name>
+    <version>1.0.0</version>
+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <springdoc.version>2.6.0</springdoc.version>
+        <swagger-ui.version>5.17.14</swagger-ui.version>
+    </properties>
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>3.1.3</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+
+    <repositories>
+        <repository>
+            <id>repository.spring.milestone</id>
+            <name>Spring Milestone Repository</name>
+            <url>https://repo.spring.io/milestone</url>
+        </repository>
+    </repositories>
+    <pluginRepositories>
+        <pluginRepository>
+            <id>spring-milestones</id>
+            <url>https://repo.spring.io/milestone</url>
+        </pluginRepository>
+    </pluginRepositories>
+
+    <build>
+        <sourceDirectory>src/main/java</sourceDirectory>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.data</groupId>
+            <artifactId>spring-data-commons</artifactId>
+        </dependency>
+          <!--SpringDoc dependencies -->
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>${springdoc.version}</version>
+        </dependency>
+        <!-- @Nullable annotation -->
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>jsr305</artifactId>
+            <version>3.0.2</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
+            <version>0.2.6</version>
+        </dependency>
+        <!-- Bean Validation API support -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>