From 7bf9763a95a58e6503666843c2701172d36048f6 Mon Sep 17 00:00:00 2001 From: "Manuel Weiser (aider)" Date: Mon, 2 Sep 2024 11:44:04 +0200 Subject: [PATCH] docs: update README to include game editing and deletion endpoints --- game_collection/README.md | 62 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/game_collection/README.md b/game_collection/README.md index 60bedbd..f7b8b42 100644 --- a/game_collection/README.md +++ b/game_collection/README.md @@ -176,6 +176,68 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine } ``` +### 8. Spiel bearbeiten + +- **URL:** `/games/` +- **Method:** `PUT` +- **Body:** + ```json + { + "title": "Neuer Titel", + "image": "Neue URL zum Bild", + "owned": true/false # Optional, um den Besitzstatus zu aktualisieren + } + ``` +- **Antwort:** + - **Status 200:** Spiel erfolgreich aktualisiert. + - **Beispiel:** + ```json + { + "message": "Game updated!" + } + ``` + - **Status 401:** Unbefugter Zugriff. + - **Beispiel:** + ```json + { + "message": "Unauthorized access!" + } + ``` + - **Status 404:** Spiel nicht gefunden. + - **Beispiel:** + ```json + { + "message": "Game not found!" + } + ``` + +### 9. Spiel löschen + +- **URL:** `/games/` +- **Method:** `DELETE` +- **Antwort:** + - **Status 200:** Spiel erfolgreich gelöscht (nur für Administratoren). + - **Beispiel:** + ```json + { + "message": "Game deleted!" + } + ``` + - **Status 401:** Unbefugter Zugriff. + - **Beispiel:** + ```json + { + "message": "Unauthorized access! Only admins can delete games." + } + ``` + - **Status 404:** Spiel nicht gefunden. + - **Beispiel:** + ```json + { + "message": "Game not found!" + } + ``` + ## Installation 1. Klone das Repository.