ADR

Author: Joern Wellniak

docs/architecture/decisions/ADR-009-coding-rules.md

@@ -0,0 +1,54 @@
+# ADR-009: Use Google Coding Rules with Exception for Indentation
+
+Date: 2025-10-23
+
+## Status
+
+Accepted
+
+## Context
+
+The project aims to maintain a consistent and widely recognized coding style to improve code
+readability and collaboration. Google Coding Rules provide a comprehensive and well-documented
+standard for Java development. However, the team prefers using tabs instead of spaces for
+indentation to allow developers to customize their viewing preferences in their IDEs.
+
+## Decision
+
+The project will adopt Google Coding Rules as the standard coding style, with the exception of using
+tabs (`\t`) instead of spaces for indentation.
+
+## Consequences
+
+- **Positive**:
+    - Ensures a consistent and widely recognized coding style.
+    - Allows developers to adjust tab width in their IDEs for personal preference.
+    - Simplifies onboarding for developers familiar with Google Coding Rules.
+
+- **Negative**:
+    - Requires configuring tools and IDEs to enforce the use of tabs.
+    - May require additional effort to ensure compliance with the exception.
+
+## Implementation
+
+1. Configure the project to use Google Coding Rules:
+    - Add the `google-java-format` plugin to the build system (e.g., Maven):
+      ```xml
+      <plugin>
+          <groupId>com.github.sherter.google-java-format</groupId>
+          <artifactId>google-java-format-maven-plugin</artifactId>
+          <version>1.15.0</version>
+      </plugin>
+      ```
+
+2. Modify the formatter configuration to use tabs for indentation:
+    - Use the `--aosp` flag or customize the formatter to replace spaces with tabs.
+
+3. Update IDE settings to enforce tabs for indentation:
+    - For IntelliJ IDEA:
+        - Go to `Preferences > Code Style > Java`.
+        - Set "Use tab character" for indentation.
+
+4. Document this decision in the project's coding standards to ensure team-wide adherence.
+
+5. Add a pre-commit hook or CI check to validate compliance with the coding rules.

docs/architecture/decisions/ADR-010-openapi.md

@@ -0,0 +1,73 @@
+# ADR-010: Use OpenAPI Swagger Annotations for All REST API Endpoints
+
+Date: 2025-10-24
+
+## Status
+
+Accepted
+
+## Context
+
+To ensure that the REST API is well-documented and easily understandable for developers and external
+consumers, it is essential to provide clear and standardized documentation. OpenAPI (Swagger)
+annotations allow for the automatic generation of API documentation, which can be visualized using
+tools like Swagger UI. Currently, not all endpoints are annotated, and OpenAPI is not fully enabled
+in the Spring Boot application.
+
+## Decision
+
+All REST API endpoints in the project will be annotated with OpenAPI Swagger annotations.
+Additionally, OpenAPI will be enabled in the Spring Boot application to generate and serve the API
+documentation.
+
+## Consequences
+
+- **Positive**:
+    - Provides a standardized and comprehensive API documentation.
+    - Simplifies integration for external consumers by offering a clear contract.
+    - Reduces manual effort in maintaining API documentation.
+
+- **Negative**:
+    - Requires additional effort to annotate all existing endpoints.
+    - Developers need to be familiar with OpenAPI annotations.
+
+## Implementation
+
+1. Add the `springdoc-openapi` dependency to the `pom.xml`:
+   ```xml
+   <dependency>
+       <groupId>org.springdoc</groupId>
+       <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+       <version>2.1.0</version>
+   </dependency>
+   ```
+
+2. Annotate all REST API endpoints with OpenAPI annotations:
+   ```java
+   @RestController
+   @RequestMapping("/example")
+   @Tag(name = "Example", description = "Example API")
+   public class ExampleController {
+
+       @Operation(summary = "Get example data", description = "Fetches example data by ID")
+       @ApiResponses(value = {
+           @ApiResponse(responseCode = "200", description = "Successful operation"),
+           @ApiResponse(responseCode = "404", description = "Example not found")
+       })
+       @GetMapping("/{id}")
+       public ResponseEntity<ExampleDto> getExample(@PathVariable Long id) {
+           // Implementation here
+           return ResponseEntity.ok(new ExampleDto());
+       }
+   }
+   ```
+
+3. Enable OpenAPI in the Spring Boot application:
+    - No additional configuration is required as `springdoc-openapi` automatically enables Swagger
+      UI at `/swagger-ui.html`.
+
+4. Document this decision in the project's development guidelines to ensure all new endpoints are
+   annotated.
+
+5. Verify the generated documentation by accessing the Swagger UI at
+   `http://localhost:8080/swagger-ui.html`.