From fde207a3e6d667b1ef1c65185448b67bcdebc5fd Mon Sep 17 00:00:00 2001
From: stephan <s.wilkens@gmx.net>
Date: Mon, 29 Dec 2025 00:08:16 +0100
Subject: [PATCH] docs: define update backend api

---
 CHANGELOG.md                                  |  1 +
 docs/update-api.md                            | 60 +++++++++++++++++++
 .../requirements/tasks/TASK_000030.md         |  1 +
 .../requirements/tasks/TASK_000031.md         |  1 +
 .../requirements/tasks/TASK_000032.md         |  1 +
 .../requirements/tasks/TASK_000033.md         |  1 +
 .../requirements/tasks/TASK_000034.md         |  1 +
 7 files changed, 66 insertions(+)
 create mode 100644 docs/update-api.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 31ab832..6f1a624 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -31,6 +31,7 @@ By: Codex (GPT-5)
 | 28.12.2025 | 🏗️ Planning | ID: US_000033 Rollback-UI dokumentiert. By: Codex (GPT-5) |
 | 28.12.2025 | 🏗️ Planning | ID: Update-UI Anforderungen um Backup-Voraussetzung ergaenzt. By: Codex (GPT-5) |
 | 28.12.2025 | 🏗️ Planning | ID: TASK_000030-TASK_000034 fuer Update-UI ausgearbeitet. By: Codex (GPT-5) |
+| 28.12.2025 | 📝 Req | ID: Update-API Endpunkte dokumentiert. By: Codex (GPT-5) |
 | 28.12.2025 | ⚙️ Code | ID: Update-Client Prototyp-Skript hinzugefuegt. By: Codex (GPT-5) |
 
 ---
diff --git a/docs/update-api.md b/docs/update-api.md
new file mode 100644
index 0000000..5a7b6fd
--- /dev/null
+++ b/docs/update-api.md
@@ -0,0 +1,60 @@
+ID: DOC_000006 | Version: 0.1.0 | Status: Draft
+By: Codex (GPT-5)
+
+# Update API (Kiddo Backend)
+
+## Purpose
+Definiert interne API-Endpunkte fuer Update-Status, Check, Apply, Rollback und Logs.
+
+## Endpoints
+
+### GET /update/status
+Antwort:
+```json
+{
+  "current_version": "0.1.2",
+  "last_status": "success|failed|unknown",
+  "last_error": "<optional>",
+  "last_timestamp": "2025-12-28T12:34:56Z"
+}
+```
+
+### POST /update/check
+Antwort:
+```json
+{
+  "available": true,
+  "latest_version": "0.1.3",
+  "artifact_url": "https://update.wlkns.org/kiddo/kiddo-0.1.3.tar.gz",
+  "sha256": "<hex>",
+  "message": "<optional>"
+}
+```
+
+### POST /update/apply
+Body (optional):
+```json
+{ "version": "0.1.3" }
+```
+Antwort:
+```json
+{ "started": true, "message": "update started" }
+```
+
+### POST /update/rollback
+Antwort:
+```json
+{ "started": true, "message": "rollback started" }
+```
+
+### GET /update/logs
+Antwort:
+```json
+[
+  {"timestamp":"2025-12-28T12:34:56Z","status":"success","message":"updated to 0.1.2"}
+]
+```
+
+## Notes
+- Alle Endpunkte erfordern Auth (Session/Bearer).
+- Apply/Rollback starten async; UI pollt /update/status.
diff --git a/project-management/requirements/tasks/TASK_000030.md b/project-management/requirements/tasks/TASK_000030.md
index 1d3f108..10b4387 100644
--- a/project-management/requirements/tasks/TASK_000030.md
+++ b/project-management/requirements/tasks/TASK_000030.md
@@ -12,6 +12,7 @@ US_000029
 ## Beschreibung
 - Update-Status und Version im UI anzeigen.
 - Letzten Status mit Zeitstempel visualisieren.
+- API-Basis: `GET /update/status` (siehe `docs/update-api.md`).
 
 ## Definition of Done (DoD)
 - UI zeigt Version + letzten Status.
diff --git a/project-management/requirements/tasks/TASK_000031.md b/project-management/requirements/tasks/TASK_000031.md
index 88daf3c..09371fa 100644
--- a/project-management/requirements/tasks/TASK_000031.md
+++ b/project-management/requirements/tasks/TASK_000031.md
@@ -12,6 +12,7 @@ US_000030
 ## Beschreibung
 - Button/Action fuer "Nach Updates suchen".
 - Ergebnisanzeige (Update verfuegbar/keine Updates/Fehler).
+- API-Basis: `POST /update/check` (siehe `docs/update-api.md`).
 
 ## Definition of Done (DoD)
 - UI zeigt Ergebnis des Update-Checks.
diff --git a/project-management/requirements/tasks/TASK_000032.md b/project-management/requirements/tasks/TASK_000032.md
index cbeea74..1314b54 100644
--- a/project-management/requirements/tasks/TASK_000032.md
+++ b/project-management/requirements/tasks/TASK_000032.md
@@ -13,6 +13,7 @@ US_000031
 - "Update installieren" Action.
 - Vor Start Backup-Pruefung/Backup-Erstellung erzwingen.
 - Fortschritt/Status im UI.
+- API-Basis: `POST /update/apply` (siehe `docs/update-api.md`).
 
 ## Definition of Done (DoD)
 - Update startet nur mit vorhandenem Backup.
diff --git a/project-management/requirements/tasks/TASK_000033.md b/project-management/requirements/tasks/TASK_000033.md
index f50de1b..4705ee1 100644
--- a/project-management/requirements/tasks/TASK_000033.md
+++ b/project-management/requirements/tasks/TASK_000033.md
@@ -12,6 +12,7 @@ US_000032
 ## Beschreibung
 - Logliste mit Zeitstempel und Ergebnis.
 - Keine sensiblen Daten anzeigen.
+- API-Basis: `GET /update/logs` (siehe `docs/update-api.md`).
 
 ## Definition of Done (DoD)
 - Logs sind sichtbar und chronologisch sortiert.
diff --git a/project-management/requirements/tasks/TASK_000034.md b/project-management/requirements/tasks/TASK_000034.md
index dcab0cc..7e5e399 100644
--- a/project-management/requirements/tasks/TASK_000034.md
+++ b/project-management/requirements/tasks/TASK_000034.md
@@ -13,6 +13,7 @@ US_000033
 - "Rollback" Action.
 - Nur aktiv, wenn Backup vorhanden.
 - Fortschritt/Status im UI.
+- API-Basis: `POST /update/rollback` (siehe `docs/update-api.md`).
 
 ## Definition of Done (DoD)
 - Rollback startet nur bei verfuegbarem Backup.