From 64bfbecd8410822d168c4779850dc4bc797b55a2 Mon Sep 17 00:00:00 2001 From: "theis.gaedigk" Date: Tue, 19 Aug 2025 21:40:28 +0200 Subject: [PATCH] enhance documentation with additional context for item states and API responses --- Docs/backend_API_docs/README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Docs/backend_API_docs/README.md b/Docs/backend_API_docs/README.md index 03ead6f..ce50061 100644 --- a/Docs/backend_API_docs/README.md +++ b/Docs/backend_API_docs/README.md @@ -57,7 +57,7 @@ Each item has the following properties: - `id`: The unique identifier for the item. - `item_name`: The name of the item. - `can_borrow_role`: The role ID that is allowed to borrow the item. -- `inSafe`: Indicates whether the item is currently in the locker (1) or not (0). +- `inSafe`: Indicates whether the item is currently in the locker (1) or not (0). This variable/state can change over time. --- @@ -81,6 +81,10 @@ POST /apiV2/controlInSafe/your_admin_key/5/0 {} ``` +*An empty object means, that the operation was successful and no further information is returned.* + +*You also get an http 2xx status code.* + --- ### 3. Set Return Date @@ -103,6 +107,10 @@ POST /apiV2/setReturnDate/your_admin_key/123456 {} ``` +*An empty object means, that the operation was successful and no further information is returned.* + +*You also get an http 2xx status code.* + --- ### 4. Set Take Date @@ -125,6 +133,10 @@ POST /apiV2/setTakeDate/your_admin_key/123456 {} ``` +*An empty object means, that the operation was successful and no further information is returned.* + +*You also get an http 2xx status code.* + --- ## Error Handling