add missing javadoc comment

ls1intum · Feb 20, 2025 · 382fee3 · 382fee3
1 parent 565c285
commit 382fee3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/web/AnswerMessageResource.java b/src/main/java/de/tum/cit/aet/artemis/communication/web/AnswerMessageResource.java
@@ -106,6 +106,16 @@ public ResponseEntity<Void> deleteAnswerMessage(@PathVariable Long courseId, @Pa
         return ResponseEntity.ok().build();
     }
 
+    /**
+     * GET /communication/courses/{courseId}/answer-messages-source-posts : Retrieve source answer posts by their IDs
+     *
+     * @param courseId      id of the course the answer posts belong to
+     * @param answerPostIds list of answer post IDs to retrieve
+     * @return ResponseEntity with status 200 (OK) containing the list of found answer posts,
+     *         400 (Bad Request) if the provided list is null or empty,
+     *         or 404 (Not Found) if no matching answer posts are found
+     * @throws BadRequestAlertException if the provided answer post IDs are null, empty, or belong to a different course
+     */
     @GetMapping("communication/courses/{courseId}/answer-messages-source-posts")
     @EnforceAtLeastStudentInCourse
     public ResponseEntity<List<AnswerPost>> getSourceAnswerPostsByIds(@PathVariable Long courseId, @RequestParam List<Long> answerPostIds) {