From 6a86b62aedb30d75c6b424b733fdab64f09ed537 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20K=C3=BCnzel?= <simonk@fsmpi.rwth-aachen.de>
Date: Wed, 19 Jun 2024 13:29:38 +0200
Subject: [PATCH] Fix feedback entry name

---
 api_specification.md | 11 ++++++-----
 src/api/feedback.py  | 18 +++++++++---------
 2 files changed, 15 insertions(+), 14 deletions(-)

diff --git a/api_specification.md b/api_specification.md
index 7b1c185..89de747 100644
--- a/api_specification.md
+++ b/api_specification.md
@@ -550,10 +550,10 @@ This route is only for moderators.
 
 ###### Response:
 
-| Field      | Type                           | Notes |
-|------------|--------------------------------|-------|
-| page_count | int                            |       |
-| page       | array of [feedback](#feedback) |       |
+| Field      | Type                                       | Notes |
+|------------|--------------------------------------------|-------|
+| page_count | int                                        |       |
+| page       | array of [feedback_entry](#feedback_entry) |       |
 
 ---
 
@@ -1215,7 +1215,7 @@ video or audio file
 | aspect_ratio | string |                                                 |
 | priority     | int    |                                                 |
 
-#### feedback
+#### feedback_entry
 
 | Field        | Type     | Notes |
 |--------------|----------|-------|
@@ -1569,6 +1569,7 @@ Possible `error_code`:
 ### v0.54
 
 * Added `PUT /feedback/new`, `GET /feedback?entries_per_page={entries_per_page}&page={page}`
+* Added `feedback_entry` object
 
 ### v0.53
 
diff --git a/src/api/feedback.py b/src/api/feedback.py
index b78fda9..9c553eb 100644
--- a/src/api/feedback.py
+++ b/src/api/feedback.py
@@ -20,15 +20,15 @@ VALUES (?, ?)
 """)
 
 
-def _feedback_db_to_json(feedback_db: DbResultRow):
-    feedback_json = {
-        "id": feedback_db["id"],
-        "time_created": feedback_db["time_created"].strftime(API_DATETIME_FORMAT),
-        "text": feedback_db["text"]
+def _feedback_entry_db_to_json(feedback_entry_db: DbResultRow):
+    feedback_entry_json = {
+        "id": feedback_entry_db["id"],
+        "time_created": feedback_entry_db["time_created"].strftime(API_DATETIME_FORMAT),
+        "text": feedback_entry_db["text"]
     }
-    if feedback_db["email"] is not None:
-        feedback_json["email"] = feedback_db["email"]
-    return feedback_json
+    if feedback_entry_db["email"] is not None:
+        feedback_entry_json["email"] = feedback_entry_db["email"]
+    return feedback_entry_json
 
 
 def get_feedback_entries(
@@ -48,7 +48,7 @@ def get_feedback_entries(
         """, [])
     )
     return (math.ceil(row_count_set[0]["count"] / entries_per_page),
-            list(map(_feedback_db_to_json, entries_db)))
+            list(map(_feedback_entry_db_to_json, entries_db)))
 
 
 def put_feedback(email: str or None, text: str):
-- 
GitLab