From d7cf96978a4e83769b5d9b600a14f92e1cd22a41 Mon Sep 17 00:00:00 2001 From: "Manuel Weiser (aider)" Date: Mon, 2 Sep 2024 11:12:54 +0200 Subject: [PATCH] docs: update README to include user edit and delete endpoints information --- game_collection/README.md | 61 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/game_collection/README.md b/game_collection/README.md index aedfe0a..05962b6 100644 --- a/game_collection/README.md +++ b/game_collection/README.md @@ -114,6 +114,67 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine ] ``` +### 6. Benutzer bearbeiten + +- **URL:** `/users/` +- **Method:** `PUT` +- **Body:** + ```json + { + "username": "Neuer Benutzername", + "role": "user/admin" # Optional + } + ``` +- **Antwort:** + - **Status 200:** Benutzer erfolgreich aktualisiert (nur für Administratoren). + - **Beispiel:** + ```json + { + "message": "User updated!" + } + ``` + - **Status 401:** Unbefugter Zugriff. + - **Beispiel:** + ```json + { + "message": "Unauthorized access! Only admins can edit users." + } + ``` + - **Status 404:** Benutzer nicht gefunden. + - **Beispiel:** + ```json + { + "message": "User not found!" + } + ``` + +### 7. Benutzer löschen + +- **URL:** `/users/` +- **Method:** `DELETE` +- **Antwort:** + - **Status 200:** Benutzer erfolgreich gelöscht (nur für Administratoren). + - **Beispiel:** + ```json + { + "message": "User deleted!" + } + ``` + - **Status 401:** Unbefugter Zugriff. + - **Beispiel:** + ```json + { + "message": "Unauthorized access! Only admins can delete users." + } + ``` + - **Status 404:** Benutzer nicht gefunden. + - **Beispiel:** + ```json + { + "message": "User not found!" + } + ``` + ## Installation 1. Klone das Repository.