From fc123a6e94efe78cf3021b32205c1cd0fdca514e Mon Sep 17 00:00:00 2001
From: Paul Reichmuth <p.n.reichmuth@gmail.com>
Date: Thu, 18 Dec 2025 15:37:44 +0100
Subject: [PATCH] begin documentation of TeamRestController.java

---
 .../controllers/TeamRestController.java           | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/main/java/de/pnreichmuth/timekeep_backend/controllers/TeamRestController.java b/src/main/java/de/pnreichmuth/timekeep_backend/controllers/TeamRestController.java
index 5149dea..4f038b3 100644
--- a/src/main/java/de/pnreichmuth/timekeep_backend/controllers/TeamRestController.java
+++ b/src/main/java/de/pnreichmuth/timekeep_backend/controllers/TeamRestController.java
@@ -25,6 +25,14 @@ public class TeamRestController {
 
     private final TeamService teamService;
 
+    ///////////////////////////////////////////////////BEGIN POST MAPPINGS///////////////////////////////////////////////////
+
+    /**
+     * Creates a team with the information provided via the /teams/createTeam endpoint
+     * @param team
+     * @return a ResponseEntity,
+     * either containing a TeamWSTO if a team was successfully created or a HttpStatus.CONFLICT if the team already existed beforehand
+     */
     @PostMapping("createTeam")
     public ResponseEntity<@NonNull TeamWSTO> createTeam(@RequestBody Team team){
         try {
@@ -36,6 +44,11 @@ public class TeamRestController {
     }
 
 
+    ///////////////////////////////////////////////////BEGIN GET MAPPINGS///////////////////////////////////////////////////
+    /**
+     *
+     * @return
+     */
     @GetMapping("all")
     public ResponseEntity<@NonNull List<TeamWSTO>> getAllTeams(){
         List<Team> teams = teamService.getTeams();
@@ -71,6 +84,8 @@ public class TeamRestController {
         }
     }
 
+    ///////////////////////////////////////////////////BEGIN DELETE MAPPINGS///////////////////////////////////////////////////
+
     @DeleteMapping("all")
     public ResponseEntity< @NonNull String> deleteAllTeams(){
         teamService.deleteAllTeams();